From 63796be58e6f8d3dee81d80bdfb0a5f7dcf6e6b0 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Wed, 27 May 2026 14:29:16 +1000 Subject: [PATCH] cloudflare update --- .../src/cloudflare/v00.00.00000/provider.yaml | 3909 +- .../v00.00.00000/services/abuse_reports.yaml | 1375 + .../v00.00.00000/services/access.yaml | 5865 -- .../v00.00.00000/services/access_rules.yaml | 1121 - .../v00.00.00000/services/accounts.yaml | 6059 +- .../cloudflare/v00.00.00000/services/acm.yaml | 993 + .../v00.00.00000/services/addressing.yaml | 5001 + .../cloudflare/v00.00.00000/services/ai.yaml | 27892 +++++ .../v00.00.00000/services/ai_gateway.yaml | 7630 ++ .../v00.00.00000/services/aisearch.yaml | 16124 +++ .../v00.00.00000/services/alerting.yaml | 3040 + .../v00.00.00000/services/api_gateway.yaml | 5168 + .../v00.00.00000/services/api_shield.yaml | 927 - .../v00.00.00000/services/argo.yaml | 1147 +- .../v00.00.00000/services/audit_logs.yaml | 381 + .../v00.00.00000/services/billing.yaml | 1466 + .../v00.00.00000/services/bot_management.yaml | 943 + .../v00.00.00000/services/botnet_feed.yaml | 465 + .../services/brand_protection.yaml | 1548 + .../services/browser_rendering.yaml | 6058 ++ .../v00.00.00000/services/cache.yaml | 2939 + .../v00.00.00000/services/calls.yaml | 847 + .../services/certificate_authorities.yaml | 303 + .../v00.00.00000/services/certificates.yaml | 1148 - .../services/client_certificates.yaml | 802 + .../services/cloud_connector.yaml | 325 + .../v00.00.00000/services/cloudflare_ips.yaml | 188 - .../services/cloudflare_stream.yaml | 2824 - .../services/cloudflare_tunnel.yaml | 874 - .../v00.00.00000/services/cloudforce_one.yaml | 15392 +++ .../v00.00.00000/services/connectivity.yaml | 621 + .../services/content_scanning.yaml | 705 + .../services/custom_certificates.yaml | 1356 + .../services/custom_hostnames.yaml | 2624 +- .../services/custom_nameservers.yaml | 1026 +- .../v00.00.00000/services/custom_pages.yaml | 1892 + .../cloudflare/v00.00.00000/services/d1.yaml | 1718 + .../services/data_loss_prevention.yaml | 884 - .../v00.00.00000/services/dcv_delegation.yaml | 215 + .../services/ddos_protection.yaml | 3388 + .../v00.00.00000/services/devices.yaml | 2708 - .../v00.00.00000/services/diagnostics.yaml | 878 + .../cloudflare/v00.00.00000/services/dns.yaml | 13871 ++- .../v00.00.00000/services/dns_firewall.yaml | 1813 + .../v00.00.00000/services/domains.yaml | 562 - .../services/durable_objects.yaml | 451 + .../v00.00.00000/services/email_routing.yaml | 2900 +- .../v00.00.00000/services/email_security.yaml | 6341 ++ .../v00.00.00000/services/email_sending.yaml | 1673 + .../v00.00.00000/services/filters.yaml | 955 + .../v00.00.00000/services/firewall.yaml | 7260 ++ .../v00.00.00000/services/fraud.yaml | 311 + .../services/google_tag_gateway.yaml | 327 + .../v00.00.00000/services/healthchecks.yaml | 1282 + .../v00.00.00000/services/hostnames.yaml | 760 + .../v00.00.00000/services/hyperdrive.yaml | 855 + .../cloudflare/v00.00.00000/services/iam.yaml | 4607 + .../services/image_optimization.yaml | 1239 - .../v00.00.00000/services/images.yaml | 2209 + .../v00.00.00000/services/intel.yaml | 4861 + .../v00.00.00000/services/intelligence.yaml | 1183 - .../services/ip_address_management.yaml | 1674 - .../cloudflare/v00.00.00000/services/ips.yaml | 231 + .../services/keyless_certificates.yaml | 943 + .../cloudflare/v00.00.00000/services/kv.yaml | 1429 + .../services/leaked_credential_checks.yaml | 866 + .../v00.00.00000/services/lists.yaml | 1062 - .../v00.00.00000/services/load_balancers.yaml | 9747 +- .../v00.00.00000/services/logpush.yaml | 2680 + .../v00.00.00000/services/logs.yaml | 2948 +- .../v00.00.00000/services/magic.yaml | 3431 - .../services/magic_cloud_networking.yaml | 4727 + .../services/magic_network_monitoring.yaml | 1659 + .../v00.00.00000/services/magic_transit.yaml | 11523 ++ .../services/managed_transforms.yaml | 598 + .../v00.00.00000/services/memberships.yaml | 1245 + .../services/mtls_certificates.yaml | 1041 + .../services/network_interconnects.yaml | 1258 + .../v00.00.00000/services/notifications.yaml | 1305 - .../v00.00.00000/services/organization.yaml | 1256 - .../v00.00.00000/services/organizations.yaml | 2343 + .../services/origin_ca_certificates.yaml | 718 + .../origin_post_quantum_encryption.yaml | 369 + .../v00.00.00000/services/origin_pulls.yaml | 1224 - .../services/origin_tls_client_auth.yaml | 2197 + .../v00.00.00000/services/page_rules.yaml | 1073 + .../v00.00.00000/services/page_shield.yaml | 2340 +- .../v00.00.00000/services/pages.yaml | 5718 +- .../v00.00.00000/services/pipelines.yaml | 3211 + .../v00.00.00000/services/queues.yaml | 2615 + .../cloudflare/v00.00.00000/services/r2.yaml | 4648 + .../services/r2_data_catalog.yaml | 1705 + .../v00.00.00000/services/radar.yaml | 87526 ++++++++++++++-- .../v00.00.00000/services/railgun.yaml | 2133 - .../v00.00.00000/services/rate_limits.yaml | 984 + .../v00.00.00000/services/realtime_kit.yaml | 11143 ++ .../v00.00.00000/services/registrar.yaml | 2152 + .../services/request_tracers.yaml | 362 + .../services/resource_sharing.yaml | 1682 + .../services/resource_tagging.yaml | 1160 + .../v00.00.00000/services/rules.yaml | 1681 + .../v00.00.00000/services/rulesets.yaml | 7093 +- .../cloudflare/v00.00.00000/services/rum.yaml | 1150 + .../services/schema_validation.yaml | 2133 + .../v00.00.00000/services/secrets_store.yaml | 2126 + .../services/security_center.yaml | 2363 + .../v00.00.00000/services/security_txt.yaml | 381 + .../v00.00.00000/services/snippets.yaml | 1422 + .../v00.00.00000/services/spectrum.yaml | 1888 +- .../v00.00.00000/services/speed.yaml | 1368 + .../cloudflare/v00.00.00000/services/ssl.yaml | 2294 + .../v00.00.00000/services/ssl_tls.yaml | 1799 - .../v00.00.00000/services/streams.yaml | 4556 + .../v00.00.00000/services/teamnet.yaml | 765 - .../v00.00.00000/services/tenants.yaml | 698 + .../services/token_validation.yaml | 1908 + .../v00.00.00000/services/turnstile.yaml | 896 + .../services/url_normalization.yaml | 514 + .../v00.00.00000/services/url_scanner.yaml | 6839 ++ .../v00.00.00000/services/user.yaml | 3726 + .../v00.00.00000/services/users.yaml | 2736 - .../v00.00.00000/services/vectorize.yaml | 3190 + .../services/vulnerability_scanner.yaml | 2535 + .../cloudflare/v00.00.00000/services/waf.yaml | 1521 - .../v00.00.00000/services/waiting_rooms.yaml | 4572 +- .../v00.00.00000/services/web3.yaml | 2394 +- .../v00.00.00000/services/workers.yaml | 21888 +++- .../services/workers_for_platforms.yaml | 3315 + .../v00.00.00000/services/workflows.yaml | 4106 + .../v00.00.00000/services/zaraz.yaml | 1271 + .../v00.00.00000/services/zero_trust.yaml | 55136 +++++++++- .../v00.00.00000/services/zones.yaml | 20589 ++-- 132 files changed, 457561 insertions(+), 90447 deletions(-) create mode 100644 providers/src/cloudflare/v00.00.00000/services/abuse_reports.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/access.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/access_rules.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/acm.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/addressing.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/ai.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/ai_gateway.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/aisearch.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/alerting.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/api_gateway.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/api_shield.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/audit_logs.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/billing.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/bot_management.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/botnet_feed.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/brand_protection.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/browser_rendering.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/cache.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/calls.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/certificate_authorities.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/certificates.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/client_certificates.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/cloud_connector.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/cloudflare_ips.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/cloudflare_stream.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/cloudflare_tunnel.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/connectivity.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/content_scanning.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/custom_certificates.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/custom_pages.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/d1.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/data_loss_prevention.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/dcv_delegation.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/ddos_protection.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/devices.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/diagnostics.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/dns_firewall.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/domains.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/durable_objects.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/email_security.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/email_sending.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/filters.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/firewall.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/fraud.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/google_tag_gateway.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/healthchecks.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/hostnames.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/hyperdrive.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/iam.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/image_optimization.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/images.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/intel.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/intelligence.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/ip_address_management.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/ips.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/keyless_certificates.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/kv.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/leaked_credential_checks.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/lists.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/logpush.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/magic.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/magic_cloud_networking.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/magic_network_monitoring.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/magic_transit.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/managed_transforms.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/memberships.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/mtls_certificates.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/network_interconnects.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/notifications.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/organization.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/organizations.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/origin_ca_certificates.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/origin_post_quantum_encryption.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/origin_pulls.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/origin_tls_client_auth.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/page_rules.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/pipelines.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/queues.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/r2.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/railgun.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/rate_limits.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/realtime_kit.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/registrar.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/request_tracers.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/resource_sharing.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/resource_tagging.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/rules.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/rum.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/schema_validation.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/secrets_store.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/security_center.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/security_txt.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/snippets.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/speed.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/ssl.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/ssl_tls.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/streams.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/teamnet.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/tenants.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/token_validation.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/turnstile.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/url_normalization.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/url_scanner.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/user.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/users.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/vectorize.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/vulnerability_scanner.yaml delete mode 100644 providers/src/cloudflare/v00.00.00000/services/waf.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/workers_for_platforms.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/workflows.yaml create mode 100644 providers/src/cloudflare/v00.00.00000/services/zaraz.yaml diff --git a/providers/src/cloudflare/v00.00.00000/provider.yaml b/providers/src/cloudflare/v00.00.00000/provider.yaml index 7ad6b3ca..632322e1 100644 --- a/providers/src/cloudflare/v00.00.00000/provider.yaml +++ b/providers/src/cloudflare/v00.00.00000/provider.yaml @@ -2,375 +2,3894 @@ id: cloudflare name: cloudflare version: v00.00.00000 providerServices: - access: - description: Access Bookmark Applications (Deprecated) - id: 'access:v00.00.00000' - name: access + abuse_reports: + id: abuse_reports:v00.00.00000 + name: abuse_reports preferred: true service: - $ref: cloudflare/v00.00.00000/services/access.yaml - title: Cloudflare API - Access - version: v00.00.00000 - access_rules: - description: IP Access Rules For A User - id: 'access_rules:v00.00.00000' - name: access_rules - preferred: true - service: - $ref: cloudflare/v00.00.00000/services/access_rules.yaml - title: Cloudflare API - Access Rules + $ref: cloudflare/v00.00.00000/services/abuse_reports.yaml + title: abuse_reports API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). accounts: - description: Account Billing Profile - id: 'accounts:v00.00.00000' + id: accounts:v00.00.00000 name: accounts preferred: true service: $ref: cloudflare/v00.00.00000/services/accounts.yaml - title: Cloudflare API - Accounts + title: accounts API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + acm: + id: acm:v00.00.00000 + name: acm + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/acm.yaml + title: acm API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + addressing: + id: addressing:v00.00.00000 + name: addressing + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/addressing.yaml + title: addressing API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + ai: + id: ai:v00.00.00000 + name: ai + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/ai.yaml + title: ai API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + aisearch: + id: aisearch:v00.00.00000 + name: aisearch + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/aisearch.yaml + title: aisearch API version: v00.00.00000 - api_shield: - description: API Shield Endpoint Management - id: 'api_shield:v00.00.00000' - name: api_shield + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + ai_gateway: + id: ai_gateway:v00.00.00000 + name: ai_gateway preferred: true service: - $ref: cloudflare/v00.00.00000/services/api_shield.yaml - title: Cloudflare API - Api Shield + $ref: cloudflare/v00.00.00000/services/ai_gateway.yaml + title: ai_gateway API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + alerting: + id: alerting:v00.00.00000 + name: alerting + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/alerting.yaml + title: alerting API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + api_gateway: + id: api_gateway:v00.00.00000 + name: api_gateway + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/api_gateway.yaml + title: api_gateway API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). argo: - description: Argo Analytics For Geolocation - id: 'argo:v00.00.00000' + id: argo:v00.00.00000 name: argo preferred: true service: $ref: cloudflare/v00.00.00000/services/argo.yaml - title: Cloudflare API - Argo + title: argo API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + audit_logs: + id: audit_logs:v00.00.00000 + name: audit_logs + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/audit_logs.yaml + title: audit_logs API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + billing: + id: billing:v00.00.00000 + name: billing + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/billing.yaml + title: billing API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + botnet_feed: + id: botnet_feed:v00.00.00000 + name: botnet_feed + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/botnet_feed.yaml + title: botnet_feed API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + bot_management: + id: bot_management:v00.00.00000 + name: bot_management + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/bot_management.yaml + title: bot_management API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + brand_protection: + id: brand_protection:v00.00.00000 + name: brand_protection + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/brand_protection.yaml + title: brand_protection API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + browser_rendering: + id: browser_rendering:v00.00.00000 + name: browser_rendering + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/browser_rendering.yaml + title: browser_rendering API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + cache: + id: cache:v00.00.00000 + name: cache + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/cache.yaml + title: cache API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + calls: + id: calls:v00.00.00000 + name: calls + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/calls.yaml + title: calls API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + certificate_authorities: + id: certificate_authorities:v00.00.00000 + name: certificate_authorities + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/certificate_authorities.yaml + title: certificate_authorities API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + client_certificates: + id: client_certificates:v00.00.00000 + name: client_certificates + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/client_certificates.yaml + title: client_certificates API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + cloudforce_one: + id: cloudforce_one:v00.00.00000 + name: cloudforce_one + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/cloudforce_one.yaml + title: cloudforce_one API version: v00.00.00000 - certificates: - description: Analyze Certificate - id: 'certificates:v00.00.00000' - name: certificates + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + cloud_connector: + id: cloud_connector:v00.00.00000 + name: cloud_connector preferred: true service: - $ref: cloudflare/v00.00.00000/services/certificates.yaml - title: Cloudflare API - Certificates + $ref: cloudflare/v00.00.00000/services/cloud_connector.yaml + title: cloud_connector API version: v00.00.00000 - cloudflare_ips: - description: Cloudflare IPs - id: 'cloudflare_ips:v00.00.00000' - name: cloudflare_ips + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + connectivity: + id: connectivity:v00.00.00000 + name: connectivity preferred: true service: - $ref: cloudflare/v00.00.00000/services/cloudflare_ips.yaml - title: Cloudflare API - Cloudflare Ips + $ref: cloudflare/v00.00.00000/services/connectivity.yaml + title: connectivity API version: v00.00.00000 - cloudflare_stream: - description: Stream Live Inputs - id: 'cloudflare_stream:v00.00.00000' - name: cloudflare_stream + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + content_scanning: + id: content_scanning:v00.00.00000 + name: content_scanning preferred: true service: - $ref: cloudflare/v00.00.00000/services/cloudflare_stream.yaml - title: Cloudflare API - Cloudflare Stream + $ref: cloudflare/v00.00.00000/services/content_scanning.yaml + title: content_scanning API version: v00.00.00000 - cloudflare_tunnel: - description: Cloudflare Tunnel - id: 'cloudflare_tunnel:v00.00.00000' - name: cloudflare_tunnel + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + custom_certificates: + id: custom_certificates:v00.00.00000 + name: custom_certificates preferred: true service: - $ref: cloudflare/v00.00.00000/services/cloudflare_tunnel.yaml - title: Cloudflare API - Cloudflare Tunnel + $ref: cloudflare/v00.00.00000/services/custom_certificates.yaml + title: custom_certificates API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). custom_hostnames: - description: Custom Hostname Fallback Origin For A Zone - id: 'custom_hostnames:v00.00.00000' + id: custom_hostnames:v00.00.00000 name: custom_hostnames preferred: true service: $ref: cloudflare/v00.00.00000/services/custom_hostnames.yaml - title: Cloudflare API - Custom Hostnames + title: custom_hostnames API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). custom_nameservers: - description: Account Level Custom Nameservers - id: 'custom_nameservers:v00.00.00000' + id: custom_nameservers:v00.00.00000 name: custom_nameservers preferred: true service: $ref: cloudflare/v00.00.00000/services/custom_nameservers.yaml - title: Cloudflare API - Custom Nameservers + title: custom_nameservers API version: v00.00.00000 - data_loss_prevention: - description: DLP Pattern Validation - id: 'data_loss_prevention:v00.00.00000' - name: data_loss_prevention + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + custom_pages: + id: custom_pages:v00.00.00000 + name: custom_pages preferred: true service: - $ref: cloudflare/v00.00.00000/services/data_loss_prevention.yaml - title: Cloudflare API - Data Loss Prevention + $ref: cloudflare/v00.00.00000/services/custom_pages.yaml + title: custom_pages API version: v00.00.00000 - devices: - description: Device Posture Integrations - id: 'devices:v00.00.00000' - name: devices + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + d1: + id: d1:v00.00.00000 + name: d1 preferred: true service: - $ref: cloudflare/v00.00.00000/services/devices.yaml - title: Cloudflare API - Devices + $ref: cloudflare/v00.00.00000/services/d1.yaml + title: d1 API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + dcv_delegation: + id: dcv_delegation:v00.00.00000 + name: dcv_delegation + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/dcv_delegation.yaml + title: dcv_delegation API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + ddos_protection: + id: ddos_protection:v00.00.00000 + name: ddos_protection + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/ddos_protection.yaml + title: ddos_protection API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + diagnostics: + id: diagnostics:v00.00.00000 + name: diagnostics + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/diagnostics.yaml + title: diagnostics API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). dns: - description: DNS Analytics - id: 'dns:v00.00.00000' + id: dns:v00.00.00000 name: dns preferred: true service: $ref: cloudflare/v00.00.00000/services/dns.yaml - title: Cloudflare API - Dns + title: dns API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + dns_firewall: + id: dns_firewall:v00.00.00000 + name: dns_firewall + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/dns_firewall.yaml + title: dns_firewall API version: v00.00.00000 - domains: - description: Registrar Domains - id: 'domains:v00.00.00000' - name: domains + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + durable_objects: + id: durable_objects:v00.00.00000 + name: durable_objects preferred: true service: - $ref: cloudflare/v00.00.00000/services/domains.yaml - title: Cloudflare API - Domains + $ref: cloudflare/v00.00.00000/services/durable_objects.yaml + title: durable_objects API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). email_routing: - description: Email Routing Destination Addresses - id: 'email_routing:v00.00.00000' + id: email_routing:v00.00.00000 name: email_routing preferred: true service: $ref: cloudflare/v00.00.00000/services/email_routing.yaml - title: Cloudflare API - Email Routing + title: email_routing API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + email_security: + id: email_security:v00.00.00000 + name: email_security + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/email_security.yaml + title: email_security API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + email_sending: + id: email_sending:v00.00.00000 + name: email_sending + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/email_sending.yaml + title: email_sending API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + filters: + id: filters:v00.00.00000 + name: filters + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/filters.yaml + title: filters API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + firewall: + id: firewall:v00.00.00000 + name: firewall + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/firewall.yaml + title: firewall API version: v00.00.00000 - image_optimization: - description: Cloudflare Images - id: 'image_optimization:v00.00.00000' - name: image_optimization + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + fraud: + id: fraud:v00.00.00000 + name: fraud preferred: true service: - $ref: cloudflare/v00.00.00000/services/image_optimization.yaml - title: Cloudflare API - Image Optimization + $ref: cloudflare/v00.00.00000/services/fraud.yaml + title: fraud API version: v00.00.00000 - intelligence: - description: ASN Intelligence - id: 'intelligence:v00.00.00000' - name: intelligence + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + google_tag_gateway: + id: google_tag_gateway:v00.00.00000 + name: google_tag_gateway preferred: true service: - $ref: cloudflare/v00.00.00000/services/intelligence.yaml - title: Cloudflare API - Intelligence + $ref: cloudflare/v00.00.00000/services/google_tag_gateway.yaml + title: google_tag_gateway API version: v00.00.00000 - ip_address_management: - description: IP Address Management Address Maps - id: 'ip_address_management:v00.00.00000' - name: ip_address_management + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + healthchecks: + id: healthchecks:v00.00.00000 + name: healthchecks preferred: true service: - $ref: cloudflare/v00.00.00000/services/ip_address_management.yaml - title: Cloudflare API - Ip Address Management + $ref: cloudflare/v00.00.00000/services/healthchecks.yaml + title: healthchecks API version: v00.00.00000 - lists: - description: Lists - id: 'lists:v00.00.00000' - name: lists + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + hostnames: + id: hostnames:v00.00.00000 + name: hostnames preferred: true service: - $ref: cloudflare/v00.00.00000/services/lists.yaml - title: Cloudflare API - Lists + $ref: cloudflare/v00.00.00000/services/hostnames.yaml + title: hostnames API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + hyperdrive: + id: hyperdrive:v00.00.00000 + name: hyperdrive + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/hyperdrive.yaml + title: hyperdrive API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + iam: + id: iam:v00.00.00000 + name: iam + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/iam.yaml + title: iam API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + images: + id: images:v00.00.00000 + name: images + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/images.yaml + title: images API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + intel: + id: intel:v00.00.00000 + name: intel + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/intel.yaml + title: intel API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + ips: + id: ips:v00.00.00000 + name: ips + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/ips.yaml + title: ips API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + keyless_certificates: + id: keyless_certificates:v00.00.00000 + name: keyless_certificates + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/keyless_certificates.yaml + title: keyless_certificates API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + kv: + id: kv:v00.00.00000 + name: kv + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/kv.yaml + title: kv API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + leaked_credential_checks: + id: leaked_credential_checks:v00.00.00000 + name: leaked_credential_checks + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/leaked_credential_checks.yaml + title: leaked_credential_checks API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). load_balancers: - description: Account Load Balancer Monitors - id: 'load_balancers:v00.00.00000' + id: load_balancers:v00.00.00000 name: load_balancers preferred: true service: $ref: cloudflare/v00.00.00000/services/load_balancers.yaml - title: Cloudflare API - Load Balancers + title: load_balancers API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + logpush: + id: logpush:v00.00.00000 + name: logpush + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/logpush.yaml + title: logpush API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). logs: - description: Logpush Jobs - id: 'logs:v00.00.00000' + id: logs:v00.00.00000 name: logs preferred: true service: $ref: cloudflare/v00.00.00000/services/logs.yaml - title: Cloudflare API - Logs + title: logs API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + magic_cloud_networking: + id: magic_cloud_networking:v00.00.00000 + name: magic_cloud_networking + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/magic_cloud_networking.yaml + title: magic_cloud_networking API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + magic_network_monitoring: + id: magic_network_monitoring:v00.00.00000 + name: magic_network_monitoring + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/magic_network_monitoring.yaml + title: magic_network_monitoring API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + magic_transit: + id: magic_transit:v00.00.00000 + name: magic_transit + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/magic_transit.yaml + title: magic_transit API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + managed_transforms: + id: managed_transforms:v00.00.00000 + name: managed_transforms + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/managed_transforms.yaml + title: managed_transforms API version: v00.00.00000 - magic: - description: Magic GRE Tunnels - id: 'magic:v00.00.00000' - name: magic + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + memberships: + id: memberships:v00.00.00000 + name: memberships preferred: true service: - $ref: cloudflare/v00.00.00000/services/magic.yaml - title: Cloudflare API - Magic + $ref: cloudflare/v00.00.00000/services/memberships.yaml + title: memberships API version: v00.00.00000 - notifications: - description: Notification Alert Types - id: 'notifications:v00.00.00000' - name: notifications + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + mtls_certificates: + id: mtls_certificates:v00.00.00000 + name: mtls_certificates preferred: true service: - $ref: cloudflare/v00.00.00000/services/notifications.yaml - title: Cloudflare API - Notifications + $ref: cloudflare/v00.00.00000/services/mtls_certificates.yaml + title: mtls_certificates API version: v00.00.00000 - organization: - description: Organization Invites - id: 'organization:v00.00.00000' - name: organization + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + network_interconnects: + id: network_interconnects:v00.00.00000 + name: network_interconnects preferred: true service: - $ref: cloudflare/v00.00.00000/services/organization.yaml - title: Cloudflare API - Organization + $ref: cloudflare/v00.00.00000/services/network_interconnects.yaml + title: network_interconnects API version: v00.00.00000 - origin_pulls: - description: Per Hostname Authenticated Origin Pull - id: 'origin_pulls:v00.00.00000' - name: origin_pulls + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + organizations: + id: organizations:v00.00.00000 + name: organizations preferred: true service: - $ref: cloudflare/v00.00.00000/services/origin_pulls.yaml - title: Cloudflare API - Origin Pulls + $ref: cloudflare/v00.00.00000/services/organizations.yaml + title: organizations API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + origin_ca_certificates: + id: origin_ca_certificates:v00.00.00000 + name: origin_ca_certificates + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/origin_ca_certificates.yaml + title: origin_ca_certificates API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + origin_post_quantum_encryption: + id: origin_post_quantum_encryption:v00.00.00000 + name: origin_post_quantum_encryption + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/origin_post_quantum_encryption.yaml + title: origin_post_quantum_encryption API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + origin_tls_client_auth: + id: origin_tls_client_auth:v00.00.00000 + name: origin_tls_client_auth + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/origin_tls_client_auth.yaml + title: origin_tls_client_auth API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). pages: - description: Available Page Rules Settings - id: 'pages:v00.00.00000' + id: pages:v00.00.00000 name: pages preferred: true service: $ref: cloudflare/v00.00.00000/services/pages.yaml - title: Cloudflare API - Pages + title: pages API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + page_rules: + id: page_rules:v00.00.00000 + name: page_rules + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/page_rules.yaml + title: page_rules API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). page_shield: - description: Page Shield - id: 'page_shield:v00.00.00000' + id: page_shield:v00.00.00000 name: page_shield preferred: true service: $ref: cloudflare/v00.00.00000/services/page_shield.yaml - title: Cloudflare API - Page Shield + title: page_shield API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + pipelines: + id: pipelines:v00.00.00000 + name: pipelines + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/pipelines.yaml + title: pipelines API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + queues: + id: queues:v00.00.00000 + name: queues + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/queues.yaml + title: queues API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + r2: + id: r2:v00.00.00000 + name: r2 + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/r2.yaml + title: r2 API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + r2_data_catalog: + id: r2_data_catalog:v00.00.00000 + name: r2_data_catalog + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/r2_data_catalog.yaml + title: r2_data_catalog API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). radar: - description: Radar BGP - id: 'radar:v00.00.00000' + id: radar:v00.00.00000 name: radar preferred: true service: $ref: cloudflare/v00.00.00000/services/radar.yaml - title: Cloudflare API - Radar + title: radar API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + rate_limits: + id: rate_limits:v00.00.00000 + name: rate_limits + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/rate_limits.yaml + title: rate_limits API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + realtime_kit: + id: realtime_kit:v00.00.00000 + name: realtime_kit + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/realtime_kit.yaml + title: realtime_kit API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + registrar: + id: registrar:v00.00.00000 + name: registrar + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/registrar.yaml + title: registrar API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + request_tracers: + id: request_tracers:v00.00.00000 + name: request_tracers + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/request_tracers.yaml + title: request_tracers API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + resource_sharing: + id: resource_sharing:v00.00.00000 + name: resource_sharing + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/resource_sharing.yaml + title: resource_sharing API version: v00.00.00000 - railgun: - description: Account Railguns - id: 'railgun:v00.00.00000' - name: railgun + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + resource_tagging: + id: resource_tagging:v00.00.00000 + name: resource_tagging preferred: true service: - $ref: cloudflare/v00.00.00000/services/railgun.yaml - title: Cloudflare API - Railgun + $ref: cloudflare/v00.00.00000/services/resource_tagging.yaml + title: resource_tagging API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + rules: + id: rules:v00.00.00000 + name: rules + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/rules.yaml + title: rules API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). rulesets: - description: Account Rulesets - id: 'rulesets:v00.00.00000' + id: rulesets:v00.00.00000 name: rulesets preferred: true service: $ref: cloudflare/v00.00.00000/services/rulesets.yaml - title: Cloudflare API - Rulesets + title: rulesets API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + rum: + id: rum:v00.00.00000 + name: rum + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/rum.yaml + title: rum API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + schema_validation: + id: schema_validation:v00.00.00000 + name: schema_validation + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/schema_validation.yaml + title: schema_validation API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + secrets_store: + id: secrets_store:v00.00.00000 + name: secrets_store + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/secrets_store.yaml + title: secrets_store API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + security_center: + id: security_center:v00.00.00000 + name: security_center + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/security_center.yaml + title: security_center API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + security_txt: + id: security_txt:v00.00.00000 + name: security_txt + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/security_txt.yaml + title: security_txt API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + snippets: + id: snippets:v00.00.00000 + name: snippets + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/snippets.yaml + title: snippets API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). spectrum: - description: Spectrum Aggregate Analytics - id: 'spectrum:v00.00.00000' + id: spectrum:v00.00.00000 name: spectrum preferred: true service: $ref: cloudflare/v00.00.00000/services/spectrum.yaml - title: Cloudflare API - Spectrum + title: spectrum API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + speed: + id: speed:v00.00.00000 + name: speed + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/speed.yaml + title: speed API version: v00.00.00000 - ssl_tls: - description: Custom SSL For A Zone - id: 'ssl_tls:v00.00.00000' - name: ssl_tls + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + ssl: + id: ssl:v00.00.00000 + name: ssl preferred: true service: - $ref: cloudflare/v00.00.00000/services/ssl_tls.yaml - title: Cloudflare API - Ssl Tls + $ref: cloudflare/v00.00.00000/services/ssl.yaml + title: ssl API version: v00.00.00000 - teamnet: - description: Tunnel Route - id: 'teamnet:v00.00.00000' - name: teamnet + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + streams: + id: streams:v00.00.00000 + name: streams preferred: true service: - $ref: cloudflare/v00.00.00000/services/teamnet.yaml - title: Cloudflare API - Teamnet + $ref: cloudflare/v00.00.00000/services/streams.yaml + title: streams API version: v00.00.00000 - users: - description: Permission Groups - id: 'users:v00.00.00000' - name: users + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + tenants: + id: tenants:v00.00.00000 + name: tenants preferred: true service: - $ref: cloudflare/v00.00.00000/services/users.yaml - title: Cloudflare API - Users + $ref: cloudflare/v00.00.00000/services/tenants.yaml + title: tenants API version: v00.00.00000 - waf: - description: WAF Overrides - id: 'waf:v00.00.00000' - name: waf + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + token_validation: + id: token_validation:v00.00.00000 + name: token_validation preferred: true service: - $ref: cloudflare/v00.00.00000/services/waf.yaml - title: Cloudflare API - Waf + $ref: cloudflare/v00.00.00000/services/token_validation.yaml + title: token_validation API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + turnstile: + id: turnstile:v00.00.00000 + name: turnstile + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/turnstile.yaml + title: turnstile API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + url_normalization: + id: url_normalization:v00.00.00000 + name: url_normalization + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/url_normalization.yaml + title: url_normalization API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + url_scanner: + id: url_scanner:v00.00.00000 + name: url_scanner + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/url_scanner.yaml + title: url_scanner API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + user: + id: user:v00.00.00000 + name: user + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/user.yaml + title: user API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + vectorize: + id: vectorize:v00.00.00000 + name: vectorize + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/vectorize.yaml + title: vectorize API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + vulnerability_scanner: + id: vulnerability_scanner:v00.00.00000 + name: vulnerability_scanner + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/vulnerability_scanner.yaml + title: vulnerability_scanner API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). waiting_rooms: - description: Waiting Room - id: 'waiting_rooms:v00.00.00000' + id: waiting_rooms:v00.00.00000 name: waiting_rooms preferred: true service: $ref: cloudflare/v00.00.00000/services/waiting_rooms.yaml - title: Cloudflare API - Waiting Rooms + title: waiting_rooms API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). web3: - description: Web3 Hostname - id: 'web3:v00.00.00000' + id: web3:v00.00.00000 name: web3 preferred: true service: $ref: cloudflare/v00.00.00000/services/web3.yaml - title: Cloudflare API - Web3 + title: web3 API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). workers: - description: Durable Objects Namespace - id: 'workers:v00.00.00000' + id: workers:v00.00.00000 name: workers preferred: true service: $ref: cloudflare/v00.00.00000/services/workers.yaml - title: Cloudflare API - Workers + title: workers API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + workers_for_platforms: + id: workers_for_platforms:v00.00.00000 + name: workers_for_platforms + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/workers_for_platforms.yaml + title: workers_for_platforms API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + workflows: + id: workflows:v00.00.00000 + name: workflows + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/workflows.yaml + title: workflows API + version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + zaraz: + id: zaraz:v00.00.00000 + name: zaraz + preferred: true + service: + $ref: cloudflare/v00.00.00000/services/zaraz.yaml + title: zaraz API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). zero_trust: - description: Zero Trust Gateway Application And Application Type Mappings - id: 'zero_trust:v00.00.00000' + id: zero_trust:v00.00.00000 name: zero_trust preferred: true service: $ref: cloudflare/v00.00.00000/services/zero_trust.yaml - title: Cloudflare API - Zero Trust + title: zero_trust API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). zones: - description: Filters - id: 'zones:v00.00.00000' + id: zones:v00.00.00000 name: zones preferred: true service: $ref: cloudflare/v00.00.00000/services/zones.yaml - title: Cloudflare API - Zones + title: zones API version: v00.00.00000 + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with + an updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) + to maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from + the Cloudflare dashboard, go to My Profile > API Tokens and select Create + Token. For more information on how to create and troubleshoot API tokens, + refer to our [API + fundamentals](https://developers.cloudflare.com/fundamentals/api/). For + information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). config: auth: type: bearer diff --git a/providers/src/cloudflare/v00.00.00000/services/abuse_reports.yaml b/providers/src/cloudflare/v00.00.00000/services/abuse_reports.yaml new file mode 100644 index 00000000..e5ffb44e --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/abuse_reports.yaml @@ -0,0 +1,1375 @@ +openapi: 3.0.3 +info: + title: abuse_reports API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/abuse-reports: + get: + description: List the abuse reports for a given account + operationId: ListAbuseReports + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Where in pagination to start listing abuse reports + in: query + name: page + schema: + type: integer + - description: How many abuse reports per page to list + in: query + name: per_page + schema: + type: integer + - description: >- + A property to sort by, followed by the order (id, cdate, domain, + type, status) + in: query + name: sort + schema: + type: string + - description: Filter by domain name related to the abuse report + in: query + name: domain + schema: + type: string + - description: Returns reports created before the specified date + in: query + name: created_before + schema: + description: >- + Time in RFC 3339 format + (https://www.rfc-editor.org/rfc/rfc3339.html) + type: string + - description: Returns reports created after the specified date + in: query + name: created_after + schema: + description: >- + Time in RFC 3339 format + (https://www.rfc-editor.org/rfc/rfc3339.html) + type: string + - description: Filter by the status of the report. + in: query + name: status + schema: + $ref: '#/components/schemas/abuseReportsReportStatus' + - description: Filter by the type of the report. + in: query + name: type + schema: + $ref: '#/components/schemas/abuseReportsReportType' + - description: Filter reports that have any mitigations in the given status. + in: query + name: mitigation_status + schema: + $ref: '#/components/schemas/abuseReportsMitigationStatus' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + result: + properties: + reports: + items: + $ref: '#/components/schemas/abuseReportsAbuseReport' + type: array + required: + - reports + type: object + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - page + - per_page + - count + - total_count + - total_pages + type: object + success: + type: boolean + required: + - success + type: object + description: Abuse report list successful + '500': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + success: + type: boolean + required: + - success + type: object + description: Failed to retrieve abuse reports + security: + - api_token: [] + summary: List abuse reports + tags: + - tseng-abuse-complaint-processor_other + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + x-stackql-sdk: + service: abuse_reports + resource_chain: [] + method: list + /accounts/{account_id}/abuse-reports/{report_id}/emails: + get: + description: >- + List emails sent to the customer for an abuse report. Returns all + successful customer emails sent for the specified abuse report. Does not + include emails sent to hosts or submitters. + operationId: ListEmails + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Abuse Report ID + in: path + name: report_id + schema: + type: string + required: true + - description: Page number to retrieve (default 1) + in: query + name: page + schema: + type: integer + - description: Number of emails per page (default 20, max 100) + in: query + name: per_page + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + result: + properties: + emails: + items: + $ref: '#/components/schemas/abuseReportsEmailListItem' + type: array + required: + - emails + type: object + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - page + - per_page + - count + - total_count + - total_pages + type: object + success: + type: boolean + required: + - success + type: object + description: List abuse report emails successful + '400': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + success: + type: boolean + required: + - success + type: object + description: Bad request - invalid parameters or report not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + success: + type: boolean + required: + - success + type: object + description: Failed to list abuse report emails + security: + - api_token: [] + summary: List abuse report emails + tags: + - tseng-abuse-complaint-processor_other + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + /accounts/{account_id}/abuse-reports/{report_id}/mitigations: + get: + description: List mitigations done to remediate the abuse report. + operationId: ListMitigations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Abuse Report ID + in: path + name: report_id + schema: + type: string + required: true + - description: Where in pagination to start listing abuse reports + in: query + name: page + schema: + type: integer + - description: How many abuse reports per page to list + in: query + name: per_page + schema: + type: integer + - description: A property to sort by, followed by the order + in: query + name: sort + schema: + enum: + - type,asc + - type,desc + - effective_date,asc + - effective_date,desc + - status,asc + - status,desc + - entity_type,asc + - entity_type,desc + type: string + - description: >- + Filter by the type of mitigation. This filter parameter can be + specified multiple times to include multiple types of mitigations in + the result set, e.g. ?type=rate_limit_cache&type=legal_block. + in: query + name: type + schema: + $ref: '#/components/schemas/abuseReportsMitigationType' + - description: Returns mitigations that were dispatched before the given date + in: query + name: effective_before + schema: + description: >- + Time in RFC 3339 format + (https://www.rfc-editor.org/rfc/rfc3339.html) + type: string + - description: Returns mitigation that were dispatched after the given date + in: query + name: effective_after + schema: + description: >- + Time in RFC 3339 format + (https://www.rfc-editor.org/rfc/rfc3339.html) + type: string + - description: Filter by the status of the mitigation. + in: query + name: status + schema: + $ref: '#/components/schemas/abuseReportsMitigationStatus' + - description: Filter by the type of entity the mitigation impacts. + in: query + name: entity_type + schema: + $ref: '#/components/schemas/abuseReportsMitigatedEntityType' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + result: + properties: + mitigations: + items: + $ref: '#/components/schemas/abuseReportsMitigationListItem' + type: array + required: + - mitigations + type: object + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - page + - per_page + - count + - total_count + - total_pages + type: object + success: + type: boolean + required: + - success + type: object + description: List abuse report mitigations successful + '500': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + success: + type: boolean + required: + - success + type: object + description: Failed to list abuse report mitigations + security: + - api_token: [] + summary: List abuse report mitigations + tags: + - tseng-abuse-complaint-processor_other + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + x-stackql-sdk: + service: abuse_reports + resource_chain: + - mitigations + method: list + /accounts/{account_id}/abuse-reports/{report_id}/mitigations/appeal: + post: + description: Request a review for mitigations on an account. + operationId: RequestReview + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Abuse Report ID + in: path + name: report_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/abuseReportsMitigationAppealRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/abuseReportsMitigationAppealResult' + description: Mitigation appeals received + '500': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + success: + type: boolean + required: + - success + type: object + description: Failed to request review on delayed action. + security: + - api_token: [] + summary: Request review on mitigations + tags: + - tseng-abuse-complaint-processor_other + x-api-token-group: + - Trust and Safety Write + /accounts/{account_id}/abuse-reports/{report_param}: + get: + description: Retrieve the details of an abuse report. + operationId: GetAbuseReport + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Identifier of the abuse report + in: path + name: report_param + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsErrorMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + result: + $ref: '#/components/schemas/abuseReportsAbuseReport' + success: + type: boolean + required: + - success + - result + type: object + description: Report submitted successfully + '400': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsErrorMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + result: + $ref: '#/components/schemas/abuseReportsAbuseReport' + success: + type: boolean + required: + - success + - errors + type: object + description: Report submitted with an error + '500': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsErrorMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + result: + $ref: '#/components/schemas/abuseReportsAbuseReport' + success: + type: boolean + required: + - success + - errors + type: object + description: Report submitted with an error + security: + - api_token: [] + summary: Abuse Report Details + tags: + - tseng-abuse-complaint-processor_other + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + x-stackql-sdk: + service: abuse_reports + resource_chain: [] + method: get + post: + description: Submit the Abuse Report of a particular type + operationId: SubmitAbuseReport + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: 'The report type to be submitted. Example: abuse_general' + in: path + name: report_param + schema: + $ref: '#/components/schemas/abuseReportsSubmissionReportType' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/abuseReportsSubmitReportRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/abuseReportsSubmitReportResponse' + description: Report submitted successfully + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/abuseReportsSubmitErrorResponse' + description: Report submitted with an error + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/abuseReportsSubmitErrorResponse' + description: Report submitted with an error + security: + - api_token: [] + summary: Submit an abuse report + tags: + - tseng-abuse-complaint-processor_other + x-stackql-sdk: + service: abuse_reports + resource_chain: [] + method: create +components: + schemas: + abuseReportsAbuseReport: + properties: + cdate: + description: >- + Creation date of report. Time in RFC 3339 format + (https://www.rfc-editor.org/rfc/rfc3339.html) + example: '2009-11-10T23:00:00Z' + type: string + domain: + description: Domain that relates to the report. + type: string + id: + description: Public facing ID of abuse report, aka abuse_rand. + type: string + justification: + description: Justification for the report. + type: string + mitigation_summary: + $ref: '#/components/schemas/abuseReportsMitigationSummary' + original_work: + description: Original work / Targeted brand in the alleged abuse. + type: string + status: + $ref: '#/components/schemas/abuseReportsReportStatus' + submitter: + $ref: '#/components/schemas/abuseReportsSubmitterDetails' + type: + $ref: '#/components/schemas/abuseReportsReportType' + urls: + items: + type: string + type: array + required: + - id + - cdate + - domain + - type + - status + - mitigation_summary + type: object + abuseReportsAppealReason: + description: Reason why the customer is appealing. + enum: + - removed + - misclassified + example: misclassified + type: string + abuseReportsEmailListItem: + description: An email sent to the customer for an abuse report. + properties: + body: + description: Body content of the email. + type: string + id: + description: Unique identifier of the email. + type: string + recipient: + description: Email address of the recipient. + type: string + sent_at: + description: >- + When the email was sent. Time in RFC 3339 format + (https://www.rfc-editor.org/rfc/rfc3339.html) + example: '2009-11-10T23:00:00Z' + type: string + subject: + description: Subject line of the email. + type: string + required: + - id + - subject + - body + - recipient + - sent_at + type: object + abuseReportsErrorCode: + type: string + description: Report has invalid type + abuseReportsErrorMessage: + properties: + code: + type: string + message: + type: string + required: + - message + type: object + abuseReportsMessage: + properties: + message: + type: string + required: + - message + type: object + abuseReportsMitigatedEntityType: + enum: + - url_pattern + - account + - zone + type: string + abuseReportsMitigationAppeal: + properties: + id: + description: ID of the mitigation to appeal. + type: string + reason: + $ref: '#/components/schemas/abuseReportsAppealReason' + required: + - id + - reason + type: object + abuseReportsMitigationAppealRequest: + properties: + appeals: + description: List of mitigations to appeal. + items: + $ref: '#/components/schemas/abuseReportsMitigationAppeal' + type: array + required: + - appeals + type: object + abuseReportsMitigationAppealResult: + properties: + errors: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + messages: + items: + $ref: '#/components/schemas/abuseReportsMessage' + type: array + result: + items: + $ref: '#/components/schemas/abuseReportsMitigationListItem' + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - page + - per_page + - count + - total_count + - total_pages + type: object + success: + type: boolean + required: + - success + - result_info + type: object + abuseReportsMitigationListItem: + properties: + effective_date: + description: >- + Date when the mitigation will become active. Time in RFC 3339 format + (https://www.rfc-editor.org/rfc/rfc3339.html) + example: '2009-11-10T23:00:00Z' + type: string + entity_id: + type: string + entity_type: + $ref: '#/components/schemas/abuseReportsMitigatedEntityType' + id: + description: ID of remediation. + type: string + status: + $ref: '#/components/schemas/abuseReportsMitigationStatus' + type: + $ref: '#/components/schemas/abuseReportsMitigationType' + required: + - id + - type + - effective_date + - status + - entity_type + - entity_id + type: object + abuseReportsMitigationStatus: + description: The status of a mitigation + enum: + - pending + - active + - in_review + - cancelled + - removed + type: string + abuseReportsMitigationSummary: + description: A summary of the mitigations related to this report. + properties: + accepted_url_count: + description: How many of the reported URLs were confirmed as abusive. + type: integer + active_count: + description: How many mitigations are active. + type: integer + external_host_notified: + description: >- + Whether the report has been forwarded to an external hosting + provider. + type: boolean + in_review_count: + description: How many mitigations are under review. + type: integer + pending_count: + description: How many mitigations are pending their effective date. + type: integer + required: + - accepted_url_count + - pending_count + - active_count + - in_review_count + - external_host_notified + type: object + abuseReportsMitigationType: + description: The type of mitigation + enum: + - legal_block + - misleading_interstitial + - phishing_interstitial + - network_block + - rate_limit_cache + - account_suspend + - redirect_video_stream + type: string + abuseReportsRegistrarWhoIsFields: + description: RDP-mandated fields for registrar WHOIS data disclosure requests. + properties: + reg_who_authorization_statement: + description: >- + Optional authorization statement or power of attorney per RDP + 10.2.1.3. + maxLength: 5000 + type: string + reg_who_good_faith_affirmation: + description: >- + Affirmation that the request is made in good faith per RDP 10.2.4. + Must be true. + type: boolean + reg_who_lawful_processing_agreement: + description: Agreement to process data lawfully per RDP 10.2.5. Must be true. + type: boolean + reg_who_legal_basis: + description: >- + Legal rights and rationale for the request per RDP 10.2.3. Required + for all WHOIS requests. + maxLength: 5000 + type: string + reg_who_request_type: + description: The type of WHOIS data request per RDP procedure. + enum: + - disclosure + - invalid_whois + type: string + reg_who_requested_data_elements: + description: >- + The specific WHOIS data elements being requested per RDP 10.2.2. + Required for all WHOIS requests. + items: + enum: + - registrant_name + - registrant_organization + - registrant_email + - registrant_phone + - registrant_address + - registrant_address_country + - registrant_address_postal_code + - admin_name + - admin_organization + - admin_email + - admin_phone + - admin_address + - tech_name + - tech_organization + - tech_email + - tech_phone + - tech_address + type: string + maxItems: 17 + minItems: 1 + type: array + reg_who_requestor_type: + description: The nature of the requestor per RDP 10.2.1.2. + enum: + - government + - corporation + - individual + type: string + required: + - reg_who_request_type + - reg_who_requested_data_elements + - reg_who_legal_basis + - reg_who_good_faith_affirmation + - reg_who_lawful_processing_agreement + type: object + abuseReportsReportStatus: + description: An enum value that represents the status of an abuse record + enum: + - accepted + - in_review + type: string + abuseReportsReportType: + description: The abuse report type + enum: + - PHISH + - GEN + - THREAT + - DMCA + - EMER + - TM + - REG_WHO + - NCSEI + - NETWORK + type: string + abuseReportsSubmissionReportType: + description: The report type for submitted reports. + type: string + abuseReportsSubmitErrorResponse: + properties: + error_code: + $ref: '#/components/schemas/abuseReportsErrorCode' + msg: + description: The error message for the error + type: string + request: + properties: + act: + $ref: '#/components/schemas/abuseReportsSubmissionReportType' + required: + - act + type: object + result: + description: The result should be 'error' for successful response + type: string + required: + - request + - result + - msg + - error_code + type: object + abuseReportsSubmitReportRequest: + type: object + title: DMCA Report + properties: + act: + description: The report type for submitted reports. + type: string + enum: + - abuse_dmca + comments: + description: >- + Any additional comments about the infringement not exceeding 2000 + characters + maxLength: 2000 + minLength: 1 + type: string + company: + description: >- + Text not exceeding 100 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 100 + minLength: 1 + type: string + email: + description: >- + A valid email of the abuse reporter. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + type: string + email2: + description: Should match the value provided in `email` + type: string + name: + description: >- + Text not exceeding 255 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 255 + minLength: 1 + type: string + reported_country: + description: Text containing 2 characters + maxLength: 2 + minLength: 2 + type: string + reported_user_agent: + description: Text not exceeding 255 characters + maxLength: 255 + minLength: 1 + type: string + tele: + description: >- + Text not exceeding 20 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 20 + minLength: 1 + type: string + title: + description: Text not exceeding 255 characters + maxLength: 255 + minLength: 1 + type: string + urls: + description: >- + A list of valid URLs separated by ‘\n’ (new line character). The + list of the URLs should not exceed 250 URLs. All URLs should have + the same hostname. Each URL should be unique. This field may be + released by Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + type: string + address1: + description: >- + Text not exceeding 100 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 100 + minLength: 1 + type: string + agent_name: + description: >- + The name of the copyright holder. Text not exceeding 60 characters. + This field may be released by Cloudflare to third parties such as + the Lumen Database (https://lumendatabase.org/). + maxLength: 60 + minLength: 1 + type: string + agree: + description: >- + Can be `0` for false or `1` for true. Must be value: 1 for DMCA + reports + enum: + - 1 + type: integer + city: + description: >- + Text not exceeding 255 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 255 + minLength: 1 + type: string + country: + description: >- + Text not exceeding 255 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 255 + minLength: 1 + type: string + host_notification: + description: >- + Notification type based on the abuse type. NOTE: Copyright (DMCA) + and Trademark reports cannot be anonymous. + enum: + - send + type: string + original_work: + description: >- + Text not exceeding 255 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 255 + minLength: 1 + type: string + owner_notification: + description: >- + Notification type based on the abuse type. NOTE: Copyright (DMCA) + and Trademark reports cannot be anonymous. + enum: + - send + type: string + signature: + description: >- + Required for DMCA reports, should be same as Name. An affirmation + that all information in the report is true and accurate while + agreeing to the policies of Cloudflare's abuse reports + type: string + state: + description: >- + Text not exceeding 255 characters. This field may be released by + Cloudflare to third parties such as the Lumen Database + (https://lumendatabase.org/). + maxLength: 255 + minLength: 1 + type: string + justification: + description: >- + A detailed description of the infringement, including any necessary + access details and the exact steps needed to view the content, not + exceeding 5000 characters. + maxLength: 5000 + minLength: 1 + type: string + trademark_number: + description: Text not exceeding 1000 characters + maxLength: 1000 + minLength: 1 + type: string + trademark_office: + description: Text not exceeding 1000 characters + maxLength: 1000 + minLength: 1 + type: string + trademark_symbol: + description: Text not exceeding 1000 characters + maxLength: 1000 + minLength: 1 + type: string + destination_ips: + description: >- + A list of IP addresses separated by ‘\n’ (new line character). The + list of destination IPs should not exceed 30 IP addresses. Each one + of the IP addresses ought to be unique. + type: string + ports_protocols: + description: >- + A comma separated list of ports and protocols e.g. 80/TCP, 22/UDP. + The total size of the field should not exceed 2000 characters. Each + individual port/protocol should not exceed 100 characters. The list + should not have more than 30 unique ports and protocols. + type: string + source_ips: + description: >- + A list of IP addresses separated by ‘\n’ (new line character). The + list of source IPs should not exceed 30 IP addresses. Each one of + the IP addresses ought to be unique. + type: string + ncmec_notification: + description: >- + Notification type based on the abuse type. NOTE: Copyright (DMCA) + and Trademark reports cannot be anonymous. + enum: + - send + - send-anon + type: string + reg_who_request: + $ref: '#/components/schemas/abuseReportsRegistrarWhoIsFields' + ncsei_subject_representation: + description: >- + If the submitter is the target of NCSEI in the URLs of the abuse + report. + type: boolean + required: + - act + - email + - email2 + - name + - owner_notification + - urls + abuseReportsSubmitReportResponse: + properties: + abuse_rand: + description: The identifier for the submitted abuse report. + type: string + request: + properties: + act: + $ref: '#/components/schemas/abuseReportsSubmissionReportType' + required: + - act + type: object + result: + description: The result should be 'success' for successful response + type: string + required: + - request + - result + - abuse_rand + type: object + abuseReportsSubmitterDetails: + description: Information about the submitter of the report. + properties: + company: + type: string + email: + type: string + name: + type: string + telephone: + type: string + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + abuse_reports: + id: cloudflare.abuse_reports.abuse_reports + name: abuse_reports + title: Abuse Reports + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1abuse-reports/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.reports + request_review: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1abuse-reports~1{report_id}~1mitigations~1appeal/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1abuse-reports~1{report_param}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1abuse-reports~1{report_param}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/abuse_reports/methods/get' + - $ref: '#/components/x-stackQL-resources/abuse_reports/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/abuse_reports/methods/create' + update: [] + delete: [] + replace: [] + emails: + id: cloudflare.abuse_reports.emails + name: emails + title: Emails + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1abuse-reports~1{report_id}~1emails/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.emails + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/emails/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + mitigations: + id: cloudflare.abuse_reports.mitigations + name: mitigations + title: Mitigations + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1abuse-reports~1{report_id}~1mitigations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.mitigations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/mitigations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/access.yaml b/providers/src/cloudflare/v00.00.00000/services/access.yaml deleted file mode 100644 index 59edaecc..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/access.yaml +++ /dev/null @@ -1,5865 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Access Bookmark applications (Deprecated) - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - access - version: 4.0.0 -components: - schemas: - bookmarks_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - bookmarks_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/bookmarks' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - bookmarks: - properties: - app_launcher_visible: - $ref: '#/components/schemas/schemas-app_launcher_visible' - created_at: - $ref: '#/components/schemas/timestamp' - domain: - $ref: '#/components/schemas/components-schemas-domain' - id: - description: The unique identifier for the Bookmark application. - logo_url: - $ref: '#/components/schemas/logo_url' - name: - $ref: '#/components/schemas/bookmarks_components-schemas-name' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - schemas-app_launcher_visible: - description: Displays the application in the App Launcher. - example: true - type: boolean - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - components-schemas-domain: - description: The domain of the Bookmark application. - example: example.com - type: string - logo_url: - description: The image URL for the logo shown in the App Launcher dashboard. - example: 'https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg' - type: string - bookmarks_components-schemas-name: - description: The name of the Bookmark application. - example: My Website - type: string - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - uuid: - description: UUID - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true - type: string - bookmarks_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/uuid' - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - bookmarks_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/bookmarks' - apps_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - apps_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/apps' - type: array - apps: - anyOf: - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/self_hosted_props' - title: Self Hosted Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/saas_props' - title: SaaS Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/ssh_props' - title: Browser SSH Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/vnc_props' - title: Browser VNC Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/app_launcher_props' - title: App Launcher Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/warp_props' - title: Device Enrollment Permissions Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/biso_props' - title: Browser Isolation Permissions Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/bookmark_props' - title: Bookmark application - type: object - basic_app_response_props: - properties: - aud: - $ref: '#/components/schemas/schemas-aud' - created_at: - $ref: '#/components/schemas/timestamp' - id: - $ref: '#/components/schemas/uuid' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - self_hosted_props: - properties: - allowed_idps: - $ref: '#/components/schemas/allowed_idps' - app_launcher_visible: - $ref: '#/components/schemas/app_launcher_visible' - auto_redirect_to_identity: - $ref: '#/components/schemas/auto_redirect_to_identity' - cors_headers: - $ref: '#/components/schemas/cors_headers' - custom_deny_message: - $ref: '#/components/schemas/custom_deny_message' - custom_deny_url: - $ref: '#/components/schemas/custom_deny_url' - domain: - $ref: '#/components/schemas/schemas-domain' - enable_binding_cookie: - $ref: '#/components/schemas/enable_binding_cookie' - http_only_cookie_attribute: - $ref: '#/components/schemas/http_only_cookie_attribute' - logo_url: - $ref: '#/components/schemas/logo_url' - name: - $ref: '#/components/schemas/apps_components-schemas-name' - same_site_cookie_attribute: - $ref: '#/components/schemas/same_site_cookie_attribute' - service_auth_401_redirect: - $ref: '#/components/schemas/service_auth_401_redirect' - session_duration: - $ref: '#/components/schemas/session_duration' - skip_interstitial: - $ref: '#/components/schemas/skip_interstitial' - type: - description: The application type. - example: self_hosted - type: string - title: Self Hosted Application - type: object - saas_props: - properties: - allowed_idps: - $ref: '#/components/schemas/allowed_idps' - app_launcher_visible: - $ref: '#/components/schemas/app_launcher_visible' - auto_redirect_to_identity: - $ref: '#/components/schemas/auto_redirect_to_identity' - logo_url: - $ref: '#/components/schemas/logo_url' - name: - $ref: '#/components/schemas/apps_components-schemas-name' - saas_app: - $ref: '#/components/schemas/saas_app' - type: - description: The application type. - example: saas - type: string - title: SaaS Application - type: object - ssh_props: - allOf: - - $ref: '#/components/schemas/self_hosted_props' - - properties: - type: - description: The application type. - example: ssh - type: string - vnc_props: - allOf: - - $ref: '#/components/schemas/self_hosted_props' - - properties: - type: - description: The application type. - example: vnc - type: string - app_launcher_props: - allOf: - - $ref: '#/components/schemas/feature_app_props' - - properties: - domain: - example: authdomain.cloudflareaccess.com - readOnly: true - name: - default: App Launcher - example: App Launcher - readOnly: true - type: - description: The application type. - example: app_launcher - type: string - warp_props: - allOf: - - $ref: '#/components/schemas/feature_app_props' - - properties: - domain: - example: authdomain.cloudflareaccess.com/warp - readOnly: true - name: - default: Warp Login App - example: Warp Login App - readOnly: true - type: - description: The application type. - example: warp - type: string - biso_props: - allOf: - - $ref: '#/components/schemas/feature_app_props' - - properties: - domain: - example: authdomain.cloudflareaccess.com/browser - readOnly: true - name: - default: Clientless Web Isolation - example: Clientless Web Isolation - readOnly: true - type: - description: The application type. - example: biso - type: string - bookmark_props: - properties: - app_launcher_visible: - default: true - domain: - description: The URL or domain of the bookmark. - example: 'https://mybookmark.com' - logo_url: - $ref: '#/components/schemas/logo_url' - name: - $ref: '#/components/schemas/apps_components-schemas-name' - type: - description: The application type. - example: bookmark - type: string - title: Bookmark application - type: object - schemas-aud: - description: Audience tag. - example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893 - maxLength: 64 - readOnly: true - type: string - allowed_idps: - description: The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account. - items: - description: The identity providers selected for application. - example: 699d98642c564d2e855e9661899b7252 - type: string - type: array - app_launcher_visible: - default: true - description: Displays the application in the App Launcher. - example: true - type: boolean - auto_redirect_to_identity: - default: false - description: 'When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.' - type: boolean - cors_headers: - properties: - allow_all_headers: - $ref: '#/components/schemas/allow_all_headers' - allow_all_methods: - $ref: '#/components/schemas/allow_all_methods' - allow_all_origins: - $ref: '#/components/schemas/allow_all_origins' - allow_credentials: - $ref: '#/components/schemas/allow_credentials' - allowed_headers: - $ref: '#/components/schemas/allowed_headers' - allowed_methods: - $ref: '#/components/schemas/allowed_methods' - allowed_origins: - $ref: '#/components/schemas/allowed_origins' - max_age: - $ref: '#/components/schemas/max_age' - type: object - custom_deny_message: - description: The custom error message shown to a user when they are denied access to the application. - type: string - custom_deny_url: - description: The custom URL a user is redirected to when they are denied access to the application. - type: string - schemas-domain: - description: The domain and path that Access will secure. - example: test.example.com/admin - type: string - enable_binding_cookie: - default: false - description: 'Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.' - type: boolean - http_only_cookie_attribute: - default: true - description: 'Enables the HttpOnly cookie attribute, which increases security against XSS attacks.' - example: true - type: boolean - apps_components-schemas-name: - description: The name of the application. - example: Admin Site - type: string - same_site_cookie_attribute: - description: 'Sets the SameSite cookie setting, which provides increased security against CSRF attacks.' - example: strict - type: string - service_auth_401_redirect: - description: Returns a 401 status code when the request is blocked by a Service Auth policy. - example: true - type: boolean - session_duration: - default: 24h - description: 'The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.' - example: 24h - type: string - skip_interstitial: - description: Enables automatic authentication through cloudflared. - example: true - type: boolean - saas_app: - properties: - consumer_service_url: - description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion. - example: 'https://example.com' - type: string - created_at: - $ref: '#/components/schemas/timestamp' - custom_attributes: - properties: - name: - description: The name of the attribute. - example: family_name - type: string - name_format: - description: A globally unique name for an identity or service provider. - enum: - - 'urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified' - - 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic' - - 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri' - example: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic' - type: string - source: - properties: - name: - description: The name of the IdP attribute. - example: last_name - type: string - type: object - type: object - idp_entity_id: - description: The unique identifier for your SaaS application. - example: 'https://example.cloudflareaccess.com' - type: string - name_id_format: - description: The format of the name identifier sent to the SaaS application. - enum: - - id - - email - example: id - type: string - public_key: - description: The Access public certificate that will be used to verify your identity. - example: example unique name - type: string - sp_entity_id: - description: A globally unique name for an identity or service provider. - example: example unique name - type: string - sso_endpoint: - description: The endpoint where your SaaS application will send login requests. - example: 'https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd' - type: string - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - feature_app_props: - properties: - allowed_idps: - $ref: '#/components/schemas/allowed_idps' - auto_redirect_to_identity: - $ref: '#/components/schemas/auto_redirect_to_identity' - domain: - $ref: '#/components/schemas/schemas-domain' - name: - $ref: '#/components/schemas/apps_components-schemas-name' - session_duration: - $ref: '#/components/schemas/session_duration' - type: - $ref: '#/components/schemas/apps_components-schemas-type' - type: object - allow_all_headers: - description: Allows all HTTP request headers. - example: true - type: boolean - allow_all_methods: - description: Allows all HTTP request methods. - type: boolean - allow_all_origins: - description: Allows all origins. - type: boolean - allow_credentials: - description: 'When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.' - type: boolean - allowed_headers: - description: Allowed HTTP request headers. - items: {} - type: array - allowed_methods: - description: Allowed HTTP request methods. - example: - - GET - items: - enum: - - GET - - POST - - HEAD - - PUT - - DELETE - - CONNECT - - OPTIONS - - TRACE - - PATCH - type: string - type: array - allowed_origins: - description: Allowed origins. - example: - - 'https://example.com' - items: {} - type: array - max_age: - description: The maximum number of seconds the results of a preflight request can be cached. - example: -1 - maximum: 86400 - minimum: -1 - type: number - apps_components-schemas-type: - description: The application type. - enum: - - self_hosted - - saas - - ssh - - vnc - - app_launcher - - warp - - biso - - bookmark - - dash_sso - example: self_hosted - type: string - apps_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/apps' - schemas-app_id: - example: 699d98642c564d2e855e9661899b7252 - apps_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/uuid' - type: object - components-schemas-empty_response: - allOf: - - properties: - result: - nullable: true - success: - enum: - - true - - false - example: true - type: boolean - policy_check_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - app_state: - properties: - app_uid: - $ref: '#/components/schemas/uuid' - aud: - example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389 - type: string - hostname: - example: test.com - type: string - name: - example: Test App - type: string - policies: - example: - - decision: allow - exclude: [] - include: - - _type: email - email: testuser@gmail.com - precedence: 0 - require: [] - status: Success - items: {} - type: array - status: - example: Success - type: string - type: object - user_identity: - properties: - account_id: - example: 41ecfbb341f033e52b46742756aabb8b - type: string - device_sessions: - example: {} - type: object - email: - example: testuser@gmail.com - type: string - geo: - properties: - country: - example: US - type: string - type: object - iat: - type: integer - id: - example: '1164449231815010287495' - type: string - is_gateway: - example: false - type: boolean - is_warp: - example: false - type: boolean - name: - example: Test User - type: string - user_uuid: - $ref: '#/components/schemas/uuid' - version: - type: integer - type: object - type: object - access-requests_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - access-requests_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/access-requests' - type: array - access-requests: - properties: - action: - $ref: '#/components/schemas/access-requests_components-schemas-action' - allowed: - $ref: '#/components/schemas/schemas-allowed' - app_domain: - $ref: '#/components/schemas/app_domain' - app_uid: - $ref: '#/components/schemas/app_uid' - connection: - $ref: '#/components/schemas/components-schemas-connection' - created_at: - $ref: '#/components/schemas/timestamp' - ip_address: - $ref: '#/components/schemas/components-schemas-ip' - ray_id: - $ref: '#/components/schemas/ray_id' - user_email: - $ref: '#/components/schemas/schemas-email' - type: object - access-requests_components-schemas-action: - description: 'The event that occurred, such as a login attempt.' - example: login - type: string - schemas-allowed: - default: false - description: The result of the authentication event. - type: boolean - app_domain: - description: The URL of the Access application. - example: test.example.com/admin - type: string - app_uid: - description: The unique identifier for the Access application. - example: df7e2w5f-02b7-4d9d-af26-8d1988fca630 - components-schemas-connection: - description: The IdP used to authenticate. - example: saml - type: string - components-schemas-ip: - description: The IP address of the authenticating user. - example: 198.41.129.166 - type: string - ray_id: - description: The unique identifier for the request to Cloudflare. - example: 187d944c61940c77 - maxLength: 16 - type: string - schemas-email: - description: The email address of the authenticating user. - example: user@example.com - format: email - type: string - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - groups_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-groups' - type: array - schemas-groups: - properties: - created_at: - $ref: '#/components/schemas/timestamp' - exclude: - $ref: '#/components/schemas/exclude' - id: - $ref: '#/components/schemas/schemas-uuid' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/groups_components-schemas-name' - require: - $ref: '#/components/schemas/require' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - exclude: - description: 'Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.' - items: - $ref: '#/components/schemas/rule_components-schemas-rule' - type: array - schemas-uuid: - description: The unique identifier for the Access group. - include: - description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules. - items: - $ref: '#/components/schemas/rule_components-schemas-rule' - type: array - groups_components-schemas-name: - description: The name of the Access group. - example: Allow devs - type: string - require: - description: 'Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.' - items: - $ref: '#/components/schemas/rule_components-schemas-rule' - type: array - rule_components-schemas-rule: - oneOf: - - $ref: '#/components/schemas/email_rule' - - $ref: '#/components/schemas/domain_rule' - - $ref: '#/components/schemas/everyone_rule' - - $ref: '#/components/schemas/ip_rule' - - $ref: '#/components/schemas/ip_list_rule' - - $ref: '#/components/schemas/certificate_rule' - - $ref: '#/components/schemas/access_group_rule' - - $ref: '#/components/schemas/azure_group_rule' - - $ref: '#/components/schemas/github_organization_rule' - - $ref: '#/components/schemas/gsuite_group_rule' - - $ref: '#/components/schemas/okta_group_rule' - - $ref: '#/components/schemas/saml_group_rule' - type: object - email_rule: - description: Matches a specific email. - properties: - email: - properties: - email: - description: The email of the user. - example: test@example.com - format: email - type: string - required: - - email - type: object - required: - - email - title: Email - type: object - domain_rule: - description: Match an entire email domain. - properties: - email_domain: - properties: - domain: - description: The email domain to match. - example: example.com - type: string - required: - - domain - type: object - required: - - email_domain - title: Email domain - type: object - everyone_rule: - description: Matches everyone. - properties: - everyone: - description: An empty object which matches on all users. - example: {} - type: object - required: - - everyone - title: Everyone - type: object - ip_rule: - description: Matches an IP address block. - properties: - ip: - properties: - ip: - description: An IPv4 or IPv6 CIDR block. - example: '2400:cb00:21:10a::/64' - type: string - required: - - ip - type: object - required: - - ip - title: IP ranges - type: object - ip_list_rule: - description: Matches an IP address from a list. - properties: - ip_list: - properties: - id: - description: The ID of a previously created IP list. - example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f - type: string - required: - - id - type: object - required: - - ip_list - title: IP list - type: object - certificate_rule: - description: Matches any valid client certificate. - example: - certificate: {} - properties: - certificate: - example: {} - type: object - required: - - certificate - title: Valid certificate - type: object - access_group_rule: - description: Matches an Access group. - properties: - group: - properties: - id: - description: The ID of a previously created Access group. - example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f - type: string - required: - - id - type: object - required: - - group - title: Access groups - type: object - azure_group_rule: - description: |- - Matches an Azure group. - Requires an Azure identity provider. - properties: - azureAD: - properties: - connection_id: - description: The ID of your Azure identity provider. - example: ea85612a-29c8-46c2-bacb-669d65136971 - type: string - id: - description: The ID of an Azure group. - example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f - type: string - required: - - id - - connection_id - type: object - required: - - azureAD - title: Azure group - type: object - github_organization_rule: - description: |- - Matches a Github organization. - Requires a Github identity provider. - properties: - github-organization: - properties: - connection_id: - description: The ID of your Github identity provider. - example: ea85612a-29c8-46c2-bacb-669d65136971 - type: string - name: - description: The name of the organization. - example: cloudflare - type: string - required: - - name - - connection_id - type: object - required: - - github-organization - title: Github organization - type: object - gsuite_group_rule: - description: |- - Matches a group in Google Workspace. - Requires a Google Workspace identity provider. - properties: - gsuite: - properties: - connection_id: - description: The ID of your Google Workspace identity provider. - example: ea85612a-29c8-46c2-bacb-669d65136971 - type: string - email: - description: The email of the Google Workspace group. - example: devs@cloudflare.com - type: string - required: - - email - - connection_id - type: object - required: - - gsuite - title: Google Workspace group - type: object - okta_group_rule: - description: |- - Matches an Okta group. - Requires an Okta identity provider. - properties: - okta: - properties: - connection_id: - description: The ID of your Okta identity provider. - example: ea85612a-29c8-46c2-bacb-669d65136971 - type: string - email: - description: The email of the Okta group. - example: devs@cloudflare.com - type: string - required: - - email - - connection_id - type: object - required: - - okta - title: Okta group - type: object - saml_group_rule: - description: |- - Matches a SAML group. - Requires a SAML identity provider. - properties: - saml: - properties: - attribute_name: - description: The name of the SAML attribute. - example: group - type: string - attribute_value: - description: The SAML attribute value to look for. - example: devs@cloudflare.com - type: string - required: - - attribute_name - - attribute_value - type: object - required: - - saml - title: SAML group - type: object - groups_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/schemas-groups' - groups_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/schemas-uuid' - type: object - identity-providers_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - identity-providers_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/identity-providers' - type: array - identity-providers: - properties: - config: - $ref: '#/components/schemas/schemas-config' - id: - $ref: '#/components/schemas/uuid' - name: - $ref: '#/components/schemas/identity-providers_components-schemas-name' - type: - $ref: '#/components/schemas/identity-providers_components-schemas-type' - type: object - schemas-config: - description: 'The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).' - type: object - identity-providers_components-schemas-name: - description: 'The name of the identity provider, shown to users on the login page.' - example: Widget Corps OTP - type: string - identity-providers_components-schemas-type: - description: 'The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).' - example: onetimepin - type: string - identity-providers_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/identity-providers' - keys_components-schemas-identifier-2: - example: 699d98642c564d2e855e9661899b7252 - keys_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/key_config' - key_config: - properties: - days_until_next_rotation: - $ref: '#/components/schemas/days_until_next_rotation' - key_rotation_interval_days: - $ref: '#/components/schemas/key_rotation_interval_days' - last_key_rotation_at: - $ref: '#/components/schemas/last_key_rotation_at' - type: object - days_until_next_rotation: - description: The number of days until the next key rotation. - example: 1 - readOnly: true - type: number - key_rotation_interval_days: - description: The number of days between key rotations. - example: 30 - maximum: 365 - minimum: 21 - type: number - last_key_rotation_at: - description: The timestamp of the previous key rotation. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - type: string - certificates_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-certificates' - type: array - schemas-certificates: - properties: - associated_hostnames: - $ref: '#/components/schemas/associated_hostnames' - created_at: - $ref: '#/components/schemas/timestamp' - expires_on: - $ref: '#/components/schemas/timestamp' - fingerprint: - $ref: '#/components/schemas/fingerprint' - id: - description: The ID of the application that will use this certificate. - name: - $ref: '#/components/schemas/certificates_components-schemas-name' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - associated_hostnames: - description: The hostnames of the applications that will use this certificate. - items: - description: A fully-qualified domain name (FQDN). - example: admin.example.com - type: string - type: array - fingerprint: - description: The MD5 fingerprint of the certificate. - example: 'MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91' - type: string - certificates_components-schemas-name: - description: The name of the certificate. - example: Allow devs - type: string - certificates_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/schemas-certificates' - certificates_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/uuid' - type: object - components-schemas-uuid: - description: The policy ID. - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - type: string - policies_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - policies_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/components-schemas-uuid' - type: object - policies_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/schemas-policies' - schemas-policies: - properties: - approval_groups: - $ref: '#/components/schemas/approval_groups' - approval_required: - $ref: '#/components/schemas/approval_required' - created_at: - $ref: '#/components/schemas/timestamp' - decision: - $ref: '#/components/schemas/decision' - exclude: - $ref: '#/components/schemas/schemas-exclude' - id: - $ref: '#/components/schemas/components-schemas-uuid' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/policies_components-schemas-name' - precedence: - $ref: '#/components/schemas/precedence' - purpose_justification_prompt: - $ref: '#/components/schemas/purpose_justification_prompt' - purpose_justification_required: - $ref: '#/components/schemas/purpose_justification_required' - require: - $ref: '#/components/schemas/schemas-require' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - approval_groups: - description: Administrators who can approve a temporary authentication request. - example: - - approvals_needed: 1 - email_addresses: - - test1@cloudflare.com - - test2@cloudflare.com - - approvals_needed: 3 - email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34 - items: - $ref: '#/components/schemas/approval_group' - type: array - approval_required: - default: false - description: Requires the user to request access from an administrator at the start of each session. - example: true - type: boolean - decision: - description: The action Access will take if a user matches this policy. - enum: - - allow - - deny - - non_identity - - bypass - example: allow - type: string - schemas-exclude: - description: 'Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.' - items: - $ref: '#/components/schemas/rule_components-schemas-rule' - type: array - policies_components-schemas-name: - description: The name of the Access policy. - example: Allow devs - type: string - precedence: - description: The order of execution for this policy. Must be unique for each policy. - type: integer - purpose_justification_prompt: - description: A custom message that will appear on the purpose justification screen. - example: Please enter a justification for entering this protected domain. - type: string - purpose_justification_required: - default: false - description: Require users to enter a justification when they log in to the application. - example: true - type: boolean - schemas-require: - description: 'Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.' - items: - $ref: '#/components/schemas/rule_components-schemas-rule' - type: array - approval_group: - description: A group of email addresses that can approve a temporary authentication request. - properties: - approvals_needed: - description: The number of approvals needed to obtain access. - example: 1 - minimum: 0 - type: number - email_addresses: - description: A list of emails that can approve the access request. - example: - - test@cloudflare.com - - test2@cloudflare.com - items: {} - type: array - email_list_uuid: - description: The UUID of an re-usable email list. - type: string - required: - - approvals_needed - type: object - policies_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-policies' - type: array - service-tokens_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/service-tokens' - type: array - service-tokens: - properties: - client_id: - $ref: '#/components/schemas/client_id' - created_at: - $ref: '#/components/schemas/timestamp' - id: - description: The ID of the service token. - name: - $ref: '#/components/schemas/service-tokens_components-schemas-name' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - client_id: - description: The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header. - example: 88bf3b6d86161464f6509f7219099e57.access.example.com - type: string - service-tokens_components-schemas-name: - description: The name of the service token. - example: CI/CD token - type: string - create_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - client_id: - $ref: '#/components/schemas/client_id' - client_secret: - $ref: '#/components/schemas/client_secret' - created_at: - $ref: '#/components/schemas/timestamp' - id: - description: The ID of the service token. - name: - $ref: '#/components/schemas/service-tokens_components-schemas-name' - updated_at: - $ref: '#/components/schemas/timestamp' - client_secret: - description: The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header. - example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5 - type: string - service-tokens_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/service-tokens' - ca_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/ca' - type: array - ca: - properties: - aud: - $ref: '#/components/schemas/aud' - id: - $ref: '#/components/schemas/ca_components-schemas-id' - public_key: - $ref: '#/components/schemas/public_key' - type: object - aud: - description: The Application Audience (AUD) tag. Identifies the application associated with the CA. - example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893 - maxLength: 64 - readOnly: true - type: string - ca_components-schemas-id: - description: The ID of the CA. - example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9 - maxLength: 48 - readOnly: true - type: string - public_key: - description: The public key to add to your SSH server configuration. - example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org - readOnly: true - type: string - ca_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/ca_components-schemas-id' - type: object - ca_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - apps_components-schemas-response_collection-2: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-apps' - type: array - schemas-apps: - anyOf: - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/self_hosted_props' - title: Self Hosted Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/saas_props' - title: SaaS Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/ssh_props' - title: Browser SSH Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/vnc_props' - title: Browser VNC Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/app_launcher_props' - title: App Launcher Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/warp_props' - title: Device Enrollment Permissions Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/biso_props' - title: Browser Isolation Permissions Application - type: object - - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/schemas-bookmark_props' - title: Bookmark application - type: object - type: object - schemas-bookmark_props: - properties: - app_launcher_visible: - default: true - domain: - description: The URL or domain of the bookmark. - example: 'https://mybookmark.com' - logo_url: - $ref: '#/components/schemas/logo_url' - name: - $ref: '#/components/schemas/apps_components-schemas-name' - type: - description: The application type. - example: bookmark - type: string - title: Bookmark Application - type: object - apps_components-schemas-single_response-2: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/schemas-apps' - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_bookmarks: - id: cloudflare.access.accounts_bookmarks - name: accounts_bookmarks - title: Accounts Bookmarks - methods: - bookmark_applications___deprecated__list_bookmark_applications: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1bookmarks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _bookmark_applications___deprecated__list_bookmark_applications: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1bookmarks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - bookmark_applications___deprecated__delete_a_bookmark_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1bookmarks~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - bookmark_applications___deprecated__get_a_bookmark_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1bookmarks~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _bookmark_applications___deprecated__get_a_bookmark_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1bookmarks~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - bookmark_applications___deprecated__create_a_bookmark_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1bookmarks~1{uuid}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - bookmark_applications___deprecated__update_a_bookmark_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1bookmarks~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_bookmarks/methods/bookmark_applications___deprecated__list_bookmark_applications' - - $ref: '#/components/x-stackQL-resources/accounts_bookmarks/methods/bookmark_applications___deprecated__get_a_bookmark_application' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_bookmarks/methods/bookmark_applications___deprecated__create_a_bookmark_application' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_bookmarks/methods/bookmark_applications___deprecated__delete_a_bookmark_application' - accounts_apps: - id: cloudflare.access.accounts_apps - name: accounts_apps - title: Accounts Apps - methods: - applications_list_access_applications: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _applications_list_access_applications: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - applications_add_a_bookmark_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps/post' - response: - mediaType: application/json - openAPIDocKey: '200' - applications_delete_an_access_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{app_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - applications_get_an_access_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{app_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _applications_get_an_access_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{app_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - applications_update_a_bookmark_application: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{app_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - applications_revoke_service_tokens: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{app_id}~1revoke_tokens/post' - response: - mediaType: application/json - openAPIDocKey: '200' - applications_test_access_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{app_id}~1user_policy_checks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _applications_test_access_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{app_id}~1user_policy_checks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_apps/methods/applications_list_access_applications' - - $ref: '#/components/x-stackQL-resources/accounts_apps/methods/applications_get_an_access_application' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_apps/methods/applications_delete_an_access_application' - accounts_logs_access_requests: - id: cloudflare.access.accounts_logs_access_requests - name: accounts_logs_access_requests - title: Accounts Logs Access Requests - methods: - authentication_logs_get_access_authentication_logs: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1logs~1access_requests/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _authentication_logs_get_access_authentication_logs: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1logs~1access_requests/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_logs_access_requests/methods/authentication_logs_get_access_authentication_logs' - insert: [] - update: [] - delete: [] - accounts_groups: - id: cloudflare.access.accounts_groups - name: accounts_groups - title: Accounts Groups - methods: - groups_list_access_groups: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _groups_list_access_groups: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - groups_create_an_access_group: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1groups/post' - response: - mediaType: application/json - openAPIDocKey: '200' - groups_delete_an_access_group: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1groups~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - groups_get_an_access_group: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1groups~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _groups_get_an_access_group: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1groups~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - groups_update_an_access_group: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1groups~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_groups/methods/groups_list_access_groups' - - $ref: '#/components/x-stackQL-resources/accounts_groups/methods/groups_get_an_access_group' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_groups/methods/groups_create_an_access_group' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_groups/methods/groups_delete_an_access_group' - accounts_identity_providers: - id: cloudflare.access.accounts_identity_providers - name: accounts_identity_providers - title: Accounts Identity Providers - methods: - identity_providers_list_access_identity_providers: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1identity_providers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _identity_providers_list_access_identity_providers: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1identity_providers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - identity_providers_add_an_access_identity_provider: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1identity_providers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - identity_providers_delete_an_access_identity_provider: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1identity_providers~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - identity_providers_get_an_access_identity_provider: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1identity_providers~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _identity_providers_get_an_access_identity_provider: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1identity_providers~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - identity_providers_update_an_access_identity_provider: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1identity_providers~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_identity_providers/methods/identity_providers_list_access_identity_providers' - - $ref: '#/components/x-stackQL-resources/accounts_identity_providers/methods/identity_providers_get_an_access_identity_provider' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_identity_providers/methods/identity_providers_delete_an_access_identity_provider' - accounts_keys: - id: cloudflare.access.accounts_keys - name: accounts_keys - title: Accounts Keys - methods: - key_configuration_get_the_access_key_configuration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1keys/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _key_configuration_get_the_access_key_configuration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1keys/get' - response: - mediaType: application/json - openAPIDocKey: '200' - key_configuration_update_the_access_key_configuration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1keys/put' - response: - mediaType: application/json - openAPIDocKey: '200' - key_configuration_rotate_access_keys: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1keys~1rotate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_keys/methods/key_configuration_get_the_access_key_configuration' - insert: [] - update: [] - delete: [] - accounts_certificates: - id: cloudflare.access.accounts_certificates - name: accounts_certificates - title: Accounts Certificates - methods: - m_tls_authentication_list_m_tls_certificates: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _m_tls_authentication_list_m_tls_certificates: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - m_tls_authentication_add_an_m_tls_certificate: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1certificates/post' - response: - mediaType: application/json - openAPIDocKey: '200' - m_tls_authentication_delete_an_m_tls_certificate: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1certificates~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - m_tls_authentication_get_an_m_tls_certificate: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1certificates~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _m_tls_authentication_get_an_m_tls_certificate: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1certificates~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - m_tls_authentication_update_an_m_tls_certificate: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1certificates~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_certificates/methods/m_tls_authentication_list_m_tls_certificates' - - $ref: '#/components/x-stackQL-resources/accounts_certificates/methods/m_tls_authentication_get_an_m_tls_certificate' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_certificates/methods/m_tls_authentication_delete_an_m_tls_certificate' - accounts_apps_policies: - id: cloudflare.access.accounts_apps_policies - name: accounts_apps_policies - title: Accounts Apps Policies - methods: - policies_delete_an_access_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_get_an_access_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _policies_get_an_access_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_update_an_access_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_list_access_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid}~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _policies_list_access_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid}~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_create_an_access_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid}~1policies/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_apps_policies/methods/policies_get_an_access_policy' - - $ref: '#/components/x-stackQL-resources/accounts_apps_policies/methods/policies_list_access_policies' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_apps_policies/methods/policies_create_an_access_policy' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_apps_policies/methods/policies_delete_an_access_policy' - accounts_service_tokens: - id: cloudflare.access.accounts_service_tokens - name: accounts_service_tokens - title: Accounts Service Tokens - methods: - service_tokens_list_service_tokens: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1service_tokens/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _service_tokens_list_service_tokens: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1service_tokens/get' - response: - mediaType: application/json - openAPIDocKey: '200' - service_tokens_create_a_service_token: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1service_tokens/post' - response: - mediaType: application/json - openAPIDocKey: '200' - service_tokens_delete_a_service_token: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1service_tokens~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - service_tokens_update_a_service_token: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1service_tokens~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - service_tokens_refresh_a_service_token: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1service_tokens~1{uuid}~1refresh/post' - response: - mediaType: application/json - openAPIDocKey: '200' - service_tokens_rotate_a_service_token: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1service_tokens~1{uuid}~1rotate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_service_tokens/methods/service_tokens_list_service_tokens' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_service_tokens/methods/service_tokens_create_a_service_token' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_service_tokens/methods/service_tokens_delete_a_service_token' - accounts_apps_ca: - id: cloudflare.access.accounts_apps_ca - name: accounts_apps_ca - title: Accounts Apps Ca - methods: - short_lived_certificate_c_as_list_short_lived_certificate_c_as: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _short_lived_certificate_c_as_list_short_lived_certificate_c_as: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - short_lived_certificate_c_as_delete_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid}~1ca/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - short_lived_certificate_c_as_get_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid}~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _short_lived_certificate_c_as_get_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid}~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - short_lived_certificate_c_as_create_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1apps~1{uuid}~1ca/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_apps_ca/methods/short_lived_certificate_c_as_list_short_lived_certificate_c_as' - - $ref: '#/components/x-stackQL-resources/accounts_apps_ca/methods/short_lived_certificate_c_as_get_a_short_lived_certificate_ca' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_apps_ca/methods/short_lived_certificate_c_as_create_a_short_lived_certificate_ca' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_apps_ca/methods/short_lived_certificate_c_as_delete_a_short_lived_certificate_ca' - zones_apps: - id: cloudflare.access.zones_apps - name: zones_apps - title: Zones Apps - methods: - zone_level_access_applications_list_access_applications: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_level_access_applications_list_access_applications: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_applications_add_a_bookmark_application: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_applications_delete_an_access_application: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{app_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_applications_get_an_access_application: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{app_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_level_access_applications_get_an_access_application: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{app_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_applications_update_a_bookmark_application: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{app_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_applications_revoke_service_tokens: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{app_id}~1revoke_tokens/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_applications_test_access_policies: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{app_id}~1user_policy_checks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_applications_test_access_policies: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{app_id}~1user_policy_checks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_apps/methods/zone_level_access_applications_list_access_applications' - - $ref: '#/components/x-stackQL-resources/zones_apps/methods/zone_level_access_applications_get_an_access_application' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_apps/methods/zone_level_access_applications_delete_an_access_application' - zones_groups: - id: cloudflare.access.zones_groups - name: zones_groups - title: Zones Groups - methods: - zone_level_access_groups_list_access_groups: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_groups_list_access_groups: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_groups_create_an_access_group: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1groups/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_groups_delete_an_access_group: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1groups~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_groups_get_an_access_group: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1groups~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_groups_get_an_access_group: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1groups~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_groups_update_an_access_group: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1groups~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_groups/methods/zone_level_access_groups_list_access_groups' - - $ref: '#/components/x-stackQL-resources/zones_groups/methods/zone_level_access_groups_get_an_access_group' - insert: - - $ref: '#/components/x-stackQL-resources/zones_groups/methods/zone_level_access_groups_create_an_access_group' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_groups/methods/zone_level_access_groups_delete_an_access_group' - zones_identity_providers: - id: cloudflare.access.zones_identity_providers - name: zones_identity_providers - title: Zones Identity Providers - methods: - zone_level_access_identity_providers_list_access_identity_providers: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1identity_providers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_identity_providers_list_access_identity_providers: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1identity_providers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_identity_providers_add_an_access_identity_provider: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1identity_providers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_identity_providers_delete_an_access_identity_provider: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1identity_providers~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_identity_providers_get_an_access_identity_provider: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1identity_providers~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_identity_providers_get_an_access_identity_provider: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1identity_providers~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_identity_providers_update_an_access_identity_provider: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1identity_providers~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_identity_providers/methods/zone_level_access_identity_providers_list_access_identity_providers' - - $ref: '#/components/x-stackQL-resources/zones_identity_providers/methods/zone_level_access_identity_providers_get_an_access_identity_provider' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_identity_providers/methods/zone_level_access_identity_providers_delete_an_access_identity_provider' - zones_certificates: - id: cloudflare.access.zones_certificates - name: zones_certificates - title: Zones Certificates - methods: - zone_level_access_m_tls_authentication_list_m_tls_certificates: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_m_tls_authentication_list_m_tls_certificates: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_m_tls_authentication_add_an_m_tls_certificate: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1certificates/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_m_tls_authentication_delete_an_m_tls_certificate: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1certificates~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_m_tls_authentication_get_an_m_tls_certificate: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1certificates~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_m_tls_authentication_get_an_m_tls_certificate: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1certificates~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_m_tls_authentication_update_an_m_tls_certificate: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1certificates~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_certificates/methods/zone_level_access_m_tls_authentication_list_m_tls_certificates' - - $ref: '#/components/x-stackQL-resources/zones_certificates/methods/zone_level_access_m_tls_authentication_get_an_m_tls_certificate' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_certificates/methods/zone_level_access_m_tls_authentication_delete_an_m_tls_certificate' - zones_apps_policies: - id: cloudflare.access.zones_apps_policies - name: zones_apps_policies - title: Zones Apps Policies - methods: - zone_level_access_policies_delete_an_access_policy: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_policies_get_an_access_policy: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_policies_get_an_access_policy: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_policies_update_an_access_policy: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid1}~1policies~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_policies_list_access_policies: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid}~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_policies_list_access_policies: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid}~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_policies_create_an_access_policy: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid}~1policies/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_apps_policies/methods/zone_level_access_policies_get_an_access_policy' - - $ref: '#/components/x-stackQL-resources/zones_apps_policies/methods/zone_level_access_policies_list_access_policies' - insert: - - $ref: '#/components/x-stackQL-resources/zones_apps_policies/methods/zone_level_access_policies_create_an_access_policy' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_apps_policies/methods/zone_level_access_policies_delete_an_access_policy' - zones_service_tokens: - id: cloudflare.access.zones_service_tokens - name: zones_service_tokens - title: Zones Service Tokens - methods: - zone_level_access_service_tokens_list_service_tokens: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1service_tokens/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_service_tokens_list_service_tokens: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1service_tokens/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_service_tokens_create_a_service_token: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1service_tokens/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_service_tokens_delete_a_service_token: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1service_tokens~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_service_tokens_update_a_service_token: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1service_tokens~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_service_tokens/methods/zone_level_access_service_tokens_list_service_tokens' - insert: - - $ref: '#/components/x-stackQL-resources/zones_service_tokens/methods/zone_level_access_service_tokens_create_a_service_token' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_service_tokens/methods/zone_level_access_service_tokens_delete_a_service_token' - zones_apps_ca: - id: cloudflare.access.zones_apps_ca - name: zones_apps_ca - title: Zones Apps Ca - methods: - zone_level_access_short_lived_certificate_c_as_list_short_lived_certificate_c_as: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_short_lived_certificate_c_as_list_short_lived_certificate_c_as: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_short_lived_certificate_c_as_delete_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid}~1ca/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_short_lived_certificate_c_as_get_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid}~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_access_short_lived_certificate_c_as_get_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid}~1ca/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_access_short_lived_certificate_c_as_create_a_short_lived_certificate_ca: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1apps~1{uuid}~1ca/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_apps_ca/methods/zone_level_access_short_lived_certificate_c_as_list_short_lived_certificate_c_as' - - $ref: '#/components/x-stackQL-resources/zones_apps_ca/methods/zone_level_access_short_lived_certificate_c_as_get_a_short_lived_certificate_ca' - insert: - - $ref: '#/components/x-stackQL-resources/zones_apps_ca/methods/zone_level_access_short_lived_certificate_c_as_create_a_short_lived_certificate_ca' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_apps_ca/methods/zone_level_access_short_lived_certificate_c_as_delete_a_short_lived_certificate_ca' -paths: - '/accounts/{identifier}/access/bookmarks': - get: - deprecated: true - description: Lists Bookmark applications. - operationId: access-bookmark-applications-(-deprecated)-list-bookmark-applications - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-response_collection' - description: List Bookmark applications response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/bookmarks_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Bookmark applications response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Bookmark applications - tags: - - Access Bookmark applications (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation' - '/accounts/{identifier}/access/bookmarks/{uuid}': - delete: - deprecated: true - description: Deletes a Bookmark application. - operationId: access-bookmark-applications-(-deprecated)-delete-a-bookmark-application - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-id_response' - description: Delete a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/bookmarks_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a Bookmark application - tags: - - Access Bookmark applications (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation' - get: - deprecated: true - description: Fetches a single Bookmark application. - operationId: access-bookmark-applications-(-deprecated)-get-a-bookmark-application - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-single_response' - description: Get a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/bookmarks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Bookmark application - tags: - - Access Bookmark applications (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation' - post: - deprecated: true - description: Create a new Bookmark application. - operationId: access-bookmark-applications-(-deprecated)-create-a-bookmark-application - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-single_response' - description: Create a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/bookmarks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a Bookmark application - tags: - - Access Bookmark applications (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation' - put: - deprecated: true - description: Updates a configured Bookmark application. - operationId: access-bookmark-applications-(-deprecated)-update-a-bookmark-application - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/bookmarks_components-schemas-single_response' - description: Update a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/bookmarks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a Bookmark application - tags: - - Access Bookmark applications (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation' - '/accounts/{identifier}/access/apps': - get: - description: Lists all Access applications in an account. - operationId: access-applications-list-access-applications - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps_components-schemas-response_collection' - description: List Access applications response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access applications response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access applications - tags: - - Access applications - post: - description: Adds a custom link to the App Launcher. Bookmark applications are not protected by Access. - operationId: access-applications-add-a-bookmark-application - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - type - - domain - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/bookmark_props' - description: Add a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/bookmark_props' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add a Bookmark application - tags: - - Access applications - '/accounts/{identifier}/access/apps/{app_id}': - delete: - description: Deletes an application from Access. - operationId: access-applications-delete-an-access-application - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps_components-schemas-id_response' - description: Delete an Access application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access application - tags: - - Access applications - get: - description: Fetches information about an Access application. - operationId: access-applications-get-an-access-application - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps_components-schemas-single_response' - description: Get an Access application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access application - tags: - - Access applications - put: - description: Updates a Bookmark application. - operationId: access-applications-update-a-bookmark-application - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - type - - domain - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/bookmark_props' - description: Update a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/bookmark_props' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a Bookmark application - tags: - - Access applications - '/accounts/{identifier}/access/apps/{app_id}/revoke_tokens': - post: - description: Revokes all service tokens used by an application. - operationId: access-applications-revoke-service-tokens - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-empty_response' - description: Revoke service tokens response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Revoke service tokens response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Revoke service tokens - tags: - - Access applications - '/accounts/{identifier}/access/apps/{app_id}/user_policy_checks': - get: - description: Tests if a specific user has permission to access an application. - operationId: access-applications-test-access-policies - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policy_check_response' - description: Test Access policies response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policy_check_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Test Access policies response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Test Access policies - tags: - - Access applications - '/accounts/{identifier}/access/logs/access_requests': - get: - description: Gets a list of Access authentication audit logs for an account. - operationId: access-authentication-logs-get-access-authentication-logs - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/access-requests_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/access-requests_components-schemas-response_collection' - description: Get Access authentication logs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/access-requests_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Access authentication logs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Access authentication logs - tags: - - Access authentication logs - '/accounts/{identifier}/access/groups': - get: - description: Lists all Access groups. - operationId: access-groups-list-access-groups - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-response_collection' - description: List Access groups response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access groups response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access groups - tags: - - Access groups - post: - description: Creates a new Access group. - operationId: access-groups-create-an-access-group - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - exclude: - $ref: '#/components/schemas/exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/groups_components-schemas-name' - require: - $ref: '#/components/schemas/require' - required: - - name - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-single_response' - description: Create an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create an Access group - tags: - - Access groups - '/accounts/{identifier}/access/groups/{uuid}': - delete: - description: Deletes an Access group. - operationId: access-groups-delete-an-access-group - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-id_response' - description: Delete an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access group - tags: - - Access groups - get: - description: Fetches a single Access group. - operationId: access-groups-get-an-access-group - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-single_response' - description: Get an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access group - tags: - - Access groups - put: - description: Updates a configured Access group. - operationId: access-groups-update-an-access-group - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - exclude: - $ref: '#/components/schemas/exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/groups_components-schemas-name' - require: - $ref: '#/components/schemas/require' - required: - - name - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-single_response' - description: Update an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an Access group - tags: - - Access groups - '/accounts/{identifier}/access/identity_providers': - get: - description: Lists all configured identity providers. - operationId: access-identity-providers-list-access-identity-providers - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-response_collection' - description: List Access identity providers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access identity providers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access identity providers - tags: - - Access identity providers - post: - description: Adds a new identity provider to Access. - operationId: access-identity-providers-add-an-access-identity-provider - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - $ref: '#/components/schemas/schemas-config' - name: - $ref: '#/components/schemas/identity-providers_components-schemas-name' - type: - $ref: '#/components/schemas/identity-providers_components-schemas-type' - required: - - name - - type - - config - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Add an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add an Access identity provider - tags: - - Access identity providers - '/accounts/{identifier}/access/identity_providers/{uuid}': - delete: - description: Deletes an identity provider from Access. - operationId: access-identity-providers-delete-an-access-identity-provider - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Delete an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access identity provider - tags: - - Access identity providers - get: - description: Fetches a configured identity provider. - operationId: access-identity-providers-get-an-access-identity-provider - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Get an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access identity provider - tags: - - Access identity providers - put: - description: Updates a configured identity provider. - operationId: access-identity-providers-update-an-access-identity-provider - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - $ref: '#/components/schemas/schemas-config' - name: - $ref: '#/components/schemas/identity-providers_components-schemas-name' - type: - $ref: '#/components/schemas/identity-providers_components-schemas-type' - required: - - name - - type - - config - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Update an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an Access identity provider - tags: - - Access identity providers - '/accounts/{identifier}/access/keys': - get: - description: Gets the Access key rotation settings for an account. - operationId: access-key-configuration-get-the-access-key-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/keys_components-schemas-identifier-2' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keys_components-schemas-single_response' - description: Get the Access key configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keys_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get the Access key configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get the Access key configuration - tags: - - Access key configuration - put: - description: Updates the Access key rotation settings for an account. - operationId: access-key-configuration-update-the-access-key-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/keys_components-schemas-identifier-2' - requestBody: - content: - application/json: - schema: - properties: - key_rotation_interval_days: - $ref: '#/components/schemas/key_rotation_interval_days' - required: - - key_rotation_interval_days - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keys_components-schemas-single_response' - description: Update the Access key configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keys_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update the Access key configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update the Access key configuration - tags: - - Access key configuration - '/accounts/{identifier}/access/keys/rotate': - post: - description: Perfoms a key rotation for an account. - operationId: access-key-configuration-rotate-access-keys - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/keys_components-schemas-identifier-2' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keys_components-schemas-single_response' - description: Rotate Access keys response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keys_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Rotate Access keys response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Rotate Access keys - tags: - - Access key configuration - '/accounts/{identifier}/access/certificates': - get: - description: Lists all mTLS certificates. - operationId: access-m-tls-authentication-list-m-tls-certificates - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-response_collection' - description: List mTLS certificates response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List mTLS certificates response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List mTLS certificates - tags: - - Access mTLS authentication - post: - description: Adds a new mTLS root certificate to Access. - operationId: access-m-tls-authentication-add-an-m-tls-certificate - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - associated_hostnames: - $ref: '#/components/schemas/associated_hostnames' - certificate: - description: The certificate content. - example: |- - -----BEGIN CERTIFICATE----- - MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10 - DrUtmu/B - -----END CERTIFICATE----- - type: string - name: - $ref: '#/components/schemas/certificates_components-schemas-name' - required: - - name - - certificate - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-single_response' - description: Add an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add an mTLS certificate - tags: - - Access mTLS authentication - '/accounts/{identifier}/access/certificates/{uuid}': - delete: - description: Deletes an mTLS certificate. - operationId: access-m-tls-authentication-delete-an-m-tls-certificate - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-id_response' - description: Delete an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an mTLS certificate - tags: - - Access mTLS authentication - get: - description: Fetches a single mTLS certificate. - operationId: access-m-tls-authentication-get-an-m-tls-certificate - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-single_response' - description: Get an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an mTLS certificate - tags: - - Access mTLS authentication - put: - description: Updates a configured mTLS certificate. - operationId: access-m-tls-authentication-update-an-m-tls-certificate - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - associated_hostnames: - $ref: '#/components/schemas/associated_hostnames' - name: - $ref: '#/components/schemas/certificates_components-schemas-name' - required: - - name - - associated_hostnames - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-single_response' - description: Update an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an mTLS certificate - tags: - - Access mTLS authentication - '/accounts/{identifier}/access/apps/{uuid1}/policies/{uuid}': - delete: - description: Delete an Access policy. - operationId: access-policies-delete-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: uuid1 - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-id_response' - description: Delete an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access policy - tags: - - Access policies - get: - description: Fetches a single Access policy. - operationId: access-policies-get-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: uuid1 - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-single_response' - description: Get an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access policy - tags: - - Access policies - put: - description: Update a configured Access policy. - operationId: access-policies-update-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: uuid1 - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - approval_groups: - $ref: '#/components/schemas/approval_groups' - approval_required: - $ref: '#/components/schemas/approval_required' - decision: - $ref: '#/components/schemas/decision' - exclude: - $ref: '#/components/schemas/schemas-exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/policies_components-schemas-name' - precedence: - $ref: '#/components/schemas/precedence' - purpose_justification_prompt: - $ref: '#/components/schemas/purpose_justification_prompt' - purpose_justification_required: - $ref: '#/components/schemas/purpose_justification_required' - require: - $ref: '#/components/schemas/schemas-require' - required: - - name - - decision - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-single_response' - description: Update an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an Access policy - tags: - - Access policies - '/accounts/{identifier}/access/apps/{uuid}/policies': - get: - description: Lists Access policies configured for an application. - operationId: access-policies-list-access-policies - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-response_collection' - description: List Access policies response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access policies response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access policies - tags: - - Access policies - post: - description: Create a new Access policy for an application. - operationId: access-policies-create-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - approval_groups: - $ref: '#/components/schemas/approval_groups' - approval_required: - $ref: '#/components/schemas/approval_required' - decision: - $ref: '#/components/schemas/decision' - exclude: - $ref: '#/components/schemas/schemas-exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/policies_components-schemas-name' - precedence: - $ref: '#/components/schemas/precedence' - purpose_justification_prompt: - $ref: '#/components/schemas/purpose_justification_prompt' - purpose_justification_required: - $ref: '#/components/schemas/purpose_justification_required' - require: - $ref: '#/components/schemas/schemas-require' - required: - - name - - decision - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-single_response' - description: Create an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create an Access policy - tags: - - Access policies - '/accounts/{identifier}/access/service_tokens': - get: - description: Lists all service tokens. - operationId: access-service-tokens-list-service-tokens - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/service-tokens_components-schemas-response_collection' - description: List service tokens response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/service-tokens_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List service tokens response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List service tokens - tags: - - Access service tokens - post: - description: 'Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.' - operationId: access-service-tokens-create-a-service-token - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/service-tokens_components-schemas-name' - required: - - name - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/create_response' - description: Create a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/create_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a service token - tags: - - Access service tokens - '/accounts/{identifier}/access/service_tokens/{uuid}': - delete: - description: Deletes a service token. - operationId: access-service-tokens-delete-a-service-token - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - description: Delete a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a service token - tags: - - Access service tokens - put: - description: Updates a configured service token. - operationId: access-service-tokens-update-a-service-token - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/service-tokens_components-schemas-name' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - description: Update a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a service token - tags: - - Access service tokens - '/accounts/{identifier}/access/service_tokens/{uuid}/refresh': - post: - description: Refreshes the expiration of a service token. - operationId: access-service-tokens-refresh-a-service-token - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - description: Refresh a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Refresh a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Refresh a service token - tags: - - Access service tokens - '/accounts/{identifier}/access/service_tokens/{uuid}/rotate': - post: - description: Generates a new Client Secret for a service token and revokes the old one. - operationId: access-service-tokens-rotate-a-service-token - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/create_response' - description: Rotate a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/create_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Rotate a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Rotate a service token - tags: - - Access service tokens - '/accounts/{identifier}/access/apps/ca': - get: - description: Lists short-lived certificate CAs and their public keys. - operationId: access-short-lived-certificate-c-as-list-short-lived-certificate-c-as - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-response_collection' - description: List short-lived certificate CAs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List short-lived certificate CAs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List short-lived certificate CAs - tags: - - Access short-lived certificate CAs - '/accounts/{identifier}/access/apps/{uuid}/ca': - delete: - description: Deletes a short-lived certificate CA. - operationId: access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-id_response' - description: Delete a short-lived certificate CA response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a short-lived certificate CA response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a short-lived certificate CA - tags: - - Access short-lived certificate CAs - get: - description: Fetches a short-lived certificate CA and its public key. - operationId: access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-single_response' - description: Get a short-lived certificate CA response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a short-lived certificate CA response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a short-lived certificate CA - tags: - - Access short-lived certificate CAs - post: - description: Generates a new short-lived certificate CA and public key. - operationId: access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-single_response' - description: Create a short-lived certificate CA response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a short-lived certificate CA response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a short-lived certificate CA - tags: - - Access short-lived certificate CAs - '/zones/{identifier}/access/apps': - get: - description: List all Access Applications in a zone. - operationId: zone-level-access-applications-list-access-applications - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps_components-schemas-response_collection-2' - description: List Access Applications response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-response_collection-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access Applications response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access Applications - tags: - - Zone-Level Access applications - post: - description: Adds a custom link to the App Launcher. Bookmark applications are not protected by Access. - operationId: zone-level-access-applications-add-a-bookmark-application - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - type - - domain - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response-2' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/schemas-bookmark_props' - description: Add a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response-2' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/schemas-bookmark_props' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add a Bookmark application - tags: - - Zone-Level Access applications - '/zones/{identifier}/access/apps/{app_id}': - delete: - description: Deletes an application from Access. - operationId: zone-level-access-applications-delete-an-access-application - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps_components-schemas-id_response' - description: Delete an Access application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access application - tags: - - Zone-Level Access applications - get: - description: Fetches information about an Access application. - operationId: zone-level-access-applications-get-an-access-application - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps_components-schemas-single_response-2' - description: Get an Access application response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access application - tags: - - Zone-Level Access applications - put: - description: Updates a Bookmark application. - operationId: zone-level-access-applications-update-a-bookmark-application - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - type - - domain - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response-2' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/schemas-bookmark_props' - description: Update a Bookmark application response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/apps_components-schemas-single_response-2' - - properties: - result: - allOf: - - $ref: '#/components/schemas/basic_app_response_props' - - $ref: '#/components/schemas/schemas-bookmark_props' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a Bookmark application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a Bookmark application - tags: - - Zone-Level Access applications - '/zones/{identifier}/access/apps/{app_id}/revoke_tokens': - post: - description: Revokes all service tokens used by an application. - operationId: zone-level-access-applications-revoke-service-tokens - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-empty_response' - description: Revoke service tokens response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Revoke service tokens response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Revoke service tokens - tags: - - Zone-Level Access applications - '/zones/{identifier}/access/apps/{app_id}/user_policy_checks': - get: - description: Tests if a specific user has permission to access an application. - operationId: zone-level-access-applications-test-access-policies - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/schemas-app_id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/apps_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policy_check_response' - description: Test Access policies response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policy_check_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Test Access policies response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Test Access policies - tags: - - Zone-Level Access applications - '/zones/{identifier}/access/groups': - get: - description: Lists all Access groups. - operationId: zone-level-access-groups-list-access-groups - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-response_collection' - description: List Access groups response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access groups response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access groups - tags: - - Zone-Level Access groups - post: - description: Creates a new Access group. - operationId: zone-level-access-groups-create-an-access-group - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - exclude: - $ref: '#/components/schemas/exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/groups_components-schemas-name' - require: - $ref: '#/components/schemas/require' - required: - - name - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-single_response' - description: Create an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create an Access group - tags: - - Zone-Level Access groups - '/zones/{identifier}/access/groups/{uuid}': - delete: - description: Deletes an Access group. - operationId: zone-level-access-groups-delete-an-access-group - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-id_response' - description: Delete an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access group - tags: - - Zone-Level Access groups - get: - description: Fetches a single Access group. - operationId: zone-level-access-groups-get-an-access-group - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-single_response' - description: Get an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access group - tags: - - Zone-Level Access groups - put: - description: Updates a configured Access group. - operationId: zone-level-access-groups-update-an-access-group - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - exclude: - $ref: '#/components/schemas/exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/groups_components-schemas-name' - require: - $ref: '#/components/schemas/require' - required: - - name - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/groups_components-schemas-single_response' - description: Update an Access group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/groups_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an Access group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an Access group - tags: - - Zone-Level Access groups - '/zones/{identifier}/access/identity_providers': - get: - description: Lists all configured identity providers. - operationId: zone-level-access-identity-providers-list-access-identity-providers - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-response_collection' - description: List Access identity providers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access identity providers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access identity providers - tags: - - Zone-Level Access identity providers - post: - description: Adds a new identity provider to Access. - operationId: zone-level-access-identity-providers-add-an-access-identity-provider - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - $ref: '#/components/schemas/schemas-config' - name: - $ref: '#/components/schemas/identity-providers_components-schemas-name' - type: - $ref: '#/components/schemas/identity-providers_components-schemas-type' - required: - - name - - type - - config - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Add an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add an Access identity provider - tags: - - Zone-Level Access identity providers - '/zones/{identifier}/access/identity_providers/{uuid}': - delete: - description: Deletes an identity provider from Access. - operationId: zone-level-access-identity-providers-delete-an-access-identity-provider - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Delete an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access identity provider - tags: - - Zone-Level Access identity providers - get: - description: Fetches a configured identity provider. - operationId: zone-level-access-identity-providers-get-an-access-identity-provider - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Get an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access identity provider - tags: - - Zone-Level Access identity providers - put: - description: Updates a configured identity provider. - operationId: zone-level-access-identity-providers-update-an-access-identity-provider - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - $ref: '#/components/schemas/schemas-config' - name: - $ref: '#/components/schemas/identity-providers_components-schemas-name' - type: - $ref: '#/components/schemas/identity-providers_components-schemas-type' - required: - - name - - type - - config - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - description: Update an Access identity provider response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/identity-providers_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an Access identity provider response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an Access identity provider - tags: - - Zone-Level Access identity providers - '/zones/{identifier}/access/certificates': - get: - description: Lists all mTLS certificates. - operationId: zone-level-access-m-tls-authentication-list-m-tls-certificates - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-response_collection' - description: List mTLS certificates response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List mTLS certificates response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List mTLS certificates - tags: - - Zone-Level Access mTLS authentication - post: - description: Adds a new mTLS root certificate to Access. - operationId: zone-level-access-m-tls-authentication-add-an-m-tls-certificate - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - associated_hostnames: - $ref: '#/components/schemas/associated_hostnames' - certificate: - description: The certificate content. - example: |- - -----BEGIN CERTIFICATE----- - MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10 - DrUtmu/B - -----END CERTIFICATE----- - type: string - name: - $ref: '#/components/schemas/certificates_components-schemas-name' - required: - - name - - certificate - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-single_response' - description: Add an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add an mTLS certificate - tags: - - Zone-Level Access mTLS authentication - '/zones/{identifier}/access/certificates/{uuid}': - delete: - description: Deletes an mTLS certificate. - operationId: zone-level-access-m-tls-authentication-delete-an-m-tls-certificate - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-id_response' - description: Delete an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an mTLS certificate - tags: - - Zone-Level Access mTLS authentication - get: - description: Fetches a single mTLS certificate. - operationId: zone-level-access-m-tls-authentication-get-an-m-tls-certificate - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-single_response' - description: Get an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an mTLS certificate - tags: - - Zone-Level Access mTLS authentication - put: - description: Updates a configured mTLS certificate. - operationId: zone-level-access-m-tls-authentication-update-an-m-tls-certificate - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - associated_hostnames: - $ref: '#/components/schemas/associated_hostnames' - name: - $ref: '#/components/schemas/certificates_components-schemas-name' - required: - - name - - associated_hostnames - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificates_components-schemas-single_response' - description: Update an mTLS certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificates_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an mTLS certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an mTLS certificate - tags: - - Zone-Level Access mTLS authentication - '/zones/{identifier}/access/apps/{uuid1}/policies/{uuid}': - delete: - description: Delete an Access policy. - operationId: zone-level-access-policies-delete-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: uuid1 - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-id_response' - description: Delete an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an Access policy - tags: - - Zone-Level Access policies - get: - description: Fetches a single Access policy. - operationId: zone-level-access-policies-get-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: uuid1 - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-single_response' - description: Get an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an Access policy - tags: - - Zone-Level Access policies - put: - description: Update a configured Access policy. - operationId: zone-level-access-policies-update-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: uuid1 - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - approval_groups: - $ref: '#/components/schemas/approval_groups' - approval_required: - $ref: '#/components/schemas/approval_required' - decision: - $ref: '#/components/schemas/decision' - exclude: - $ref: '#/components/schemas/schemas-exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/policies_components-schemas-name' - precedence: - $ref: '#/components/schemas/precedence' - purpose_justification_prompt: - $ref: '#/components/schemas/purpose_justification_prompt' - purpose_justification_required: - $ref: '#/components/schemas/purpose_justification_required' - require: - $ref: '#/components/schemas/schemas-require' - required: - - name - - decision - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-single_response' - description: Update an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an Access policy - tags: - - Zone-Level Access policies - '/zones/{identifier}/access/apps/{uuid}/policies': - get: - description: Lists Access policies configured for an application. - operationId: zone-level-access-policies-list-access-policies - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-response_collection' - description: List Access policies response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Access policies response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Access policies - tags: - - Zone-Level Access policies - post: - description: Create a new Access policy for an application. - operationId: zone-level-access-policies-create-an-access-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/policies_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - approval_groups: - $ref: '#/components/schemas/approval_groups' - approval_required: - $ref: '#/components/schemas/approval_required' - decision: - $ref: '#/components/schemas/decision' - exclude: - $ref: '#/components/schemas/schemas-exclude' - include: - $ref: '#/components/schemas/include' - name: - $ref: '#/components/schemas/policies_components-schemas-name' - precedence: - $ref: '#/components/schemas/precedence' - purpose_justification_prompt: - $ref: '#/components/schemas/purpose_justification_prompt' - purpose_justification_required: - $ref: '#/components/schemas/purpose_justification_required' - require: - $ref: '#/components/schemas/schemas-require' - required: - - name - - decision - - include - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-single_response' - description: Create an Access policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an Access policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create an Access policy - tags: - - Zone-Level Access policies - '/zones/{identifier}/access/service_tokens': - get: - description: Lists all service tokens. - operationId: zone-level-access-service-tokens-list-service-tokens - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/service-tokens_components-schemas-response_collection' - description: List service tokens response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/service-tokens_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List service tokens response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List service tokens - tags: - - Zone-Level Access service tokens - post: - description: 'Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token.' - operationId: zone-level-access-service-tokens-create-a-service-token - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/service-tokens_components-schemas-name' - required: - - name - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/create_response' - description: Create a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/create_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a service token - tags: - - Zone-Level Access service tokens - '/zones/{identifier}/access/service_tokens/{uuid}': - delete: - description: Deletes a service token. - operationId: zone-level-access-service-tokens-delete-a-service-token - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - description: Delete a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a service token - tags: - - Zone-Level Access service tokens - put: - description: Updates a configured service token. - operationId: zone-level-access-service-tokens-update-a-service-token - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/service-tokens_components-schemas-name' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - description: Update a service token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/service-tokens_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a service token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a service token - tags: - - Zone-Level Access service tokens - '/zones/{identifier}/access/apps/ca': - get: - description: Lists short-lived certificate CAs and their public keys. - operationId: zone-level-access-short-lived-certificate-c-as-list-short-lived-certificate-c-as - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-response_collection' - description: List short-lived certificate CAs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List short-lived certificate CAs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List short-lived certificate CAs - tags: - - Zone-Level Access short-lived certificate CAs - '/zones/{identifier}/access/apps/{uuid}/ca': - delete: - description: Deletes a short-lived certificate CA. - operationId: zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-id_response' - description: Delete a short-lived certificate CA response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a short-lived certificate CA response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a short-lived certificate CA - tags: - - Zone-Level Access short-lived certificate CAs - get: - description: Fetches a short-lived certificate CA and its public key. - operationId: zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-single_response' - description: Get a short-lived certificate CA response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a short-lived certificate CA response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a short-lived certificate CA - tags: - - Zone-Level Access short-lived certificate CAs - post: - description: Generates a new short-lived certificate CA and public key. - operationId: zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ca_components-schemas-single_response' - description: Create a short-lived certificate CA response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ca_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a short-lived certificate CA response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a short-lived certificate CA - tags: - - Zone-Level Access short-lived certificate CAs diff --git a/providers/src/cloudflare/v00.00.00000/services/access_rules.yaml b/providers/src/cloudflare/v00.00.00000/services/access_rules.yaml deleted file mode 100644 index 59aced9a..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/access_rules.yaml +++ /dev/null @@ -1,1121 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: IP Access rules for a user - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - access_rules - version: 4.0.0 -components: - schemas: - rule_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/rule' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - rule: - properties: - allowed_modes: - description: The available actions that a rule can apply to a matched request. - example: - - whitelist - - block - - challenge - - js_challenge - - managed_challenge - items: - $ref: '#/components/schemas/schemas-mode' - readOnly: true - type: array - configuration: - $ref: '#/components/schemas/schemas-configuration' - created_on: - description: The timestamp of when the rule was created. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - id: - $ref: '#/components/schemas/rule_components-schemas-identifier' - mode: - $ref: '#/components/schemas/schemas-mode' - modified_on: - description: The timestamp of when the rule was last modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - notes: - $ref: '#/components/schemas/notes' - required: - - id - - mode - - allowed_modes - - configuration - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - schemas-mode: - description: The action to apply to a matched request. - enum: - - block - - challenge - - whitelist - - js_challenge - - managed_challenge - example: challenge - type: string - schemas-configuration: - description: The rule configuration. - oneOf: - - $ref: '#/components/schemas/ip_configuration' - - $ref: '#/components/schemas/ipv6_configuration' - - $ref: '#/components/schemas/cidr_configuration' - - $ref: '#/components/schemas/asn_configuration' - - $ref: '#/components/schemas/country_configuration' - type: object - rule_components-schemas-identifier: - description: The unique identifier of the IP Access rule. - example: 92f17202ed8bd63d69a66b86a49a8f6b - maxLength: 32 - readOnly: true - type: string - notes: - description: 'An informative summary of the rule, typically used as a reminder or explanation.' - example: This rule is enabled because of an event that occurred on date X. - type: string - ip_configuration: - properties: - target: - description: The configuration target. You must set the target to `ip` when specifying an IP address in the rule. - enum: - - ip - example: ip - value: - description: The IP address to match. This address will be compared to the IP address of incoming requests. - example: 198.51.100.4 - type: string - title: An IP address configuration. - ipv6_configuration: - properties: - target: - description: The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule. - enum: - - ip6 - example: ip6 - value: - description: The IPv6 address to match. - example: '2001:DB8:100::CF' - type: string - title: An IPv6 address configuration. - cidr_configuration: - properties: - target: - description: The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule. - enum: - - ip_range - example: ip_range - value: - description: 'The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges.' - example: 198.51.100.4/16 - type: string - title: An IP address range configuration. - asn_configuration: - properties: - target: - description: The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule. - enum: - - asn - example: asn - value: - description: The AS number to match. - example: AS12345 - type: string - title: An ASN configuration. - country_configuration: - properties: - target: - description: The configuration target. You must set the target to `country` when specifying a country code in the rule. - enum: - - country - example: country - value: - description: 'The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).' - example: US - type: string - title: A country configuration. - rule_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/rule' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - rule_single_id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/rule_components-schemas-identifier' - type: object - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - account_identifier: {} - response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - type: object - type: array - type: object - response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - schemas-identifier: {} - api-response-single-id: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - type: object - schemas-rule: - allOf: - - $ref: '#/components/schemas/rule' - - properties: - scope: - description: All zones owned by the user will have the rule applied. - properties: - email: - $ref: '#/components/schemas/email' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: - description: The scope of the rule. - enum: - - user - - organization - example: user - readOnly: true - readOnly: true - type: object - required: - - id - - mode - - allowed_modes - - configuration - - scope - email: - description: The contact email address of the user. - example: user@example.com - maxLength: 90 - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - user_firewall_rules: - id: cloudflare.access_rules.user_firewall_rules - name: user_firewall_rules - title: User Firewall Rules - methods: - ip_access_rules_for_a_user_list_ip_access_rules: - operation: - $ref: '#/paths/~1user~1firewall~1access_rules~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _ip_access_rules_for_a_user_list_ip_access_rules: - operation: - $ref: '#/paths/~1user~1firewall~1access_rules~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_a_user_create_an_ip_access_rule: - operation: - $ref: '#/paths/~1user~1firewall~1access_rules~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_a_user_delete_an_ip_access_rule: - operation: - $ref: '#/paths/~1user~1firewall~1access_rules~1rules~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_a_user_update_an_ip_access_rule: - operation: - $ref: '#/paths/~1user~1firewall~1access_rules~1rules~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_firewall_rules/methods/ip_access_rules_for_a_user_list_ip_access_rules' - insert: - - $ref: '#/components/x-stackQL-resources/user_firewall_rules/methods/ip_access_rules_for_a_user_create_an_ip_access_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/user_firewall_rules/methods/ip_access_rules_for_a_user_delete_an_ip_access_rule' - zones_firewall_rules: - id: cloudflare.access_rules.zones_firewall_rules - name: zones_firewall_rules - title: Zones Firewall Rules - methods: - ip_access_rules_for_a_zone_list_ip_access_rules: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _ip_access_rules_for_a_zone_list_ip_access_rules: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_a_zone_create_an_ip_access_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_a_zone_delete_an_ip_access_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_a_zone_update_an_ip_access_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_firewall_rules/methods/ip_access_rules_for_a_zone_list_ip_access_rules' - insert: - - $ref: '#/components/x-stackQL-resources/zones_firewall_rules/methods/ip_access_rules_for_a_zone_create_an_ip_access_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_firewall_rules/methods/ip_access_rules_for_a_zone_delete_an_ip_access_rule' - accounts_firewall_rules: - id: cloudflare.access_rules.accounts_firewall_rules - name: accounts_firewall_rules - title: Accounts Firewall Rules - methods: - ip_access_rules_for_an_account_list_ip_access_rules: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1firewall~1access_rules~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _ip_access_rules_for_an_account_list_ip_access_rules: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1firewall~1access_rules~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_an_account_create_an_ip_access_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1firewall~1access_rules~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_an_account_delete_an_ip_access_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1firewall~1access_rules~1rules~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_an_account_get_an_ip_access_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1firewall~1access_rules~1rules~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _ip_access_rules_for_an_account_get_an_ip_access_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1firewall~1access_rules~1rules~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - ip_access_rules_for_an_account_update_an_ip_access_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1firewall~1access_rules~1rules~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_firewall_rules/methods/ip_access_rules_for_an_account_list_ip_access_rules' - - $ref: '#/components/x-stackQL-resources/accounts_firewall_rules/methods/ip_access_rules_for_an_account_get_an_ip_access_rule' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_firewall_rules/methods/ip_access_rules_for_an_account_create_an_ip_access_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_firewall_rules/methods/ip_access_rules_for_an_account_delete_an_ip_access_rule' -paths: - /user/firewall/access_rules/rules: - get: - description: Fetches IP Access rules of the user. You can filter the results using several optional parameters. - operationId: ip-access-rules-for-a-user-list-ip-access-rules - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_collection_response' - description: List IP Access rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List IP Access rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List IP Access rules - tags: - - IP Access rules for a user - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: |- - Creates a new IP Access rule for all zones owned by the current user. - - Note: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints. - operationId: ip-access-rules-for-a-user-create-an-ip-access-rule - requestBody: - content: - application/json: - schema: - properties: - configuration: - $ref: '#/components/schemas/schemas-configuration' - mode: - $ref: '#/components/schemas/schemas-mode' - notes: - $ref: '#/components/schemas/notes' - required: - - mode - - configuration - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_single_response' - description: Create an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create an IP Access rule - tags: - - IP Access rules for a user - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/user/firewall/access_rules/rules/{identifier}': - delete: - description: |- - Deletes an IP Access rule at the user level. - - Note: Deleting a user-level rule will affect all zones owned by the user. - operationId: ip-access-rules-for-a-user-delete-an-ip-access-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rule_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_single_id_response' - description: Delete an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_single_id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an IP Access rule - tags: - - IP Access rules for a user - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes. - operationId: ip-access-rules-for-a-user-update-an-ip-access-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rule_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - mode: - $ref: '#/components/schemas/schemas-mode' - notes: - $ref: '#/components/schemas/notes' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_single_response' - description: Update an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an IP Access rule - tags: - - IP Access rules for a user - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_id}/firewall/access_rules/rules': - get: - description: Fetches IP Access rules of a zone. You can filter the results using several optional parameters. - operationId: ip-access-rules-for-a-zone-list-ip-access-rules - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_collection_response' - description: List IP Access rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List IP Access rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List IP Access rules - tags: - - IP Access rules for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: |- - Creates a new IP Access rule for a zone. - - Note: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate. - operationId: ip-access-rules-for-a-zone-create-an-ip-access-rule - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - configuration: - $ref: '#/components/schemas/schemas-configuration' - mode: - $ref: '#/components/schemas/schemas-mode' - notes: - $ref: '#/components/schemas/notes' - required: - - mode - - configuration - - notes - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_single_response' - description: Create an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create an IP Access rule - tags: - - IP Access rules for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_id}/firewall/access_rules/rules/{identifier}': - delete: - description: |- - Deletes an IP Access rule defined at the zone level. - - Optionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner. - operationId: ip-access-rules-for-a-zone-delete-an-ip-access-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rule_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - cascade: - default: none - description: 'The level to attempt to delete similar rules defined for other zones with the same owner. The default value is `none`, which will only delete the current rule. Using `basic` will delete rules that match the same action (mode) and configuration, while using `aggressive` will delete rules that match the same configuration.' - enum: - - none - - basic - - aggressive - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_single_id_response' - description: Delete an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_single_id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an IP Access rule - tags: - - IP Access rules for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes. - operationId: ip-access-rules-for-a-zone-update-an-ip-access-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rule_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - mode: - $ref: '#/components/schemas/schemas-mode' - notes: - $ref: '#/components/schemas/notes' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_single_response' - description: Update an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an IP Access rule - tags: - - IP Access rules for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/firewall/access_rules/rules': - get: - description: Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters. - operationId: ip-access-rules-for-an-account-list-ip-access-rules - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_collection' - description: List IP Access rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List IP Access rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List IP Access rules - tags: - - IP Access rules for an account - x-cfPermissionsRequired: - enum: - - '#waf:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: |- - Creates a new IP Access rule for an account. The rule will apply to all zones in the account. - - Note: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints. - operationId: ip-access-rules-for-an-account-create-an-ip-access-rule - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/account_identifier' - requestBody: - content: - application/json: - schema: - properties: - configuration: - $ref: '#/components/schemas/schemas-configuration' - mode: - $ref: '#/components/schemas/schemas-mode' - notes: - $ref: '#/components/schemas/notes' - required: - - mode - - configuration - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single' - description: Create an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create an IP Access rule - tags: - - IP Access rules for an account - x-cfPermissionsRequired: - enum: - - '#waf:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}': - delete: - description: |- - Deletes an existing IP Access rule defined at the account level. - - Note: This operation will affect all zones in the account. - operationId: ip-access-rules-for-an-account-delete-an-ip-access-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an IP Access rule - tags: - - IP Access rules for an account - x-cfPermissionsRequired: - enum: - - '#waf:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the details of an IP Access rule defined at the account level. - operationId: ip-access-rules-for-an-account-get-an-ip-access-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single' - description: Get an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get an IP Access rule - tags: - - IP Access rules for an account - x-cfPermissionsRequired: - enum: - - '#waf:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: |- - Updates an IP Access rule defined at the account level. - - Note: This operation will affect all zones in the account. - operationId: ip-access-rules-for-an-account-update-an-ip-access-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-rule' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single' - description: Update an IP Access rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an IP Access rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an IP Access rule - tags: - - IP Access rules for an account - x-cfPermissionsRequired: - enum: - - '#waf:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true diff --git a/providers/src/cloudflare/v00.00.00000/services/accounts.yaml b/providers/src/cloudflare/v00.00.00000/services/accounts.yaml index 9161c4f1..9ca6e218 100644 --- a/providers/src/cloudflare/v00.00.00000/services/accounts.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/accounts.yaml @@ -1,1292 +1,1058 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Account Billing Profile - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - accounts + title: accounts API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - account_identifier: {} - billing_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts: + get: + description: List all accounts you have ownership or verified access to. + operationId: accounts-list-accounts + parameters: + - in: query + name: name + schema: + description: Name of the account. type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - type: object - type: array - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - create: - properties: - email: - $ref: '#/components/schemas/email' - roles: - description: Array of roles associated with this member. - items: - $ref: '#/components/schemas/role_components-schemas-identifier' - type: array - status: - default: pending - enum: - - accepted - - pending - required: - - email - - roles - type: object - response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - email: - description: The contact email address of the user. - example: user@example.com - maxLength: 90 - type: string - role_components-schemas-identifier: - description: Role identifier tag. - example: 3536bcfad5faccb999b47003c79917fb - maxLength: 32 - readOnly: true - type: string - schemas-identifier: {} - api-response-single-id: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of results per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: direction + schema: + description: Direction to order results. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamResponseCollectionAccounts' + description: List Accounts response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Accounts response failure + security: + - api_email: [] + api_key: [] + summary: List Accounts + tags: + - Accounts + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: accounts + resource_chain: [] + method: list + post: + description: Create an account (only available for tenant admins at this time) + operationId: account-creation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamCreateAccount' + description: Parameters for account creation + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamResponseSingleAccount' + description: Account Creation Success Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Account Creation Failure Response + security: + - api_email: [] + api_key: [] + summary: Create an account + tags: + - Accounts + x-cfPlanAvailability: + business: false + enterprise: false + free: false + pro: false + x-stackql-sdk: + service: accounts + resource_chain: [] + method: create + /accounts/move: + post: + description: >- + Batch move a collection of accounts to a specific organization. ⚠️ Not + implemented. + operationId: Accounts_batchMoveAccounts + requestBody: + content: + application/json: + schema: properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' + account_ids: + description: Move these accounts to the destination organization. + items: + type: string + type: array + destination_organization_id: + description: Move accounts to this organization ID. + type: string required: - - id + - account_ids + - destination_organization_id type: object - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - schemas-member: - allOf: - - $ref: '#/components/schemas/member' - member: - properties: - code: - $ref: '#/components/schemas/code' - id: - $ref: '#/components/schemas/membership_components-schemas-identifier' - roles: - description: Roles assigned to this member. - items: - $ref: '#/components/schemas/role' - type: array - status: - readOnly: true - user: - properties: - email: - $ref: '#/components/schemas/email' - first_name: - $ref: '#/components/schemas/first_name' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - last_name: - $ref: '#/components/schemas/last_name' - two_factor_authentication_enabled: - $ref: '#/components/schemas/two_factor_authentication_enabled' - readOnly: true - required: - - email - type: object - required: - - id - - user - - status - - roles - type: object - code: - description: The unique activation code for the account membership. - example: 05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0 - maxLength: 64 - readOnly: true - type: string - membership_components-schemas-identifier: - description: Membership identifier tag. - example: 4536bcfad5faccb111b47003c79917fa - maxLength: 32 - readOnly: true - type: string - role: - properties: - description: - description: Description of role's permissions. - example: Administrative access to the entire Account - readOnly: true - type: string - id: - $ref: '#/components/schemas/role_components-schemas-identifier' - name: - description: Role name. - example: Account Administrator - maxLength: 120 - readOnly: true - type: string - permissions: - $ref: '#/components/schemas/permissions' - required: - - id - - name - - description - - permissions - type: object - first_name: - description: User's first name - example: John - maxLength: 60 - nullable: true - type: string - last_name: - description: User's last name - example: Appleseed - maxLength: 60 - nullable: true - type: string - two_factor_authentication_enabled: - default: false - description: Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. - readOnly: true - type: boolean - permissions: - example: - analytics: - read: true - write: false - zones: - read: true - write: true - properties: - analytics: - $ref: '#/components/schemas/grants' - billing: - $ref: '#/components/schemas/grants' - cache_purge: - $ref: '#/components/schemas/grants' - dns: - $ref: '#/components/schemas/grants' - dns_records: - $ref: '#/components/schemas/grants' - lb: - $ref: '#/components/schemas/grants' - logs: - $ref: '#/components/schemas/grants' - organization: - $ref: '#/components/schemas/grants' - ssl: - $ref: '#/components/schemas/grants' - waf: - $ref: '#/components/schemas/grants' - zone_settings: - $ref: '#/components/schemas/grants' - zones: - $ref: '#/components/schemas/grants' - type: object - grants: - example: - read: true - write: false - properties: - read: - example: true - type: boolean - write: - example: true - type: boolean - type: object - account_subscription_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/subscription' - type: array - type: object - subscription: - allOf: - - $ref: '#/components/schemas/subscription-v2' - subscription-v2: - properties: - app: - properties: - install_id: - $ref: '#/components/schemas/install_id' - component_values: - $ref: '#/components/schemas/component_values' - currency: - $ref: '#/components/schemas/currency' - current_period_end: - $ref: '#/components/schemas/current_period_end' - current_period_start: - $ref: '#/components/schemas/current_period_start' - frequency: - $ref: '#/components/schemas/frequency' - id: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - price: - $ref: '#/components/schemas/price' - rate_plan: - $ref: '#/components/schemas/rate_plan' - state: - $ref: '#/components/schemas/state' - zone: - $ref: '#/components/schemas/zone' - type: object - install_id: - description: app install id. - type: string - component_values: - description: The list of add-ons subscribed to. - items: - $ref: '#/components/schemas/component_value' - type: array - currency: - description: The monetary unit in which pricing information is displayed. - example: USD - readOnly: true - type: string - current_period_end: - description: The end of the current period and also when the next billing is due. - example: '2014-03-31T12:20:00Z' - format: date-time - readOnly: true - type: string - current_period_start: - description: When the current billing period started. May match initial_period_start if this is the first period. - example: '2014-05-11T12:20:00Z' - format: date-time - readOnly: true - type: string - frequency: - description: How often the subscription is renewed automatically. - enum: - - weekly - - monthly - - quarterly - - yearly - example: monthly - type: string - subscription-v2_components-schemas-identifier: - description: Subscription identifier tag. - example: 506e3185e9c882d175a2d0cb0093d9f2 - maxLength: 32 - readOnly: true - type: string - price: - description: 'The price of the subscription that will be billed, in US dollars.' - example: 20 - readOnly: true - type: number - rate_plan: - description: The rate plan applied to the subscription. - properties: - currency: - description: The currency applied to the rate plan subscription. - example: USD - type: string - externally_managed: - description: Whether this rate plan is managed externally from Cloudflare. - example: false - type: boolean - id: - description: The ID of the rate plan. - example: free - is_contract: - description: Whether a rate plan is enterprise-based (or newly adopted term contract). - example: false - type: boolean - public_name: - description: The full name of the rate plan. - example: Business Plan - type: string - scope: - description: The scope that this rate plan applies to. - example: zone - type: string - sets: - description: The list of sets this rate plan applies to. - items: + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: >- + #/components/schemas/organizationsApiBatchAccountMoveResponse + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Batch move accounts + tags: + - Accounts + /accounts/{account_id}: + delete: + description: >- + Delete a specific account (only available for tenant admins at this + time). This is a permanent operation that will delete any zones or other + resources under the account + operationId: account-deletion + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - type: array - type: object - state: - description: The state that the subscription is in. - enum: - - Trial - - Provisioned - - Paid - - AwaitingPayment - - Cancelled - - Failed - - Expired - example: Paid - readOnly: true - type: string - zone: - description: A simple zone object. May have null properties if not a zone subscription. - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/properties-name' - type: object - component_value: - description: A component value for a subscription. - properties: - default: - description: The default amount assigned. - example: 5 - type: number - name: - description: The name of the component value. - example: page_rules - type: string - price: - description: The unit price for the component value. - example: 5 - type: number - value: - description: The amount of the component value assigned. - example: 20 - type: number - type: object - properties-name: - description: The domain name - example: example.com - maxLength: 253 - pattern: '^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$' - readOnly: true - type: string - account_subscription_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - components-schemas-account: - allOf: - - $ref: '#/components/schemas/account' - account: - properties: - created_on: - description: Timestamp for the creation of the account - example: '2014-03-01T12:21:02.0000Z' - format: date-time - readOnly: true - type: string - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - description: Account name - example: Demo Account - maxLength: 100 - type: string - settings: - description: Account settings - properties: - enforce_twofactor: - default: false - description: |- - Indicates whether membership in this account requires that - Two-Factor Authentication is enabled - type: boolean - use_account_custom_ns_by_default: - default: false - description: |- - Indicates whether new zones should use the account-level custom - nameservers by default - type: boolean - type: object - required: - - id - - name - type: object - audit_logs_response_collection: - oneOf: - - properties: - errors: - nullable: true - messages: - example: [] - items: {} - type: array - result: - items: - $ref: '#/components/schemas/audit-logs' - type: array - success: - example: true - type: boolean - - $ref: '#/components/schemas/api-response-common' - audit-logs: - properties: - action: - properties: - result: - description: A boolean that indicates if the action attempted was successful. - example: true - type: boolean - type: - description: A short string that describes the action that was performed. - example: change_setting - type: string - type: object - actor: - properties: - email: - description: The email of the user that performed the action. - example: michelle@example.com - format: email - type: string - id: - description: 'The ID of the actor that performed the action. If a user performed the action, this will be their User ID.' - example: f6b5de0326bb5182b8a4840ee01ec774 - type: string - ip: - description: The IP address of the request that performed the action. - example: 198.41.129.166 - type: string - type: - description: 'The type of actor, whether a User, Cloudflare Admin, or an Automated System.' - enum: - - user - - admin - - Cloudflare - example: user - type: string - type: object - id: - description: A string that uniquely identifies the audit log. - example: d5b0f326-1232-4452-8858-1089bd7168ef - type: string - interface: - description: The source of the event. - example: API - type: string - metadata: - description: An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. - example: - name: security_level - type: firewall - value: high - zone_name: example.com - type: object - newValue: - description: The new value of the resource that was modified. - example: low - type: string - oldValue: - description: The value of the resource before it was modified. - example: high - type: string - owner: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: object - resource: - properties: - id: - description: An identifier for the resource that was affected by the action. - example: 023e105f4ecef8ad9ca31a8372d0c353 - type: string - type: - description: A short string that describes the resource that was affected by the action. - example: zone - type: string - type: object - when: - description: A UTC RFC3339 timestamp that specifies when the action being logged occured. - example: '2017-04-26T17:31:07Z' - format: date-time - type: string - type: object - organization: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/schemas-name' - permissions: - $ref: '#/components/schemas/schemas-permissions' - roles: - description: List of roles that a user has within an organization. - items: - example: All Privileges - Super Administrator - maxLength: 120 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseSingleId' + description: Account Deletion Success Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Account Deletion Failure Response + security: + - api_email: [] + api_key: [] + summary: Delete a specific account + tags: + - Accounts + x-api-token-group: + - Account Settings Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: false + free: false + pro: false + x-stackql-sdk: + service: accounts + resource_chain: [] + method: delete + get: + description: Get information about a specific account that you are a member of. + operationId: accounts-account-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - readOnly: true - type: array - status: - $ref: '#/components/schemas/components-schemas-status' - type: object - schemas-name: - description: Organization name. - example: 'Cloudflare, Inc.' - maxLength: 100 - type: string - schemas-permissions: - description: Access permissions for this User. - items: - example: '#zones:read' - maxLength: 160 - type: string - readOnly: true - type: array - components-schemas-status: - description: Whether the user is a member of the organization or has an inivitation pending. - enum: - - member - - invited - example: member - type: string - colos: - description: 'If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.' - example: - - den - - sin - items: - description: Source colo name. - type: string - type: array - schemas-options: - example: - max_ttl: 15 - packet_type: icmp - properties: - max_ttl: - $ref: '#/components/schemas/max_ttl' - packet_type: - $ref: '#/components/schemas/packet_type' - packets_per_ttl: - $ref: '#/components/schemas/packets_per_ttl' - port: - $ref: '#/components/schemas/traceroute_components-schemas-port' - wait_time: - $ref: '#/components/schemas/wait_time' - schemas-targets: - example: - - 203.0.113.1 - - cloudflare.com - items: - description: Hosts as a hostname or IPv4/IPv6 address represented by strings. - example: 203.0.113.1 - type: string - maxLength: 10 - type: array - traceroute_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/target_result' - type: array - max_ttl: - default: 15 - description: Max TTL. - maximum: 64 - minimum: 0 - type: integer - packet_type: - default: icmp - description: Type of packet sent. - enum: - - icmp - - tcp - - udp - - gre - - gre+icmp - example: icmp - type: string - packets_per_ttl: - default: 3 - description: Number of packets sent at each TTL. - maximum: 10 - minimum: 0 - type: integer - traceroute_components-schemas-port: - default: 0 - description: 'For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for each protocol.' - maximum: 65535 - minimum: 0 - type: integer - wait_time: - default: 1 - description: Set the time (in seconds) to wait for a response to a probe. - maximum: 5 - minimum: 1 - type: integer - target_result: - properties: - colos: - items: - $ref: '#/components/schemas/colo_result' - type: array - target: - $ref: '#/components/schemas/schemas-target' - type: object - colo_result: - properties: - colo: - $ref: '#/components/schemas/colo' - error: - $ref: '#/components/schemas/error' - hops: - items: - $ref: '#/components/schemas/hop_result' - type: array - target_summary: - $ref: '#/components/schemas/target_summary' - traceroute_time_ms: - $ref: '#/components/schemas/traceroute_time_ms' - type: object - schemas-target: - description: 'The target hostname, IPv6, or IPv6 address.' - example: 1.1.1.1 - type: string - colo: - properties: - city: - $ref: '#/components/schemas/colo_city' - name: - $ref: '#/components/schemas/colo_name' - type: object - error: - description: Errors resulting from collecting traceroute from colo to target. - enum: - - '' - - 'Could not gather traceroute data: Code 1' - - 'Could not gather traceroute data: Code 2' - - 'Could not gather traceroute data: Code 3' - - 'Could not gather traceroute data: Code 4' - example: '' - type: string - hop_result: - properties: - nodes: - description: An array of node objects. - items: - $ref: '#/components/schemas/node_result' - type: array - packets_lost: - $ref: '#/components/schemas/packets_lost' - packets_sent: - $ref: '#/components/schemas/packets_sent' - packets_ttl: - $ref: '#/components/schemas/packets_ttl' - type: object - target_summary: - description: Aggregated statistics from all hops about the target. - example: - asn: '' - ip: 1.1.1.1 - max_latency_ms: 0.034 - mean_latency_ms: 0.021 - min_latency_ms: 0.014 - name: 1.1.1.1 - packet_count: 3 - std_dev_latency_ms: 0.011269427669584647 - type: object - traceroute_time_ms: - description: Total time of traceroute in ms. - type: integer - colo_city: - description: Source colo city. - example: 'Denver, CO, US' - type: string - colo_name: - description: Source colo name. - example: den01 - type: string - node_result: - example: - asn: AS13335 - ip: 1.1.1.1 - max_latency_ms: 0.034 - mean_latency_ms: 0.021 - min_latency_ms: 0.014 - name: one.one.one.one - packet_count: 3 - std_dev_latency_ms: 0.011269427669584647 - properties: - asn: - $ref: '#/components/schemas/schemas-asn' - ip: - $ref: '#/components/schemas/traceroute_components-schemas-ip' - labels: - $ref: '#/components/schemas/labels' - max_rtt_ms: - $ref: '#/components/schemas/max_rtt_ms' - mean_rtt_ms: - $ref: '#/components/schemas/mean_rtt_ms' - min_rtt_ms: - $ref: '#/components/schemas/min_rtt_ms' - name: - $ref: '#/components/schemas/traceroute_components-schemas-name' - packet_count: - $ref: '#/components/schemas/packet_count' - std_dev_rtt_ms: - $ref: '#/components/schemas/std_dev_rtt_ms' - type: object - packets_lost: - description: Number of packets where no response was received. - type: integer - packets_sent: - description: Number of packets sent with specified TTL. - type: integer - packets_ttl: - description: The time to live (TTL). - type: integer - schemas-asn: - description: AS number associated with the node object. - type: string - traceroute_components-schemas-ip: - description: IP address of the node. - type: string - labels: - description: Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from. - items: - type: string - type: array - max_rtt_ms: - description: Maximum RTT in ms. - type: number - mean_rtt_ms: - description: Mean RTT in ms. - type: number - min_rtt_ms: - description: Minimum RTT in ms. - type: number - traceroute_components-schemas-name: - description: 'Host name of the address, this may be the same as the IP address.' - type: string - packet_count: - description: Number of packets with a response from this node. - type: integer - std_dev_rtt_ms: - description: Standard deviation of the RTTs in ms. - type: number - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - billing_profile: - id: cloudflare.accounts.billing_profile - name: billing_profile - title: Billing Profile - methods: - account_billing_profile_billing_profile_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1billing~1profile/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_billing_profile_billing_profile_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1billing~1profile/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/billing_profile/methods/account_billing_profile_billing_profile_details' - insert: [] - update: [] - delete: [] - members: - id: cloudflare.accounts.members - name: members - title: Members - methods: - account_members_list_members: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1members/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_members_list_members: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1members/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_members_add_member: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1members/post' - response: - mediaType: application/json - openAPIDocKey: '200' - account_members_remove_member: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1members~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_members_member_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1members~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_members_member_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1members~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_members_update_member: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1members~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/members/methods/account_members_list_members' - - $ref: '#/components/x-stackQL-resources/members/methods/account_members_member_details' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/members/methods/account_members_remove_member' - roles: - id: cloudflare.accounts.roles - name: roles - title: Roles - methods: - account_roles_list_roles: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1roles/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_roles_list_roles: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1roles/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_roles_role_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1roles~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_roles_role_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1roles~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/roles/methods/account_roles_list_roles' - - $ref: '#/components/x-stackQL-resources/roles/methods/account_roles_role_details' - insert: [] - update: [] - delete: [] - subscriptions: - id: cloudflare.accounts.subscriptions - name: subscriptions - title: Subscriptions - methods: - account_subscriptions_list_subscriptions: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1subscriptions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_subscriptions_list_subscriptions: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1subscriptions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_subscriptions_create_subscription: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1subscriptions/post' - response: - mediaType: application/json - openAPIDocKey: '200' - account_subscriptions_delete_subscription: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1subscriptions~1{subscription_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_subscriptions_update_subscription: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1subscriptions~1{subscription_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/subscriptions/methods/account_subscriptions_list_subscriptions' - insert: - - $ref: '#/components/x-stackQL-resources/subscriptions/methods/account_subscriptions_create_subscription' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/subscriptions/methods/account_subscriptions_delete_subscription' - accounts: - id: cloudflare.accounts.accounts - name: accounts - title: Accounts - methods: - list_accounts: - operation: - $ref: '#/paths/~1accounts/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _list_accounts: - operation: - $ref: '#/paths/~1accounts/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts/methods/list_accounts' - - $ref: '#/components/x-stackQL-resources/accounts/methods/account_details' - insert: [] - update: [] - delete: [] - audit_logs: - id: cloudflare.accounts.audit_logs - name: audit_logs - title: Audit Logs - methods: - get_account_audit_logs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1audit_logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_account_audit_logs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1audit_logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/audit_logs/methods/get_account_audit_logs' - insert: [] - update: [] - delete: [] - organizations_audit_logs: - id: cloudflare.accounts.organizations_audit_logs - name: organizations_audit_logs - title: Organizations Audit Logs - methods: - audit_logs_get_organization_audit_logs: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1audit_logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _audit_logs_get_organization_audit_logs: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1audit_logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/organizations_audit_logs/methods/audit_logs_get_organization_audit_logs' - insert: [] - update: [] - delete: [] - user_audit_logs: - id: cloudflare.accounts.user_audit_logs - name: user_audit_logs - title: User Audit Logs - methods: - audit_logs_get_user_audit_logs: - operation: - $ref: '#/paths/~1user~1audit_logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _audit_logs_get_user_audit_logs: - operation: - $ref: '#/paths/~1user~1audit_logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_audit_logs/methods/audit_logs_get_user_audit_logs' - insert: [] - update: [] - delete: [] - diagnostics_traceroute: - id: cloudflare.accounts.diagnostics_traceroute - name: diagnostics_traceroute - title: Diagnostics Traceroute - methods: - diagnostics_traceroute: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1diagnostics~1traceroute/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/billing/profile': - get: - description: Gets the current billing profile for the account. - operationId: account-billing-profile-billing-profile-details - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/account_identifier' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/billing_response_single' - description: Billing Profile Details response - 4xx: + $ref: '#/components/schemas/iamResponseSingleAccount' + description: Account Details response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/billing_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Billing Profile Details response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Account Details response failure security: - api_email: [] api_key: [] - - api_token: [] - summary: Billing Profile Details + summary: Account Details tags: - - Account Billing Profile + - Accounts + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read x-cfPermissionsRequired: enum: - - '#billing:read' + - '#organization:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: accounts + resource_chain: [] + method: get + put: + description: Update an existing account. + operationId: accounts-update-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamComponentsSchemasAccount' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamResponseSingleAccount' + description: Update Account response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update Account response failure + security: + - api_email: [] + api_key: [] + summary: Update Account + tags: + - Accounts + x-api-token-group: + - Account Settings Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: accounts + resource_chain: [] + method: update + /accounts/{account_id}/email/sending/feedback: + get: + operationId: get_publicFeedbackStatus + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: start_at + schema: + format: date-time + type: string + - in: query + name: end_at + schema: + format: date-time + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + count: + type: number + end_at: + format: date-time + type: string + start_at: + format: date-time + type: string + required: + - count + - start_at + - end_at + type: object + required: + - result + type: object + description: Returns feedback statistics. + security: + - bearerAuth: [] + summary: Get feedback emails statistics + tags: + - Public + /accounts/{account_id}/email/sending/limits: + get: + description: >- + Returns the current daily sending quota for the account. Null when the + quota is not yet available. + operationId: email-sending-get-sending-limits + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingLimitsResponseSingle' + description: Get sending limits response + security: + - api_email: [] + api_key: [] + summary: Get sending limits + tags: + - Email Sending + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/logs/audit: + get: + description: Gets a list of audit logs for an account. + operationId: audit-logs-v2-get-account-audit-logs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: account_name + schema: + description: Filters by the account name. + items: + type: string + type: array + explode: true + - in: query + name: action_result + schema: + description: Filters by whether the action was successful or not. + items: + enum: + - success + - failure + type: string + type: array + explode: true + - in: query + name: action_type + schema: + description: Filters by the action type. + items: + enum: + - create + - delete + - view + - update + type: string + type: array + explode: true + - in: query + name: actor_context + schema: + description: Filters by the actor context. + items: + enum: + - api_key + - api_token + - dash + - oauth + - origin_ca_key + type: string + type: array + explode: true + - in: query + name: actor_email + schema: + description: Filters by the actor's email address. + items: + format: email + type: string + type: array + explode: true + - in: query + name: actor_id + schema: + description: >- + Filters by the actor ID. This can be either the Account ID or User + ID. + items: + type: string + type: array + explode: true + - in: query + name: actor_ip_address + schema: + description: The IP address where the action was initiated. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_id + schema: + description: >- + Filters by the API token ID when the actor context is an api_token + or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_name + schema: + description: >- + Filters by the API token name when the actor context is an + api_token or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_type + schema: + description: Filters by the actor type. + items: + enum: + - account + - cloudflare_admin + - system + - user + type: string + type: array + explode: true + - in: query + name: audit_log_id + schema: + deprecated: true + description: Finds a specific log by its ID. + items: + type: string + type: array + explode: true + - in: query + name: id + schema: + description: Finds a specific log by its ID. + items: + type: string + type: array + explode: true + - in: query + name: raw_cf_ray_id + schema: + description: Filters by the response CF Ray ID. + items: + type: string + type: array + explode: true + - in: query + name: raw_method + schema: + description: The HTTP method for the API call. + items: + type: string + type: array + explode: true + - in: query + name: raw_status_code + schema: + description: The response status code that was returned. + items: + type: integer + type: array + explode: true + - in: query + name: raw_uri + schema: + description: Filters by the request URI. + items: + type: string + type: array + explode: true + - in: query + name: resource_id + schema: + description: Filters by the resource ID. + items: + type: string + type: array + explode: true + - in: query + name: resource_product + schema: + description: >- + Filters audit logs by the Cloudflare product associated with the + changed resource. + items: + type: string + type: array + explode: true + - in: query + name: resource_type + schema: + description: >- + Filters audit logs based on the unique type of resource changed by + the action. + items: + type: string + type: array + explode: true + - in: query + name: resource_scope + schema: + description: >- + Filters by the resource scope, specifying whether the resource is + associated with an user, an account, a zone, or a membership. + items: + enum: + - accounts + - user + - zones + - memberships + type: string + type: array + explode: true + - in: query + name: zone_id + schema: + description: Filters by the zone ID. + items: + type: string + type: array + explode: true + - in: query + name: zone_name + schema: + description: Filters by the zone name associated with the change. + items: + type: string + type: array + explode: true + - in: query + name: account_name.not + schema: + description: Filters out audit logs by the account name. + items: + type: string + type: array + explode: true + - in: query + name: action_result.not + schema: + description: >- + Filters out audit logs by whether the action was successful or + not. + items: + enum: + - success + - failure + type: string + type: array + explode: true + - in: query + name: action_type.not + schema: + description: Filters out audit logs by the action type. + items: + enum: + - create + - delete + - view + - update + type: string + type: array + explode: true + - in: query + name: actor_context.not + schema: + description: Filters out audit logs by the actor context. + items: + enum: + - api_key + - api_token + - dash + - oauth + - origin_ca_key + type: string + type: array + explode: true + - in: query + name: actor_email.not + schema: + description: Filters out audit logs by the actor's email address. + items: + format: email + type: string + type: array + explode: true + - in: query + name: actor_id.not + schema: + description: >- + Filters out audit logs by the actor ID. This can be either the + Account ID or User ID. + items: + type: string + type: array + explode: true + - in: query + name: actor_ip_address.not + schema: + description: Filters out audit logs IP address where the action was initiated. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_id.not + schema: + description: >- + Filters out audit logs by the API token ID when the actor context + is an api_token or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_name.not + schema: + description: >- + Filters out audit logs by the API token name when the actor + context is an api_token or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_type.not + schema: + description: Filters out audit logs by the actor type. + items: + enum: + - account + - cloudflare_admin + - system + - user + type: string + type: array + explode: true + - in: query + name: audit_log_id.not + schema: + deprecated: true + description: Filters out audit logs by their IDs. + items: + type: string + type: array + explode: true + - in: query + name: id.not + schema: + description: Filters out audit logs by their IDs. + items: + type: string + type: array + explode: true + - in: query + name: raw_cf_ray_id.not + schema: + description: Filters out audit logs by the response CF Ray ID. + items: + type: string + type: array + explode: true + - in: query + name: raw_method.not + schema: + description: Filters out audit logs by the HTTP method for the API call. + items: + type: string + type: array + explode: true + - in: query + name: raw_status_code.not + schema: + description: >- + Filters out audit logs by the response status code that was + returned. + items: + type: integer + type: array + explode: true + - in: query + name: raw_uri.not + schema: + description: Filters out audit logs by the request URI. + items: + type: string + type: array + explode: true + - in: query + name: resource_id.not + schema: + description: Filters out audit logs by the resource ID. + items: + type: string + type: array + explode: true + - in: query + name: resource_product.not + schema: + description: >- + Filters out audit logs by the Cloudflare product associated with + the changed resource. + items: + type: string + type: array + explode: true + - in: query + name: resource_type.not + schema: + description: >- + Filters out audit logs based on the unique type of resource + changed by the action. + items: + type: string + type: array + explode: true + - in: query + name: resource_scope.not + schema: + description: >- + Filters out audit logs by the resource scope, specifying whether + the resource is associated with an user, an account, a zone, or a + membership. + items: + enum: + - accounts + - user + - zones + - memberships + type: string + type: array + explode: true + - in: query + name: zone_id.not + schema: + description: Filters out audit logs by the zone ID. + items: + type: string + type: array + explode: true + - in: query + name: zone_name.not + schema: + description: >- + Filters out audit logs by the zone name associated with the + change. + items: + type: string + type: array + explode: true + - description: >- + Limits the returned results to logs newer than the specified date. + This can be a date string 2019-04-30 (interpreted in UTC) or an + absolute timestamp that conforms to RFC3339. + in: query + name: since + schema: + format: date + type: string + - description: >- + Limits the returned results to logs older than the specified date. + This can be a date string 2019-04-30 (interpreted in UTC) or an + absolute timestamp that conforms to RFC3339. + in: query + name: before + schema: + format: date + type: string + - in: query + name: direction + schema: + default: desc + description: Sets sorting order. + enum: + - desc + - asc + type: string + - in: query + name: limit + schema: + default: 100 + description: >- + The number limits the objects to return. The cursor attribute may + be used to iterate over the next batch of objects if there are + more than the limit. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: cursor + schema: + description: >- + The cursor is an opaque token used to paginate through large sets + of records. It indicates the position from which to continue when + requesting the next set of records. A valid cursor value can be + obtained from the cursor object in the result_info structure of a + previous response. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaAuditLogsV2ResponseCollection' + description: Get account audit logs successful response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasApiResponseCommonFailure' + description: Get account audit logs failed response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get account audit logs (Version 2) + tags: + - Audit Logs + x-api-token-group: + - Account Settings Write + - Account Settings Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_identifier}/members': + x-stackql-sdk: + service: accounts + resource_chain: + - logs + - audit + method: list + /accounts/{account_id}/members: get: description: List all members of an account. operationId: account-members-list-members parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: order + schema: + description: Field to order results by. + enum: + - user.first_name + - user.last_name + - user.email + - status + type: string + - in: query + name: status schema: - $ref: '#/components/schemas/account_identifier' + description: A member's status in the account. + enum: + - accepted + - pending + - rejected + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of results per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: direction + schema: + description: Direction to order results. + enum: + - asc + - desc + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_collection' + $ref: '#/components/schemas/iamCollectionMemberResponseWithPolicies' description: List Members response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + $ref: '#/components/schemas/iamApiResponseCommonFailure' description: List Members response failure security: - api_email: [] api_key: [] - - api_token: [] summary: List Members tags: - Account Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read x-cfPermissionsRequired: enum: - '#organization:read' @@ -1295,43 +1061,66 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: accounts + resource_chain: + - members + method: list post: description: Add a user to the list of members for this account. operationId: account-members-add-member parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/account_identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/create' - required: true + type: object + title: Add Member with Account Roles + properties: + email: + $ref: '#/components/schemas/iamEmail' + roles: + description: Array of roles associated with this member. + items: + $ref: '#/components/schemas/iamRoleComponentsSchemasIdentifier' + type: array + status: + $ref: '#/components/schemas/iamMemberInvitationStatus' + policies: + description: Array of policies associated with this member. + items: + $ref: '#/components/schemas/iamCreateMemberPolicy' + type: array + required: + - email responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_single' + $ref: '#/components/schemas/iamSingleMemberResponseWithPolicies' description: Add Member response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' + $ref: '#/components/schemas/iamApiResponseCommonFailure' description: Add Member response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Add Member tags: - Account Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write x-cfPermissionsRequired: enum: - '#organization:edit' @@ -1340,47 +1129,50 @@ paths: enterprise: true free: true pro: true - '/accounts/{account_identifier}/members/{identifier}': + x-stackql-sdk: + service: accounts + resource_chain: + - members + method: create + /accounts/{account_id}/members/{member_id}: delete: description: Remove a member from an account. operationId: account-members-remove-member parameters: - - in: path - name: identifier + - name: member_id + in: path required: true + description: The account member ID. schema: - $ref: '#/components/schemas/schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/account_identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/api-response-single-id' + $ref: '#/components/schemas/iamApiResponseSingleId' description: Remove Member response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' + $ref: '#/components/schemas/iamApiResponseCommonFailure' description: Remove Member response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Remove Member tags: - Account Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write x-cfPermissionsRequired: enum: - '#organization:edit' @@ -1389,42 +1181,50 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: accounts + resource_chain: + - members + method: delete get: description: Get information about a specific member of an account. operationId: account-members-member-details parameters: - - in: path - name: identifier + - name: member_id + in: path required: true + description: The account member ID. schema: - $ref: '#/components/schemas/schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/account_identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_single' + $ref: '#/components/schemas/iamSingleMemberResponseWithPolicies' description: Member Details response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' + $ref: '#/components/schemas/iamApiResponseCommonFailure' description: Member Details response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Member Details tags: - Account Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read x-cfPermissionsRequired: enum: - '#organization:read' @@ -1433,48 +1233,97 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: accounts + resource_chain: + - members + method: get put: description: Modify an account member. operationId: account-members-update-member parameters: - - in: path - name: identifier + - name: member_id + in: path required: true + description: The account member ID. schema: - $ref: '#/components/schemas/schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/account_identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/schemas-member' - required: true + type: object + title: Update Member with Account Roles + properties: + id: + $ref: >- + #/components/schemas/iamMembershipComponentsSchemasIdentifier + roles: + description: Roles assigned to this member. + items: + $ref: '#/components/schemas/iamRole' + type: array + status: + description: A member's status in the account. + enum: + - accepted + - pending + readOnly: true + x-auditable: true + type: string + user: + description: Details of the user associated to the membership. + properties: + email: + $ref: '#/components/schemas/iamEmail' + first_name: + $ref: '#/components/schemas/iamFirstName' + id: + $ref: >- + #/components/schemas/iamCommonComponentsSchemasIdentifier + last_name: + $ref: '#/components/schemas/iamLastName' + two_factor_authentication_enabled: + $ref: '#/components/schemas/iamTwoFactorAuthenticationEnabled' + readOnly: true + required: + - email + type: object + policies: + description: Array of policies associated with this member. + items: + $ref: '#/components/schemas/iamCreateMemberPolicy' + type: array + required: + - policies responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_single' + $ref: '#/components/schemas/iamSingleMemberResponseWithPolicies' description: Update Member response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' + $ref: '#/components/schemas/iamApiResponseCommonFailure' description: Update Member response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Update Member tags: - Account Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write x-cfPermissionsRequired: enum: - '#organization:edit' @@ -1483,113 +1332,246 @@ paths: enterprise: true free: true pro: true - '/accounts/{account_identifier}/roles': - get: - description: Get all available roles for an account. - operationId: account-roles-list-roles + x-stackql-sdk: + service: accounts + resource_chain: + - members + method: update + /accounts/{account_id}/move: + post: + description: >- + Move an account within an organization hierarchy or an account outside + an organization. (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Accounts_moveAccounts parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/account_identifier' - responses: - '200': + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_organization_id: + type: string + required: + - destination_organization_id + type: object + description: The destination organization ID is where the account is to be moved. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiMoveAccountResponse' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Move account + tags: + - Accounts + x-api-token-group: null + /accounts/{account_id}/roles: + get: + description: Get all available roles for an account. + operationId: account-roles-list-roles + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of roles per page. + maximum: 50 + minimum: 5 + type: number + responses: + '200': content: application/json: schema: - $ref: '#/components/schemas/response_collection' + $ref: '#/components/schemas/iamCollectionRoleResponse' description: List Roles response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + $ref: '#/components/schemas/iamApiResponseCommonFailure' description: List Roles response failure security: - api_email: [] api_key: [] - - api_token: [] summary: List Roles tags: - Account Roles + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read x-cfPermissionsRequired: enum: - '#organization:read' - '/accounts/{account_identifier}/roles/{identifier}': + x-stackql-sdk: + service: accounts + resource_chain: + - roles + method: list + /accounts/{account_id}/roles/{role_id}: get: description: Get information about a specific role for an account. operationId: account-roles-role-details parameters: - - in: path - name: identifier + - name: role_id + in: path required: true + description: The role ID. schema: - $ref: '#/components/schemas/schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/account_identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_single' + $ref: '#/components/schemas/iamSingleRoleResponse' description: Role Details response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' + $ref: '#/components/schemas/iamApiResponseCommonFailure' description: Role Details response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Role Details tags: - Account Roles + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read x-cfPermissionsRequired: enum: - '#organization:read' - '/accounts/{account_identifier}/subscriptions': + x-stackql-sdk: + service: accounts + resource_chain: + - roles + method: get + /accounts/{account_id}/subscriptions: get: description: Lists all of an account's subscriptions. operationId: account-subscriptions-list-subscriptions parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/account_subscription_response_collection' + $ref: >- + #/components/schemas/billSubsApiAccountSubscriptionResponseCollection description: List Subscriptions response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/account_subscription_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiSubscription' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result description: List Subscriptions response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: List Subscriptions tags: - Account Subscriptions + x-api-token-group: + - Billing Write + - Billing Read x-cfPermissionsRequired: enum: - '#billing:read' @@ -1598,43 +1580,90 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: accounts + resource_chain: + - subscriptions + method: get post: description: Creates an account subscription. operationId: account-subscriptions-create-subscription parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/subscription-v2' - required: true + $ref: '#/components/schemas/billSubsApiSubscriptionV2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/account_subscription_response_single' + $ref: >- + #/components/schemas/billSubsApiAccountSubscriptionResponseSingle description: Create Subscription response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/account_subscription_response_single' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + type: object + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + $ref: '#/components/schemas/billSubsApiFrequency' + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result description: Create Subscription response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Subscription tags: - Account Subscriptions + x-api-token-group: + - Billing Write x-cfPermissionsRequired: enum: - '#billing:read' @@ -1644,106 +1673,188 @@ paths: enterprise: true free: true pro: true - '/accounts/{account_identifier}/subscriptions/{subscription_identifier}': + x-stackql-sdk: + service: accounts + resource_chain: + - subscriptions + method: create + /accounts/{account_id}/subscriptions/{subscription_identifier}: delete: description: Deletes an account's subscription. operationId: account-subscriptions-delete-subscription parameters: - in: path name: subscription_identifier - required: true schema: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - - in: path - name: account_identifier + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + required: true + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - subscription_id: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - type: object + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + properties: + subscription_id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + type: object + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result description: Delete Subscription response - 4xx: + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - subscription_id: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - type: object - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + properties: + subscription_id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result description: Delete Subscription response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Subscription tags: - Account Subscriptions + x-api-token-group: + - Billing Write x-cfPermissionsRequired: enum: - '#billing:edit' + x-stackql-sdk: + service: accounts + resource_chain: + - subscriptions + method: delete put: description: Updates an account subscription. operationId: account-subscriptions-update-subscription parameters: - in: path name: subscription_identifier - required: true schema: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - - in: path - name: account_identifier + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + required: true + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/subscription-v2' - required: true + $ref: '#/components/schemas/billSubsApiSubscriptionV2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/account_subscription_response_single' + $ref: >- + #/components/schemas/billSubsApiAccountSubscriptionResponseSingle description: Update Subscription response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/account_subscription_response_single' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + type: object + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + $ref: '#/components/schemas/billSubsApiFrequency' + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result description: Update Subscription response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update Subscription tags: - Account Subscriptions + x-api-token-group: + - Billing Write x-cfPermissionsRequired: enum: - '#billing:read' @@ -1753,281 +1864,3171 @@ paths: enterprise: true free: true pro: true - /accounts: + x-stackql-sdk: + service: accounts + resource_chain: + - subscriptions + method: update + /accounts/{account_id}/tokens: get: - description: List all accounts you have ownership or verified access to. - operationId: accounts-list-accounts + description: List all Account Owned API tokens created for this account. + operationId: account-api-tokens-list-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of results per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: direction + schema: + description: Direction to order results. + enum: + - asc + - desc + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_collection' - description: List Accounts response - 4xx: + $ref: '#/components/schemas/iamCollectionTokensResponse' + description: List Tokens response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Accounts response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Tokens response failure security: - - api_email: [] - api_key: [] - api_token: [] - summary: List Accounts + summary: List Tokens tags: - - Accounts + - Account Owned API Tokens + x-api-token-group: + - Account API Tokens Write + - Account API Tokens Read x-cfPermissionsRequired: enum: - - '#organization:read' + - com.cloudflare.api.account.token.list x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{identifier}': - get: - description: Get information about a specific account that you are a member of. - operationId: accounts-account-details + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + method: list + post: + description: Create a new Account Owned API token. + operationId: account-api-tokens-create-token parameters: - - in: path - name: identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamCreatePayload' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_single' - description: Account Details response - 4xx: + $ref: '#/components/schemas/iamSingleTokenCreateResponse' + description: Create Token response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Account Details response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Create Token response failure security: - - api_email: [] - api_key: [] - api_token: [] - summary: Account Details + summary: Create Token tags: - - Accounts + - Account Owned API Tokens + x-api-token-group: + - Account API Tokens Write x-cfPermissionsRequired: enum: - - '#organization:read' + - com.cloudflare.api.account.token.create x-cfPlanAvailability: business: true enterprise: true free: true pro: true - put: - description: Update an existing account. - operationId: accounts-update-account + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + method: create + /accounts/{account_id}/tokens/permission_groups: + get: + description: Find all available permission groups for Account Owned API Tokens + operationId: account-api-tokens-list-permission-groups parameters: - - in: path - name: identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-account' - required: true + type: string + - description: >- + Filter by the name of the permission group. The value must be + URL-encoded. + in: query + name: name + schema: + type: string + - description: >- + Filter by the scope of the permission group. The value must be + URL-encoded. + in: query + name: scope + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/response_single' - description: Update Account response - 4xx: + $ref: '#/components/schemas/iamPermissionsGroupResponseCollection' + description: List Account Owned API Token Permission Groups response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Account response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Account Owned API Token Permission Groups response failure security: - - api_email: [] - api_key: [] - api_token: [] - summary: Update Account + summary: List Permission Groups tags: - - Accounts + - Account Owned API Tokens + x-api-token-group: + - Account API Tokens Write + - Account API Tokens Read x-cfPermissionsRequired: enum: - - '#organization:edit' + - com.cloudflare.api.account.token.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_identifier}/audit_logs': + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + - permission_groups + method: list + /accounts/{account_id}/tokens/verify: get: - description: 'Gets a list of audit logs for an account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.' - operationId: audit-logs-get-account-audit-logs + description: Test whether a token works. + operationId: account-api-tokens-verify-token parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/audit_logs_response_collection' - description: Get account audit logs response - 4xx: + $ref: '#/components/schemas/iamTokenVerifyResponseSingleSegment' + description: Verify Token response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/audit_logs_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get account audit logs response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Verify Token response failure security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get account audit logs + summary: Verify Token tags: - - Audit Logs + - Account Owned API Tokens x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/organizations/{organization_identifier}/audit_logs': - get: - deprecated: true - description: 'Gets a list of audit logs for an organization. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.' - operationId: audit-logs-get-organization-audit-logs + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + method: verify + /accounts/{account_id}/tokens/{token_id}: + delete: + description: Destroy an Account Owned API token. + operationId: account-api-tokens-delete-token parameters: - - in: path - name: organization_identifier + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: token_id + in: path required: true + description: The API token ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/audit_logs_response_collection' - description: Get organization audit logs response - 4xx: + $ref: '#/components/schemas/iamApiResponseSingleId' + description: Delete Token response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/audit_logs_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get organization audit logs response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Delete Token response failure security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get organization audit logs + summary: Delete Token tags: - - Audit Logs - x-cfDeprecation: - $ref: organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation + - Account Owned API Tokens + x-api-token-group: + - Account API Tokens Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.token.delete x-cfPlanAvailability: - business: false + business: true enterprise: true - free: false - pro: false - /user/audit_logs: + free: true + pro: true + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + method: delete get: - description: 'Gets a list of audit logs for a user account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.' - operationId: audit-logs-get-user-audit-logs + description: Get information about a specific Account Owned API token. + operationId: account-api-tokens-token-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/audit_logs_response_collection' - description: Get user audit logs response - 4xx: + $ref: '#/components/schemas/iamSingleTokenResponse' + description: Token Details response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/audit_logs_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get user audit logs response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Token Details response failure security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get user audit logs + summary: Token Details tags: - - Audit Logs + - Account Owned API Tokens + x-api-token-group: + - Account API Tokens Write + - Account API Tokens Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.token.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_identifier}/diagnostics/traceroute': - post: - description: Run traceroutes from Cloudflare colos. - operationId: diagnostics-traceroute + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + method: get + put: + description: Update an existing token. + operationId: account-api-tokens-update-token parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string requestBody: content: application/json: schema: - properties: - colos: - $ref: '#/components/schemas/colos' - options: - $ref: '#/components/schemas/schemas-options' - targets: - $ref: '#/components/schemas/schemas-targets' - required: - - targets - required: true + $ref: '#/components/schemas/iamTokenBody' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/traceroute_response_collection' - description: Traceroute response - 4xx: + $ref: '#/components/schemas/iamSingleTokenResponse' + description: Update Token response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/traceroute_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Traceroute response failure + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update Token response failure security: - - api_email: [] - api_key: [] - api_token: [] - summary: Traceroute + summary: Update Token tags: - - Diagnostics + - Account Owned API Tokens + x-api-token-group: + - Account API Tokens Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.token.update x-cfPlanAvailability: - business: false + business: true enterprise: true - free: false - pro: false + free: true + pro: true + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + method: update + /accounts/{account_id}/tokens/{token_id}/value: + put: + description: Roll the Account Owned API token secret. + operationId: account-api-tokens-roll-token + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamResponseSingleValue' + description: Roll Token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Roll Token response failure + security: + - api_token: [] + summary: Roll Token + tags: + - Account Owned API Tokens + x-api-token-group: + - Account API Tokens Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.token.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: accounts + resource_chain: + - tokens + - value + method: update + /accounts/{account_id}/email/routing/suppression: + get: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 0 + type: integer + - in: query + name: per_page + schema: + default: 100 + maximum: 1000 + minimum: 0 + type: integer + - in: query + name: order + schema: + default: created_at + enum: + - email + - expires_at + - created_at + type: string + - in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + page: + type: integer + per_page: + type: integer + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + type: array + total: + type: integer + required: + - page + - per_page + - total + - result + type: object + description: Returns suppressed emails. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: List account or zone email suppressions + tags: [] + operationId: get_accounts_account_id_email_routing_suppression + post: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + required: + - email + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + format: uuid + type: string + required: + - id + type: object + required: + - result + type: object + description: Returns suppression. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: Create account or zone email suppression + tags: [] + operationId: post_accounts_account_id_email_routing_suppression + /accounts/{account_id}/email/routing/suppression/{suppression_id}: + get: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + required: + - result + type: object + description: Returns suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Get account or zone email suppression + tags: [] + operationId: get_accounts_account_id_email_routing_suppression_suppression_id + delete: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + success: + type: boolean + required: + - success + type: object + description: Deletes suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Delete account or zone email suppression + tags: [] + operationId: delete_accounts_account_id_email_routing_suppression_suppression_id + /accounts/{account_id}/email/sending/suppression: + get: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 0 + type: integer + - in: query + name: per_page + schema: + default: 100 + maximum: 1000 + minimum: 0 + type: integer + - in: query + name: order + schema: + default: created_at + enum: + - email + - expires_at + - created_at + type: string + - in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + page: + type: integer + per_page: + type: integer + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + type: array + total: + type: integer + required: + - page + - per_page + - total + - result + type: object + description: Returns suppressed emails. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: List account or zone email suppressions + tags: [] + operationId: get_accounts_account_id_email_sending_suppression + post: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + required: + - email + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + format: uuid + type: string + required: + - id + type: object + required: + - result + type: object + description: Returns suppression. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: Create account or zone email suppression + tags: [] + operationId: post_accounts_account_id_email_sending_suppression + /accounts/{account_id}/email/sending/suppression/{suppression_id}: + get: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + required: + - result + type: object + description: Returns suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Get account or zone email suppression + tags: [] + operationId: get_accounts_account_id_email_sending_suppression_suppression_id + delete: + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + success: + type: boolean + required: + - success + type: object + description: Deletes suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Delete account or zone email suppression + tags: [] + operationId: delete_accounts_account_id_email_sending_suppression_suppression_id +components: + schemas: + aaaAuditLogAction: + description: Provides information about the action performed. + properties: + description: + description: A short description of the action performed. + example: Add Member + type: string + result: + description: The result of the action, indicating success or failure. + example: success + type: string + time: + description: A timestamp indicating when the action was logged. + example: '2024-04-26T17:31:07Z' + format: date-time + type: string + type: + description: A short string that describes the action that was performed. + example: create + type: string + type: object + aaaAuditLogRaw: + description: Provides raw information about the request and response. + properties: + cf_ray_id: + description: The Cloudflare Ray ID for the request. + example: 8e9b1c60ef9e1c9a + type: string + method: + description: The HTTP method of the request. + example: POST + type: string + status_code: + description: The HTTP response status code returned by the API. + example: 200 + type: integer + uri: + description: The URI of the request. + example: /accounts/4bb334f7c94c4a29a045f03944f072e5/members + type: string + user_agent: + description: The client's user agent string sent with the request. + example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Safari/605.1.15 + type: string + type: object + aaaAuditLogsV2: + properties: + account: + description: Contains account related information. + properties: + id: + description: A unique identifier for the account. + example: 4bb334f7c94c4a29a045f03944f072e5 + type: string + name: + description: A string that identifies the account name. + example: Example Account + type: string + type: object + action: + $ref: '#/components/schemas/aaaAuditLogAction' + actor: + description: Provides details about the actor who performed the action. + properties: + context: + enum: + - api_key + - api_token + - dash + - oauth + - origin_ca_key + example: dash + type: string + email: + description: The email of the actor who performed the action. + example: alice@example.com + format: email + type: string + id: + description: >- + The ID of the actor who performed the action. If a user + performed the action, this will be their User ID. + example: f6b5de0326bb5182b8a4840ee01ec774 + type: string + ip_address: + description: The IP address of the request that performed the action. + example: 198.41.129.166 + type: string + token_id: + description: >- + The API token ID when the actor context is an api_token or + oauth. + type: string + token_name: + description: >- + The API token name when the actor context is an api_token or + oauth. + type: string + type: + description: The type of actor. + enum: + - account + - cloudflare_admin + - system + - user + example: user + type: string + type: object + id: + $ref: '#/components/schemas/aaaSchemasIdentifier' + raw: + $ref: '#/components/schemas/aaaAuditLogRaw' + resource: + description: Provides details about the affected resource. + properties: + id: + description: The unique identifier for the affected resource. + type: string + product: + description: The Cloudflare product associated with the resource. + example: members + type: string + request: + type: object + response: + type: object + scope: + description: The scope of the resource. + type: object + type: + description: The type of the resource. + type: string + type: object + zone: + description: Provides details about the zone affected by the action. + properties: + id: + description: A string that identifies the zone id. + type: string + name: + description: A string that identifies the zone name. + example: example.com + type: string + type: object + type: object + aaaAuditLogsV2ResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaSchemasMessages' + result_info: + $ref: '#/components/schemas/aaaResultInfo' + success: + description: Indicates whether the API call was successful + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/aaaAuditLogsV2' + type: array + type: object + aaaResultInfo: + description: >- + Provides information about the result of the request, including count + and cursor. + properties: + count: + description: The number of records returned in the response. + example: '1' + type: string + cursor: + description: The cursor token used for pagination. + example: >- + ASqdKd7dKgxh-aZ8bm0mZos1BtW4BdEqifCzNkEeGRzi_5SN_-362Y8sF-C1TRn60_6rd3z2dIajf9EAPyQ_NmIeAMkacmaJPXipqvP7PLU4t72wyqBeJfjmjdE= + type: string + type: object + aaaSchemasApiResponseCommonFailure: + properties: + errors: + description: A list of error messages. + items: + properties: + message: + description: A text description of this message. + example: No route for the URI + type: string + required: + - message + type: object + uniqueItems: true + type: array + messages: + example: [] + items: + properties: + message: + type: string + type: object + uniqueItems: true + type: array + success: + description: Indicates whether the API call was failed + enum: + - false + example: false + type: boolean + required: + - success + - errors + type: object + aaaSchemasIdentifier: + description: A unique identifier for the audit log entry. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + aaaSchemasMessages: + example: [] + items: + properties: + message: + type: string + required: + - message + type: object + uniqueItems: true + type: array + billSubsApiAccountSubscriptionResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiSubscription' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + billSubsApiAccountSubscriptionResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + $ref: '#/components/schemas/billSubsApiSubscription' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + billSubsApiCurrency: + description: The monetary unit in which pricing information is displayed. + example: USD + readOnly: true + type: string + x-auditable: true + billSubsApiCurrentPeriodEnd: + description: The end of the current period and also when the next billing is due. + example: '2014-03-31T12:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + billSubsApiCurrentPeriodStart: + description: >- + When the current billing period started. May match initial_period_start + if this is the first period. + example: '2014-05-11T12:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + billSubsApiFrequency: + description: How often the subscription is renewed automatically. + enum: + - weekly + - monthly + - quarterly + - yearly + example: monthly + type: string + x-auditable: true + billSubsApiMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + billSubsApiPrice: + description: The price of the subscription that will be billed, in US dollars. + example: 20 + readOnly: true + type: number + x-auditable: true + billSubsApiRatePlan_2: + description: The rate plan applied to the subscription. + properties: + currency: + description: The currency applied to the rate plan subscription. + example: USD + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + externally_managed: + description: Whether this rate plan is managed externally from Cloudflare. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + id: + description: The ID of the rate plan. + example: free + type: string + x-auditable: true + enum: + - free + - lite + - pro + - pro_plus + - business + - enterprise + - partners_free + - partners_pro + - partners_business + - partners_enterprise + is_contract: + description: >- + Whether a rate plan is enterprise-based (or newly adopted term + contract). + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + public_name: + description: The full name of the rate plan. + example: Business Plan + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + scope: + description: The scope that this rate plan applies to. + example: zone + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + sets: + description: >- + The list of sets this rate plan applies to. Returns array of + strings. + example: [] + items: + type: string + x-auditable: true + type: array + x-stainless-terraform-configurability: optional + type: object + billSubsApiResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + billSubsApiSchemasIdentifier: + description: Subscription identifier tag. + example: 506e3185e9c882d175a2d0cb0093d9f2 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + billSubsApiState: + description: The state that the subscription is in. + enum: + - Trial + - Provisioned + - Paid + - AwaitingPayment + - Cancelled + - Failed + - Expired + example: Paid + readOnly: true + type: string + x-auditable: true + billSubsApiSubscription: + type: object + $ref: '#/components/schemas/billSubsApiSubscriptionV2' + billSubsApiSubscriptionV2: + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + $ref: '#/components/schemas/billSubsApiFrequency' + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + type: object + emailMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + emailSendingLimitsProperties: + properties: + quota: + description: >- + The resolved daily sending quota for the account. Null when the + quota is not yet available. + nullable: true + properties: + unit: + description: The time period for the quota. + enum: + - day + - hour + example: day + type: string + value: + description: The quota limit. + example: 1000 + type: integer + readOnly: true + type: object + type: object + emailSendingLimitsResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/emailSendingLimitsProperties' + required: + - success + - errors + - messages + iamAccess: + description: Allow or deny operations against the resources. + enum: + - allow + - deny + example: allow + type: string + x-auditable: true + iamAccount: + properties: + created_on: + description: Timestamp for the creation of the account + example: '2014-03-01T12:21:02.0000Z' + format: date-time + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + managed_by: + description: Parent container details + properties: + parent_org_id: + description: ID of the parent Organization, if one exists + example: 4536bcfad5faccb111b47003c79917fa + maxLength: 32 + readOnly: true + type: string + x-auditable: true + parent_org_name: + description: Name of the parent Organization, if one exists + example: Demo Parent Organization + readOnly: true + type: string + x-auditable: true + type: object + name: + description: Account name + example: Demo Account + maxLength: 100 + type: string + x-auditable: true + settings: + description: Account settings + properties: + abuse_contact_email: + description: Sets an abuse contact email to notify for abuse reports. + type: string + x-auditable: true + enforce_twofactor: + default: false + description: >- + Indicates whether membership in this account requires that + Two-Factor Authentication is enabled + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + type: + $ref: '#/components/schemas/iamAccountType' + required: + - id + - name + - type + type: object + iamAccountType: + enum: + - standard + - enterprise + type: string + iamApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/iamSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/iamSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + iamApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + required: + - id + type: object + required: + - success + - errors + - messages + iamCidrList: + description: List of IPv4/IPv6 CIDR addresses. + example: + - 199.27.128.0/21 + - 2400:cb00::/32 + items: + description: IPv4/IPv6 CIDR. + example: 199.27.128.0/21 + type: string + x-auditable: true + type: array + iamCollectionMemberResponseWithPolicies: + title: Members with Policies + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamMemberWithPolicies' + type: array + required: + - success + - errors + - messages + iamCollectionRoleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamRole' + type: array + required: + - success + - errors + - messages + iamCollectionTokensResponse: + title: Response with a list of tokens + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamTokenBase' + type: array + required: + - success + - errors + - messages + iamCommonComponentsSchemasIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + minLength: 32 + type: string + x-auditable: true + iamComponentsSchemasAccount: + $ref: '#/components/schemas/iamAccount' + iamCondition: + properties: + request_ip: + $ref: '#/components/schemas/iamRequestIp' + type: object + iamCreateAccount: + properties: + name: + description: Account name + type: string + type: + $ref: '#/components/schemas/iamAccountType' + unit: + description: >- + information related to the tenant unit, and optionally, an id of the + unit to create the account on. see + https://developers.cloudflare.com/tenant/how-to/manage-accounts/ + properties: + id: + description: Tenant unit ID + example: f267e341f3dd4697bd3b9f71dd96247f + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + x-stainless-terraform-configurability: computed_optional + required: + - name + title: Create account + type: object + iamCreateMemberPolicy: + properties: + access: + $ref: '#/components/schemas/iamAccess' + id: + $ref: '#/components/schemas/iamPolicyIdentifier' + permission_groups: + $ref: '#/components/schemas/iamMemberPermissionGroups' + resource_groups: + $ref: '#/components/schemas/iamMemberResourceGroups' + required: + - id + - access + - permission_groups + - resource_groups + title: create_member_policy + type: object + iamCreatePayload: + properties: + condition: + $ref: '#/components/schemas/iamCondition' + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + name: + $ref: '#/components/schemas/iamName' + not_before: + $ref: '#/components/schemas/iamNotBefore' + policies: + $ref: '#/components/schemas/iamTokenPolicies' + required: + - name + - policies + type: object + iamEffect: + description: Allow or deny operations against the resources. + enum: + - allow + - deny + example: allow + type: string + x-auditable: true + iamEmail: + description: The contact email address of the user. + example: user@example.com + maxLength: 90 + type: string + x-auditable: true + iamExpiresOn: + description: >- + The expiration time on or after which the JWT MUST NOT be accepted for + processing. + example: '2020-01-01T00:00:00Z' + format: date-time + type: string + x-auditable: true + iamFirstName: + description: User's first name + example: John + maxLength: 60 + nullable: true + type: string + x-auditable: true + iamGrants: + example: + read: true + write: false + properties: + read: + example: true + type: boolean + x-auditable: true + write: + example: true + type: boolean + x-auditable: true + type: object + iamIssuedOn: + description: The time on which the token was created. + example: '2018-07-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamLastName: + description: User's last name + example: Appleseed + maxLength: 60 + nullable: true + type: string + x-auditable: true + iamLastUsedOn: + description: Last time the token was used. + example: '2020-01-02T12:34:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamListMemberPolicy: + properties: + access: + $ref: '#/components/schemas/iamAccess' + id: + $ref: '#/components/schemas/iamPolicyIdentifier' + permission_groups: + $ref: '#/components/schemas/iamPermissionGroups' + resource_groups: + $ref: '#/components/schemas/iamResourceGroups' + title: list_member_policy + type: object + iamMemberInvitationStatus: + description: >- + Status of the member invitation. If not provided during creation, + defaults to 'pending'. Changing from 'accepted' back to 'pending' will + trigger a replacement of the member resource in Terraform. + enum: + - accepted + - pending + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + iamMemberPermissionGroup: + description: A group of permissions. + properties: + id: + description: Identifier of the group. + example: c8fed203ed3043cba015a93ad1616f1f + type: string + x-auditable: true + required: + - id + type: object + iamMemberPermissionGroups: + description: A set of permission groups that are specified to the policy. + example: + - id: c8fed203ed3043cba015a93ad1616f1f + - id: 82e64a83756745bbbb1c9c2701bf816b + items: + $ref: '#/components/schemas/iamMemberPermissionGroup' + type: array + iamMemberResourceGroup: + description: A group of scoped resources. + properties: + id: + description: Identifier of the group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + type: string + x-auditable: true + required: + - id + type: object + iamMemberResourceGroups: + description: A list of resource groups that the policy applies to. + items: + $ref: '#/components/schemas/iamMemberResourceGroup' + type: array + iamMemberWithPolicies: + properties: + email: + $ref: '#/components/schemas/iamEmail' + id: + $ref: '#/components/schemas/iamMembershipComponentsSchemasIdentifier' + policies: + description: Access policy for the membership + items: + $ref: '#/components/schemas/iamListMemberPolicy' + type: array + roles: + description: Roles assigned to this Member. + items: + $ref: '#/components/schemas/iamRole' + type: array + status: + description: A member's status in the account. + enum: + - accepted + - pending + example: accepted + readOnly: true + x-auditable: true + type: string + user: + description: Details of the user associated to the membership. + properties: + email: + $ref: '#/components/schemas/iamEmail' + first_name: + $ref: '#/components/schemas/iamFirstName' + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + last_name: + $ref: '#/components/schemas/iamLastName' + two_factor_authentication_enabled: + $ref: '#/components/schemas/iamTwoFactorAuthenticationEnabled' + readOnly: true + required: + - email + type: object + type: object + iamMembershipComponentsSchemasIdentifier: + description: Membership identifier tag. + example: 4536bcfad5faccb111b47003c79917fa + maxLength: 32 + readOnly: true + type: string + x-auditable: true + iamModifiedOn: + description: Last time the token was modified. + example: '2018-07-02T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamName: + description: Token name. + example: readonly token + maxLength: 120 + type: string + x-auditable: true + iamNotBefore: + description: The time before which the token MUST NOT be accepted for processing. + example: '2018-07-01T05:20:00Z' + format: date-time + type: string + x-auditable: true + iamPermissionGroup: + description: >- + A named group of permissions that map to a group of operations against + resources. + properties: + id: + description: Identifier of the permission group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + type: string + x-auditable: true + meta: + description: Attributes associated to the permission group. + example: + label: load_balancer_admin + scopes: com.cloudflare.api.account + properties: + key: + type: string + x-auditable: true + value: + type: string + x-auditable: true + type: object + name: + description: Name of the permission group. + example: Load Balancer + readOnly: true + type: string + x-auditable: true + required: + - id + type: object + iamPermissionGroups: + description: A set of permission groups that are specified to the policy. + example: + - id: c8fed203ed3043cba015a93ad1616f1f + meta: + label: load_balancer_admin + scopes: com.cloudflare.api.account + name: Zone Read + - id: 82e64a83756745bbbb1c9c2701bf816b + meta: + label: fbm_user + scopes: com.cloudflare.api.account + name: Magic Network Monitoring + items: + $ref: '#/components/schemas/iamPermissionGroup' + type: array + iamPermissions: + example: + analytics: + read: true + write: false + zones: + read: true + write: true + properties: + analytics: + $ref: '#/components/schemas/iamGrants' + billing: + $ref: '#/components/schemas/iamGrants' + cache_purge: + $ref: '#/components/schemas/iamGrants' + dns: + $ref: '#/components/schemas/iamGrants' + dns_records: + $ref: '#/components/schemas/iamGrants' + lb: + $ref: '#/components/schemas/iamGrants' + logs: + $ref: '#/components/schemas/iamGrants' + organization: + $ref: '#/components/schemas/iamGrants' + ssl: + $ref: '#/components/schemas/iamGrants' + waf: + $ref: '#/components/schemas/iamGrants' + zone_settings: + $ref: '#/components/schemas/iamGrants' + zones: + $ref: '#/components/schemas/iamGrants' + type: object + iamPermissionsGroupResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + example: + - id: 7cf72faf220841aabcfdfab81c43c4f6 + name: Billing Read + scopes: + - com.cloudflare.api.account + - id: 9d24387c6e8544e2bc4024a03991339f + name: 'Load Balancing: Monitors and Pools Read' + scopes: + - com.cloudflare.api.account + - id: d2a1802cc9a34e30852f8b33869b2f3c + name: 'Load Balancing: Monitors and Pools Write' + scopes: + - com.cloudflare.api.account + - id: 8b47d2786a534c08a1f94ee8f9f599ef + name: Workers KV Storage Read + scopes: + - com.cloudflare.api.account + - id: f7f0eda5697f475c90846e879bab8666 + name: Workers KV Storage Write + scopes: + - com.cloudflare.api.account + - id: 1a71c399035b4950a1bd1466bbe4f420 + name: Workers Scripts Read + scopes: + - com.cloudflare.api.account + - id: e086da7e2179491d91ee5f35b3ca210a + name: Workers Scripts Write + scopes: + - com.cloudflare.api.account + items: + $ref: >- + #/components/schemas/iamPermissionsGroupResponseCollection_result_item + type: array + required: + - success + - errors + - messages + iamPermissionsGroupResponseCollection_result_item: + properties: + id: + description: Public ID. + type: string + x-auditable: true + name: + description: Permission Group Name + type: string + x-auditable: true + scopes: + description: Resources to which the Permission Group is scoped + items: + enum: + - com.cloudflare.api.account + - com.cloudflare.api.account.zone + - com.cloudflare.api.user + - com.cloudflare.edge.r2.bucket + type: string + x-auditable: true + type: array + type: object + iamPolicyIdentifier: + description: Policy identifier. + example: f267e341f3dd4697bd3b9f71dd96247f + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-always-send: true + iamPolicyWithPermissionGroupsAndResources: + properties: + effect: + $ref: '#/components/schemas/iamEffect' + id: + $ref: '#/components/schemas/iamPolicyIdentifier' + permission_groups: + $ref: '#/components/schemas/iamPermissionGroups' + resources: + $ref: '#/components/schemas/iamResources' + required: + - id + - effect + - permission_groups + - resources + title: Policy with Permission Groups and Resources + type: object + iamRequestIp: + description: Client IP restrictions. + example: + in: + - 123.123.123.0/24 + - 2606:4700::/32 + not_in: + - 123.123.123.100/24 + - 2606:4700:4700::/48 + properties: + in: + $ref: '#/components/schemas/iamCidrList' + not_in: + $ref: '#/components/schemas/iamCidrList' + type: object + iamResourceGroup: + description: A group of scoped resources. + properties: + id: + description: Identifier of the resource group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + readOnly: true + type: string + x-auditable: true + meta: + description: Attributes associated to the resource group. + example: + editable: 'false' + properties: + key: + type: string + value: + type: string + type: object + name: + description: Name of the resource group. + example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4 + readOnly: true + type: string + x-auditable: true + scope: + description: The scope associated to the resource group + items: + $ref: '#/components/schemas/iamScope' + type: array + required: + - id + - scope + type: object + iamResourceGroups: + description: A list of resource groups that the policy applies to. + items: + $ref: '#/components/schemas/iamResourceGroup' + type: array + iamResources: + description: A list of resource names that the policy applies to. + x-auditable: true + type: object + iamResponseCollectionAccounts: + title: Response with a list of accounts + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamAccount' + type: array + required: + - success + - errors + - messages + iamResponseSingleAccount: + title: Response with a single account + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamAccount' + required: + - success + - errors + - messages + iamResponseSingleValue: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamValue' + required: + - success + - errors + - messages + iamResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + iamRole: + properties: + description: + description: Description of role's permissions. + example: Administrative access to the entire Account + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/iamRoleComponentsSchemasIdentifier' + name: + description: Role name. + example: Account Administrator + maxLength: 120 + readOnly: true + type: string + x-auditable: true + permissions: + $ref: '#/components/schemas/iamPermissions' + readOnly: true + required: + - id + - name + - description + - permissions + type: object + iamRoleComponentsSchemasIdentifier: + description: Role identifier tag. + example: 3536bcfad5faccb999b47003c79917fb + maxLength: 32 + type: string + x-auditable: true + iamSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + iamScope: + description: >- + A scope is a combination of scope objects which provides additional + context. + properties: + key: + $ref: '#/components/schemas/iamScopeKey' + objects: + description: A list of scope objects for additional context. + items: + $ref: '#/components/schemas/iamScopeObject' + type: array + required: + - key + - objects + type: object + iamScopeKey: + description: >- + This is a combination of pre-defined resource name and identifier (like + Account ID etc.) + example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4 + readOnly: true + x-auditable: true + type: string + iamScopeObject: + description: >- + A scope object represents any resource that can have actions applied + against invite. + properties: + key: + $ref: '#/components/schemas/iamScopeObjectKey' + required: + - key + type: object + iamScopeObjectKey: + description: >- + This is a combination of pre-defined resource name and identifier (like + Zone ID etc.) + example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5 + readOnly: true + x-auditable: true + type: string + iamSingleMemberResponseWithPolicies: + title: Response with Policies + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamMemberWithPolicies' + required: + - success + - errors + - messages + iamSingleRoleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamRole' + required: + - success + - errors + - messages + iamSingleTokenCreateResponse: + title: Response of a create request with a single token + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamTokenWithValue' + required: + - success + - errors + - messages + iamSingleTokenResponse: + title: Response with a single token + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamTokenBase' + required: + - success + - errors + - messages + iamTokenBase: + properties: + condition: + $ref: '#/components/schemas/iamCondition' + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + id: + $ref: '#/components/schemas/iamTokenIdentifier' + issued_on: + $ref: '#/components/schemas/iamIssuedOn' + last_used_on: + $ref: '#/components/schemas/iamLastUsedOn' + modified_on: + $ref: '#/components/schemas/iamModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/iamName' + not_before: + $ref: '#/components/schemas/iamNotBefore' + policies: + $ref: '#/components/schemas/iamTokenPolicies' + status: + $ref: '#/components/schemas/iamTokenStatus' + type: object + iamTokenBody: + title: Token defined in a request body + $ref: '#/components/schemas/iamTokenBase' + type: object + iamTokenIdentifier: + description: Token identifier tag. + example: ed17574386854bf78a67040be0a770b0 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + iamTokenPolicies: + description: List of access policies assigned to the token. + items: + $ref: '#/components/schemas/iamPolicyWithPermissionGroupsAndResources' + type: array + iamTokenStatus: + description: Status of the token. + enum: + - active + - disabled + - expired + example: active + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + iamTokenVerifyResponseSingleSegment: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + id: + $ref: '#/components/schemas/iamTokenIdentifier' + not_before: + $ref: '#/components/schemas/iamNotBefore' + status: + $ref: '#/components/schemas/iamTokenStatus' + required: + - id + - status + type: object + required: + - success + - errors + - messages + iamTokenWithValue: + title: Create token response, with the token value + properties: + condition: + $ref: '#/components/schemas/iamCondition' + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + id: + $ref: '#/components/schemas/iamTokenIdentifier' + issued_on: + $ref: '#/components/schemas/iamIssuedOn' + last_used_on: + $ref: '#/components/schemas/iamLastUsedOn' + modified_on: + $ref: '#/components/schemas/iamModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/iamName' + not_before: + $ref: '#/components/schemas/iamNotBefore' + policies: + $ref: '#/components/schemas/iamTokenPolicies' + status: + $ref: '#/components/schemas/iamTokenStatus' + value: + $ref: '#/components/schemas/iamValue' + type: object + iamTwoFactorAuthenticationEnabled: + default: false + description: >- + Indicates whether two-factor authentication is enabled for the user + account. Does not apply to API authentication. + readOnly: true + type: boolean + iamValue: + description: The token value. + example: 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T + maxLength: 80 + minLength: 40 + readOnly: true + type: string + x-sensitive: true + organizationsApiBatchAccountMoveResponse: + properties: + statuses: + properties: + message: + type: string + moved: + type: boolean + tag: + type: string + required: + - tag + - moved + type: object + required: + - statuses + type: object + organizationsApiMoveAccountResponse: + properties: + account_id: + type: string + destination_organization_id: + type: string + source_organization_id: + type: string + required: + - account_id + - source_organization_id + - destination_organization_id + type: object + organizationsApiV4ErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + type: object + success: + enum: + - false + type: boolean + required: + - success + - errors + - messages + type: object + organizationsApiV4Message: + $ref: '#/components/schemas/responseInfo' + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + accounts: + id: cloudflare.accounts.accounts + name: accounts + title: Accounts + methods: + list: + operation: + $ref: '#/paths/~1accounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts/post' + response: + mediaType: application/json + openAPIDocKey: '200' + accounts_batch_move_accounts: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1move/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + accounts_move_accounts: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1move/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts/methods/get' + - $ref: '#/components/x-stackQL-resources/accounts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/accounts/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/accounts/methods/update' + feedback: + id: cloudflare.accounts.feedback + name: feedback + title: Feedback + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1sending~1feedback/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feedback/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + limits: + id: cloudflare.accounts.limits + name: limits + title: Limits + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1sending~1limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/limits/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + audit: + id: cloudflare.accounts.audit + name: audit + title: Audit + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logs~1audit/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + members: + id: cloudflare.accounts.members + name: members + title: Members + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1members/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1members~1{member_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1members~1{member_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1members~1{member_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/members/methods/get' + - $ref: '#/components/x-stackQL-resources/members/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/members/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/members/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/members/methods/update' + roles: + id: cloudflare.accounts.roles + name: roles + title: Roles + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1roles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1roles~1{role_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/roles/methods/get' + - $ref: '#/components/x-stackQL-resources/roles/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + subscriptions: + id: cloudflare.accounts.subscriptions + name: subscriptions + title: Subscriptions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1subscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1subscriptions~1{subscription_identifier}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1subscriptions~1{subscription_identifier}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/update' + account_tokens: + id: cloudflare.accounts.account_tokens + name: account_tokens + title: Account Tokens + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/account_tokens/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tokens: + id: cloudflare.accounts.tokens + name: tokens + title: Tokens + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens~1{token_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens~1{token_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens~1{token_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + roll_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens~1{token_id}~1value/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/tokens/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tokens/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/tokens/methods/update' + permission_groups: + id: cloudflare.accounts.permission_groups + name: permission_groups + title: Permission Groups + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens~1permission_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tokens_verify: + id: cloudflare.accounts.tokens_verify + name: tokens_verify + title: Tokens Verify + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tokens~1verify/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens_verify/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_suppression: + id: cloudflare.accounts.routing_suppression + name: routing_suppression + title: Routing Suppression + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1routing~1suppression/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_accounts_account_id_email_routing_suppression: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1routing~1suppression/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email~1routing~1suppression~1{suppression_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_accounts_account_id_email_routing_suppression_suppression_id: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email~1routing~1suppression~1{suppression_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_suppression/methods/get' + - $ref: '#/components/x-stackQL-resources/routing_suppression/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/routing_suppression/methods/post_accounts_account_id_email_routing_suppression + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/routing_suppression/methods/delete_accounts_account_id_email_routing_suppression_suppression_id + replace: [] + sending_suppression: + id: cloudflare.accounts.sending_suppression + name: sending_suppression + title: Sending Suppression + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1sending~1suppression/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_accounts_account_id_email_sending_suppression: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1sending~1suppression/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email~1sending~1suppression~1{suppression_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_accounts_account_id_email_sending_suppression_suppression_id: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email~1sending~1suppression~1{suppression_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sending_suppression/methods/get' + - $ref: '#/components/x-stackQL-resources/sending_suppression/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/sending_suppression/methods/post_accounts_account_id_email_sending_suppression + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sending_suppression/methods/delete_accounts_account_id_email_sending_suppression_suppression_id + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/acm.yaml b/providers/src/cloudflare/v00.00.00000/services/acm.yaml new file mode 100644 index 00000000..9e851708 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/acm.yaml @@ -0,0 +1,993 @@ +openapi: 3.0.3 +info: + title: acm API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/acm/custom_trust_store: + get: + description: Get Custom Origin Trust Store for a Zone. + operationId: custom-origin-trust-store-list-details + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of records per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: limit + schema: + description: Limit to the number of records returned. + type: integer + - in: query + name: offset + schema: + description: Offset the results + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStoreResponseCollection + description: Custom Origin Trust Store Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStore + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Custom Origin Trust Store response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Custom Origin Trust Store Details + tags: + - Custom Origin Trust Store + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: acm + resource_chain: + - custom_trust_store + method: list + post: + description: Add Custom Origin Trust Store for a Zone. + operationId: custom-origin-trust-store-create + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificate + required: + - certificate + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStoreResponseSingle + description: Upload Custom Origin Trust Store response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificate + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStoreComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasUpdatedAt + readOnly: true + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUploadedOn + required: + - id + - status + - issuer + - signature + - certificate + - expires_on + - uploaded_on + - updated_at + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Upload Custom Origin Trust Store response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload Custom Origin Trust Store + tags: + - Custom Origin Trust Store + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: acm + resource_chain: + - custom_trust_store + method: create + /zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}: + delete: + description: >- + Removes a CA certificate from the custom origin trust store. Origins + using certificates signed by this CA will no longer be trusted. + operationId: custom-origin-trust-store-delete + parameters: + - in: path + name: custom_origin_trust_store_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStoreResponseIdOnly + description: Delete Custom Origin Trust Store response + 4XX: + content: + application/json: + schema: + description: Identifier. + maxLength: 32 + type: object + x-auditable: true + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + description: Delete Custom Origin Trust Store response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Custom Origin Trust Store + tags: + - Custom Origin Trust Store + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: acm + resource_chain: + - custom_trust_store + method: delete + get: + description: >- + Retrieves details about a specific certificate in the custom origin + trust store, including expiration and subject information. + operationId: custom-origin-trust-store-details + parameters: + - in: path + name: custom_origin_trust_store_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStoreResponseSingle + description: Custom Origin Trust Store Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificate + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStoreComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasUpdatedAt + readOnly: true + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUploadedOn + required: + - id + - status + - issuer + - signature + - certificate + - expires_on + - uploaded_on + - updated_at + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Custom Origin Trust Store Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Custom Origin Trust Store Details + tags: + - Custom Origin Trust Store + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: acm + resource_chain: + - custom_trust_store + method: get + /zones/{zone_id}/acm/total_tls: + get: + description: Get Total TLS Settings for a Zone. + operationId: total-tls-total-tls-settings-details + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesTotalTlsSettingsResponse + description: Total TLS Settings Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateAuthority + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasEnabled + validity_period: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidityPeriod + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Total TLS Settings Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Total TLS Settings Details + tags: + - Total TLS + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: acm + resource_chain: + - total_tls + method: get + post: + description: Set Total TLS Settings or disable the feature for a Zone. + operationId: total-tls-enable-or-disable-total-tls + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateAuthority + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasEnabled + required: + - enabled + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesTotalTlsSettingsResponse + description: Enable or Disable Total TLS response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateAuthority + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasEnabled + validity_period: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidityPeriod + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Enable or Disable Total TLS response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Enable or Disable Total TLS + tags: + - Total TLS + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: acm + resource_chain: + - total_tls + method: update +components: + schemas: + tlsCertificatesAndHostnamesComponentsSchemasCertificate: + description: The zone's SSL certificate or certificate and the intermediate(s). + example: | + -----BEGIN CERTIFICATE----- + MIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx... + -----END CERTIFICATE----- + type: string + tlsCertificatesAndHostnamesComponentsSchemasCertificateAuthority: + description: >- + The Certificate Authority that Total TLS certificates will be issued + through. + enum: + - google + - lets_encrypt + - ssl_com + example: google + type: string + x-auditable: true + tlsCertificatesAndHostnamesComponentsSchemasEnabled: + description: >- + If enabled, Total TLS will order a hostname specific TLS certificate for + any proxied A, AAAA, or CNAME record in your zone. + example: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesCustomTrustStore: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificate + expires_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomTrustStoreComponentsSchemasStatus + updated_at: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasUpdatedAt' + readOnly: true + uploaded_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUploadedOn' + required: + - id + - status + - issuer + - signature + - certificate + - expires_on + - uploaded_on + - updated_at + type: object + tlsCertificatesAndHostnamesCustomTrustStoreComponentsSchemasStatus: + description: Status of the zone's custom SSL. + enum: + - initializing + - pending_deployment + - active + - pending_deletion + - deleted + - expired + example: active + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesCustomTrustStoreResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomTrustStore' + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCustomTrustStoreResponseIdOnly: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCustomTrustStoreResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomTrustStore' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesIssuer: + description: The certificate authority that issued the certificate. + example: GlobalSign + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesSchemasExpiresOn: + description: When the certificate expires. + example: '2122-10-29T16:59:47Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasUpdatedAt: + description: When the certificate was last modified. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSignature: + description: The type of hash used for the certificate. + example: SHA256WithRSA + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesTotalTlsSettingsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateAuthority + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasEnabled + validity_period: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidityPeriod' + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesUploadedOn: + description: When the certificate was uploaded to Cloudflare. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesValidityPeriod: + description: The validity period in days for the certificates ordered via Total TLS. + enum: + - 90 + type: integer + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + custom_trust_store: + id: cloudflare.acm.custom_trust_store + name: custom_trust_store + title: Custom Trust Store + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1acm~1custom_trust_store/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1acm~1custom_trust_store/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1acm~1custom_trust_store~1{custom_origin_trust_store_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1acm~1custom_trust_store~1{custom_origin_trust_store_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_trust_store/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_trust_store/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_trust_store/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/custom_trust_store/methods/delete' + replace: [] + total_tls: + id: cloudflare.acm.total_tls + name: total_tls + title: Total Tls + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1acm~1total_tls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1acm~1total_tls/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/total_tls/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/total_tls/methods/update' + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/addressing.yaml b/providers/src/cloudflare/v00.00.00000/services/addressing.yaml new file mode 100644 index 00000000..30a00b63 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/addressing.yaml @@ -0,0 +1,5001 @@ +openapi: 3.0.3 +info: + title: addressing API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/addressing/address_maps: + get: + description: List all address maps owned by the account. + operationId: ip-address-management-address-maps-list-address-maps + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingComponentsSchemasResponseCollection' + description: List Address Maps response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/addressingAddressMaps' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Address Maps response failure + security: + - api_email: [] + api_key: [] + summary: List Address Maps + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + - Address Maps Read + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + method: list + post: + description: Create a new address map under the account. + operationId: ip-address-management-address-maps-create-address-map + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/addressingSchemasDescription' + enabled: + $ref: '#/components/schemas/addressingEnabled' + ips: + items: + $ref: '#/components/schemas/addressingIpAddress' + type: array + memberships: + $ref: '#/components/schemas/addressingMembershipRequests' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingFullResponse' + description: Create Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + can_delete: + $ref: '#/components/schemas/addressingCanDelete' + can_modify_ips: + $ref: '#/components/schemas/addressingCanModifyIps' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + default_sni: + $ref: '#/components/schemas/addressingDefaultSni' + description: + $ref: '#/components/schemas/addressingSchemasDescription' + enabled: + $ref: '#/components/schemas/addressingEnabled' + id: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + ips: + $ref: '#/components/schemas/addressingIps' + memberships: + $ref: '#/components/schemas/addressingMemberships' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Create Address Map + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + method: create + /accounts/{account_id}/addressing/address_maps/{address_map_id}: + delete: + description: Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted. + operationId: ip-address-management-address-maps-delete-address-map + parameters: + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCollection' + description: Delete Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Delete Address Map + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + method: delete + get: + description: Show a particular address map owned by the account. + operationId: ip-address-management-address-maps-address-map-details + parameters: + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingFullResponse' + description: Address Map Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + can_delete: + $ref: '#/components/schemas/addressingCanDelete' + can_modify_ips: + $ref: '#/components/schemas/addressingCanModifyIps' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + default_sni: + $ref: '#/components/schemas/addressingDefaultSni' + description: + $ref: '#/components/schemas/addressingSchemasDescription' + enabled: + $ref: '#/components/schemas/addressingEnabled' + id: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + ips: + $ref: '#/components/schemas/addressingIps' + memberships: + $ref: '#/components/schemas/addressingMemberships' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Address Map Details response failure + security: + - api_email: [] + api_key: [] + summary: Address Map Details + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + - Address Maps Read + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + method: get + patch: + description: Modify properties of an address map owned by the account. + operationId: ip-address-management-address-maps-update-address-map + parameters: + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + default_sni: + $ref: '#/components/schemas/addressingDefaultSni' + description: + $ref: '#/components/schemas/addressingSchemasDescription' + enabled: + $ref: '#/components/schemas/addressingEnabled' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingComponentsSchemasSingleResponse' + description: Update Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + can_delete: + $ref: '#/components/schemas/addressingCanDelete' + can_modify_ips: + $ref: '#/components/schemas/addressingCanModifyIps' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + default_sni: + $ref: '#/components/schemas/addressingDefaultSni' + description: + $ref: '#/components/schemas/addressingSchemasDescription' + enabled: + $ref: '#/components/schemas/addressingEnabled' + id: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Update Address Map + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + method: edit + /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}: + delete: + description: Remove an account as a member of a particular address map. + operationId: ip-address-management-address-maps-remove-an-account-membership-from-an-address-map + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCollection' + description: Remove an account membership from an Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Remove an account membership from an Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Remove an account membership from an Address Map + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + - accounts + method: delete + put: + description: Add an account as a member of a particular address map. + operationId: ip-address-management-address-maps-add-an-account-membership-to-an-address-map + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCollection' + description: Add an account membership to an Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Add an account membership to an Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Add an account membership to an Address Map + tags: + - IP Address Management Address Maps + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + - accounts + method: update + /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}: + delete: + description: Remove an IP from a particular address map. + operationId: ip-address-management-address-maps-remove-an-ip-from-an-address-map + parameters: + - in: path + name: ip_address + schema: + $ref: '#/components/schemas/addressingIpAddress' + required: true + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCollection' + description: Remove an IP from an Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Remove an IP from an Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Remove an IP from an Address Map + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + - ips + method: delete + put: + description: Add an IP from a prefix owned by the account to a particular address map. + operationId: ip-address-management-address-maps-add-an-ip-to-an-address-map + parameters: + - in: path + name: ip_address + schema: + $ref: '#/components/schemas/addressingIpAddress' + required: true + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCollection' + description: Add an IP to an Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Add an IP to an Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Add an IP to an Address Map + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + - ips + method: update + /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}: + delete: + description: Remove a zone as a member of a particular address map. + operationId: ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCollection' + description: Remove a zone membership from an Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Remove a zone membership from an Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Remove a zone membership from an Address Map + tags: + - IP Address Management Address Maps + x-api-token-group: + - Address Maps Write + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + - zones + method: delete + put: + description: Add a zone as a member of a particular address map. + operationId: ip-address-management-address-maps-add-a-zone-membership-to-an-address-map + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: address_map_id + schema: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCollection' + description: Add a zone membership to an Address Map response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Add a zone membership to an Address Map response failure + security: + - api_email: [] + api_key: [] + summary: Add a zone membership to an Address Map + tags: + - IP Address Management Address Maps + x-stackql-sdk: + service: addressing + resource_chain: + - address_maps + - zones + method: update + /accounts/{account_id}/addressing/leases: + get: + description: List all leases owned by the account. + operationId: ip-address-management-list-leases + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingLeasesComponentsSchemasResponseCollection' + description: List Leases response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/addressingLease' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Leases response failure + security: + - api_email: [] + api_key: [] + summary: List Leases + tags: + - IP Address Management Leases + x-api-token-group: null + /accounts/{account_id}/addressing/loa_documents: + post: + description: Submit LOA document (pdf format) under the account. + operationId: ip-address-management-prefixes-upload-loa-document + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + loa_document: + description: LOA document to upload. + type: string + required: + - loa_document + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingLoaUploadResponse' + description: Upload LOA Document response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + account_id: + $ref: '#/components/schemas/addressingAccountIdentifier' + auto_generated: + $ref: '#/components/schemas/addressingAutoGenerated' + created: + $ref: '#/components/schemas/addressingTimestamp' + filename: + $ref: '#/components/schemas/addressingFilename' + id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + size_bytes: + $ref: '#/components/schemas/addressingSizeBytes' + verified: + $ref: '#/components/schemas/addressingVerified' + verified_at: + $ref: '#/components/schemas/addressingVerifiedAt' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Upload LOA Document response failure + security: + - api_email: [] + api_key: [] + summary: Upload LOA Document + tags: + - IP Address Management Prefixes + x-api-token-group: + - Magic Transit Write + x-stackql-sdk: + service: addressing + resource_chain: + - loa_documents + method: create + /accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download: + get: + description: Download specified LOA document under the account. + operationId: ip-address-management-prefixes-download-loa-document + parameters: + - in: path + name: loa_document_id + schema: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/pdf: + schema: + type: object + properties: + contents: + type: string + description: Download LOA Document response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommonFailure' + description: Download LOA Document response failure + security: + - api_email: [] + api_key: [] + summary: Download LOA Document + tags: + - IP Address Management Prefixes + x-api-token-group: + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: addressing + resource_chain: + - loa_documents + method: get + /accounts/{account_id}/addressing/prefixes: + get: + description: List all prefixes owned by the account. + operationId: ip-address-management-prefixes-list-prefixes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingResponseCollection' + description: List Prefixes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/addressingIpamPrefixes' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Prefixes response failure + security: + - api_email: [] + api_key: [] + summary: List Prefixes + tags: + - IP Address Management Prefixes + x-api-token-group: + - Magic Transit Read + - Magic Transit Write + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + - 'IP Prefixes: BGP On Demand Write' + - 'IP Prefixes: BGP On Demand Read' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + method: list + post: + description: Add a new prefix under the account. + operationId: ip-address-management-prefixes-add-prefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + asn: + $ref: '#/components/schemas/addressingAsn' + cidr: + $ref: '#/components/schemas/addressingCidr' + delegate_loa_creation: + $ref: '#/components/schemas/addressingDelegateLoaCreation' + description: + $ref: '#/components/schemas/addressingDescription' + loa_document_id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + required: + - cidr + - asn + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSingleResponse' + description: Add Prefix response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + account_id: + $ref: '#/components/schemas/addressingAccountIdentifier' + advertised: + $ref: '#/components/schemas/addressingAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingAdvertisedModifiedAtNullable' + readOnly: true + approved: + $ref: '#/components/schemas/addressingApproved' + asn: + $ref: '#/components/schemas/addressingAsn' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + delegate_loa_creation: + $ref: '#/components/schemas/addressingDelegateLoaCreation' + description: + $ref: '#/components/schemas/addressingDescription' + id: + $ref: '#/components/schemas/addressingPrefixIdentifier' + irr_validation_state: + $ref: '#/components/schemas/addressingValidationState' + loa_document_id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand_enabled: + $ref: '#/components/schemas/addressingOnDemandEnabled' + on_demand_locked: + $ref: '#/components/schemas/addressingOnDemandLocked' + ownership_validation_state: + $ref: '#/components/schemas/addressingValidationState' + ownership_validation_token: + $ref: '#/components/schemas/addressingOwnershipValidationToken' + rpki_validation_state: + $ref: '#/components/schemas/addressingValidationState' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Add Prefix response failure + security: + - api_email: [] + api_key: [] + summary: Add Prefix + tags: + - IP Address Management Prefixes + x-api-token-group: null + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + method: create + /accounts/{account_id}/addressing/prefixes/{prefix_id}: + delete: + description: Delete an unapproved prefix owned by the account. + operationId: ip-address-management-prefixes-delete-prefix + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseSingle' + description: Delete Prefix response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Prefix response failure + security: + - api_email: [] + api_key: [] + summary: Delete Prefix + tags: + - IP Address Management Prefixes + x-api-token-group: + - Magic Transit Write + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + method: delete + get: + description: List a particular prefix owned by the account. + operationId: ip-address-management-prefixes-prefix-details + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSingleResponse' + description: Prefix Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + account_id: + $ref: '#/components/schemas/addressingAccountIdentifier' + advertised: + $ref: '#/components/schemas/addressingAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingAdvertisedModifiedAtNullable' + readOnly: true + approved: + $ref: '#/components/schemas/addressingApproved' + asn: + $ref: '#/components/schemas/addressingAsn' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + delegate_loa_creation: + $ref: '#/components/schemas/addressingDelegateLoaCreation' + description: + $ref: '#/components/schemas/addressingDescription' + id: + $ref: '#/components/schemas/addressingPrefixIdentifier' + irr_validation_state: + $ref: '#/components/schemas/addressingValidationState' + loa_document_id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand_enabled: + $ref: '#/components/schemas/addressingOnDemandEnabled' + on_demand_locked: + $ref: '#/components/schemas/addressingOnDemandLocked' + ownership_validation_state: + $ref: '#/components/schemas/addressingValidationState' + ownership_validation_token: + $ref: '#/components/schemas/addressingOwnershipValidationToken' + rpki_validation_state: + $ref: '#/components/schemas/addressingValidationState' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Prefix Details response failure + security: + - api_email: [] + api_key: [] + summary: Prefix Details + tags: + - IP Address Management Prefixes + x-api-token-group: + - Magic Transit Read + - Magic Transit Write + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + - 'IP Prefixes: BGP On Demand Write' + - 'IP Prefixes: BGP On Demand Read' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + method: get + patch: + description: Modify the description for a prefix owned by the account. + operationId: ip-address-management-prefixes-update-prefix-description + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/addressingDescription' + required: + - description + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSingleResponse' + description: Update Prefix Description response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + account_id: + $ref: '#/components/schemas/addressingAccountIdentifier' + advertised: + $ref: '#/components/schemas/addressingAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingAdvertisedModifiedAtNullable' + readOnly: true + approved: + $ref: '#/components/schemas/addressingApproved' + asn: + $ref: '#/components/schemas/addressingAsn' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + delegate_loa_creation: + $ref: '#/components/schemas/addressingDelegateLoaCreation' + description: + $ref: '#/components/schemas/addressingDescription' + id: + $ref: '#/components/schemas/addressingPrefixIdentifier' + irr_validation_state: + $ref: '#/components/schemas/addressingValidationState' + loa_document_id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand_enabled: + $ref: '#/components/schemas/addressingOnDemandEnabled' + on_demand_locked: + $ref: '#/components/schemas/addressingOnDemandLocked' + ownership_validation_state: + $ref: '#/components/schemas/addressingValidationState' + ownership_validation_token: + $ref: '#/components/schemas/addressingOwnershipValidationToken' + rpki_validation_state: + $ref: '#/components/schemas/addressingValidationState' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Prefix Description response failure + security: + - api_email: [] + api_key: [] + summary: Update Prefix Description + tags: + - IP Address Management Prefixes + x-api-token-group: + - Magic Transit Write + - 'IP Prefixes: Write' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + method: edit + /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes: + get: + description: List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes. + operationId: ip-address-management-prefixes-list-bgp-prefixes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingResponseCollectionBgp' + description: List BGP Prefixes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/addressingIpamBgpPrefixes' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List BGP Prefixes response failure + security: + - api_email: [] + api_key: [] + summary: List BGP Prefixes + tags: + - IP Address Management BGP Prefixes + x-api-token-group: + - Magic Transit Read + - Magic Transit Write + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + - 'IP Prefixes: BGP On Demand Write' + - 'IP Prefixes: BGP On Demand Read' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - bgp_prefixes + method: list + post: + description: Create a BGP prefix, controlling the BGP advertisement status of a specific subnet. When created, BGP prefixes are initially withdrawn, and can be advertised with the Update BGP Prefix API. + operationId: ip-address-management-prefixes-create-bgp-prefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingBgpPrefixCreate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSingleResponseBgp' + description: Create BGP Prefix response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + asn: + $ref: '#/components/schemas/addressingSchemasAsn' + asn_prepend_count: + $ref: '#/components/schemas/addressingAsnPrependCount' + auto_advertise_withdraw: + $ref: '#/components/schemas/addressingAutoAdvertiseWithdraw' + bgp_signal_opts: + $ref: '#/components/schemas/addressingBgpSignalOpts' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/addressingBgpPrefixIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand: + $ref: '#/components/schemas/addressingBgpOnDemand' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create BGP Prefix response failure + security: + - api_email: [] + api_key: [] + summary: Create BGP Prefix + tags: + - IP Address Management BGP Prefixes + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - bgp_prefixes + method: create + /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}: + delete: + description: Delete a BGP Prefix associated with the specified IP Prefix. A BGP Prefix must be withdrawn before it can be deleted. + operationId: ip-address-management-prefixes-delete-bgp-prefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - in: path + name: bgp_prefix_id + schema: + $ref: '#/components/schemas/addressingBgpPrefixIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommon' + description: Delete BGP Prefix response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommonFailure' + description: Delete BGP Prefix response failure + security: + - api_email: [] + api_key: [] + summary: Delete BGP Prefix + tags: + - IP Address Management BGP Prefixes + get: + description: Retrieve a single BGP Prefix according to its identifier + operationId: ip-address-management-prefixes-fetch-bgp-prefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - in: path + name: bgp_prefix_id + schema: + $ref: '#/components/schemas/addressingBgpPrefixIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSingleResponseBgp' + description: Fetch BGP Prefix response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + asn: + $ref: '#/components/schemas/addressingSchemasAsn' + asn_prepend_count: + $ref: '#/components/schemas/addressingAsnPrependCount' + auto_advertise_withdraw: + $ref: '#/components/schemas/addressingAutoAdvertiseWithdraw' + bgp_signal_opts: + $ref: '#/components/schemas/addressingBgpSignalOpts' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/addressingBgpPrefixIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand: + $ref: '#/components/schemas/addressingBgpOnDemand' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Fetch BGP Prefix response failure + security: + - api_email: [] + api_key: [] + summary: Fetch BGP Prefix + tags: + - IP Address Management BGP Prefixes + x-api-token-group: + - Magic Transit Read + - Magic Transit Write + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + - 'IP Prefixes: BGP On Demand Write' + - 'IP Prefixes: BGP On Demand Read' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - bgp_prefixes + method: get + patch: + description: Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn). + operationId: ip-address-management-prefixes-update-bgp-prefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - in: path + name: bgp_prefix_id + schema: + $ref: '#/components/schemas/addressingBgpPrefixIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingBgpPrefixUpdateAdvertisement' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSingleResponseBgp' + description: Update BGP Prefix response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + asn: + $ref: '#/components/schemas/addressingSchemasAsn' + asn_prepend_count: + $ref: '#/components/schemas/addressingAsnPrependCount' + auto_advertise_withdraw: + $ref: '#/components/schemas/addressingAutoAdvertiseWithdraw' + bgp_signal_opts: + $ref: '#/components/schemas/addressingBgpSignalOpts' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/addressingBgpPrefixIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand: + $ref: '#/components/schemas/addressingBgpOnDemand' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update BGP Prefix response failure + security: + - api_email: [] + api_key: [] + summary: Update BGP Prefix + tags: + - IP Address Management BGP Prefixes + x-api-token-group: + - Magic Transit Write + - 'IP Prefixes: Write' + - 'IP Prefixes: BGP On Demand Write' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - bgp_prefixes + method: edit + /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status: + get: + deprecated: true + description: View the current advertisement state for a prefix. **Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix. + operationId: ip-address-management-dynamic-advertisement-get-advertisement-status + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingAdvertisedResponse' + description: Get Advertisement Status response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + advertised: + $ref: '#/components/schemas/addressingComponentsSchemasAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingModifiedAtNullable' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Advertisement Status response failure + security: + - api_email: [] + api_key: [] + summary: Get Advertisement Status + tags: + - IP Address Management Dynamic Advertisement + x-api-token-group: + - Magic Transit Read + - Magic Transit Write + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + - 'IP Prefixes: BGP On Demand Write' + - 'IP Prefixes: BGP On Demand Read' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - advertisement_status + method: get + patch: + deprecated: true + description: Advertise or withdraw the BGP route for a prefix. **Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix. + operationId: ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + advertised: + $ref: '#/components/schemas/addressingComponentsSchemasAdvertised' + required: + - advertised + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingAdvertisedResponse' + description: Update Prefix Dynamic Advertisement Status response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + advertised: + $ref: '#/components/schemas/addressingComponentsSchemasAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingModifiedAtNullable' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Prefix Dynamic Advertisement Status response failure + security: + - api_email: [] + api_key: [] + summary: Update Prefix Dynamic Advertisement Status + tags: + - IP Address Management Dynamic Advertisement + x-api-token-group: + - Magic Transit Write + - 'IP Prefixes: Write' + - 'IP Prefixes: BGP On Demand Write' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - advertisement_status + method: edit + /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings: + get: + description: List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address. **Example:** binding `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit. + operationId: ip-address-management-service-bindings-list-service-bindings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/addressingServiceBinding' + type: array + required: + - success + - errors + - messages + type: object + description: Service Bindings attached to the Prefix + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommonFailure' + description: List Service Bindings response failure + security: + - api_email: [] + api_key: [] + summary: List Service Bindings + tags: + - IP Address Management Service Bindings + x-api-token-group: + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - service_bindings + method: list + post: + description: Creates a new Service Binding, routing traffic to IPs within the given CIDR to a service running on Cloudflare's network. **NOTE:** The first Service Binding created for an IP Prefix must exactly match the IP Prefix's CIDR. Subsequent Service Bindings may be created with a more-specific CIDR. Refer to the [Service Bindings Documentation](https://developers.cloudflare.com/byoip/service-bindings/) for compatibility details. + operationId: ip-address-management-service-bindings-create-service-binding + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingCreateBindingRequest' + responses: + '201': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/addressingServiceBinding' + required: + - success + - errors + - messages + type: object + description: The created Service Binding + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommonFailure' + description: Create Service Binding response failure + security: + - api_email: [] + api_key: [] + summary: Create Service Binding + tags: + - IP Address Management Service Bindings + x-api-token-group: + - 'IP Prefixes: Write' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - service_bindings + method: create + /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}: + delete: + description: Delete a Service Binding + operationId: ip-address-management-service-bindings-delete-service-binding + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - in: path + name: binding_id + schema: + $ref: '#/components/schemas/addressingServiceBindingIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommon' + description: Service Binding deleted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommonFailure' + description: Delete Service Binding response failure + security: + - api_email: [] + api_key: [] + summary: Delete Service Binding + tags: + - IP Address Management Service Bindings + x-api-token-group: + - 'IP Prefixes: Write' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - service_bindings + method: delete + get: + description: Fetch a single Service Binding + operationId: ip-address-management-service-bindings-get-service-binding + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - in: path + name: binding_id + schema: + $ref: '#/components/schemas/addressingServiceBindingIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/addressingServiceBinding' + required: + - success + - errors + - messages + type: object + description: The Service Binding with the requested ID + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommonFailure' + description: Get Service Binding response failure + security: + - api_email: [] + api_key: [] + summary: Get Service Binding + tags: + - IP Address Management Service Bindings + x-api-token-group: + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - service_bindings + method: get + /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations: + get: + description: List all delegations for a given account IP prefix. + operationId: ip-address-management-prefix-delegation-list-prefix-delegations + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSchemasResponseCollection' + description: List Prefix Delegations response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/addressingIpamDelegations' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Prefix Delegations response failure + security: + - api_email: [] + api_key: [] + summary: List Prefix Delegations + tags: + - IP Address Management Prefix Delegation + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - delegations + method: list + post: + description: Create a new account delegation for a given IP prefix. + operationId: ip-address-management-prefix-delegation-create-prefix-delegation + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + cidr: + $ref: '#/components/schemas/addressingCidr' + delegated_account_id: + $ref: '#/components/schemas/addressingDelegatedAccountIdentifier' + required: + - cidr + - delegated_account_id + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSchemasSingleResponse' + description: Create Prefix Delegation response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + delegated_account_id: + $ref: '#/components/schemas/addressingDelegatedAccountIdentifier' + id: + $ref: '#/components/schemas/addressingDelegationIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + parent_prefix_id: + $ref: '#/components/schemas/addressingPrefixIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Prefix Delegation response failure + security: + - api_email: [] + api_key: [] + summary: Create Prefix Delegation + tags: + - IP Address Management Prefix Delegation + x-api-token-group: + - 'IP Prefixes: Write' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - delegations + method: create + /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}: + delete: + description: Delete an account delegation for a given IP prefix. + operationId: ip-address-management-prefix-delegation-delete-prefix-delegation + parameters: + - in: path + name: delegation_id + schema: + $ref: '#/components/schemas/addressingDelegationIdentifier' + required: true + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingIdResponse' + description: Delete Prefix Delegation response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/addressingDelegationIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Prefix Delegation response failure + security: + - api_email: [] + api_key: [] + summary: Delete Prefix Delegation + tags: + - IP Address Management Prefix Delegation + x-api-token-group: + - 'IP Prefixes: Write' + x-stackql-sdk: + service: addressing + resource_chain: + - prefixes + - delegations + method: delete + /accounts/{account_id}/addressing/prefixes/{prefix_id}/validate: + post: + description: Triggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership. + operationId: ip-address-management-prefixes-validate-prefix + parameters: + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/addressingSingleResponse' + description: Validate Prefix response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + account_id: + $ref: '#/components/schemas/addressingAccountIdentifier' + advertised: + $ref: '#/components/schemas/addressingAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingAdvertisedModifiedAtNullable' + readOnly: true + approved: + $ref: '#/components/schemas/addressingApproved' + asn: + $ref: '#/components/schemas/addressingAsn' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + delegate_loa_creation: + $ref: '#/components/schemas/addressingDelegateLoaCreation' + description: + $ref: '#/components/schemas/addressingDescription' + id: + $ref: '#/components/schemas/addressingPrefixIdentifier' + irr_validation_state: + $ref: '#/components/schemas/addressingValidationState' + loa_document_id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand_enabled: + $ref: '#/components/schemas/addressingOnDemandEnabled' + on_demand_locked: + $ref: '#/components/schemas/addressingOnDemandLocked' + ownership_validation_state: + $ref: '#/components/schemas/addressingValidationState' + ownership_validation_token: + $ref: '#/components/schemas/addressingOwnershipValidationToken' + rpki_validation_state: + $ref: '#/components/schemas/addressingValidationState' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Validate Prefix response failure + security: + - api_email: [] + api_key: [] + summary: Validate Prefix + tags: + - IP Address Management Prefixes + x-api-token-group: + - Magic Transit Write + - 'IP Prefixes: Write' + /accounts/{account_id}/addressing/regional_hostnames/regions: + get: + description: List all Regional Services regions available for use by this account. + operationId: dls-account-regional-hostnames-account-list-regions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlsMessages' + messages: + $ref: '#/components/schemas/dlsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + properties: + key: + $ref: '#/components/schemas/dlsRegionKey' + label: + description: Human-readable text label for the region + type: string + type: object + type: array + required: + - success + - errors + - messages + description: List regions response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlsApiResponseCommonFailure' + description: Failure to list regions + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Regions + tags: + - DLS Regional Services + x-api-token-group: + - DNS Read + - DNS Write + x-stackql-sdk: + service: addressing + resource_chain: + - regional_hostnames + - regions + method: list + /accounts/{account_id}/addressing/services: + get: + description: Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs. + operationId: ip-address-management-service-bindings-list-services + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + properties: + id: + $ref: '#/components/schemas/addressingServiceIdentifier' + name: + $ref: '#/components/schemas/addressingServiceName' + type: object + type: array + required: + - success + - errors + - messages + type: object + description: Service names and IDs + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/addressingApiResponseCommonFailure' + description: List Services response failure + security: + - api_email: [] + api_key: [] + summary: List Services + tags: + - IP Address Management Service Bindings + x-api-token-group: + - 'IP Prefixes: Write' + - 'IP Prefixes: Read' + x-stackql-sdk: + service: addressing + resource_chain: + - services + method: list + /zones/{zone_id}/addressing/regional_hostnames: + get: + description: List all Regional Hostnames within a zone. + operationId: dls-account-regional-hostnames-account-list-hostnames + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlsMessages' + messages: + $ref: '#/components/schemas/dlsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/dlsRegionalHostnameResponse' + type: array + required: + - success + - errors + - messages + description: List hostnames response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlsApiResponseCommonFailure' + description: Failure to list hostnames + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Regional Hostnames + tags: + - DLS Regional Services + x-api-token-group: + - DNS Read + - DNS Write + x-stackql-sdk: + service: addressing + resource_chain: + - regional_hostnames + method: list + post: + description: Create a new Regional Hostname entry. Cloudflare will only use data centers that are physically located within the chosen region to decrypt and service HTTPS traffic. Learn more about [Regional Services](https://developers.cloudflare.com/data-localization/regional-services/get-started/). + operationId: dls-account-regional-hostnames-account-create-hostname + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + hostname: + $ref: '#/components/schemas/dlsHostname' + region_key: + $ref: '#/components/schemas/dlsRegionKey' + routing: + $ref: '#/components/schemas/dlsRouting' + required: + - hostname + - region_key + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/dlsMessages' + messages: + $ref: '#/components/schemas/dlsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlsRegionalHostnameResponse' + required: + - success + - errors + - messages + type: object + description: Create hostname response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlsApiResponseCommonFailure' + description: Failure to create hostname + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Regional Hostname + tags: + - DLS Regional Services + x-api-token-group: + - DNS Write + x-stackql-sdk: + service: addressing + resource_chain: + - regional_hostnames + method: create + /zones/{zone_id}/addressing/regional_hostnames/{hostname}: + delete: + description: Delete the region configuration for a specific Regional Hostname. + operationId: dls-account-regional-hostnames-account-delete-hostname + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: hostname + schema: + $ref: '#/components/schemas/dlsHostname' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dlsApiResponseCommon' + description: Delete hostname response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlsApiResponseCommonFailure' + description: Failure to delete hostname + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Regional Hostname + tags: + - DLS Regional Services + x-api-token-group: + - DNS Write + x-stackql-sdk: + service: addressing + resource_chain: + - regional_hostnames + method: delete + get: + description: Fetch the configuration for a specific Regional Hostname, within a zone. + operationId: dls-account-regional-hostnames-account-fetch-hostname + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: hostname + schema: + $ref: '#/components/schemas/dlsHostname' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlsMessages' + messages: + $ref: '#/components/schemas/dlsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlsRegionalHostnameResponse' + required: + - success + - errors + - messages + description: Fetch hostname response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlsApiResponseCommonFailure' + description: Failure to fetch hostname + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch Regional Hostname + tags: + - DLS Regional Services + x-api-token-group: + - DNS Read + - DNS Write + x-stackql-sdk: + service: addressing + resource_chain: + - regional_hostnames + method: get + patch: + description: Update the configuration for a specific Regional Hostname. Only the region_key of a hostname is mutable. + operationId: dls-account-regional-hostnames-account-patch-hostname + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: hostname + schema: + $ref: '#/components/schemas/dlsHostname' + required: true + requestBody: + content: + application/json: + schema: + properties: + region_key: + $ref: '#/components/schemas/dlsRegionKey' + required: + - region_key + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/dlsMessages' + messages: + $ref: '#/components/schemas/dlsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlsRegionalHostnameResponse' + required: + - success + - errors + - messages + type: object + description: Update hostname response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlsApiResponseCommonFailure' + description: Failure to update hostname + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Regional Hostname + tags: + - DLS Regional Services + x-api-token-group: + - DNS Write + x-stackql-sdk: + service: addressing + resource_chain: + - regional_hostnames + method: edit +components: + schemas: + addressingAccountIdentifier: + description: Identifier of a Cloudflare account. + example: 258def64c72dae45f3e4c8516e2111f2 + maxLength: 32 + type: string + x-auditable: true + addressingAddressMapIdentifier: + description: Identifier of an Address Map. + example: 055817b111884e0227e1be16a0be6ee0 + maxLength: 32 + type: string + x-auditable: true + addressingAddressMaps: + properties: + can_delete: + $ref: '#/components/schemas/addressingCanDelete' + can_modify_ips: + $ref: '#/components/schemas/addressingCanModifyIps' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + default_sni: + $ref: '#/components/schemas/addressingDefaultSni' + description: + $ref: '#/components/schemas/addressingSchemasDescription' + enabled: + $ref: '#/components/schemas/addressingEnabled' + id: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + type: object + addressingAddressMapsIp: + properties: + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + ip: + $ref: '#/components/schemas/addressingIp' + type: object + addressingAddressMapsMembership: + properties: + can_delete: + $ref: '#/components/schemas/addressingSchemasCanDelete' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + identifier: + $ref: '#/components/schemas/addressingIdentifier' + kind: + $ref: '#/components/schemas/addressingKind' + type: object + addressingAddressMapsMembershipRequest: + properties: + identifier: + $ref: '#/components/schemas/addressingIdentifier' + kind: + $ref: '#/components/schemas/addressingKind' + type: object + addressingAdvertised: + deprecated: true + description: Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled. + example: true + nullable: true + type: boolean + x-auditable: true + x-stainless-deprecation-message: Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix. + addressingAdvertisedModifiedAtNullable: + deprecated: true + description: Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + type: string + x-auditable: true + x-stainless-deprecation-message: Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix. + addressingAdvertisedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + advertised: + $ref: '#/components/schemas/addressingComponentsSchemasAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingModifiedAtNullable' + readOnly: true + type: object + required: + - success + - errors + - messages + addressingApiResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + required: + - success + - errors + - messages + addressingApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + addressingApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/addressingMessages' + messages: + example: [] + $ref: '#/components/schemas/addressingMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + addressingApiResponseSingle: + type: object + $ref: '#/components/schemas/addressingApiResponseCommon' + addressingApproved: + description: Approval state of the prefix (P = pending, V = active). + example: P + type: string + x-auditable: true + addressingAsn: + description: Autonomous System Number (ASN) the prefix will be advertised under. + example: 13335 + type: integer + x-auditable: true + addressingAsnPrependCount: + default: 0 + description: Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute + example: 2 + maximum: 3 + minimum: 0 + type: integer + x-auditable: true + addressingAutoAdvertiseWithdraw: + default: false + description: Determines if Cloudflare advertises a BYOIP BGP prefix even when there is no matching BGP prefix in the Magic routing table. When true, Cloudflare will automatically withdraw the BGP prefix when there are no matching BGP routes, and will resume advertising when there is at least one matching BGP route. + example: true + type: boolean + x-auditable: true + addressingAutoGenerated: + description: Whether the LOA has been auto-generated for the prefix owner by Cloudflare. + example: true + type: boolean + x-auditable: true + addressingBgpOnDemand: + properties: + advertised: + $ref: '#/components/schemas/addressingSchemasAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingModifiedAtNullable' + readOnly: true + on_demand_enabled: + $ref: '#/components/schemas/addressingSchemasOnDemandEnabled' + on_demand_locked: + $ref: '#/components/schemas/addressingSchemasOnDemandLocked' + type: object + addressingBgpPrefixCreate: + properties: + cidr: + $ref: '#/components/schemas/addressingCidr' + required: + - cidr + type: object + addressingBgpPrefixIdentifier: + description: Identifier of BGP Prefix. + example: 7009ba364c7a5760798ceb430e603b74 + maxLength: 32 + type: string + x-auditable: true + addressingBgpPrefixUpdateAdvertisement: + properties: + asn_prepend_count: + $ref: '#/components/schemas/addressingAsnPrependCount' + auto_advertise_withdraw: + $ref: '#/components/schemas/addressingAutoAdvertiseWithdraw' + on_demand: + properties: + advertised: + type: boolean + type: object + type: object + addressingBgpSignalOpts: + properties: + enabled: + $ref: '#/components/schemas/addressingBgpSignalingEnabled' + modified_at: + $ref: '#/components/schemas/addressingBgpSignalingModifiedAt' + readOnly: true + type: object + addressingBgpSignalingEnabled: + description: Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal + example: false + type: boolean + x-auditable: true + addressingBgpSignalingModifiedAt: + description: Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + type: string + x-auditable: true + addressingCanDelete: + description: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps. + example: true + readOnly: true + type: boolean + x-auditable: true + addressingCanModifyIps: + description: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps. + example: true + readOnly: true + type: boolean + x-auditable: true + addressingCidr: + description: IP Prefix in Classless Inter-Domain Routing format. + example: 192.0.2.0/24 + type: string + x-auditable: true + addressingComponentsSchemasAdvertised: + description: Advertisement status of the prefix. If `true`, the BGP route for the prefix is advertised to the Internet. If `false`, the BGP route is withdrawn. + example: true + type: boolean + x-auditable: true + addressingComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/addressingAddressMaps' + type: array + required: + - success + - errors + - messages + addressingComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/addressingAddressMaps' + required: + - success + - errors + - messages + addressingCreateBindingRequest: + properties: + cidr: + $ref: '#/components/schemas/addressingCidr' + service_id: + $ref: '#/components/schemas/addressingServiceIdentifier' + required: + - cidr + - service_id + type: object + addressingCreatedAt: + description: Timestamp of the moment the object was created. + format: date-time + type: string + addressingDefaultSni: + description: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account. + example: '*.example.com' + nullable: true + type: string + x-auditable: true + addressingDelegateLoaCreation: + default: false + description: Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner. + example: true + type: boolean + x-auditable: true + addressingDelegatedAccountIdentifier: + description: Account identifier for the account to which prefix is being delegated. + example: b1946ac92492d2347c6235b4d2611184 + maxLength: 32 + type: string + x-auditable: true + addressingDelegationIdentifier: + description: Identifier of a Delegation. + example: d933b1530bc56c9953cf8ce166da8004 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + addressingDescription: + description: Description of the prefix. + example: Internal test prefix + maxLength: 1000 + type: string + x-auditable: true + addressingEnabled: + default: false + description: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled. + example: true + nullable: true + type: boolean + x-auditable: true + addressingFilename: + description: Name of LOA document. Max file size 10MB, and supported filetype is pdf. + example: site_loa_doc.pdf + type: string + x-auditable: true + addressingFullResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + can_delete: + $ref: '#/components/schemas/addressingCanDelete' + can_modify_ips: + $ref: '#/components/schemas/addressingCanModifyIps' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + default_sni: + $ref: '#/components/schemas/addressingDefaultSni' + description: + $ref: '#/components/schemas/addressingSchemasDescription' + enabled: + $ref: '#/components/schemas/addressingEnabled' + id: + $ref: '#/components/schemas/addressingAddressMapIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + ips: + $ref: '#/components/schemas/addressingIps' + memberships: + $ref: '#/components/schemas/addressingMemberships' + type: object + required: + - success + - errors + - messages + addressingIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/addressingDelegationIdentifier' + type: object + required: + - success + - errors + - messages + addressingIdentifier: + description: The identifier for the membership (eg. a zone or account tag). + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + addressingIp: + description: An IPv4 or IPv6 address. + example: 192.0.2.1 + type: string + x-auditable: true + addressingIpAddress: + description: An IPv4 or IPv6 address. + example: 192.0.2.1 + type: string + x-auditable: true + addressingIpamBgpPrefixes: + properties: + asn: + $ref: '#/components/schemas/addressingSchemasAsn' + asn_prepend_count: + $ref: '#/components/schemas/addressingAsnPrependCount' + auto_advertise_withdraw: + $ref: '#/components/schemas/addressingAutoAdvertiseWithdraw' + bgp_signal_opts: + $ref: '#/components/schemas/addressingBgpSignalOpts' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/addressingBgpPrefixIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand: + $ref: '#/components/schemas/addressingBgpOnDemand' + type: object + addressingIpamDelegations: + properties: + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + delegated_account_id: + $ref: '#/components/schemas/addressingDelegatedAccountIdentifier' + id: + $ref: '#/components/schemas/addressingDelegationIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + parent_prefix_id: + $ref: '#/components/schemas/addressingPrefixIdentifier' + type: object + addressingIpamPrefixes: + properties: + account_id: + $ref: '#/components/schemas/addressingAccountIdentifier' + advertised: + $ref: '#/components/schemas/addressingAdvertised' + advertised_modified_at: + $ref: '#/components/schemas/addressingAdvertisedModifiedAtNullable' + readOnly: true + approved: + $ref: '#/components/schemas/addressingApproved' + asn: + $ref: '#/components/schemas/addressingAsn' + cidr: + $ref: '#/components/schemas/addressingCidr' + created_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + delegate_loa_creation: + $ref: '#/components/schemas/addressingDelegateLoaCreation' + description: + $ref: '#/components/schemas/addressingDescription' + id: + $ref: '#/components/schemas/addressingPrefixIdentifier' + irr_validation_state: + $ref: '#/components/schemas/addressingValidationState' + loa_document_id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + modified_at: + $ref: '#/components/schemas/addressingTimestamp' + readOnly: true + on_demand_enabled: + $ref: '#/components/schemas/addressingOnDemandEnabled' + on_demand_locked: + $ref: '#/components/schemas/addressingOnDemandLocked' + ownership_validation_state: + $ref: '#/components/schemas/addressingValidationState' + ownership_validation_token: + $ref: '#/components/schemas/addressingOwnershipValidationToken' + rpki_validation_state: + $ref: '#/components/schemas/addressingValidationState' + type: object + addressingIps: + description: The set of IPs on the Address Map. + items: + $ref: '#/components/schemas/addressingAddressMapsIp' + type: array + x-stainless-naming: + node: + model_name: ips_array + addressingKind: + description: The type of the membership. + enum: + - zone + - account + example: zone + type: string + x-auditable: true + addressingLease: + properties: + active_from: + description: Timestamp of the moment the lease was created. + example: '2020-01-01T00:00:00Z' + format: date-time + type: string + cidrs: + description: CIDRs attached to the lease + example: + - 192.0.2.100/32 + - 192.0.2.101/32 + items: + $ref: '#/components/schemas/addressingSchemasCidr' + type: array + created_at: + $ref: '#/components/schemas/addressingCreatedAt' + readOnly: true + id: + $ref: '#/components/schemas/addressingLeaseId' + modified_at: + $ref: '#/components/schemas/addressingModifiedAt' + readOnly: true + owner_id: + $ref: '#/components/schemas/addressingLeaseOwnerId' + purpose: + description: Describes the purpose of the addresses. + example: Spectrum Static IPs + type: string + type: object + addressingLeaseId: + description: Identifier for the lease + example: 8fee4b6fd361283a72381ccfda355471 + type: string + addressingLeaseOwnerId: + description: Cloudflare account ID of the account owning the lease. + example: 3a7d3de1d0682240cf046c7f50866cc5 + type: string + addressingLeasesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/addressingLease' + type: array + required: + - success + - errors + - messages + addressingLoaDocumentIdentifier: + description: Identifier for the uploaded LOA document. + example: d933b1530bc56c9953cf8ce166da8004 + maxLength: 32 + nullable: true + type: string + x-auditable: true + addressingLoaUploadResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + account_id: + $ref: '#/components/schemas/addressingAccountIdentifier' + auto_generated: + $ref: '#/components/schemas/addressingAutoGenerated' + created: + $ref: '#/components/schemas/addressingTimestamp' + filename: + $ref: '#/components/schemas/addressingFilename' + id: + $ref: '#/components/schemas/addressingLoaDocumentIdentifier' + size_bytes: + $ref: '#/components/schemas/addressingSizeBytes' + verified: + $ref: '#/components/schemas/addressingVerified' + verified_at: + $ref: '#/components/schemas/addressingVerifiedAt' + type: object + required: + - success + - errors + - messages + addressingMembershipRequests: + description: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership. + example: + - identifier: 023e105f4ecef8ad9ca31a8372d0c353 + kind: zone + items: + $ref: '#/components/schemas/addressingAddressMapsMembershipRequest' + type: array + addressingMemberships: + description: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership. + items: + $ref: '#/components/schemas/addressingAddressMapsMembership' + type: array + addressingMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + addressingModifiedAt: + description: Timestamp of the moment the object was modified. + format: date-time + type: string + addressingModifiedAtNullable: + description: Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + type: string + x-auditable: true + addressingOnDemandEnabled: + deprecated: true + description: Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. + example: true + type: boolean + x-auditable: true + x-stainless-deprecation-message: Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix. + addressingOnDemandLocked: + deprecated: true + description: Whether advertisement status of the prefix is locked, meaning it cannot be changed. + example: false + type: boolean + x-auditable: true + x-stainless-deprecation-message: Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix. + addressingOwnershipValidationToken: + description: Token provided to demonstrate ownership of the prefix. + example: 1234a5b6-1234-1abc-12a3-1234a5b6789c + type: string + x-auditable: true + addressingPrefixIdentifier: + description: Identifier of an IP Prefix. + example: 2af39739cc4e3b5910c918468bb89828 + maxLength: 32 + type: string + x-auditable: true + addressingProvisioning: + description: Status of a Service Binding's deployment to the Cloudflare network + properties: + state: + description: When a binding has been deployed to a majority of Cloudflare datacenters, the binding will become active and can be used with its associated service. + enum: + - provisioning + - active + example: provisioning + type: string + x-auditable: true + type: object + addressingResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/addressingIpamPrefixes' + type: array + required: + - success + - errors + - messages + addressingResponseCollectionBgp: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/addressingIpamBgpPrefixes' + type: array + required: + - success + - errors + - messages + addressingSchemasAdvertised: + description: Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled. + example: true + nullable: true + type: boolean + x-auditable: true + addressingSchemasAsn: + description: Autonomous System Number (ASN) the prefix will be advertised under. + example: 13335 + nullable: true + type: integer + x-auditable: true + addressingSchemasCanDelete: + description: Controls whether the membership can be deleted via the API or not. + example: true + readOnly: true + type: boolean + x-auditable: true + addressingSchemasCidr: + description: IP Prefix in Classless Inter-Domain Routing format. + example: 192.0.2.0/24 + type: string + addressingSchemasDescription: + description: An optional description field which may be used to describe the types of IPs or zones on the map. + example: My Ecommerce zones + nullable: true + type: string + x-auditable: true + addressingSchemasOnDemandEnabled: + description: Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. + example: true + type: boolean + x-auditable: true + addressingSchemasOnDemandLocked: + description: Whether the advertisement status of the prefix is locked, meaning it cannot be changed. + example: false + type: boolean + x-auditable: true + addressingSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/addressingIpamDelegations' + type: array + required: + - success + - errors + - messages + addressingSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/addressingIpamDelegations' + required: + - success + - errors + - messages + addressingServiceBinding: + properties: + cidr: + $ref: '#/components/schemas/addressingCidr' + id: + $ref: '#/components/schemas/addressingServiceBindingIdentifier' + provisioning: + $ref: '#/components/schemas/addressingProvisioning' + service_id: + $ref: '#/components/schemas/addressingServiceIdentifier' + service_name: + $ref: '#/components/schemas/addressingServiceName' + type: object + addressingServiceBindingIdentifier: + description: Identifier of a Service Binding. + example: 0429b49b6a5155297b78e75a44b09e14 + maxLength: 32 + type: string + x-auditable: true + addressingServiceIdentifier: + description: Identifier of a Service on the Cloudflare network. Available services and their IDs may be found in the **List Services** endpoint. + example: 2db684ee7ca04e159946fd05b99e1bcd + maxLength: 32 + type: string + x-auditable: true + addressingServiceName: + description: Name of a service running on the Cloudflare network + example: Magic Transit + type: string + x-auditable: true + addressingSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/addressingIpamPrefixes' + required: + - success + - errors + - messages + addressingSingleResponseBgp: + type: object + properties: + errors: + $ref: '#/components/schemas/addressingMessages' + messages: + $ref: '#/components/schemas/addressingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/addressingIpamBgpPrefixes' + required: + - success + - errors + - messages + addressingSizeBytes: + description: File size of the uploaded LOA document. + example: 444 + type: integer + x-auditable: true + addressingTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + addressingValidationState: + description: State of one kind of validation for an IP prefix. + example: pending + type: string + x-auditable: true + addressingVerified: + description: Whether the LOA has been verified by Cloudflare staff. + example: true + type: boolean + x-auditable: true + addressingVerifiedAt: + description: Timestamp of the moment the LOA was marked as validated. + format: date-time + nullable: true + type: string + x-auditable: true + dlsApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/dlsMessages' + messages: + $ref: '#/components/schemas/dlsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + dlsApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/dlsMessages' + messages: + example: [] + $ref: '#/components/schemas/dlsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + dlsHostname: + description: DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g `*.example.com` + example: foo.example.com + type: string + x-auditable: true + dlsMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dlsRegionKey: + description: Identifying key for the region + example: ca + type: string + x-auditable: true + dlsRegionalHostnameResponse: + properties: + created_on: + $ref: '#/components/schemas/dlsTimestamp' + description: When the regional hostname was created + example: '2014-01-01T05:20:00.12345Z' + readOnly: true + hostname: + $ref: '#/components/schemas/dlsHostname' + region_key: + $ref: '#/components/schemas/dlsRegionKey' + routing: + $ref: '#/components/schemas/dlsRouting' + required: + - hostname + - region_key + - created_on + type: object + dlsRouting: + default: dns + description: Configure which routing method to use for the regional hostname + example: dns + type: string + x-auditable: true + dlsTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + address_maps: + id: cloudflare.addressing.address_maps + name: address_maps + title: Address Maps + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/address_maps/methods/get' + - $ref: '#/components/x-stackQL-resources/address_maps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/address_maps/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/address_maps/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/address_maps/methods/delete' + replace: [] + accounts: + id: cloudflare.addressing.accounts + name: accounts + title: Accounts + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1accounts~1{account_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1accounts~1{account_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/accounts/methods/update' + ips: + id: cloudflare.addressing.ips + name: ips + title: Ips + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1ips~1{ip_address}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1ips~1{ip_address}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/ips/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/ips/methods/update' + zones: + id: cloudflare.addressing.zones + name: zones + title: Zones + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1zones~1{zone_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1address_maps~1{address_map_id}~1zones~1{zone_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/zones/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/zones/methods/update' + leases: + id: cloudflare.addressing.leases + name: leases + title: Leases + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1leases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + loa_documents: + id: cloudflare.addressing.loa_documents + name: loa_documents + title: Loa Documents + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1loa_documents/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1loa_documents~1{loa_document_id}~1download/get' + response: + mediaType: application/pdf + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/loa_documents/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/loa_documents/methods/create' + update: [] + delete: [] + replace: [] + prefixes: + id: cloudflare.addressing.prefixes + name: prefixes + title: Prefixes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + ip_address_management_prefixes_delete_bgp_prefix: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bgp~1prefixes~1{bgp_prefix_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/prefixes/methods/get' + - $ref: '#/components/x-stackQL-resources/prefixes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/prefixes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/prefixes/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/prefixes/methods/ip_address_management_prefixes_delete_bgp_prefix' + - $ref: '#/components/x-stackQL-resources/prefixes/methods/delete' + replace: [] + bgp_prefixes: + id: cloudflare.addressing.bgp_prefixes + name: bgp_prefixes + title: Bgp Prefixes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bgp~1prefixes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bgp~1prefixes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bgp~1prefixes~1{bgp_prefix_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bgp~1prefixes~1{bgp_prefix_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bgp_prefixes/methods/get' + - $ref: '#/components/x-stackQL-resources/bgp_prefixes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/bgp_prefixes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/bgp_prefixes/methods/edit' + delete: [] + replace: [] + advertisement_status: + id: cloudflare.addressing.advertisement_status + name: advertisement_status + title: Advertisement Status + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bgp~1status/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bgp~1status/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/advertisement_status/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/advertisement_status/methods/edit' + delete: [] + replace: [] + service_bindings: + id: cloudflare.addressing.service_bindings + name: service_bindings + title: Service Bindings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bindings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bindings/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bindings~1{binding_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1bindings~1{binding_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_bindings/methods/get' + - $ref: '#/components/x-stackQL-resources/service_bindings/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_bindings/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/service_bindings/methods/delete' + replace: [] + delegations: + id: cloudflare.addressing.delegations + name: delegations + title: Delegations + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1delegations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1delegations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1delegations~1{delegation_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/delegations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/delegations/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/delegations/methods/delete' + replace: [] + validate: + id: cloudflare.addressing.validate + name: validate + title: Validate + methods: + ip_address_management_prefixes_validate_prefix: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1prefixes~1{prefix_id}~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/validate/methods/ip_address_management_prefixes_validate_prefix' + update: [] + delete: [] + replace: [] + regions: + id: cloudflare.addressing.regions + name: regions + title: Regions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1regional_hostnames~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/regions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + services: + id: cloudflare.addressing.services + name: services + title: Services + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1addressing~1services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + regional_hostnames: + id: cloudflare.addressing.regional_hostnames + name: regional_hostnames + title: Regional Hostnames + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1addressing~1regional_hostnames/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1addressing~1regional_hostnames/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1addressing~1regional_hostnames~1{hostname}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1addressing~1regional_hostnames~1{hostname}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1addressing~1regional_hostnames~1{hostname}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/regional_hostnames/methods/get' + - $ref: '#/components/x-stackQL-resources/regional_hostnames/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/regional_hostnames/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/regional_hostnames/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/regional_hostnames/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/ai.yaml b/providers/src/cloudflare/v00.00.00000/services/ai.yaml new file mode 100644 index 00000000..ebfbc3ef --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/ai.yaml @@ -0,0 +1,27892 @@ +openapi: 3.0.3 +info: + title: ai API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/ai/authors/search: + get: + description: Searches Workers AI models by author or organization name. + operationId: workers-ai-search-author + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + type: array + messages: + items: + type: string + type: array + result: + items: + type: object + type: array + success: + type: boolean + required: + - success + - result + - errors + - messages + type: object + description: Returns a list of authors + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Author Search + tags: + - Workers AI + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - authors + method: list + /accounts/{account_id}/ai/finetunes: + get: + description: >- + Lists all fine-tuning jobs created by the account, including status and + metrics. + operationId: workers-ai-list-finetunes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + type: string + id: + format: uuid + type: string + x-auditable: true + model: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - id + - model + - name + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns all finetunes + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Finetunes + tags: + - Workers AI Finetune + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - finetunes + method: list + post: + description: >- + Creates a new fine-tuning job for a Workers AI model using custom + training data. + operationId: workers-ai-create-finetune + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + type: string + model: + type: string + x-auditable: true + name: + type: string + x-auditable: true + public: + default: false + type: boolean + x-auditable: true + required: + - model + - name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + type: string + id: + format: uuid + type: string + x-auditable: true + model: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + public: + type: boolean + x-auditable: true + required: + - id + - created_at + - modified_at + - public + - name + - model + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the created finetune + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: object + type: array + success: + type: boolean + required: + - errors + - success + type: object + description: Finetune creation failed + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Finetune + tags: + - Workers AI Finetune + x-api-token-group: + - Workers AI Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - finetunes + method: create + /accounts/{account_id}/ai/finetunes/public: + get: + description: >- + Lists publicly available fine-tuned models that can be used with Workers + AI. + operationId: workers-ai-list-public-finetunes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Pagination Limit + in: query + name: limit + schema: + default: 20 + description: Pagination Limit + type: number + - description: Pagination Offset + in: query + name: offset + schema: + default: 0 + description: Pagination Offset + type: number + - description: Order By Column Name + in: query + name: orderBy + schema: + description: Order By Column Name + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + type: string + id: + format: uuid + type: string + x-auditable: true + model: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + public: + type: boolean + x-auditable: true + required: + - id + - model + - name + - public + - created_at + - modified_at + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: Returns all public finetunes + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Public Finetunes + tags: + - Workers AI Finetune + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - finetunes + - public + method: list + /accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets: + post: + description: Uploads training data assets for a Workers AI fine-tuning job. + operationId: workers-ai-upload-finetune-asset + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: finetune_id + schema: + type: string + required: true + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + description: File to upload + format: binary + type: string + file_name: + description: >- + Name of the file (adapter_config.json or + adapter_model.safetensors) + type: string + required: + - file_name + - file + type: object + description: Finetune asset file upload + responses: + '200': + content: + application/json: + schema: + properties: + success: + type: boolean + required: + - success + type: object + description: Returns successfully if finetunes were uploaded + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Finetune creation failed + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload a Finetune Asset + tags: + - Workers AI Finetune + x-api-token-group: + - Workers AI Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - finetunes + - assets + method: create + /accounts/{account_id}/ai/models/schema: + get: + description: >- + Retrieves the input and output JSON schema definition for a Workers AI + model. + operationId: workers-ai-get-model-schema + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Model Name + in: query + name: model + schema: + description: Model Name + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + input: + properties: + additionalProperties: + type: boolean + description: + type: string + type: + type: string + required: + - type + - description + - additionalProperties + type: object + output: + properties: + additionalProperties: + type: boolean + description: + type: string + type: + type: string + required: + - type + - description + - additionalProperties + type: object + required: + - input + - output + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Model Schema + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Model Schema + tags: + - Workers AI + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - models + - schema + method: get + /accounts/{account_id}/ai/models/search: + get: + description: Searches Workers AI models by name or description. + operationId: workers-ai-search-model + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: per_page + schema: + default: 100 + type: integer + - in: query + name: page + schema: + default: 1 + type: integer + - description: Filter by Task Name + in: query + name: task + schema: + default: '' + description: Filter by Task Name + type: string + - description: Filter by Author + in: query + name: author + schema: + default: '' + description: Filter by Author + type: string + - description: Filter by Source Id + in: query + name: source + schema: + description: Filter by Source Id + type: number + - description: Filter to hide experimental models + in: query + name: hide_experimental + schema: + default: false + description: Filter to hide experimental models + type: boolean + - description: Search + in: query + name: search + schema: + default: '' + description: Search + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + type: array + messages: + items: + type: string + type: array + result: + items: + type: object + type: array + success: + type: boolean + required: + - success + - result + - errors + - messages + type: object + description: Returns a list of models + '404': + content: + application/json: + schema: + properties: + errors: + items: + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Object not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Model Search + tags: + - Workers AI + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - models + method: list + /accounts/{account_id}/ai/run/@cf/ai4bharat/indictrans2-en-indic-1B: + post: + description: Runs inference on the @cf/ai4bharat/indictrans2-en-indic-1B model. + operationId: workers-ai-post-run-cf-ai4bharat-indictrans2-en-indic-1B + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + target_language: + default: hin_Deva + description: Target langauge to translate to + enum: + - asm_Beng + - awa_Deva + - ben_Beng + - bho_Deva + - brx_Deva + - doi_Deva + - eng_Latn + - gom_Deva + - gon_Deva + - guj_Gujr + - hin_Deva + - hne_Deva + - kan_Knda + - kas_Arab + - kas_Deva + - kha_Latn + - lus_Latn + - mag_Deva + - mai_Deva + - mal_Mlym + - mar_Deva + - mni_Beng + - mni_Mtei + - npi_Deva + - ory_Orya + - pan_Guru + - san_Deva + - sat_Olck + - snd_Arab + - snd_Deva + - tam_Taml + - tel_Telu + - urd_Arab + - unr_Deva + type: string + text: + description: >- + Input text to translate. Can be a single string or a list of + strings. + type: string + items: + type: string + required: + - text + - target_language + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/ai4bharat/indictrans2-en-indic-1B model. + tags: + - Workers AI Translation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/ai4bharat/nonomni-indictrans2-en-indic-1b: + post: + description: >- + Runs inference on the @cf/ai4bharat/nonomni-indictrans2-en-indic-1b + model. + operationId: workers-ai-post-run-cf-ai4bharat-nonomni-indictrans2-en-indic-1b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + target_language: + default: hin_Deva + description: Target langauge to translate to + enum: + - asm_Beng + - awa_Deva + - ben_Beng + - bho_Deva + - brx_Deva + - doi_Deva + - eng_Latn + - gom_Deva + - gon_Deva + - guj_Gujr + - hin_Deva + - hne_Deva + - kan_Knda + - kas_Arab + - kas_Deva + - kha_Latn + - lus_Latn + - mag_Deva + - mai_Deva + - mal_Mlym + - mar_Deva + - mni_Beng + - mni_Mtei + - npi_Deva + - ory_Orya + - pan_Guru + - san_Deva + - sat_Olck + - snd_Arab + - snd_Deva + - tam_Taml + - tel_Telu + - urd_Arab + - unr_Deva + type: string + text: + description: >- + Input text to translate. Can be a single string or a list of + strings. + type: string + items: + type: string + required: + - text + - target_language + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/ai4bharat/nonomni-indictrans2-en-indic-1b model. + tags: + - Workers AI Translation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/aisingapore/gemma-sea-lion-v4-27b-it: + post: + description: Runs inference on the @cf/aisingapore/gemma-sea-lion-v4-27b-it model. + operationId: workers-ai-post-run-cf-aisingapore-gemma-sea-lion-v4-27b-it + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 2000 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + requests: + items: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the + same lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to + fine-tune the base model. + type: string + max_tokens: + default: 256 + description: >- + The maximum number of tokens to generate in the + response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: >- + The input text prompt for the model to generate a + response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must + adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back + incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values + produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; + higher values introduce more variety and potential + surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by + controlling how many possible words it considers. + Lower values make outputs more predictable; higher + values allow for more varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the + conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: >- + The name of the tool. More descriptive the + better. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: >- + A brief description of what the function + does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by + the function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object + (usually 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/aisingapore/gemma-sea-lion-v4-27b-it model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/bge-base-en-v1.5: + post: + description: Runs inference on the @cf/baai/bge-base-en-v1.5 model. + operationId: workers-ai-post-run-cf-baai-bge-base-en-v1-5 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. `cls` + pooling will generate more accurate embeddings on larger + inputs - however, embeddings created with cls pooling are + not compatible with embeddings generated with mean pooling. + The default pooling method is `mean` in order for this to + not be a breaking change, but we highly suggest using the + new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. + `cls` pooling will generate more accurate embeddings + on larger inputs - however, embeddings created with + cls pooling are not compatible with embeddings + generated with mean pooling. The default pooling + method is `mean` in order for this to not be a + breaking change, but we highly suggest using the new + `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: + - text + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/bge-base-en-v1.5 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/bge-large-en-v1.5: + post: + description: Runs inference on the @cf/baai/bge-large-en-v1.5 model. + operationId: workers-ai-post-run-cf-baai-bge-large-en-v1-5 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. `cls` + pooling will generate more accurate embeddings on larger + inputs - however, embeddings created with cls pooling are + not compatible with embeddings generated with mean pooling. + The default pooling method is `mean` in order for this to + not be a breaking change, but we highly suggest using the + new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. + `cls` pooling will generate more accurate embeddings + on larger inputs - however, embeddings created with + cls pooling are not compatible with embeddings + generated with mean pooling. The default pooling + method is `mean` in order for this to not be a + breaking change, but we highly suggest using the new + `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: + - text + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/bge-large-en-v1.5 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/bge-m3: + post: + description: Runs inference on the @cf/baai/bge-m3 model. + operationId: workers-ai-post-run-cf-baai-bge-m3 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Input Query and Contexts + properties: + contexts: + description: >- + List of provided contexts. Note that the index in this array + is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: >- + A query you wish to perform against the provided contexts. + If no query is provided the model with respond with + embeddings for contexts + minLength: 1 + type: string + truncate_inputs: + default: false + description: >- + When provided with too long context should the model error + out or truncate the context to fit? + type: boolean + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + type: object + title: Input Query and Contexts + properties: + contexts: + description: >- + List of provided contexts. Note that the index in this + array is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: >- + A query you wish to perform against the provided + contexts. If no query is provided the model with + respond with embeddings for contexts + minLength: 1 + type: string + truncate_inputs: + default: false + description: >- + When provided with too long context should the model + error out or truncate the context to fit? + type: boolean + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/bge-m3 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/bge-reranker-base: + post: + description: Runs inference on the @cf/baai/bge-reranker-base model. + operationId: workers-ai-post-run-cf-baai-bge-reranker-base + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + contexts: + description: >- + List of provided contexts. Note that the index in this array + is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: A query you wish to perform against the provided contexts. + minLength: 1 + type: string + top_k: + description: Number of returned results starting with the best score. + minimum: 1 + type: integer + required: + - query + - contexts + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/bge-reranker-base model. + tags: + - Workers AI Text Classification + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/bge-small-en-v1.5: + post: + description: Runs inference on the @cf/baai/bge-small-en-v1.5 model. + operationId: workers-ai-post-run-cf-baai-bge-small-en-v1-5 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. `cls` + pooling will generate more accurate embeddings on larger + inputs - however, embeddings created with cls pooling are + not compatible with embeddings generated with mean pooling. + The default pooling method is `mean` in order for this to + not be a breaking change, but we highly suggest using the + new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. + `cls` pooling will generate more accurate embeddings + on larger inputs - however, embeddings created with + cls pooling are not compatible with embeddings + generated with mean pooling. The default pooling + method is `mean` in order for this to not be a + breaking change, but we highly suggest using the new + `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: + - text + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/bge-small-en-v1.5 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-base-en-v1.5: + post: + description: Runs inference on the @cf/baai/nonomni-bge-base-en-v1.5 model. + operationId: workers-ai-post-run-cf-baai-nonomni-bge-base-en-v1-5 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. `cls` + pooling will generate more accurate embeddings on larger + inputs - however, embeddings created with cls pooling are + not compatible with embeddings generated with mean pooling. + The default pooling method is `mean` in order for this to + not be a breaking change, but we highly suggest using the + new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. + `cls` pooling will generate more accurate embeddings + on larger inputs - however, embeddings created with + cls pooling are not compatible with embeddings + generated with mean pooling. The default pooling + method is `mean` in order for this to not be a + breaking change, but we highly suggest using the new + `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: + - text + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/nonomni-bge-base-en-v1.5 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-large-en-v1.5: + post: + description: Runs inference on the @cf/baai/nonomni-bge-large-en-v1.5 model. + operationId: workers-ai-post-run-cf-baai-nonomni-bge-large-en-v1-5 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. `cls` + pooling will generate more accurate embeddings on larger + inputs - however, embeddings created with cls pooling are + not compatible with embeddings generated with mean pooling. + The default pooling method is `mean` in order for this to + not be a breaking change, but we highly suggest using the + new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. + `cls` pooling will generate more accurate embeddings + on larger inputs - however, embeddings created with + cls pooling are not compatible with embeddings + generated with mean pooling. The default pooling + method is `mean` in order for this to not be a + breaking change, but we highly suggest using the new + `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: + - text + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/nonomni-bge-large-en-v1.5 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-m3: + post: + description: Runs inference on the @cf/baai/nonomni-bge-m3 model. + operationId: workers-ai-post-run-cf-baai-nonomni-bge-m3 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Input Query and Contexts + properties: + contexts: + description: >- + List of provided contexts. Note that the index in this array + is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: >- + A query you wish to perform against the provided contexts. + If no query is provided the model with respond with + embeddings for contexts + minLength: 1 + type: string + truncate_inputs: + default: false + description: >- + When provided with too long context should the model error + out or truncate the context to fit? + type: boolean + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + type: object + title: Input Query and Contexts + properties: + contexts: + description: >- + List of provided contexts. Note that the index in this + array is important, as the response will refer to it. + items: + properties: + text: + description: One of the provided context content + minLength: 1 + type: string + type: object + type: array + query: + description: >- + A query you wish to perform against the provided + contexts. If no query is provided the model with + respond with embeddings for contexts + minLength: 1 + type: string + truncate_inputs: + default: false + description: >- + When provided with too long context should the model + error out or truncate the context to fit? + type: boolean + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/nonomni-bge-m3 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/baai/nonomni-bge-small-en-v1.5: + post: + description: Runs inference on the @cf/baai/nonomni-bge-small-en-v1.5 model. + operationId: workers-ai-post-run-cf-baai-nonomni-bge-small-en-v1-5 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. `cls` + pooling will generate more accurate embeddings on larger + inputs - however, embeddings created with cls pooling are + not compatible with embeddings generated with mean pooling. + The default pooling method is `mean` in order for this to + not be a breaking change, but we highly suggest using the + new `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + pooling: + default: mean + description: >- + The pooling method used in the embedding process. + `cls` pooling will generate more accurate embeddings + on larger inputs - however, embeddings created with + cls pooling are not compatible with embeddings + generated with mean pooling. The default pooling + method is `mean` in order for this to not be a + breaking change, but we highly suggest using the new + `cls` pooling for better accuracy. + enum: + - mean + - cls + type: string + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: + - text + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/baai/nonomni-bge-small-en-v1.5 model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-1-schnell: + post: + description: Runs inference on the @cf/black-forest-labs/flux-1-schnell model. + operationId: workers-ai-post-run-cf-black-forest-labs-flux-1-schnell + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + prompt: + description: A text description of the image you want to generate. + maxLength: 2048 + minLength: 1 + type: string + steps: + default: 4 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer. + maximum: 8 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/black-forest-labs/flux-1-schnell model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-2-dev: + post: + description: Runs inference on the @cf/black-forest-labs/flux-2-dev model. + operationId: workers-ai-post-run-cf-black-forest-labs-flux-2-dev + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + multipart: + properties: + body: + type: object + contentType: + type: string + type: object + required: + - multipart + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/black-forest-labs/flux-2-dev model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-2-klein-4b: + post: + description: Runs inference on the @cf/black-forest-labs/flux-2-klein-4b model. + operationId: workers-ai-post-run-cf-black-forest-labs-flux-2-klein-4b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + multipart: + properties: + body: + type: object + contentType: + type: string + type: object + required: + - multipart + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/black-forest-labs/flux-2-klein-4b model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-2-klein-9b: + post: + description: Runs inference on the @cf/black-forest-labs/flux-2-klein-9b model. + operationId: workers-ai-post-run-cf-black-forest-labs-flux-2-klein-9b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + multipart: + properties: + body: + type: object + contentType: + type: string + type: object + required: + - multipart + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/black-forest-labs/flux-2-klein-9b model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/bytedance/stable-diffusion-xl-lightning: + post: + description: Runs inference on the @cf/bytedance/stable-diffusion-xl-lightning model. + operationId: workers-ai-post-run-cf-bytedance-stable-diffusion-xl-lightning + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + guidance: + default: 7.5 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: >- + For use with img2img tasks. An array of integers that + represent the image data constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + image_b64: + description: >- + For use with img2img tasks. A base64-encoded string of the + input image + type: string + mask: + description: >- + An array representing An array of integers that represent + mask image data for inpainting constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 20 + type: integer + prompt: + description: A text description of the image you want to generate + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: >- + A value between 0 and 1 indicating how strongly to apply the + transformation during img2img tasks; lower values make the + output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + image/png: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/bytedance/stable-diffusion-xl-lightning model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/deepgram/aura-1: + post: + description: Runs inference on the @cf/deepgram/aura-1 model. + operationId: workers-ai-post-run-cf-deepgram-aura-1 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + bit_rate: + description: >- + The bitrate of the audio in bits per second. Choose from + predefined ranges or specific values based on the encoding + type. + type: number + container: + description: >- + Container specifies the file format wrapper for the output + audio. The available options depend on the encoding type.. + enum: + - none + - wav + - ogg + type: string + encoding: + description: Encoding of the output audio. + enum: + - linear16 + - flac + - mulaw + - alaw + - mp3 + - opus + - aac + type: string + sample_rate: + description: >- + Sample Rate specifies the sample rate for the output audio. + Based on the encoding, different sample rates are supported. + For some encodings, the sample rate is not configurable + type: number + speaker: + default: angus + description: Speaker used to produce the audio. + enum: + - angus + - asteria + - arcas + - orion + - orpheus + - athena + - luna + - zeus + - perseus + - helios + - hera + - stella + type: string + text: + description: The text content to be converted to speech + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + audio/mpeg: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/deepgram/aura-1 model. + tags: + - Workers AI Text To Speech + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/deepgram/aura-2-en: + post: + description: Runs inference on the @cf/deepgram/aura-2-en model. + operationId: workers-ai-post-run-cf-deepgram-aura-2-en + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + bit_rate: + description: >- + The bitrate of the audio in bits per second. Choose from + predefined ranges or specific values based on the encoding + type. + type: number + container: + description: >- + Container specifies the file format wrapper for the output + audio. The available options depend on the encoding type.. + enum: + - none + - wav + - ogg + type: string + encoding: + description: Encoding of the output audio. + enum: + - linear16 + - flac + - mulaw + - alaw + - mp3 + - opus + - aac + type: string + sample_rate: + description: >- + Sample Rate specifies the sample rate for the output audio. + Based on the encoding, different sample rates are supported. + For some encodings, the sample rate is not configurable + type: number + speaker: + default: luna + description: Speaker used to produce the audio. + enum: + - amalthea + - andromeda + - apollo + - arcas + - aries + - asteria + - athena + - atlas + - aurora + - callista + - cora + - cordelia + - delia + - draco + - electra + - harmonia + - helena + - hera + - hermes + - hyperion + - iris + - janus + - juno + - jupiter + - luna + - mars + - minerva + - neptune + - odysseus + - ophelia + - orion + - orpheus + - pandora + - phoebe + - pluto + - saturn + - thalia + - theia + - vesta + - zeus + type: string + text: + description: The text content to be converted to speech + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + audio/mpeg: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/deepgram/aura-2-en model. + tags: + - Workers AI Text To Speech + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/deepgram/aura-2-es: + post: + description: Runs inference on the @cf/deepgram/aura-2-es model. + operationId: workers-ai-post-run-cf-deepgram-aura-2-es + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + bit_rate: + description: >- + The bitrate of the audio in bits per second. Choose from + predefined ranges or specific values based on the encoding + type. + type: number + container: + description: >- + Container specifies the file format wrapper for the output + audio. The available options depend on the encoding type.. + enum: + - none + - wav + - ogg + type: string + encoding: + description: Encoding of the output audio. + enum: + - linear16 + - flac + - mulaw + - alaw + - mp3 + - opus + - aac + type: string + sample_rate: + description: >- + Sample Rate specifies the sample rate for the output audio. + Based on the encoding, different sample rates are supported. + For some encodings, the sample rate is not configurable + type: number + speaker: + default: aquila + description: Speaker used to produce the audio. + enum: + - sirio + - nestor + - carina + - celeste + - alvaro + - diana + - aquila + - selena + - estrella + - javier + type: string + text: + description: The text content to be converted to speech + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + audio/mpeg: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/deepgram/aura-2-es model. + tags: + - Workers AI Text To Speech + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/deepgram/flux: + post: + description: Runs inference on the @cf/deepgram/flux model. + operationId: workers-ai-post-run-cf-deepgram-flux + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + eager_eot_threshold: + description: >- + End-of-turn confidence required to fire an eager end-of-turn + event. When set, enables EagerEndOfTurn and TurnResumed + events. Valid Values 0.3 - 0.9. + type: string + encoding: + description: >- + Encoding of the audio stream. Currently only supports raw + signed little-endian 16-bit PCM. + enum: + - linear16 + type: string + eot_threshold: + default: '0.7' + description: >- + End-of-turn confidence required to finish a turn. Valid + Values 0.5 - 0.9. + type: string + eot_timeout_ms: + default: '5000' + description: >- + A turn will be finished when this much time has passed after + speech, regardless of EOT confidence. + type: string + keyterm: + description: >- + Keyterm prompting can improve recognition of specialized + terminology. Pass multiple keyterm query parameters to boost + multiple keyterms. + type: string + mip_opt_out: + default: 'false' + description: >- + Opts out requests from the Deepgram Model Improvement + Program. Refer to Deepgram Docs for pricing impacts before + setting this to true. https://dpgr.am/deepgram-mip + enum: + - 'true' + - 'false' + type: string + sample_rate: + description: Sample rate of the audio stream in Hz. + type: string + tag: + description: >- + Label your requests for the purpose of identification during + usage reporting + type: string + required: + - sample_rate + - encoding + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/deepgram/flux model. + tags: + - Workers AI Automatic Speech Recognition + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/deepgram/nova-3: + post: + description: Runs inference on the @cf/deepgram/nova-3 model. + operationId: workers-ai-post-run-cf-deepgram-nova-3 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + audio: + properties: + body: + type: object + contentType: + type: string + required: + - body + - contentType + type: object + channels: + description: The number of channels in the submitted audio + type: number + custom_intent: + description: >- + Custom intents you want the model to detect within your + input audio if present + type: string + custom_intent_mode: + description: >- + Sets how the model will interpret intents submitted to the + custom_intent param. When strict, the model will only return + intents submitted using the custom_intent param. When + extended, the model will return its own detected intents in + addition those submitted using the custom_intents param + enum: + - extended + - strict + type: string + custom_topic: + description: >- + Custom topics you want the model to detect within your input + audio or text if present Submit up to 100 + type: string + custom_topic_mode: + description: >- + Sets how the model will interpret strings submitted to the + custom_topic param. When strict, the model will only return + topics submitted using the custom_topic param. When + extended, the model will return its own detected topics in + addition to those submitted using the custom_topic param. + enum: + - extended + - strict + type: string + detect_entities: + description: >- + Identifies and extracts key entities from content in + submitted audio + type: boolean + detect_language: + description: Identifies the dominant language spoken in submitted audio + type: boolean + diarize: + description: >- + Recognize speaker changes. Each word in the transcript will + be assigned a speaker number starting at 0 + type: boolean + dictation: + description: >- + Identify and extract key entities from content in submitted + audio + type: boolean + encoding: + description: Specify the expected encoding of your submitted audio + enum: + - linear16 + - flac + - mulaw + - amr-nb + - amr-wb + - opus + - speex + - g729 + type: string + endpointing: + description: >- + Indicates how long model will wait to detect whether a + speaker has finished speaking or pauses for a significant + period of time. When set to a value, the streaming endpoint + immediately finalizes the transcription for the processed + time range and returns the transcript with a speech_final + parameter set to true. Can also be set to false to disable + endpointing + type: string + extra: + description: >- + Arbitrary key-value pairs that are attached to the API + response for usage in downstream processing + type: string + filler_words: + description: >- + Filler Words can help transcribe interruptions in your + audio, like 'uh' and 'um' + type: boolean + interim_results: + description: >- + Specifies whether the streaming endpoint should provide + ongoing transcription updates as more audio is received. + When set to true, the endpoint sends continuous updates, + meaning transcription results may evolve over time. Note: + Supported only for webosockets. + type: boolean + keyterm: + description: >- + Key term prompting can boost or suppress specialized + terminology and brands. + type: string + keywords: + description: >- + Keywords can boost or suppress specialized terminology and + brands. + type: string + language: + description: >- + The BCP-47 language tag that hints at the primary spoken + language. Depending on the Model and API endpoint you choose + only certain languages are available. + type: string + measurements: + description: >- + Spoken measurements will be converted to their corresponding + abbreviations. + type: boolean + mip_opt_out: + description: >- + Opts out requests from the Deepgram Model Improvement + Program. Refer to our Docs for pricing impacts before + setting this to true. https://dpgr.am/deepgram-mip. + type: boolean + mode: + description: >- + Mode of operation for the model representing broad area of + topic that will be talked about in the supplied audio + enum: + - general + - medical + - finance + type: string + multichannel: + description: Transcribe each audio channel independently. + type: boolean + numerals: + description: >- + Numerals converts numbers from written format to numerical + format. + type: boolean + paragraphs: + description: >- + Splits audio into paragraphs to improve transcript + readability. + type: boolean + profanity_filter: + description: >- + Profanity Filter looks for recognized profanity and converts + it to the nearest recognized non-profane word or removes it + from the transcript completely. + type: boolean + punctuate: + description: Add punctuation and capitalization to the transcript. + type: boolean + redact: + description: >- + Redaction removes sensitive information from your + transcripts. + type: string + replace: + description: >- + Search for terms or phrases in submitted audio and replaces + them. + type: string + search: + description: Search for terms or phrases in submitted audio. + type: string + sentiment: + description: Recognizes the sentiment throughout a transcript or text. + type: boolean + smart_format: + description: >- + Apply formatting to transcript output. When set to true, + additional formatting will be applied to transcripts to + improve readability. + type: boolean + topics: + description: Detect topics throughout a transcript or text. + type: boolean + utt_split: + description: >- + Seconds to wait before detecting a pause between words in + submitted audio. + type: number + utterance_end_ms: + description: >- + Indicates how long model will wait to send an UtteranceEnd + message after a word has been transcribed. Use with + interim_results. Note: Supported only for webosockets. + type: boolean + utterances: + description: Segments speech into meaningful semantic units. + type: boolean + vad_events: + description: >- + Indicates that speech has started. You'll begin receiving + Speech Started messages upon speech starting. Note: + Supported only for webosockets. + type: boolean + required: + - audio + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/deepgram/nova-3 model. + tags: + - Workers AI Automatic Speech Recognition + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-math-7b-instruct: + post: + description: Runs inference on the @cf/deepseek-ai/deepseek-math-7b-instruct model. + operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-math-7b-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/deepseek-ai/deepseek-math-7b-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-r1-distill-qwen-32b: + post: + description: >- + Runs inference on the @cf/deepseek-ai/deepseek-r1-distill-qwen-32b + model. + operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-r1-distill-qwen-32b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/deepseek-ai/deepseek-r1-distill-qwen-32b model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/defog/sqlcoder-7b-2: + post: + description: Runs inference on the @cf/defog/sqlcoder-7b-2 model. + operationId: workers-ai-post-run-cf-defog-sqlcoder-7b-2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/defog/sqlcoder-7b-2 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/facebook/bart-large-cnn: + post: + description: Runs inference on the @cf/facebook/bart-large-cnn model. + operationId: workers-ai-post-run-cf-facebook-bart-large-cnn + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + input_text: + description: The text that you want the model to summarize + minLength: 1 + type: string + max_length: + default: 1024 + description: The maximum length of the generated summary in tokens + type: integer + required: + - input_text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/facebook/bart-large-cnn model. + tags: + - Workers AI Summarization + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/facebook/nonomni-bart-large-cnn: + post: + description: Runs inference on the @cf/facebook/nonomni-bart-large-cnn model. + operationId: workers-ai-post-run-cf-facebook-nonomni-bart-large-cnn + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + input_text: + description: The text that you want the model to summarize + minLength: 1 + type: string + max_length: + default: 1024 + description: The maximum length of the generated summary in tokens + type: integer + required: + - input_text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/facebook/nonomni-bart-large-cnn model. + tags: + - Workers AI Summarization + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/facebook/nonomni-detr-resnet-50: + post: + description: Runs inference on the @cf/facebook/nonomni-detr-resnet-50 model. + operationId: workers-ai-post-run-cf-facebook-nonomni-detr-resnet-50 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/facebook/nonomni-detr-resnet-50 model. + tags: + - Workers AI Object Detection + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/fblgit/una-cybertron-7b-v2-bf16: + post: + description: Runs inference on the @cf/fblgit/una-cybertron-7b-v2-bf16 model. + operationId: workers-ai-post-run-cf-fblgit-una-cybertron-7b-v2-bf16 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/fblgit/una-cybertron-7b-v2-bf16 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/google/embeddinggemma-300m: + post: + description: Runs inference on the @cf/google/embeddinggemma-300m model. + operationId: workers-ai-post-run-cf-google-embeddinggemma-300m + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + text: + type: string + description: The text to embed + items: + description: The text to embed + minLength: 1 + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/google/embeddinggemma-300m model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/google/gemma-2b-it-lora: + post: + description: Runs inference on the @cf/google/gemma-2b-it-lora model. + operationId: workers-ai-post-run-cf-google-gemma-2b-it-lora + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/google/gemma-2b-it-lora model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/google/gemma-3-12b-it: + post: + description: Runs inference on the @cf/google/gemma-3-12b-it model. + operationId: workers-ai-post-run-cf-google-gemma-3-12b-it + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: 0 + type: number + guided_json: + description: JSON schema that should be fufilled for the response. + type: object + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 2 + minimum: 0 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL + will not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/google/gemma-3-12b-it model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/google/gemma-7b-it-lora: + post: + description: Runs inference on the @cf/google/gemma-7b-it-lora model. + operationId: workers-ai-post-run-cf-google-gemma-7b-it-lora + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/google/gemma-7b-it-lora model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/google/nonomni-embeddinggemma-300m: + post: + description: Runs inference on the @cf/google/nonomni-embeddinggemma-300m model. + operationId: workers-ai-post-run-cf-google-nonomni-embeddinggemma-300m + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + text: + description: >- + Input text to embed. Can be a single string or a list of + strings. + type: string + items: + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/google/nonomni-embeddinggemma-300m model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/huggingface/distilbert-sst-2-int8: + post: + description: Runs inference on the @cf/huggingface/distilbert-sst-2-int8 model. + operationId: workers-ai-post-run-cf-huggingface-distilbert-sst-2-int8 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + text: + description: The text that you want to classify + minLength: 1 + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/huggingface/distilbert-sst-2-int8 model. + tags: + - Workers AI Text Classification + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/huggingface/nonomni-distilbert-sst-2-int8: + post: + description: >- + Runs inference on the @cf/huggingface/nonomni-distilbert-sst-2-int8 + model. + operationId: workers-ai-post-run-cf-huggingface-nonomni-distilbert-sst-2-int8 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + text: + description: The text that you want to classify + minLength: 1 + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/huggingface/nonomni-distilbert-sst-2-int8 model. + tags: + - Workers AI Text Classification + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/ibm-granite/granite-4.0-h-micro: + post: + description: Runs inference on the @cf/ibm-granite/granite-4.0-h-micro model. + operationId: workers-ai-post-run-cf-ibm-granite-granite-4-0-h-micro + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/ibm-granite/granite-4.0-h-micro model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/leonardo/lucid-origin: + post: + description: Runs inference on the @cf/leonardo/lucid-origin model. + operationId: workers-ai-post-run-cf-leonardo-lucid-origin + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + guidance: + default: 4.5 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + maximum: 10 + minimum: 0 + type: number + height: + default: 1120 + description: The height of the generated image in pixels + maximum: 2500 + minimum: 0 + type: integer + num_steps: + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 40 + minimum: 1 + type: integer + prompt: + description: A text description of the image you want to generate. + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + minimum: 0 + type: integer + steps: + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 40 + minimum: 1 + type: integer + width: + default: 1120 + description: The width of the generated image in pixels + maximum: 2500 + minimum: 0 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/leonardo/lucid-origin model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/leonardo/phoenix-1.0: + post: + description: Runs inference on the @cf/leonardo/phoenix-1.0 model. + operationId: workers-ai-post-run-cf-leonardo-phoenix-1-0 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + guidance: + default: 2 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + maximum: 10 + minimum: 2 + type: number + height: + default: 1024 + description: The height of the generated image in pixels + maximum: 2048 + minimum: 0 + type: integer + negative_prompt: + description: Specify what to exclude from the generated images + minLength: 1 + type: string + num_steps: + default: 25 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 50 + minimum: 1 + type: integer + prompt: + description: A text description of the image you want to generate. + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + minimum: 0 + type: integer + width: + default: 1024 + description: The width of the generated image in pixels + maximum: 2048 + minimum: 0 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + image/jpeg: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/leonardo/phoenix-1.0 model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/lykon/dreamshaper-8-lcm: + post: + description: Runs inference on the @cf/lykon/dreamshaper-8-lcm model. + operationId: workers-ai-post-run-cf-lykon-dreamshaper-8-lcm + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + guidance: + default: 7.5 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: >- + For use with img2img tasks. An array of integers that + represent the image data constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + image_b64: + description: >- + For use with img2img tasks. A base64-encoded string of the + input image + type: string + mask: + description: >- + An array representing An array of integers that represent + mask image data for inpainting constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 20 + type: integer + prompt: + description: A text description of the image you want to generate + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: >- + A value between 0 and 1 indicating how strongly to apply the + transformation during img2img tasks; lower values make the + output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + image/png: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/lykon/dreamshaper-8-lcm model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta-llama/llama-2-7b-chat-hf-lora: + post: + description: Runs inference on the @cf/meta-llama/llama-2-7b-chat-hf-lora model. + operationId: workers-ai-post-run-cf-meta-llama-llama-2-7b-chat-hf-lora + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta-llama/llama-2-7b-chat-hf-lora model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-fp16: + post: + description: Runs inference on the @cf/meta/llama-2-7b-chat-fp16 model. + operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-fp16 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-2-7b-chat-fp16 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-int8: + post: + description: Runs inference on the @cf/meta/llama-2-7b-chat-int8 model. + operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-int8 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-2-7b-chat-int8 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct: + post: + description: Runs inference on the @cf/meta/llama-3-8b-instruct model. + operationId: workers-ai-post-run-cf-meta-llama-3-8b-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3-8b-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct-awq: + post: + description: Runs inference on the @cf/meta/llama-3-8b-instruct-awq model. + operationId: workers-ai-post-run-cf-meta-llama-3-8b-instruct-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3-8b-instruct-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-70b-instruct-fp8-fast: + post: + description: Runs inference on the @cf/meta/llama-3.1-70b-instruct-fp8-fast model. + operationId: workers-ai-post-run-cf-meta-llama-3-1-70b-instruct-fp8-fast + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.1-70b-instruct-fp8-fast model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-awq: + post: + description: Runs inference on the @cf/meta/llama-3.1-8b-instruct-awq model. + operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.1-8b-instruct-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-fp8: + post: + description: Runs inference on the @cf/meta/llama-3.1-8b-instruct-fp8 model. + operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-fp8 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.1-8b-instruct-fp8 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-fp8-fast: + post: + description: Runs inference on the @cf/meta/llama-3.1-8b-instruct-fp8-fast model. + operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-fp8-fast + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.1-8b-instruct-fp8-fast model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.2-11b-vision-instruct: + post: + description: Runs inference on the @cf/meta/llama-3.2-11b-vision-instruct model. + operationId: workers-ai-post-run-cf-meta-llama-3-2-11b-vision-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: 0 + type: number + image: + type: array + description: >- + An array of integers that represent the image data + constrained to 8-bit unsigned integer values. Deprecated, + use image as a part of messages now. + items: + description: A value between 0 and 255 + type: number + format: binary + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: The input text prompt for the model to generate a response. + maxLength: 131072 + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 2 + minimum: 0 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL + will not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + type: object + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL will + not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + tool_call_id: + description: >- + The tool call id. If you don't know what to put here + you can fall back to 000000001 + type: string + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.2-11b-vision-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.2-1b-instruct: + post: + description: Runs inference on the @cf/meta/llama-3.2-1b-instruct model. + operationId: workers-ai-post-run-cf-meta-llama-3-2-1b-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.2-1b-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.2-3b-instruct: + post: + description: Runs inference on the @cf/meta/llama-3.2-3b-instruct model. + operationId: workers-ai-post-run-cf-meta-llama-3-2-3b-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.2-3b-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-3.3-70b-instruct-fp8-fast: + post: + description: Runs inference on the @cf/meta/llama-3.3-70b-instruct-fp8-fast model. + operationId: workers-ai-post-run-cf-meta-llama-3-3-70b-instruct-fp8-fast + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + requests: + items: + properties: + external_reference: + description: >- + User-supplied reference. This field will be present in + the response as well it can be used to reference the + request and response. It's NOT validated to be unique. + type: string + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the + same lines verbatim. + maximum: 2 + minimum: 0 + type: number + max_tokens: + default: 256 + description: >- + The maximum number of tokens to generate in the + response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: Prompt for the text generation model + minLength: 1 + type: string + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back + incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values + produce more random results. + maximum: 5 + minimum: 0 + type: number + top_p: + description: >- + Adjusts the creativity of the AI's responses by + controlling how many possible words it considers. + Lower values make outputs more predictable; higher + values allow for more varied and creative responses. + maximum: 2 + minimum: 0 + type: number + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-3.3-70b-instruct-fp8-fast model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-4-scout-17b-16e-instruct: + post: + description: Runs inference on the @cf/meta/llama-4-scout-17b-16e-instruct model. + operationId: workers-ai-post-run-cf-meta-llama-4-scout-17b-16e-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: 0 + type: number + guided_json: + description: JSON schema that should be fulfilled for the response. + type: object + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.15 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 2 + minimum: 0 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL + will not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + type: object + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL will + not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + tool_call_id: + description: >- + The tool call id. If you don't know what to put here + you can fall back to 000000001 + type: string + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + requests: + items: + type: object + title: Prompt_Inner + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the + same lines verbatim. + maximum: 2 + minimum: 0 + type: number + guided_json: + description: JSON schema that should be fulfilled for the response. + type: object + max_tokens: + default: 256 + description: >- + The maximum number of tokens to generate in the + response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: >- + The input text prompt for the model to generate a + response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must + adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back + incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.15 + description: >- + Controls the randomness of the output; higher values + produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; + higher values introduce more variety and potential + surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by + controlling how many possible words it considers. + Lower values make outputs more predictable; higher + values allow for more varied and creative responses. + maximum: 2 + minimum: 0 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the + conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP + URL will not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + type: object + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP + URL will not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + tool_call_id: + description: >- + The tool call id. If you don't know what to put + here you can fall back to 000000001 + type: string + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: >- + The name of the tool. More descriptive the + better. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: >- + A brief description of what the function + does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by + the function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object + (usually 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-4-scout-17b-16e-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/llama-guard-3-8b: + post: + description: Runs inference on the @cf/meta/llama-guard-3-8b model. + operationId: workers-ai-post-run-cf-meta-llama-guard-3-8b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + description: The content of the message as a string. + type: string + role: + description: >- + The role of the message sender must alternate between + 'user' and 'assistant'. + enum: + - user + - assistant + type: string + required: + - role + - content + type: object + type: array + response_format: + description: Dictate the output format of the generated response. + properties: + type: + description: >- + Set to json_object to process and output generated text + as JSON. + type: string + type: object + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + required: + - messages + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/llama-guard-3-8b model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/meta/m2m100-1.2b: + post: + description: Runs inference on the @cf/meta/m2m100-1.2b model. + operationId: workers-ai-post-run-cf-meta-m2m100-1-2b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + source_lang: + default: en + description: >- + The language code of the source text (e.g., 'en' for + English). Defaults to 'en' if not specified + type: string + target_lang: + description: >- + The language code to translate the text into (e.g., 'es' for + Spanish) + type: string + text: + description: The text to be translated + minLength: 1 + type: string + requests: + description: Batch of the embeddings requests to run using async-queue + items: + properties: + source_lang: + default: en + description: >- + The language code of the source text (e.g., 'en' for + English). Defaults to 'en' if not specified + type: string + target_lang: + description: >- + The language code to translate the text into (e.g., + 'es' for Spanish) + type: string + text: + description: The text to be translated + minLength: 1 + type: string + required: + - text + - target_lang + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/meta/m2m100-1.2b model. + tags: + - Workers AI Translation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/microsoft/nonomni-resnet-50: + post: + description: Runs inference on the @cf/microsoft/nonomni-resnet-50 model. + operationId: workers-ai-post-run-cf-microsoft-nonomni-resnet-50 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/microsoft/nonomni-resnet-50 model. + tags: + - Workers AI Image Classification + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/microsoft/phi-2: + post: + description: Runs inference on the @cf/microsoft/phi-2 model. + operationId: workers-ai-post-run-cf-microsoft-phi-2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/microsoft/phi-2 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/microsoft/resnet-50: + post: + description: Runs inference on the @cf/microsoft/resnet-50 model. + operationId: workers-ai-post-run-cf-microsoft-resnet-50 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/microsoft/resnet-50 model. + tags: + - Workers AI Image Classification + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.1: + post: + description: Runs inference on the @cf/mistral/mistral-7b-instruct-v0.1 model. + operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-1 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/mistral/mistral-7b-instruct-v0.1 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.2-lora: + post: + description: Runs inference on the @cf/mistral/mistral-7b-instruct-v0.2-lora model. + operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-2-lora + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/mistral/mistral-7b-instruct-v0.2-lora model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/mistralai/mistral-small-3.1-24b-instruct: + post: + description: >- + Runs inference on the @cf/mistralai/mistral-small-3.1-24b-instruct + model. + operationId: workers-ai-post-run-cf-mistralai-mistral-small-3-1-24b-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: 0 + type: number + guided_json: + description: JSON schema that should be fulfilled for the response. + type: object + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.15 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 2 + minimum: 0 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL + will not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + type: object + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL will + not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + tool_call_id: + description: >- + The tool call id. Must be supplied for tool calls for + Mistral-3. If you don't know what to put here you can + fall back to 000000001 + type: string + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/mistralai/mistral-small-3.1-24b-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/moonshotai/kimi-k2.5: + post: + description: Runs inference on the @cf/moonshotai/kimi-k2.5 model. + operationId: workers-ai-post-run-cf-moonshotai-kimi-k2-5 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + audio: + description: >- + Parameters for audio output. Required when modalities + includes 'audio'. + properties: + format: + enum: + - wav + - aac + - mp3 + - flac + - opus + - pcm16 + type: string + voice: + type: string + properties: + id: + type: string + required: + - id + required: + - voice + - format + type: object + chat_template_kwargs: + properties: + clear_thinking: + default: false + description: If false, preserves reasoning context between turns. + type: boolean + enable_thinking: + default: true + description: Whether to enable reasoning, enabled by default. + type: boolean + type: object + frequency_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + function_call: + type: string + enum: + - none + - auto + properties: + name: + type: string + required: + - name + functions: + items: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, described as a + JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + maxItems: 128 + minItems: 1 + type: array + logit_bias: + nullable: true + type: object + logprobs: + nullable: true + type: boolean + max_completion_tokens: + nullable: true + type: integer + max_tokens: + nullable: true + type: integer + metadata: + nullable: true + type: object + modalities: + items: + enum: + - text + - audio + type: string + nullable: true + type: array + model: + description: >- + ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, + etc'). + type: string + 'n': + maximum: 128 + minimum: 1 + nullable: true + type: integer + parallel_tool_calls: + default: true + description: Whether to enable parallel function calling during tool use. + type: boolean + prediction: + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + type: + enum: + - content + type: string + required: + - type + - content + type: object + presence_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + reasoning_effort: + enum: + - low + - medium + - high + nullable: true + type: string + response_format: + description: Specifies the format the model must output. + type: object + properties: + type: + enum: + - text + type: string + json_schema: + properties: + description: + type: string + name: + type: string + schema: + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + required: + - type + seed: + nullable: true + type: integer + service_tier: + enum: + - auto + - default + - flex + - scale + - priority + nullable: true + type: string + stop: + type: string + items: + type: string + store: + nullable: true + type: boolean + stream: + nullable: true + type: boolean + stream_options: + properties: + include_obfuscation: + type: boolean + include_usage: + type: boolean + type: object + temperature: + maximum: 2 + minimum: 0 + nullable: true + type: number + tool_choice: + description: >- + Controls which (if any) tool is called by the model. 'none' + = no tools, 'auto' = model decides, 'required' = must call a + tool. + type: string + enum: + - none + - auto + - required + properties: + function: + properties: + name: + type: string + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + name: + type: string + required: + - name + type: object + allowed_tools: + properties: + mode: + enum: + - auto + - required + type: string + tools: + items: + type: object + type: array + required: + - mode + - tools + type: object + required: + - type + tools: + description: A list of tools the model may call. + items: + type: object + properties: + function: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, described as + a JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + description: + type: string + format: + type: object + properties: + type: + enum: + - text + type: string + grammar: + properties: + definition: + type: string + syntax: + enum: + - lark + - regex + type: string + required: + - definition + - syntax + type: object + required: + - type + name: + type: string + required: + - name + type: object + required: + - type + type: array + top_logprobs: + maximum: 20 + minimum: 0 + nullable: true + type: integer + top_p: + maximum: 1 + minimum: 0 + nullable: true + type: number + user: + description: >- + A unique identifier representing your end-user, for abuse + monitoring. + type: string + web_search_options: + description: >- + Options for the web search tool (when using built-in web + search). + properties: + search_context_size: + default: medium + enum: + - low + - medium + - high + type: string + user_location: + properties: + approximate: + properties: + city: + type: string + country: + type: string + region: + type: string + timezone: + type: string + type: object + type: + enum: + - approximate + type: string + required: + - type + - approximate + type: object + type: object + messages: + description: A list of messages comprising the conversation so far. + items: + type: object + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + name: + type: string + role: + enum: + - developer + type: string + audio: + properties: + id: + type: string + required: + - id + type: object + function_call: + properties: + arguments: + type: string + name: + type: string + required: + - name + - arguments + type: object + refusal: + nullable: true + type: string + tool_calls: + items: + type: object + properties: + function: + properties: + arguments: + description: JSON-encoded arguments string. + type: string + name: + type: string + required: + - name + - arguments + type: object + id: + type: string + type: + enum: + - function + type: string + custom: + properties: + input: + type: string + name: + type: string + required: + - name + - input + type: object + required: + - id + - type + type: array + tool_call_id: + type: string + required: + - role + minItems: 1 + type: array + requests: + items: + type: object + title: Prompt + properties: + audio: + description: >- + Parameters for audio output. Required when modalities + includes 'audio'. + properties: + format: + enum: + - wav + - aac + - mp3 + - flac + - opus + - pcm16 + type: string + voice: + type: string + properties: + id: + type: string + required: + - id + required: + - voice + - format + type: object + chat_template_kwargs: + properties: + clear_thinking: + default: false + description: >- + If false, preserves reasoning context between + turns. + type: boolean + enable_thinking: + default: true + description: Whether to enable reasoning, enabled by default. + type: boolean + type: object + frequency_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + function_call: + type: string + enum: + - none + - auto + properties: + name: + type: string + required: + - name + functions: + items: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, described + as a JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + maxItems: 128 + minItems: 1 + type: array + logit_bias: + nullable: true + type: object + logprobs: + nullable: true + type: boolean + max_completion_tokens: + nullable: true + type: integer + max_tokens: + nullable: true + type: integer + metadata: + nullable: true + type: object + modalities: + items: + enum: + - text + - audio + type: string + nullable: true + type: array + model: + description: >- + ID of the model to use (e.g. + '@cf/zai-org/glm-4.7-flash, etc'). + type: string + 'n': + maximum: 128 + minimum: 1 + nullable: true + type: integer + parallel_tool_calls: + default: true + description: >- + Whether to enable parallel function calling during + tool use. + type: boolean + prediction: + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + type: + enum: + - content + type: string + required: + - type + - content + type: object + presence_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + prompt: + description: >- + The input text prompt for the model to generate a + response. + minLength: 1 + type: string + reasoning_effort: + enum: + - low + - medium + - high + nullable: true + type: string + response_format: + description: Specifies the format the model must output. + type: object + properties: + type: + enum: + - text + type: string + json_schema: + properties: + description: + type: string + name: + type: string + schema: + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + required: + - type + seed: + nullable: true + type: integer + service_tier: + enum: + - auto + - default + - flex + - scale + - priority + nullable: true + type: string + stop: + type: string + items: + type: string + store: + nullable: true + type: boolean + stream: + nullable: true + type: boolean + stream_options: + properties: + include_obfuscation: + type: boolean + include_usage: + type: boolean + type: object + temperature: + maximum: 2 + minimum: 0 + nullable: true + type: number + tool_choice: + description: >- + Controls which (if any) tool is called by the model. + 'none' = no tools, 'auto' = model decides, 'required' + = must call a tool. + type: string + enum: + - none + - auto + - required + properties: + function: + properties: + name: + type: string + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + name: + type: string + required: + - name + type: object + allowed_tools: + properties: + mode: + enum: + - auto + - required + type: string + tools: + items: + type: object + type: array + required: + - mode + - tools + type: object + required: + - type + tools: + description: A list of tools the model may call. + items: + type: object + properties: + function: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, + described as a JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + description: + type: string + format: + type: object + properties: + type: + enum: + - text + type: string + grammar: + properties: + definition: + type: string + syntax: + enum: + - lark + - regex + type: string + required: + - definition + - syntax + type: object + required: + - type + name: + type: string + required: + - name + type: object + required: + - type + type: array + top_logprobs: + maximum: 20 + minimum: 0 + nullable: true + type: integer + top_p: + maximum: 1 + minimum: 0 + nullable: true + type: number + user: + description: >- + A unique identifier representing your end-user, for + abuse monitoring. + type: string + web_search_options: + description: >- + Options for the web search tool (when using built-in + web search). + properties: + search_context_size: + default: medium + enum: + - low + - medium + - high + type: string + user_location: + properties: + approximate: + properties: + city: + type: string + country: + type: string + region: + type: string + timezone: + type: string + type: object + type: + enum: + - approximate + type: string + required: + - type + - approximate + type: object + type: object + messages: + description: A list of messages comprising the conversation so far. + items: + type: object + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + name: + type: string + role: + enum: + - developer + type: string + audio: + properties: + id: + type: string + required: + - id + type: object + function_call: + properties: + arguments: + type: string + name: + type: string + required: + - name + - arguments + type: object + refusal: + nullable: true + type: string + tool_calls: + items: + type: object + properties: + function: + properties: + arguments: + description: JSON-encoded arguments string. + type: string + name: + type: string + required: + - name + - arguments + type: object + id: + type: string + type: + enum: + - function + type: string + custom: + properties: + input: + type: string + name: + type: string + required: + - name + - input + type: object + required: + - id + - type + type: array + tool_call_id: + type: string + required: + - role + minItems: 1 + type: array + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/moonshotai/kimi-k2.5 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/myshell-ai/melotts: + post: + description: Runs inference on the @cf/myshell-ai/melotts model. + operationId: workers-ai-post-run-cf-myshell-ai-melotts + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + lang: + default: en + description: >- + The speech language (e.g., 'en' for English, 'fr' for + French). Defaults to 'en' if not specified + type: string + prompt: + description: A text description of the audio you want to generate + minLength: 1 + type: string + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/myshell-ai/melotts model. + tags: + - Workers AI Text To Speech + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/nvidia/nemotron-3-120b-a12b: + post: + description: Runs inference on the @cf/nvidia/nemotron-3-120b-a12b model. + operationId: workers-ai-post-run-cf-nvidia-nemotron-3-120b-a12b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + audio: + description: >- + Parameters for audio output. Required when modalities + includes 'audio'. + properties: + format: + enum: + - wav + - aac + - mp3 + - flac + - opus + - pcm16 + type: string + voice: + type: string + properties: + id: + type: string + required: + - id + required: + - voice + - format + type: object + chat_template_kwargs: + properties: + clear_thinking: + default: false + description: If false, preserves reasoning context between turns. + type: boolean + enable_thinking: + default: true + description: Whether to enable reasoning, enabled by default. + type: boolean + type: object + frequency_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + function_call: + type: string + enum: + - none + - auto + properties: + name: + type: string + required: + - name + functions: + items: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, described as a + JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + maxItems: 128 + minItems: 1 + type: array + logit_bias: + nullable: true + type: object + logprobs: + nullable: true + type: boolean + max_completion_tokens: + nullable: true + type: integer + max_tokens: + nullable: true + type: integer + metadata: + nullable: true + type: object + modalities: + items: + enum: + - text + - audio + type: string + nullable: true + type: array + model: + description: >- + ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, + etc'). + type: string + 'n': + maximum: 128 + minimum: 1 + nullable: true + type: integer + parallel_tool_calls: + default: true + description: Whether to enable parallel function calling during tool use. + type: boolean + prediction: + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + type: + enum: + - content + type: string + required: + - type + - content + type: object + presence_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + reasoning_effort: + enum: + - low + - medium + - high + nullable: true + type: string + response_format: + description: Specifies the format the model must output. + type: object + properties: + type: + enum: + - text + type: string + json_schema: + properties: + description: + type: string + name: + type: string + schema: + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + required: + - type + seed: + nullable: true + type: integer + service_tier: + enum: + - auto + - default + - flex + - scale + - priority + nullable: true + type: string + stop: + type: string + items: + type: string + store: + nullable: true + type: boolean + stream: + nullable: true + type: boolean + stream_options: + properties: + include_obfuscation: + type: boolean + include_usage: + type: boolean + type: object + temperature: + maximum: 2 + minimum: 0 + nullable: true + type: number + tool_choice: + description: >- + Controls which (if any) tool is called by the model. 'none' + = no tools, 'auto' = model decides, 'required' = must call a + tool. + type: string + enum: + - none + - auto + - required + properties: + function: + properties: + name: + type: string + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + name: + type: string + required: + - name + type: object + allowed_tools: + properties: + mode: + enum: + - auto + - required + type: string + tools: + items: + type: object + type: array + required: + - mode + - tools + type: object + required: + - type + tools: + description: A list of tools the model may call. + items: + type: object + properties: + function: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, described as + a JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + description: + type: string + format: + type: object + properties: + type: + enum: + - text + type: string + grammar: + properties: + definition: + type: string + syntax: + enum: + - lark + - regex + type: string + required: + - definition + - syntax + type: object + required: + - type + name: + type: string + required: + - name + type: object + required: + - type + type: array + top_logprobs: + maximum: 20 + minimum: 0 + nullable: true + type: integer + top_p: + maximum: 1 + minimum: 0 + nullable: true + type: number + user: + description: >- + A unique identifier representing your end-user, for abuse + monitoring. + type: string + web_search_options: + description: >- + Options for the web search tool (when using built-in web + search). + properties: + search_context_size: + default: medium + enum: + - low + - medium + - high + type: string + user_location: + properties: + approximate: + properties: + city: + type: string + country: + type: string + region: + type: string + timezone: + type: string + type: object + type: + enum: + - approximate + type: string + required: + - type + - approximate + type: object + type: object + messages: + description: A list of messages comprising the conversation so far. + items: + type: object + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + name: + type: string + role: + enum: + - developer + type: string + audio: + properties: + id: + type: string + required: + - id + type: object + function_call: + properties: + arguments: + type: string + name: + type: string + required: + - name + - arguments + type: object + refusal: + nullable: true + type: string + tool_calls: + items: + type: object + properties: + function: + properties: + arguments: + description: JSON-encoded arguments string. + type: string + name: + type: string + required: + - name + - arguments + type: object + id: + type: string + type: + enum: + - function + type: string + custom: + properties: + input: + type: string + name: + type: string + required: + - name + - input + type: object + required: + - id + - type + type: array + tool_call_id: + type: string + required: + - role + minItems: 1 + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/nvidia/nemotron-3-120b-a12b model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/openai/gpt-oss-120b: + post: + description: Runs inference on the @cf/openai/gpt-oss-120b model. + operationId: workers-ai-post-run-cf-openai-gpt-oss-120b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + input: + description: >- + Responses API Input messages. Refer to OpenAI Responses API + docs to learn more about supported content types + type: string + items: {} + reasoning: + properties: + effort: + description: >- + Constrains effort on reasoning for reasoning models. + Currently supported values are low, medium, and high. + Reducing reasoning effort can result in faster responses + and fewer tokens used on reasoning in a response. + enum: + - low + - medium + - high + type: string + summary: + description: >- + A summary of the reasoning performed by the model. This + can be useful for debugging and understanding the + model's reasoning process. One of auto, concise, or + detailed. + enum: + - auto + - concise + - detailed + type: string + type: object + requests: + items: + properties: + input: + description: >- + Responses API Input messages. Refer to OpenAI + Responses API docs to learn more about supported + content types + type: string + items: {} + reasoning: + properties: + effort: + description: >- + Constrains effort on reasoning for reasoning + models. Currently supported values are low, + medium, and high. Reducing reasoning effort can + result in faster responses and fewer tokens used + on reasoning in a response. + enum: + - low + - medium + - high + type: string + summary: + description: >- + A summary of the reasoning performed by the model. + This can be useful for debugging and understanding + the model's reasoning process. One of auto, + concise, or detailed. + enum: + - auto + - concise + - detailed + type: string + type: object + required: + - input + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/openai/gpt-oss-120b model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/openai/gpt-oss-20b: + post: + description: Runs inference on the @cf/openai/gpt-oss-20b model. + operationId: workers-ai-post-run-cf-openai-gpt-oss-20b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + input: + description: >- + Responses API Input messages. Refer to OpenAI Responses API + docs to learn more about supported content types + type: string + items: {} + reasoning: + properties: + effort: + description: >- + Constrains effort on reasoning for reasoning models. + Currently supported values are low, medium, and high. + Reducing reasoning effort can result in faster responses + and fewer tokens used on reasoning in a response. + enum: + - low + - medium + - high + type: string + summary: + description: >- + A summary of the reasoning performed by the model. This + can be useful for debugging and understanding the + model's reasoning process. One of auto, concise, or + detailed. + enum: + - auto + - concise + - detailed + type: string + type: object + requests: + items: + properties: + input: + description: >- + Responses API Input messages. Refer to OpenAI + Responses API docs to learn more about supported + content types + type: string + items: {} + reasoning: + properties: + effort: + description: >- + Constrains effort on reasoning for reasoning + models. Currently supported values are low, + medium, and high. Reducing reasoning effort can + result in faster responses and fewer tokens used + on reasoning in a response. + enum: + - low + - medium + - high + type: string + summary: + description: >- + A summary of the reasoning performed by the model. + This can be useful for debugging and understanding + the model's reasoning process. One of auto, + concise, or detailed. + enum: + - auto + - concise + - detailed + type: string + type: object + required: + - input + type: object + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/openai/gpt-oss-20b model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/openai/whisper: + post: + description: Runs inference on the @cf/openai/whisper model. + operationId: workers-ai-post-run-cf-openai-whisper + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/openai/whisper model. + tags: + - Workers AI Automatic Speech Recognition + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/openai/whisper-large-v3-turbo: + post: + description: Runs inference on the @cf/openai/whisper-large-v3-turbo model. + operationId: workers-ai-post-run-cf-openai-whisper-large-v3-turbo + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + audio: + type: string + description: Base64 encoded value of the audio data. + properties: + body: + type: object + contentType: + type: string + beam_size: + default: 5 + description: >- + The number of beams to use in beam search decoding. Higher + values may improve accuracy at the cost of speed. + type: integer + compression_ratio_threshold: + default: 2.4 + description: >- + Threshold for filtering out segments with high compression + ratio, which often indicate repetitive or hallucinated text. + type: number + condition_on_previous_text: + default: true + description: >- + Whether to condition on previous text during transcription. + Setting to false may help prevent hallucination loops. + type: boolean + hallucination_silence_threshold: + description: >- + Optional threshold (in seconds) to skip silent periods that + may cause hallucinations. + type: number + initial_prompt: + description: >- + A text prompt to help provide context to the model on the + contents of the audio. + type: string + language: + description: The language of the audio being transcribed or translated. + type: string + log_prob_threshold: + default: -1 + description: >- + Threshold for filtering out segments with low average log + probability, indicating low confidence. + type: number + no_speech_threshold: + default: 0.6 + description: >- + Threshold for detecting no-speech segments. Segments with + no-speech probability above this value are skipped. + type: number + prefix: + description: >- + The prefix appended to the beginning of the output of the + transcription and can guide the transcription result. + type: string + task: + default: transcribe + description: Supported tasks are 'translate' or 'transcribe'. + type: string + vad_filter: + default: false + description: Preprocess the audio with a voice activity detection model. + type: boolean + required: + - audio + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/openai/whisper-large-v3-turbo model. + tags: + - Workers AI Automatic Speech Recognition + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en: + post: + description: Runs inference on the @cf/openai/whisper-tiny-en model. + operationId: workers-ai-post-run-cf-openai-whisper-tiny-en + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/openai/whisper-tiny-en model. + tags: + - Workers AI Automatic Speech Recognition + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/openchat/openchat-3.5-0106: + post: + description: Runs inference on the @cf/openchat/openchat-3.5-0106 model. + operationId: workers-ai-post-run-cf-openchat-openchat-3-5-0106 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/openchat/openchat-3.5-0106 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/pfnet/plamo-embedding-1b: + post: + description: Runs inference on the @cf/pfnet/plamo-embedding-1b model. + operationId: workers-ai-post-run-cf-pfnet-plamo-embedding-1b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + text: + description: >- + Input text to embed. Can be a single string or a list of + strings. + type: string + items: + type: string + required: + - text + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/pfnet/plamo-embedding-1b model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-0.5b-chat: + post: + description: Runs inference on the @cf/qwen/qwen1.5-0.5b-chat model. + operationId: workers-ai-post-run-cf-qwen-qwen1-5-0-5b-chat + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwen1.5-0.5b-chat model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-1.8b-chat: + post: + description: Runs inference on the @cf/qwen/qwen1.5-1.8b-chat model. + operationId: workers-ai-post-run-cf-qwen-qwen1-5-1-8b-chat + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwen1.5-1.8b-chat model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-14b-chat-awq: + post: + description: Runs inference on the @cf/qwen/qwen1.5-14b-chat-awq model. + operationId: workers-ai-post-run-cf-qwen-qwen1-5-14b-chat-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwen1.5-14b-chat-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-7b-chat-awq: + post: + description: Runs inference on the @cf/qwen/qwen1.5-7b-chat-awq model. + operationId: workers-ai-post-run-cf-qwen-qwen1-5-7b-chat-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwen1.5-7b-chat-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwen2.5-coder-32b-instruct: + post: + description: Runs inference on the @cf/qwen/qwen2.5-coder-32b-instruct model. + operationId: workers-ai-post-run-cf-qwen-qwen2-5-coder-32b-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: 0 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 2 + minimum: 0 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + description: The content of the message as a string. + type: string + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwen2.5-coder-32b-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwen3-30b-a3b-fp8: + post: + description: Runs inference on the @cf/qwen/qwen3-30b-a3b-fp8 model. + operationId: workers-ai-post-run-cf-qwen-qwen3-30b-a3b-fp8 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 2000 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + requests: + items: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the + same lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to + fine-tune the base model. + type: string + max_tokens: + default: 256 + description: >- + The maximum number of tokens to generate in the + response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: >- + The input text prompt for the model to generate a + response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must + adhere to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back + incrementally using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values + produce more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; + higher values introduce more variety and potential + surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by + controlling how many possible words it considers. + Lower values make outputs more predictable; higher + values allow for more varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the + conversation history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: >- + The name of the tool. More descriptive the + better. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: >- + A brief description of what the function + does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by + the function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object + (usually 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwen3-30b-a3b-fp8 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwen3-embedding-0.6b: + post: + description: Runs inference on the @cf/qwen/qwen3-embedding-0.6b model. + operationId: workers-ai-post-run-cf-qwen-qwen3-embedding-0-6b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + documents: + type: string + description: A single document string + items: + minLength: 1 + type: string + instruction: + default: >- + Given a web search query, retrieve relevant passages that + answer the query + description: Optional instruction for the task + type: string + queries: + type: string + description: A single query string + items: + minLength: 1 + type: string + text: + type: string + description: 'Alias for documents: a single text string' + items: + minLength: 1 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwen3-embedding-0.6b model. + tags: + - Workers AI Text Embeddings + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/qwen/qwq-32b: + post: + description: Runs inference on the @cf/qwen/qwq-32b model. + operationId: workers-ai-post-run-cf-qwen-qwq-32b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: 0 + type: number + guided_json: + description: JSON schema that should be fulfilled for the response. + type: object + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: 0 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.15 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 2 + minimum: 0 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL + will not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + type: object + properties: + image_url: + properties: + url: + description: >- + image uri with data (e.g. + data:image/jpeg;base64,/9j/...). HTTP URL will + not be accepted + type: string + type: object + text: + type: string + type: + description: Type of the content provided + type: string + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + tool_call_id: + description: >- + The tool call id. If you don't know what to put here + you can fall back to 000000001 + type: string + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/qwen/qwq-32b model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-img2img: + post: + description: Runs inference on the @cf/runwayml/stable-diffusion-v1-5-img2img model. + operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-img2img + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + guidance: + default: 7.5 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: >- + For use with img2img tasks. An array of integers that + represent the image data constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + image_b64: + description: >- + For use with img2img tasks. A base64-encoded string of the + input image + type: string + mask: + description: >- + An array representing An array of integers that represent + mask image data for inpainting constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 20 + type: integer + prompt: + description: A text description of the image you want to generate + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: >- + A value between 0 and 1 indicating how strongly to apply the + transformation during img2img tasks; lower values make the + output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + image/png: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/runwayml/stable-diffusion-v1-5-img2img model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-inpainting: + post: + description: >- + Runs inference on the @cf/runwayml/stable-diffusion-v1-5-inpainting + model. + operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-inpainting + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + guidance: + default: 7.5 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: >- + For use with img2img tasks. An array of integers that + represent the image data constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + image_b64: + description: >- + For use with img2img tasks. A base64-encoded string of the + input image + type: string + mask: + description: >- + An array representing An array of integers that represent + mask image data for inpainting constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 20 + type: integer + prompt: + description: A text description of the image you want to generate + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: >- + A value between 0 and 1 indicating how strongly to apply the + transformation during img2img tasks; lower values make the + output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + image/png: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/stabilityai/stable-diffusion-xl-base-1.0: + post: + description: >- + Runs inference on the @cf/stabilityai/stable-diffusion-xl-base-1.0 + model. + operationId: workers-ai-post-run-cf-stabilityai-stable-diffusion-xl-base-1-0 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + guidance: + default: 7.5 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: >- + For use with img2img tasks. An array of integers that + represent the image data constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + image_b64: + description: >- + For use with img2img tasks. A base64-encoded string of the + input image + type: string + mask: + description: >- + An array representing An array of integers that represent + mask image data for inpainting constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 20 + type: integer + prompt: + description: A text description of the image you want to generate + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: >- + A value between 0 and 1 indicating how strongly to apply the + transformation during img2img tasks; lower values make the + output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + required: + - prompt + type: object + responses: + '200': + content: + application/json: + schema: + type: object + image/png: + schema: + format: binary + type: string + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model. + tags: + - Workers AI Text To Image + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/thebloke/discolm-german-7b-v1-awq: + post: + description: Runs inference on the @cf/thebloke/discolm-german-7b-v1-awq model. + operationId: workers-ai-post-run-cf-thebloke-discolm-german-7b-v1-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/thebloke/discolm-german-7b-v1-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/tiiuae/falcon-7b-instruct: + post: + description: Runs inference on the @cf/tiiuae/falcon-7b-instruct model. + operationId: workers-ai-post-run-cf-tiiuae-falcon-7b-instruct + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/tiiuae/falcon-7b-instruct model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/tinyllama/tinyllama-1.1b-chat-v1.0: + post: + description: Runs inference on the @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model. + operationId: workers-ai-post-run-cf-tinyllama-tinyllama-1-1b-chat-v1-0 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@cf/zai-org/glm-4.7-flash: + post: + description: Runs inference on the @cf/zai-org/glm-4.7-flash model. + operationId: workers-ai-post-run-cf-zai-org-glm-4-7-flash + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + audio: + description: >- + Parameters for audio output. Required when modalities + includes 'audio'. + properties: + format: + enum: + - wav + - aac + - mp3 + - flac + - opus + - pcm16 + type: string + voice: + type: string + properties: + id: + type: string + required: + - id + required: + - voice + - format + type: object + chat_template_kwargs: + properties: + clear_thinking: + default: false + description: If false, preserves reasoning context between turns. + type: boolean + enable_thinking: + default: true + description: Whether to enable reasoning, enabled by default. + type: boolean + type: object + frequency_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + function_call: + type: string + enum: + - none + - auto + properties: + name: + type: string + required: + - name + functions: + items: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, described as a + JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + maxItems: 128 + minItems: 1 + type: array + logit_bias: + nullable: true + type: object + logprobs: + nullable: true + type: boolean + max_completion_tokens: + nullable: true + type: integer + max_tokens: + nullable: true + type: integer + metadata: + nullable: true + type: object + modalities: + items: + enum: + - text + - audio + type: string + nullable: true + type: array + model: + description: >- + ID of the model to use (e.g. '@cf/zai-org/glm-4.7-flash, + etc'). + type: string + 'n': + maximum: 128 + minimum: 1 + nullable: true + type: integer + parallel_tool_calls: + default: true + description: Whether to enable parallel function calling during tool use. + type: boolean + prediction: + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + type: + enum: + - content + type: string + required: + - type + - content + type: object + presence_penalty: + maximum: 2 + minimum: -2 + nullable: true + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + reasoning_effort: + enum: + - low + - medium + - high + nullable: true + type: string + response_format: + description: Specifies the format the model must output. + type: object + properties: + type: + enum: + - text + type: string + json_schema: + properties: + description: + type: string + name: + type: string + schema: + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + required: + - type + seed: + nullable: true + type: integer + service_tier: + enum: + - auto + - default + - flex + - scale + - priority + nullable: true + type: string + stop: + type: string + items: + type: string + store: + nullable: true + type: boolean + stream: + nullable: true + type: boolean + stream_options: + properties: + include_obfuscation: + type: boolean + include_usage: + type: boolean + type: object + temperature: + maximum: 2 + minimum: 0 + nullable: true + type: number + tool_choice: + description: >- + Controls which (if any) tool is called by the model. 'none' + = no tools, 'auto' = model decides, 'required' = must call a + tool. + type: string + enum: + - none + - auto + - required + properties: + function: + properties: + name: + type: string + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + name: + type: string + required: + - name + type: object + allowed_tools: + properties: + mode: + enum: + - auto + - required + type: string + tools: + items: + type: object + type: array + required: + - mode + - tools + type: object + required: + - type + tools: + description: A list of tools the model may call. + items: + type: object + properties: + function: + properties: + description: + description: A description of what the function does. + type: string + name: + description: The name of the function to be called. + type: string + parameters: + description: >- + The parameters the function accepts, described as + a JSON Schema object. + type: object + strict: + nullable: true + type: boolean + required: + - name + type: object + type: + enum: + - function + type: string + custom: + properties: + description: + type: string + format: + type: object + properties: + type: + enum: + - text + type: string + grammar: + properties: + definition: + type: string + syntax: + enum: + - lark + - regex + type: string + required: + - definition + - syntax + type: object + required: + - type + name: + type: string + required: + - name + type: object + required: + - type + type: array + top_logprobs: + maximum: 20 + minimum: 0 + nullable: true + type: integer + top_p: + maximum: 1 + minimum: 0 + nullable: true + type: number + user: + description: >- + A unique identifier representing your end-user, for abuse + monitoring. + type: string + web_search_options: + description: >- + Options for the web search tool (when using built-in web + search). + properties: + search_context_size: + default: medium + enum: + - low + - medium + - high + type: string + user_location: + properties: + approximate: + properties: + city: + type: string + country: + type: string + region: + type: string + timezone: + type: string + type: object + type: + enum: + - approximate + type: string + required: + - type + - approximate + type: object + type: object + messages: + description: A list of messages comprising the conversation so far. + items: + type: object + properties: + content: + type: string + items: + properties: + text: + type: string + type: + enum: + - text + type: string + required: + - type + - text + type: object + name: + type: string + role: + enum: + - developer + type: string + audio: + properties: + id: + type: string + required: + - id + type: object + function_call: + properties: + arguments: + type: string + name: + type: string + required: + - name + - arguments + type: object + refusal: + nullable: true + type: string + tool_calls: + items: + type: object + properties: + function: + properties: + arguments: + description: JSON-encoded arguments string. + type: string + name: + type: string + required: + - name + - arguments + type: object + id: + type: string + type: + enum: + - function + type: string + custom: + properties: + input: + type: string + name: + type: string + required: + - name + - input + type: object + required: + - id + - type + type: array + tool_call_id: + type: string + required: + - role + minItems: 1 + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @cf/zai-org/glm-4.7-flash model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/google/gemma-7b-it: + post: + description: Runs inference on the @hf/google/gemma-7b-it model. + operationId: workers-ai-post-run-hf-google-gemma-7b-it + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/google/gemma-7b-it model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/mistral/mistral-7b-instruct-v0.2: + post: + description: Runs inference on the @hf/mistral/mistral-7b-instruct-v0.2 model. + operationId: workers-ai-post-run-hf-mistral-mistral-7b-instruct-v0-2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/mistral/mistral-7b-instruct-v0.2 model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/nexusflow/starling-lm-7b-beta: + post: + description: Runs inference on the @hf/nexusflow/starling-lm-7b-beta model. + operationId: workers-ai-post-run-hf-nexusflow-starling-lm-7b-beta + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/nexusflow/starling-lm-7b-beta model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/nousresearch/hermes-2-pro-mistral-7b: + post: + description: Runs inference on the @hf/nousresearch/hermes-2-pro-mistral-7b model. + operationId: workers-ai-post-run-hf-nousresearch-hermes-2-pro-mistral-7b + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/nousresearch/hermes-2-pro-mistral-7b model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-base-awq: + post: + description: Runs inference on the @hf/thebloke/deepseek-coder-6.7b-base-awq model. + operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-base-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-instruct-awq: + post: + description: >- + Runs inference on the @hf/thebloke/deepseek-coder-6.7b-instruct-awq + model. + operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-instruct-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/thebloke/llama-2-13b-chat-awq: + post: + description: Runs inference on the @hf/thebloke/llama-2-13b-chat-awq model. + operationId: workers-ai-post-run-hf-thebloke-llama-2-13b-chat-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/thebloke/llama-2-13b-chat-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/thebloke/mistral-7b-instruct-v0.1-awq: + post: + description: Runs inference on the @hf/thebloke/mistral-7b-instruct-v0.1-awq model. + operationId: workers-ai-post-run-hf-thebloke-mistral-7b-instruct-v0-1-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/thebloke/neural-chat-7b-v3-1-awq: + post: + description: Runs inference on the @hf/thebloke/neural-chat-7b-v3-1-awq model. + operationId: workers-ai-post-run-hf-thebloke-neural-chat-7b-v3-1-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/thebloke/neural-chat-7b-v3-1-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq: + post: + description: Runs inference on the @hf/thebloke/openhermes-2.5-mistral-7b-awq model. + operationId: workers-ai-post-run-hf-thebloke-openhermes-2-5-mistral-7b-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/@hf/thebloke/zephyr-7b-beta-awq: + post: + description: Runs inference on the @hf/thebloke/zephyr-7b-beta-awq model. + operationId: workers-ai-post-run-hf-thebloke-zephyr-7b-beta-awq + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: queueRequest + schema: + type: string + x-auditable: true + - in: query + name: tags + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: Prompt + properties: + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + prompt: + description: The input text prompt for the model to generate a response. + minLength: 1 + type: string + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + seed: + description: Random seed for reproducibility of the generation. + maximum: 9999999999 + minimum: 1 + type: integer + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + required: [] + responses: + '200': + content: + application/json: + schema: + type: object + text/event-stream: + schema: + type: object + description: Object with user data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: string + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - errors + - success + - result + type: object + description: Bad request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute @hf/thebloke/zephyr-7b-beta-awq model. + tags: + - Workers AI Text Generation + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/run/{model_name}: + post: + description: >- + This endpoint provides users with the capability to run specific AI + models on-demand. By submitting the required input data, users can + receive real-time predictions or results generated by the chosen AI + model. The endpoint supports various AI model types, ensuring + flexibility and adaptability for diverse use cases. Model specific + inputs available in [Cloudflare + Docs](https://developers.cloudflare.com/workers-ai/models/). + operationId: workers-ai-post-run-model + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: model_name + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + type: object + title: Text Classification + properties: + text: + description: The text that you want to classify + minLength: 1 + type: string + guidance: + default: 7.5 + description: >- + Controls how closely the generated image should adhere to + the prompt; higher values make the image more aligned with + the prompt + type: number + height: + description: The height of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + image: + description: >- + For use with img2img tasks. An array of integers that + represent the image data constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + image_b64: + description: >- + For use with img2img tasks. A base64-encoded string of the + input image + type: string + mask: + description: >- + An array representing An array of integers that represent + mask image data for inpainting constrained to 8-bit unsigned + integer values + items: + description: A value between 0 and 255 + type: number + type: array + negative_prompt: + description: Text describing elements to avoid in the generated image + type: string + num_steps: + default: 20 + description: >- + The number of diffusion steps; higher values can improve + quality but take longer + maximum: 20 + type: integer + prompt: + description: A text description of the image you want to generate + minLength: 1 + type: string + seed: + description: Random seed for reproducibility of the image generation + type: integer + strength: + default: 1 + description: >- + A value between 0 and 1 indicating how strongly to apply the + transformation during img2img tasks; lower values make the + output closer to the input image + type: number + width: + description: The width of the generated image in pixels + maximum: 2048 + minimum: 256 + type: integer + lang: + default: en + description: >- + The speech language (e.g., 'en' for English, 'fr' for + French). Defaults to 'en' if not specified + type: string + audio: + description: >- + An array of integers that represent the audio data + constrained to 8-bit unsigned integer values + items: + description: A value between 0 and 255 + type: number + type: array + source_lang: + description: The language of the recorded audio + type: string + target_lang: + description: >- + The language to translate the transcription into. Currently + only English is supported. + type: string + frequency_penalty: + description: >- + Decreases the likelihood of the model repeating the same + lines verbatim. + maximum: 2 + minimum: -2 + type: number + lora: + description: >- + Name of the LoRA (Low-Rank Adaptation) model to fine-tune + the base model. + type: string + max_tokens: + default: 256 + description: The maximum number of tokens to generate in the response. + type: integer + presence_penalty: + description: >- + Increases the likelihood of the model introducing new + topics. + maximum: 2 + minimum: -2 + type: number + raw: + default: false + description: >- + If true, a chat template is not applied and you must adhere + to the specific model's expected formatting. + type: boolean + repetition_penalty: + description: >- + Penalty for repeated tokens; higher values discourage + repetition. + maximum: 2 + minimum: 0 + type: number + response_format: + properties: + json_schema: {} + type: + enum: + - json_object + - json_schema + type: string + title: JSON Mode + type: object + stream: + default: false + description: >- + If true, the response will be streamed back incrementally + using SSE, Server Sent Events. + type: boolean + temperature: + default: 0.6 + description: >- + Controls the randomness of the output; higher values produce + more random results. + maximum: 5 + minimum: 0 + type: number + top_k: + description: >- + Limits the AI to choose from the top 'k' most probable + words. Lower values make responses more focused; higher + values introduce more variety and potential surprises. + maximum: 50 + minimum: 1 + type: integer + top_p: + description: >- + Adjusts the creativity of the AI's responses by controlling + how many possible words it considers. Lower values make + outputs more predictable; higher values allow for more + varied and creative responses. + maximum: 1 + minimum: 0.001 + type: number + functions: + items: + properties: + code: + type: string + name: + type: string + required: + - name + - code + type: object + type: array + messages: + description: >- + An array of message objects representing the conversation + history. + items: + properties: + content: + type: string + description: The content of the message as a string. + items: + properties: + text: + description: Text content + type: string + type: + description: Type of the content (text) + type: string + type: object + role: + description: >- + The role of the message sender (e.g., 'user', + 'assistant', 'system', 'tool'). + type: string + required: + - role + - content + type: object + type: array + tools: + description: A list of tools available for the assistant to use. + items: + type: object + properties: + description: + description: A brief description of what the tool does. + type: string + name: + description: The name of the tool. More descriptive the better. + type: string + parameters: + description: Schema defining the parameters accepted by the tool. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + function: + description: Details of the function tool. + properties: + description: + description: A brief description of what the function does. + type: string + name: + description: The name of the function. + type: string + parameters: + description: >- + Schema defining the parameters accepted by the + function. + properties: + properties: + description: Definitions of each parameter. + type: object + required: + description: List of required parameter names. + items: + type: string + type: array + type: + description: >- + The type of the parameters object (usually + 'object'). + type: string + required: + - type + - properties + type: object + required: + - name + - description + - parameters + type: object + type: + description: Specifies the type of tool (e.g., 'function'). + type: string + required: [] + type: array + input_text: + description: The text that you want the model to summarize + minLength: 1 + type: string + max_length: + default: 1024 + description: The maximum length of the generated summary in tokens + type: integer + ignore_eos: + description: >- + Whether to ignore the EOS token and continue generating + tokens after the EOS token is generated. + type: boolean + required: [] + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + title: Text Classification + description: An array of classification results for the input text + items: + properties: + label: + description: >- + The classification label assigned to the text (e.g., + 'POSITIVE' or 'NEGATIVE') + type: string + score: + description: >- + Confidence score indicating the likelihood that the + text belongs to the specified label + type: number + type: object + format: binary + properties: + audio: + description: The generated audio in MP3 format, base64-encoded + type: string + data: + description: Embeddings of the requested text values + items: + description: >- + Floating point embedding representation shaped by + the embedding model + items: + type: number + type: array + type: array + shape: + items: + type: number + type: array + text: + description: The transcription + type: string + vtt: + type: string + word_count: + type: number + words: + items: + properties: + end: + description: The ending second when the word completes + type: number + start: + description: The second this word begins in the recording + type: number + word: + type: string + type: object + type: array + response: + description: The generated text response from the model + type: string + tool_calls: + description: >- + An array of tool calls requests made during the + response generation + items: + properties: + arguments: + description: >- + The arguments passed to be passed to the tool + call request + type: object + name: + description: The name of the tool to be called + type: string + type: object + type: array + usage: + description: Usage statistics for the inference request + properties: + completion_tokens: + default: 0 + description: Total number of tokens in output + type: number + prompt_tokens: + default: 0 + description: Total number of tokens in input + type: number + total_tokens: + default: 0 + description: Total number of input and output tokens + type: number + type: object + translated_text: + description: The translated text in the target language + type: string + summary: + description: The summarized version of the input text + type: string + description: + type: string + required: [] + type: object + description: Model response + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Execute AI model + tags: + - Workers AI + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: [] + method: run + /accounts/{account_id}/ai/tasks/search: + get: + description: >- + Searches Workers AI models by task type (e.g., text-generation, + embeddings). + operationId: workers-ai-search-task + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + type: array + messages: + items: + type: string + type: array + result: + items: + type: object + type: array + success: + type: boolean + x-auditable: true + required: + - success + - result + - errors + - messages + type: object + description: Returns a list of tasks + '404': + content: + application/json: + schema: + properties: + errors: + items: + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Object not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Task Search + tags: + - Workers AI + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - tasks + method: list + /accounts/{account_id}/ai/tomarkdown: + post: + description: Converts uploaded files into Markdown format using Workers AI. + operationId: workers-ai-post-to-markdown + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + files: + items: + format: binary + type: string + type: array + required: + - files + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + data: + type: string + x-auditable: true + format: + type: string + x-auditable: true + mimeType: + type: string + x-auditable: true + name: + type: string + x-auditable: true + tokens: + type: string + x-auditable: true + required: + - name + - mimeType + - format + - tokens + - data + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: Model Schema + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Convert Files into Markdown + tags: + - Workers AI + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai/tomarkdown/supported: + get: + description: Lists all file formats supported for conversion to Markdown. + operationId: workers-ai-get-to-markdown-supported + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + extension: + type: string + x-auditable: true + mimeType: + type: string + x-auditable: true + required: + - extension + - mimeType + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: Successful response + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get all converted formats supported + tags: + - Workers AI + x-api-token-group: + - Workers AI Write + - Workers AI Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai + resource_chain: + - to_markdown + method: supported + /accounts/{account_id}/autorag/rags/{id}/ai-search: + post: + operationId: autorag-config-ai-search + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + filters: + type: object + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + filters: + items: + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + required: + - key + - type + - value + type: object + type: array + required: + - type + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + query: + type: string + ranking_options: + default: {} + properties: + ranker: + type: string + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + type: object + reranking: + properties: + enabled: + default: false + type: boolean + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + rewrite_query: + default: false + type: boolean + stream: + default: false + type: boolean + system_prompt: + type: string + required: + - query + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + data: + items: + properties: + attributes: + type: object + content: + items: + properties: + text: + type: string + type: + type: string + type: object + type: array + file_id: + type: string + filename: + type: string + score: + type: number + required: + - score + type: object + type: array + has_more: + default: false + type: boolean + next_page: + nullable: true + type: string + object: + type: string + response: + type: string + search_query: + type: string + required: + - search_query + - response + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the log details + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: AI Search + tags: + - AutoRAG RAG Search + x-api-token-group: + - Auto Rag Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.rag + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/autorag/rags/{id}/files: + get: + operationId: autorag-config-files + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + - in: query + name: search + schema: + type: string + - in: query + name: status + schema: + enum: + - completed + - queued + - running + - error + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + error: + type: string + key: + type: string + required: + - key + - error + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + default: 20 + maximum: 50 + minimum: 5 + type: integer + total_count: + type: integer + required: + - count + - page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns the AI Search files + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: autorag_not_found + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: unable_to_connect_to_autorag + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Files + tags: + - AutoRAG RAG + x-api-token-group: + - Auto Rag Write + - Auto Rag Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.rag + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/autorag/rags/{id}/jobs: + get: + operationId: autorag-config-list-jobs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + end_reason: + type: string + ended_at: + type: string + id: + type: string + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + started_at: + type: string + required: + - id + - source + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AutoRAG Jobs + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: autorag_not_found + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: unable_to_connect_to_autorag + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Jobs + tags: + - AutoRAG Jobs + x-api-token-group: + - Auto Rag Write + - Auto Rag Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.rag + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}: + get: + operationId: autorag-config-get-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + end_reason: + type: string + ended_at: + type: string + id: + type: string + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AutoRAG Job Details + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: job_not_found + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: unable_to_connect_to_autorag + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Job Details + tags: + - AutoRAG Jobs + x-api-token-group: + - Auto Rag Write + - Auto Rag Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.rag + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}/logs: + get: + operationId: autorag-config-list-job-logs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 500 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + type: number + readOnly: true + id: + type: integer + message: + type: string + message_type: + type: integer + required: + - id + - message + - message_type + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AutoRAG Job Logs + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: autorag_not_found + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: unable_to_connect_to_autorag + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Job Logs + tags: + - AutoRAG Jobs + x-api-token-group: + - Auto Rag Write + - Auto Rag Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.rag + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/autorag/rags/{id}/search: + post: + operationId: autorag-config-search + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + filters: + type: object + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + filters: + items: + properties: + key: + type: string + type: + enum: + - eq + - ne + - gt + - gte + - lt + - lte + type: string + value: + type: string + required: + - key + - type + - value + type: object + type: array + required: + - type + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + query: + type: string + ranking_options: + default: {} + properties: + ranker: + type: string + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + type: object + reranking: + properties: + enabled: + default: false + type: boolean + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + rewrite_query: + default: false + type: boolean + required: + - query + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + data: + items: + properties: + attributes: + type: object + content: + items: + properties: + text: + type: string + type: + type: string + type: object + type: array + file_id: + type: string + filename: + type: string + score: + type: number + required: + - score + type: object + type: array + has_more: + default: false + type: boolean + next_page: + nullable: true + type: string + object: + type: string + search_query: + type: string + required: + - search_query + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the log details + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search + tags: + - AutoRAG RAG Search + x-api-token-group: + - Auto Rag Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.rag + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/autorag/rags/{id}/sync: + patch: + operationId: autorag-config-sync + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + job_id: + type: string + required: + - job_id + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the autorag sync status + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: autorag_is_paused + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: autorag_not_found + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: sync_in_cooldown + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: unable_to_connect_to_autorag + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Sync + tags: + - AutoRAG RAG + x-api-token-group: + - Auto Rag Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.rag + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true +components: + schemas: {} + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + authors: + id: cloudflare.ai.authors + name: authors + title: Authors + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1authors~1search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/authors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + finetunes: + id: cloudflare.ai.finetunes + name: finetunes + title: Finetunes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/finetunes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/finetunes/methods/create' + update: [] + delete: [] + replace: [] + public: + id: cloudflare.ai.public + name: public + title: Public + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1finetunes~1public/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/public/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + assets: + id: cloudflare.ai.assets + name: assets + title: Assets + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1finetunes~1{finetune_id}~1finetune-assets/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/assets/methods/create' + update: [] + delete: [] + replace: [] + schema: + id: cloudflare.ai.schema + name: schema + title: Schema + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1models~1schema/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schema/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + models: + id: cloudflare.ai.models + name: models + title: Models + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1models~1search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/models/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + indictrans2_en_indic_1_b: + id: cloudflare.ai.indictrans2_en_indic_1_b + name: indictrans2_en_indic_1_b + title: Indictrans2 En Indic 1 B + methods: + workers_ai_post_run_cf_ai4bharat_indictrans2_en_indic_1_b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1ai4bharat~1indictrans2-en-indic-1B/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/indictrans2_en_indic_1_b/methods/workers_ai_post_run_cf_ai4bharat_indictrans2_en_indic_1_b + update: [] + delete: [] + replace: [] + nonomni_indictrans2_en_indic_1b: + id: cloudflare.ai.nonomni_indictrans2_en_indic_1b + name: nonomni_indictrans2_en_indic_1b + title: Nonomni Indictrans2 En Indic 1b + methods: + workers_ai_post_run_cf_ai4bharat_nonomni_indictrans2_en_indic_1b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1ai4bharat~1nonomni-indictrans2-en-indic-1b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_indictrans2_en_indic_1b/methods/workers_ai_post_run_cf_ai4bharat_nonomni_indictrans2_en_indic_1b + update: [] + delete: [] + replace: [] + gemma_sea_lion_v4_27b_it: + id: cloudflare.ai.gemma_sea_lion_v4_27b_it + name: gemma_sea_lion_v4_27b_it + title: Gemma Sea Lion V4 27b It + methods: + workers_ai_post_run_cf_aisingapore_gemma_sea_lion_v4_27b_it: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1aisingapore~1gemma-sea-lion-v4-27b-it/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/gemma_sea_lion_v4_27b_it/methods/workers_ai_post_run_cf_aisingapore_gemma_sea_lion_v4_27b_it + update: [] + delete: [] + replace: [] + bge_base_en_v1_5: + id: cloudflare.ai.bge_base_en_v1_5 + name: bge_base_en_v1_5 + title: Bge Base En V1 5 + methods: + workers_ai_post_run_cf_baai_bge_base_en_v1_5: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-base-en-v1.5/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bge_base_en_v1_5/methods/workers_ai_post_run_cf_baai_bge_base_en_v1_5 + update: [] + delete: [] + replace: [] + bge_large_en_v1_5: + id: cloudflare.ai.bge_large_en_v1_5 + name: bge_large_en_v1_5 + title: Bge Large En V1 5 + methods: + workers_ai_post_run_cf_baai_bge_large_en_v1_5: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-large-en-v1.5/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bge_large_en_v1_5/methods/workers_ai_post_run_cf_baai_bge_large_en_v1_5 + update: [] + delete: [] + replace: [] + bge_m3: + id: cloudflare.ai.bge_m3 + name: bge_m3 + title: Bge M3 + methods: + workers_ai_post_run_cf_baai_bge_m3: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-m3/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bge_m3/methods/workers_ai_post_run_cf_baai_bge_m3 + update: [] + delete: [] + replace: [] + bge_reranker_base: + id: cloudflare.ai.bge_reranker_base + name: bge_reranker_base + title: Bge Reranker Base + methods: + workers_ai_post_run_cf_baai_bge_reranker_base: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-reranker-base/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bge_reranker_base/methods/workers_ai_post_run_cf_baai_bge_reranker_base + update: [] + delete: [] + replace: [] + bge_small_en_v1_5: + id: cloudflare.ai.bge_small_en_v1_5 + name: bge_small_en_v1_5 + title: Bge Small En V1 5 + methods: + workers_ai_post_run_cf_baai_bge_small_en_v1_5: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1bge-small-en-v1.5/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bge_small_en_v1_5/methods/workers_ai_post_run_cf_baai_bge_small_en_v1_5 + update: [] + delete: [] + replace: [] + nonomni_bge_base_en_v1_5: + id: cloudflare.ai.nonomni_bge_base_en_v1_5 + name: nonomni_bge_base_en_v1_5 + title: Nonomni Bge Base En V1 5 + methods: + workers_ai_post_run_cf_baai_nonomni_bge_base_en_v1_5: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-base-en-v1.5/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_bge_base_en_v1_5/methods/workers_ai_post_run_cf_baai_nonomni_bge_base_en_v1_5 + update: [] + delete: [] + replace: [] + nonomni_bge_large_en_v1_5: + id: cloudflare.ai.nonomni_bge_large_en_v1_5 + name: nonomni_bge_large_en_v1_5 + title: Nonomni Bge Large En V1 5 + methods: + workers_ai_post_run_cf_baai_nonomni_bge_large_en_v1_5: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-large-en-v1.5/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_bge_large_en_v1_5/methods/workers_ai_post_run_cf_baai_nonomni_bge_large_en_v1_5 + update: [] + delete: [] + replace: [] + nonomni_bge_m3: + id: cloudflare.ai.nonomni_bge_m3 + name: nonomni_bge_m3 + title: Nonomni Bge M3 + methods: + workers_ai_post_run_cf_baai_nonomni_bge_m3: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-m3/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_bge_m3/methods/workers_ai_post_run_cf_baai_nonomni_bge_m3 + update: [] + delete: [] + replace: [] + nonomni_bge_small_en_v1_5: + id: cloudflare.ai.nonomni_bge_small_en_v1_5 + name: nonomni_bge_small_en_v1_5 + title: Nonomni Bge Small En V1 5 + methods: + workers_ai_post_run_cf_baai_nonomni_bge_small_en_v1_5: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1baai~1nonomni-bge-small-en-v1.5/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_bge_small_en_v1_5/methods/workers_ai_post_run_cf_baai_nonomni_bge_small_en_v1_5 + update: [] + delete: [] + replace: [] + flux_1_schnell: + id: cloudflare.ai.flux_1_schnell + name: flux_1_schnell + title: Flux 1 Schnell + methods: + workers_ai_post_run_cf_black_forest_labs_flux_1_schnell: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-1-schnell/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/flux_1_schnell/methods/workers_ai_post_run_cf_black_forest_labs_flux_1_schnell + update: [] + delete: [] + replace: [] + flux_2_dev: + id: cloudflare.ai.flux_2_dev + name: flux_2_dev + title: Flux 2 Dev + methods: + workers_ai_post_run_cf_black_forest_labs_flux_2_dev: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-2-dev/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/flux_2_dev/methods/workers_ai_post_run_cf_black_forest_labs_flux_2_dev + update: [] + delete: [] + replace: [] + flux_2_klein_4b: + id: cloudflare.ai.flux_2_klein_4b + name: flux_2_klein_4b + title: Flux 2 Klein 4b + methods: + workers_ai_post_run_cf_black_forest_labs_flux_2_klein_4b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-2-klein-4b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/flux_2_klein_4b/methods/workers_ai_post_run_cf_black_forest_labs_flux_2_klein_4b + update: [] + delete: [] + replace: [] + flux_2_klein_9b: + id: cloudflare.ai.flux_2_klein_9b + name: flux_2_klein_9b + title: Flux 2 Klein 9b + methods: + workers_ai_post_run_cf_black_forest_labs_flux_2_klein_9b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1black-forest-labs~1flux-2-klein-9b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/flux_2_klein_9b/methods/workers_ai_post_run_cf_black_forest_labs_flux_2_klein_9b + update: [] + delete: [] + replace: [] + stable_diffusion_xl_lightning: + id: cloudflare.ai.stable_diffusion_xl_lightning + name: stable_diffusion_xl_lightning + title: Stable Diffusion Xl Lightning + methods: + workers_ai_post_run_cf_bytedance_stable_diffusion_xl_lightning: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1bytedance~1stable-diffusion-xl-lightning/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/stable_diffusion_xl_lightning/methods/workers_ai_post_run_cf_bytedance_stable_diffusion_xl_lightning + update: [] + delete: [] + replace: [] + aura_1: + id: cloudflare.ai.aura_1 + name: aura_1 + title: Aura 1 + methods: + workers_ai_post_run_cf_deepgram_aura_1: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1aura-1/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/aura_1/methods/workers_ai_post_run_cf_deepgram_aura_1 + update: [] + delete: [] + replace: [] + aura_2_en: + id: cloudflare.ai.aura_2_en + name: aura_2_en + title: Aura 2 En + methods: + workers_ai_post_run_cf_deepgram_aura_2_en: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1aura-2-en/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/aura_2_en/methods/workers_ai_post_run_cf_deepgram_aura_2_en + update: [] + delete: [] + replace: [] + aura_2_es: + id: cloudflare.ai.aura_2_es + name: aura_2_es + title: Aura 2 Es + methods: + workers_ai_post_run_cf_deepgram_aura_2_es: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1aura-2-es/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/aura_2_es/methods/workers_ai_post_run_cf_deepgram_aura_2_es + update: [] + delete: [] + replace: [] + flux: + id: cloudflare.ai.flux + name: flux + title: Flux + methods: + workers_ai_post_run_cf_deepgram_flux: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1flux/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/flux/methods/workers_ai_post_run_cf_deepgram_flux + update: [] + delete: [] + replace: [] + nova_3: + id: cloudflare.ai.nova_3 + name: nova_3 + title: Nova 3 + methods: + workers_ai_post_run_cf_deepgram_nova_3: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepgram~1nova-3/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nova_3/methods/workers_ai_post_run_cf_deepgram_nova_3 + update: [] + delete: [] + replace: [] + deepseek_math_7b_instruct: + id: cloudflare.ai.deepseek_math_7b_instruct + name: deepseek_math_7b_instruct + title: Deepseek Math 7b Instruct + methods: + workers_ai_post_run_cf_deepseek_ai_deepseek_math_7b_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepseek-ai~1deepseek-math-7b-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/deepseek_math_7b_instruct/methods/workers_ai_post_run_cf_deepseek_ai_deepseek_math_7b_instruct + update: [] + delete: [] + replace: [] + deepseek_r1_distill_qwen_32b: + id: cloudflare.ai.deepseek_r1_distill_qwen_32b + name: deepseek_r1_distill_qwen_32b + title: Deepseek R1 Distill Qwen 32b + methods: + workers_ai_post_run_cf_deepseek_ai_deepseek_r1_distill_qwen_32b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1deepseek-ai~1deepseek-r1-distill-qwen-32b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/deepseek_r1_distill_qwen_32b/methods/workers_ai_post_run_cf_deepseek_ai_deepseek_r1_distill_qwen_32b + update: [] + delete: [] + replace: [] + sqlcoder_7b_2: + id: cloudflare.ai.sqlcoder_7b_2 + name: sqlcoder_7b_2 + title: Sqlcoder 7b 2 + methods: + workers_ai_post_run_cf_defog_sqlcoder_7b_2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1defog~1sqlcoder-7b-2/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/sqlcoder_7b_2/methods/workers_ai_post_run_cf_defog_sqlcoder_7b_2 + update: [] + delete: [] + replace: [] + bart_large_cnn: + id: cloudflare.ai.bart_large_cnn + name: bart_large_cnn + title: Bart Large Cnn + methods: + workers_ai_post_run_cf_facebook_bart_large_cnn: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1facebook~1bart-large-cnn/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bart_large_cnn/methods/workers_ai_post_run_cf_facebook_bart_large_cnn + update: [] + delete: [] + replace: [] + nonomni_bart_large_cnn: + id: cloudflare.ai.nonomni_bart_large_cnn + name: nonomni_bart_large_cnn + title: Nonomni Bart Large Cnn + methods: + workers_ai_post_run_cf_facebook_nonomni_bart_large_cnn: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1facebook~1nonomni-bart-large-cnn/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_bart_large_cnn/methods/workers_ai_post_run_cf_facebook_nonomni_bart_large_cnn + update: [] + delete: [] + replace: [] + nonomni_detr_resnet_50: + id: cloudflare.ai.nonomni_detr_resnet_50 + name: nonomni_detr_resnet_50 + title: Nonomni Detr Resnet 50 + methods: + workers_ai_post_run_cf_facebook_nonomni_detr_resnet_50: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1facebook~1nonomni-detr-resnet-50/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_detr_resnet_50/methods/workers_ai_post_run_cf_facebook_nonomni_detr_resnet_50 + update: [] + delete: [] + replace: [] + una_cybertron_7b_v2_bf16: + id: cloudflare.ai.una_cybertron_7b_v2_bf16 + name: una_cybertron_7b_v2_bf16 + title: Una Cybertron 7b V2 Bf16 + methods: + workers_ai_post_run_cf_fblgit_una_cybertron_7b_v2_bf16: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1fblgit~1una-cybertron-7b-v2-bf16/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/una_cybertron_7b_v2_bf16/methods/workers_ai_post_run_cf_fblgit_una_cybertron_7b_v2_bf16 + update: [] + delete: [] + replace: [] + embeddinggemma_300m: + id: cloudflare.ai.embeddinggemma_300m + name: embeddinggemma_300m + title: Embeddinggemma 300m + methods: + workers_ai_post_run_cf_google_embeddinggemma_300m: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1embeddinggemma-300m/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/embeddinggemma_300m/methods/workers_ai_post_run_cf_google_embeddinggemma_300m + update: [] + delete: [] + replace: [] + gemma_2b_it_lora: + id: cloudflare.ai.gemma_2b_it_lora + name: gemma_2b_it_lora + title: Gemma 2b It Lora + methods: + workers_ai_post_run_cf_google_gemma_2b_it_lora: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1gemma-2b-it-lora/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/gemma_2b_it_lora/methods/workers_ai_post_run_cf_google_gemma_2b_it_lora + update: [] + delete: [] + replace: [] + gemma_3_12b_it: + id: cloudflare.ai.gemma_3_12b_it + name: gemma_3_12b_it + title: Gemma 3 12b It + methods: + workers_ai_post_run_cf_google_gemma_3_12b_it: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1gemma-3-12b-it/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/gemma_3_12b_it/methods/workers_ai_post_run_cf_google_gemma_3_12b_it + update: [] + delete: [] + replace: [] + gemma_7b_it_lora: + id: cloudflare.ai.gemma_7b_it_lora + name: gemma_7b_it_lora + title: Gemma 7b It Lora + methods: + workers_ai_post_run_cf_google_gemma_7b_it_lora: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1gemma-7b-it-lora/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/gemma_7b_it_lora/methods/workers_ai_post_run_cf_google_gemma_7b_it_lora + update: [] + delete: [] + replace: [] + nonomni_embeddinggemma_300m: + id: cloudflare.ai.nonomni_embeddinggemma_300m + name: nonomni_embeddinggemma_300m + title: Nonomni Embeddinggemma 300m + methods: + workers_ai_post_run_cf_google_nonomni_embeddinggemma_300m: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1google~1nonomni-embeddinggemma-300m/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_embeddinggemma_300m/methods/workers_ai_post_run_cf_google_nonomni_embeddinggemma_300m + update: [] + delete: [] + replace: [] + distilbert_sst_2_int8: + id: cloudflare.ai.distilbert_sst_2_int8 + name: distilbert_sst_2_int8 + title: Distilbert Sst 2 Int8 + methods: + workers_ai_post_run_cf_huggingface_distilbert_sst_2_int8: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1huggingface~1distilbert-sst-2-int8/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/distilbert_sst_2_int8/methods/workers_ai_post_run_cf_huggingface_distilbert_sst_2_int8 + update: [] + delete: [] + replace: [] + nonomni_distilbert_sst_2_int8: + id: cloudflare.ai.nonomni_distilbert_sst_2_int8 + name: nonomni_distilbert_sst_2_int8 + title: Nonomni Distilbert Sst 2 Int8 + methods: + workers_ai_post_run_cf_huggingface_nonomni_distilbert_sst_2_int8: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1huggingface~1nonomni-distilbert-sst-2-int8/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_distilbert_sst_2_int8/methods/workers_ai_post_run_cf_huggingface_nonomni_distilbert_sst_2_int8 + update: [] + delete: [] + replace: [] + granite_4_0_h_micro: + id: cloudflare.ai.granite_4_0_h_micro + name: granite_4_0_h_micro + title: Granite 4 0 H Micro + methods: + workers_ai_post_run_cf_ibm_granite_granite_4_0_h_micro: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1ibm-granite~1granite-4.0-h-micro/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/granite_4_0_h_micro/methods/workers_ai_post_run_cf_ibm_granite_granite_4_0_h_micro + update: [] + delete: [] + replace: [] + lucid_origin: + id: cloudflare.ai.lucid_origin + name: lucid_origin + title: Lucid Origin + methods: + workers_ai_post_run_cf_leonardo_lucid_origin: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1leonardo~1lucid-origin/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/lucid_origin/methods/workers_ai_post_run_cf_leonardo_lucid_origin + update: [] + delete: [] + replace: [] + phoenix_1_0: + id: cloudflare.ai.phoenix_1_0 + name: phoenix_1_0 + title: Phoenix 1 0 + methods: + workers_ai_post_run_cf_leonardo_phoenix_1_0: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1leonardo~1phoenix-1.0/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/phoenix_1_0/methods/workers_ai_post_run_cf_leonardo_phoenix_1_0 + update: [] + delete: [] + replace: [] + dreamshaper_8_lcm: + id: cloudflare.ai.dreamshaper_8_lcm + name: dreamshaper_8_lcm + title: Dreamshaper 8 Lcm + methods: + workers_ai_post_run_cf_lykon_dreamshaper_8_lcm: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1lykon~1dreamshaper-8-lcm/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/dreamshaper_8_lcm/methods/workers_ai_post_run_cf_lykon_dreamshaper_8_lcm + update: [] + delete: [] + replace: [] + llama_2_7b_chat_hf_lora: + id: cloudflare.ai.llama_2_7b_chat_hf_lora + name: llama_2_7b_chat_hf_lora + title: Llama 2 7b Chat Hf Lora + methods: + workers_ai_post_run_cf_meta_llama_llama_2_7b_chat_hf_lora: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta-llama~1llama-2-7b-chat-hf-lora/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_2_7b_chat_hf_lora/methods/workers_ai_post_run_cf_meta_llama_llama_2_7b_chat_hf_lora + update: [] + delete: [] + replace: [] + llama_2_7b_chat_fp16: + id: cloudflare.ai.llama_2_7b_chat_fp16 + name: llama_2_7b_chat_fp16 + title: Llama 2 7b Chat Fp16 + methods: + workers_ai_post_run_cf_meta_llama_2_7b_chat_fp16: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-2-7b-chat-fp16/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_2_7b_chat_fp16/methods/workers_ai_post_run_cf_meta_llama_2_7b_chat_fp16 + update: [] + delete: [] + replace: [] + llama_2_7b_chat_int8: + id: cloudflare.ai.llama_2_7b_chat_int8 + name: llama_2_7b_chat_int8 + title: Llama 2 7b Chat Int8 + methods: + workers_ai_post_run_cf_meta_llama_2_7b_chat_int8: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-2-7b-chat-int8/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_2_7b_chat_int8/methods/workers_ai_post_run_cf_meta_llama_2_7b_chat_int8 + update: [] + delete: [] + replace: [] + llama_3_8b_instruct: + id: cloudflare.ai.llama_3_8b_instruct + name: llama_3_8b_instruct + title: Llama 3 8b Instruct + methods: + workers_ai_post_run_cf_meta_llama_3_8b_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3-8b-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_8b_instruct/methods/workers_ai_post_run_cf_meta_llama_3_8b_instruct + update: [] + delete: [] + replace: [] + llama_3_8b_instruct_awq: + id: cloudflare.ai.llama_3_8b_instruct_awq + name: llama_3_8b_instruct_awq + title: Llama 3 8b Instruct Awq + methods: + workers_ai_post_run_cf_meta_llama_3_8b_instruct_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3-8b-instruct-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_8b_instruct_awq/methods/workers_ai_post_run_cf_meta_llama_3_8b_instruct_awq + update: [] + delete: [] + replace: [] + llama_3_1_70b_instruct_fp8_fast: + id: cloudflare.ai.llama_3_1_70b_instruct_fp8_fast + name: llama_3_1_70b_instruct_fp8_fast + title: Llama 3 1 70b Instruct Fp8 Fast + methods: + workers_ai_post_run_cf_meta_llama_3_1_70b_instruct_fp8_fast: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-70b-instruct-fp8-fast/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_1_70b_instruct_fp8_fast/methods/workers_ai_post_run_cf_meta_llama_3_1_70b_instruct_fp8_fast + update: [] + delete: [] + replace: [] + llama_3_1_8b_instruct_awq: + id: cloudflare.ai.llama_3_1_8b_instruct_awq + name: llama_3_1_8b_instruct_awq + title: Llama 3 1 8b Instruct Awq + methods: + workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-8b-instruct-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_1_8b_instruct_awq/methods/workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_awq + update: [] + delete: [] + replace: [] + llama_3_1_8b_instruct_fp8: + id: cloudflare.ai.llama_3_1_8b_instruct_fp8 + name: llama_3_1_8b_instruct_fp8 + title: Llama 3 1 8b Instruct Fp8 + methods: + workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-8b-instruct-fp8/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_1_8b_instruct_fp8/methods/workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8 + update: [] + delete: [] + replace: [] + llama_3_1_8b_instruct_fp8_fast: + id: cloudflare.ai.llama_3_1_8b_instruct_fp8_fast + name: llama_3_1_8b_instruct_fp8_fast + title: Llama 3 1 8b Instruct Fp8 Fast + methods: + workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8_fast: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.1-8b-instruct-fp8-fast/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_1_8b_instruct_fp8_fast/methods/workers_ai_post_run_cf_meta_llama_3_1_8b_instruct_fp8_fast + update: [] + delete: [] + replace: [] + llama_3_2_11b_vision_instruct: + id: cloudflare.ai.llama_3_2_11b_vision_instruct + name: llama_3_2_11b_vision_instruct + title: Llama 3 2 11b Vision Instruct + methods: + workers_ai_post_run_cf_meta_llama_3_2_11b_vision_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.2-11b-vision-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_2_11b_vision_instruct/methods/workers_ai_post_run_cf_meta_llama_3_2_11b_vision_instruct + update: [] + delete: [] + replace: [] + llama_3_2_1b_instruct: + id: cloudflare.ai.llama_3_2_1b_instruct + name: llama_3_2_1b_instruct + title: Llama 3 2 1b Instruct + methods: + workers_ai_post_run_cf_meta_llama_3_2_1b_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.2-1b-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_2_1b_instruct/methods/workers_ai_post_run_cf_meta_llama_3_2_1b_instruct + update: [] + delete: [] + replace: [] + llama_3_2_3b_instruct: + id: cloudflare.ai.llama_3_2_3b_instruct + name: llama_3_2_3b_instruct + title: Llama 3 2 3b Instruct + methods: + workers_ai_post_run_cf_meta_llama_3_2_3b_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.2-3b-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_2_3b_instruct/methods/workers_ai_post_run_cf_meta_llama_3_2_3b_instruct + update: [] + delete: [] + replace: [] + llama_3_3_70b_instruct_fp8_fast: + id: cloudflare.ai.llama_3_3_70b_instruct_fp8_fast + name: llama_3_3_70b_instruct_fp8_fast + title: Llama 3 3 70b Instruct Fp8 Fast + methods: + workers_ai_post_run_cf_meta_llama_3_3_70b_instruct_fp8_fast: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-3.3-70b-instruct-fp8-fast/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_3_3_70b_instruct_fp8_fast/methods/workers_ai_post_run_cf_meta_llama_3_3_70b_instruct_fp8_fast + update: [] + delete: [] + replace: [] + llama_4_scout_17b_16e_instruct: + id: cloudflare.ai.llama_4_scout_17b_16e_instruct + name: llama_4_scout_17b_16e_instruct + title: Llama 4 Scout 17b 16e Instruct + methods: + workers_ai_post_run_cf_meta_llama_4_scout_17b_16e_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-4-scout-17b-16e-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_4_scout_17b_16e_instruct/methods/workers_ai_post_run_cf_meta_llama_4_scout_17b_16e_instruct + update: [] + delete: [] + replace: [] + llama_guard_3_8b: + id: cloudflare.ai.llama_guard_3_8b + name: llama_guard_3_8b + title: Llama Guard 3 8b + methods: + workers_ai_post_run_cf_meta_llama_guard_3_8b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1llama-guard-3-8b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_guard_3_8b/methods/workers_ai_post_run_cf_meta_llama_guard_3_8b + update: [] + delete: [] + replace: [] + m2m100_1_2b: + id: cloudflare.ai.m2m100_1_2b + name: m2m100_1_2b + title: M2m100 1 2b + methods: + workers_ai_post_run_cf_meta_m2m100_1_2b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1meta~1m2m100-1.2b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/m2m100_1_2b/methods/workers_ai_post_run_cf_meta_m2m100_1_2b + update: [] + delete: [] + replace: [] + nonomni_resnet_50: + id: cloudflare.ai.nonomni_resnet_50 + name: nonomni_resnet_50 + title: Nonomni Resnet 50 + methods: + workers_ai_post_run_cf_microsoft_nonomni_resnet_50: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1nonomni-resnet-50/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nonomni_resnet_50/methods/workers_ai_post_run_cf_microsoft_nonomni_resnet_50 + update: [] + delete: [] + replace: [] + phi_2: + id: cloudflare.ai.phi_2 + name: phi_2 + title: Phi 2 + methods: + workers_ai_post_run_cf_microsoft_phi_2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1phi-2/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/phi_2/methods/workers_ai_post_run_cf_microsoft_phi_2 + update: [] + delete: [] + replace: [] + resnet_50: + id: cloudflare.ai.resnet_50 + name: resnet_50 + title: Resnet 50 + methods: + workers_ai_post_run_cf_microsoft_resnet_50: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1microsoft~1resnet-50/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/resnet_50/methods/workers_ai_post_run_cf_microsoft_resnet_50 + update: [] + delete: [] + replace: [] + mistral_7b_instruct_v0_1: + id: cloudflare.ai.mistral_7b_instruct_v0_1 + name: mistral_7b_instruct_v0_1 + title: Mistral 7b Instruct V0 1 + methods: + workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_1: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1mistral~1mistral-7b-instruct-v0.1/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/mistral_7b_instruct_v0_1/methods/workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_1 + update: [] + delete: [] + replace: [] + mistral_7b_instruct_v0_2_lora: + id: cloudflare.ai.mistral_7b_instruct_v0_2_lora + name: mistral_7b_instruct_v0_2_lora + title: Mistral 7b Instruct V0 2 Lora + methods: + workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_2_lora: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1mistral~1mistral-7b-instruct-v0.2-lora/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/mistral_7b_instruct_v0_2_lora/methods/workers_ai_post_run_cf_mistral_mistral_7b_instruct_v0_2_lora + update: [] + delete: [] + replace: [] + mistral_small_3_1_24b_instruct: + id: cloudflare.ai.mistral_small_3_1_24b_instruct + name: mistral_small_3_1_24b_instruct + title: Mistral Small 3 1 24b Instruct + methods: + workers_ai_post_run_cf_mistralai_mistral_small_3_1_24b_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1mistralai~1mistral-small-3.1-24b-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/mistral_small_3_1_24b_instruct/methods/workers_ai_post_run_cf_mistralai_mistral_small_3_1_24b_instruct + update: [] + delete: [] + replace: [] + kimi_k2_5: + id: cloudflare.ai.kimi_k2_5 + name: kimi_k2_5 + title: Kimi K2 5 + methods: + workers_ai_post_run_cf_moonshotai_kimi_k2_5: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1moonshotai~1kimi-k2.5/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/kimi_k2_5/methods/workers_ai_post_run_cf_moonshotai_kimi_k2_5 + update: [] + delete: [] + replace: [] + melotts: + id: cloudflare.ai.melotts + name: melotts + title: Melotts + methods: + workers_ai_post_run_cf_myshell_ai_melotts: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1myshell-ai~1melotts/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/melotts/methods/workers_ai_post_run_cf_myshell_ai_melotts + update: [] + delete: [] + replace: [] + nemotron_3_120b_a12b: + id: cloudflare.ai.nemotron_3_120b_a12b + name: nemotron_3_120b_a12b + title: Nemotron 3 120b A12b + methods: + workers_ai_post_run_cf_nvidia_nemotron_3_120b_a12b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1nvidia~1nemotron-3-120b-a12b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/nemotron_3_120b_a12b/methods/workers_ai_post_run_cf_nvidia_nemotron_3_120b_a12b + update: [] + delete: [] + replace: [] + gpt_oss_120b: + id: cloudflare.ai.gpt_oss_120b + name: gpt_oss_120b + title: Gpt Oss 120b + methods: + workers_ai_post_run_cf_openai_gpt_oss_120b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1gpt-oss-120b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/gpt_oss_120b/methods/workers_ai_post_run_cf_openai_gpt_oss_120b + update: [] + delete: [] + replace: [] + gpt_oss_20b: + id: cloudflare.ai.gpt_oss_20b + name: gpt_oss_20b + title: Gpt Oss 20b + methods: + workers_ai_post_run_cf_openai_gpt_oss_20b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1gpt-oss-20b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/gpt_oss_20b/methods/workers_ai_post_run_cf_openai_gpt_oss_20b + update: [] + delete: [] + replace: [] + whisper: + id: cloudflare.ai.whisper + name: whisper + title: Whisper + methods: + workers_ai_post_run_cf_openai_whisper: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/whisper/methods/workers_ai_post_run_cf_openai_whisper + update: [] + delete: [] + replace: [] + whisper_large_v3_turbo: + id: cloudflare.ai.whisper_large_v3_turbo + name: whisper_large_v3_turbo + title: Whisper Large V3 Turbo + methods: + workers_ai_post_run_cf_openai_whisper_large_v3_turbo: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper-large-v3-turbo/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/whisper_large_v3_turbo/methods/workers_ai_post_run_cf_openai_whisper_large_v3_turbo + update: [] + delete: [] + replace: [] + whisper_tiny_en: + id: cloudflare.ai.whisper_tiny_en + name: whisper_tiny_en + title: Whisper Tiny En + methods: + workers_ai_post_run_cf_openai_whisper_tiny_en: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openai~1whisper-tiny-en/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/whisper_tiny_en/methods/workers_ai_post_run_cf_openai_whisper_tiny_en + update: [] + delete: [] + replace: [] + openchat_3_5_0106: + id: cloudflare.ai.openchat_3_5_0106 + name: openchat_3_5_0106 + title: Openchat 3 5 0106 + methods: + workers_ai_post_run_cf_openchat_openchat_3_5_0106: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1openchat~1openchat-3.5-0106/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/openchat_3_5_0106/methods/workers_ai_post_run_cf_openchat_openchat_3_5_0106 + update: [] + delete: [] + replace: [] + plamo_embedding_1b: + id: cloudflare.ai.plamo_embedding_1b + name: plamo_embedding_1b + title: Plamo Embedding 1b + methods: + workers_ai_post_run_cf_pfnet_plamo_embedding_1b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1pfnet~1plamo-embedding-1b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/plamo_embedding_1b/methods/workers_ai_post_run_cf_pfnet_plamo_embedding_1b + update: [] + delete: [] + replace: [] + qwen1_5_0_5b_chat: + id: cloudflare.ai.qwen1_5_0_5b_chat + name: qwen1_5_0_5b_chat + title: Qwen1 5 0 5b Chat + methods: + workers_ai_post_run_cf_qwen_qwen1_5_0_5b_chat: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-0.5b-chat/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwen1_5_0_5b_chat/methods/workers_ai_post_run_cf_qwen_qwen1_5_0_5b_chat + update: [] + delete: [] + replace: [] + qwen1_5_1_8b_chat: + id: cloudflare.ai.qwen1_5_1_8b_chat + name: qwen1_5_1_8b_chat + title: Qwen1 5 1 8b Chat + methods: + workers_ai_post_run_cf_qwen_qwen1_5_1_8b_chat: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-1.8b-chat/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwen1_5_1_8b_chat/methods/workers_ai_post_run_cf_qwen_qwen1_5_1_8b_chat + update: [] + delete: [] + replace: [] + qwen1_5_14b_chat_awq: + id: cloudflare.ai.qwen1_5_14b_chat_awq + name: qwen1_5_14b_chat_awq + title: Qwen1 5 14b Chat Awq + methods: + workers_ai_post_run_cf_qwen_qwen1_5_14b_chat_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-14b-chat-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwen1_5_14b_chat_awq/methods/workers_ai_post_run_cf_qwen_qwen1_5_14b_chat_awq + update: [] + delete: [] + replace: [] + qwen1_5_7b_chat_awq: + id: cloudflare.ai.qwen1_5_7b_chat_awq + name: qwen1_5_7b_chat_awq + title: Qwen1 5 7b Chat Awq + methods: + workers_ai_post_run_cf_qwen_qwen1_5_7b_chat_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen1.5-7b-chat-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwen1_5_7b_chat_awq/methods/workers_ai_post_run_cf_qwen_qwen1_5_7b_chat_awq + update: [] + delete: [] + replace: [] + qwen2_5_coder_32b_instruct: + id: cloudflare.ai.qwen2_5_coder_32b_instruct + name: qwen2_5_coder_32b_instruct + title: Qwen2 5 Coder 32b Instruct + methods: + workers_ai_post_run_cf_qwen_qwen2_5_coder_32b_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen2.5-coder-32b-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwen2_5_coder_32b_instruct/methods/workers_ai_post_run_cf_qwen_qwen2_5_coder_32b_instruct + update: [] + delete: [] + replace: [] + qwen3_30b_a3b_fp8: + id: cloudflare.ai.qwen3_30b_a3b_fp8 + name: qwen3_30b_a3b_fp8 + title: Qwen3 30b A3b Fp8 + methods: + workers_ai_post_run_cf_qwen_qwen3_30b_a3b_fp8: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen3-30b-a3b-fp8/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwen3_30b_a3b_fp8/methods/workers_ai_post_run_cf_qwen_qwen3_30b_a3b_fp8 + update: [] + delete: [] + replace: [] + qwen3_embedding_0_6b: + id: cloudflare.ai.qwen3_embedding_0_6b + name: qwen3_embedding_0_6b + title: Qwen3 Embedding 0 6b + methods: + workers_ai_post_run_cf_qwen_qwen3_embedding_0_6b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwen3-embedding-0.6b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwen3_embedding_0_6b/methods/workers_ai_post_run_cf_qwen_qwen3_embedding_0_6b + update: [] + delete: [] + replace: [] + qwq_32b: + id: cloudflare.ai.qwq_32b + name: qwq_32b + title: Qwq 32b + methods: + workers_ai_post_run_cf_qwen_qwq_32b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1qwen~1qwq-32b/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/qwq_32b/methods/workers_ai_post_run_cf_qwen_qwq_32b + update: [] + delete: [] + replace: [] + stable_diffusion_v1_5_img2img: + id: cloudflare.ai.stable_diffusion_v1_5_img2img + name: stable_diffusion_v1_5_img2img + title: Stable Diffusion V1 5 Img2img + methods: + workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_img2img: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1runwayml~1stable-diffusion-v1-5-img2img/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/stable_diffusion_v1_5_img2img/methods/workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_img2img + update: [] + delete: [] + replace: [] + stable_diffusion_v1_5_inpainting: + id: cloudflare.ai.stable_diffusion_v1_5_inpainting + name: stable_diffusion_v1_5_inpainting + title: Stable Diffusion V1 5 Inpainting + methods: + workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_inpainting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1runwayml~1stable-diffusion-v1-5-inpainting/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/stable_diffusion_v1_5_inpainting/methods/workers_ai_post_run_cf_runwayml_stable_diffusion_v1_5_inpainting + update: [] + delete: [] + replace: [] + stable_diffusion_xl_base_1_0: + id: cloudflare.ai.stable_diffusion_xl_base_1_0 + name: stable_diffusion_xl_base_1_0 + title: Stable Diffusion Xl Base 1 0 + methods: + workers_ai_post_run_cf_stabilityai_stable_diffusion_xl_base_1_0: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1stabilityai~1stable-diffusion-xl-base-1.0/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/stable_diffusion_xl_base_1_0/methods/workers_ai_post_run_cf_stabilityai_stable_diffusion_xl_base_1_0 + update: [] + delete: [] + replace: [] + discolm_german_7b_v1_awq: + id: cloudflare.ai.discolm_german_7b_v1_awq + name: discolm_german_7b_v1_awq + title: Discolm German 7b V1 Awq + methods: + workers_ai_post_run_cf_thebloke_discolm_german_7b_v1_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1thebloke~1discolm-german-7b-v1-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/discolm_german_7b_v1_awq/methods/workers_ai_post_run_cf_thebloke_discolm_german_7b_v1_awq + update: [] + delete: [] + replace: [] + falcon_7b_instruct: + id: cloudflare.ai.falcon_7b_instruct + name: falcon_7b_instruct + title: Falcon 7b Instruct + methods: + workers_ai_post_run_cf_tiiuae_falcon_7b_instruct: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1tiiuae~1falcon-7b-instruct/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/falcon_7b_instruct/methods/workers_ai_post_run_cf_tiiuae_falcon_7b_instruct + update: [] + delete: [] + replace: [] + tinyllama_1_1b_chat_v1_0: + id: cloudflare.ai.tinyllama_1_1b_chat_v1_0 + name: tinyllama_1_1b_chat_v1_0 + title: Tinyllama 1 1b Chat V1 0 + methods: + workers_ai_post_run_cf_tinyllama_tinyllama_1_1b_chat_v1_0: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1tinyllama~1tinyllama-1.1b-chat-v1.0/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/tinyllama_1_1b_chat_v1_0/methods/workers_ai_post_run_cf_tinyllama_tinyllama_1_1b_chat_v1_0 + update: [] + delete: [] + replace: [] + glm_4_7_flash: + id: cloudflare.ai.glm_4_7_flash + name: glm_4_7_flash + title: Glm 4 7 Flash + methods: + workers_ai_post_run_cf_zai_org_glm_4_7_flash: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@cf~1zai-org~1glm-4.7-flash/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/glm_4_7_flash/methods/workers_ai_post_run_cf_zai_org_glm_4_7_flash + update: [] + delete: [] + replace: [] + gemma_7b_it: + id: cloudflare.ai.gemma_7b_it + name: gemma_7b_it + title: Gemma 7b It + methods: + workers_ai_post_run_hf_google_gemma_7b_it: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1google~1gemma-7b-it/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/gemma_7b_it/methods/workers_ai_post_run_hf_google_gemma_7b_it + update: [] + delete: [] + replace: [] + mistral_7b_instruct_v0_2: + id: cloudflare.ai.mistral_7b_instruct_v0_2 + name: mistral_7b_instruct_v0_2 + title: Mistral 7b Instruct V0 2 + methods: + workers_ai_post_run_hf_mistral_mistral_7b_instruct_v0_2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1mistral~1mistral-7b-instruct-v0.2/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/mistral_7b_instruct_v0_2/methods/workers_ai_post_run_hf_mistral_mistral_7b_instruct_v0_2 + update: [] + delete: [] + replace: [] + starling_lm_7b_beta: + id: cloudflare.ai.starling_lm_7b_beta + name: starling_lm_7b_beta + title: Starling Lm 7b Beta + methods: + workers_ai_post_run_hf_nexusflow_starling_lm_7b_beta: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1nexusflow~1starling-lm-7b-beta/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/starling_lm_7b_beta/methods/workers_ai_post_run_hf_nexusflow_starling_lm_7b_beta + update: [] + delete: [] + replace: [] + hermes_2_pro_mistral_7b: + id: cloudflare.ai.hermes_2_pro_mistral_7b + name: hermes_2_pro_mistral_7b + title: Hermes 2 Pro Mistral 7b + methods: + workers_ai_post_run_hf_nousresearch_hermes_2_pro_mistral_7b: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1nousresearch~1hermes-2-pro-mistral-7b/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/hermes_2_pro_mistral_7b/methods/workers_ai_post_run_hf_nousresearch_hermes_2_pro_mistral_7b + update: [] + delete: [] + replace: [] + deepseek_coder_6_7b_base_awq: + id: cloudflare.ai.deepseek_coder_6_7b_base_awq + name: deepseek_coder_6_7b_base_awq + title: Deepseek Coder 6 7b Base Awq + methods: + workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_base_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1deepseek-coder-6.7b-base-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/deepseek_coder_6_7b_base_awq/methods/workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_base_awq + update: [] + delete: [] + replace: [] + deepseek_coder_6_7b_instruct_awq: + id: cloudflare.ai.deepseek_coder_6_7b_instruct_awq + name: deepseek_coder_6_7b_instruct_awq + title: Deepseek Coder 6 7b Instruct Awq + methods: + workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_instruct_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1deepseek-coder-6.7b-instruct-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/deepseek_coder_6_7b_instruct_awq/methods/workers_ai_post_run_hf_thebloke_deepseek_coder_6_7b_instruct_awq + update: [] + delete: [] + replace: [] + llama_2_13b_chat_awq: + id: cloudflare.ai.llama_2_13b_chat_awq + name: llama_2_13b_chat_awq + title: Llama 2 13b Chat Awq + methods: + workers_ai_post_run_hf_thebloke_llama_2_13b_chat_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1llama-2-13b-chat-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/llama_2_13b_chat_awq/methods/workers_ai_post_run_hf_thebloke_llama_2_13b_chat_awq + update: [] + delete: [] + replace: [] + mistral_7b_instruct_v0_1_awq: + id: cloudflare.ai.mistral_7b_instruct_v0_1_awq + name: mistral_7b_instruct_v0_1_awq + title: Mistral 7b Instruct V0 1 Awq + methods: + workers_ai_post_run_hf_thebloke_mistral_7b_instruct_v0_1_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1mistral-7b-instruct-v0.1-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/mistral_7b_instruct_v0_1_awq/methods/workers_ai_post_run_hf_thebloke_mistral_7b_instruct_v0_1_awq + update: [] + delete: [] + replace: [] + neural_chat_7b_v3_1_awq: + id: cloudflare.ai.neural_chat_7b_v3_1_awq + name: neural_chat_7b_v3_1_awq + title: Neural Chat 7b V3 1 Awq + methods: + workers_ai_post_run_hf_thebloke_neural_chat_7b_v3_1_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1neural-chat-7b-v3-1-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/neural_chat_7b_v3_1_awq/methods/workers_ai_post_run_hf_thebloke_neural_chat_7b_v3_1_awq + update: [] + delete: [] + replace: [] + openhermes_2_5_mistral_7b_awq: + id: cloudflare.ai.openhermes_2_5_mistral_7b_awq + name: openhermes_2_5_mistral_7b_awq + title: Openhermes 2 5 Mistral 7b Awq + methods: + workers_ai_post_run_hf_thebloke_openhermes_2_5_mistral_7b_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1openhermes-2.5-mistral-7b-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/openhermes_2_5_mistral_7b_awq/methods/workers_ai_post_run_hf_thebloke_openhermes_2_5_mistral_7b_awq + update: [] + delete: [] + replace: [] + zephyr_7b_beta_awq: + id: cloudflare.ai.zephyr_7b_beta_awq + name: zephyr_7b_beta_awq + title: Zephyr 7b Beta Awq + methods: + workers_ai_post_run_hf_thebloke_zephyr_7b_beta_awq: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai~1run~1@hf~1thebloke~1zephyr-7b-beta-awq/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/zephyr_7b_beta_awq/methods/workers_ai_post_run_hf_thebloke_zephyr_7b_beta_awq + update: [] + delete: [] + replace: [] + run: + id: cloudflare.ai.run + name: run + title: Run + methods: + run: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1run~1{model_name}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/run/methods/run' + update: [] + delete: [] + replace: [] + tasks: + id: cloudflare.ai.tasks + name: tasks + title: Tasks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1tasks~1search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tasks/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tomarkdown: + id: cloudflare.ai.tomarkdown + name: tomarkdown + title: Tomarkdown + methods: + workers_ai_post_to_markdown: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1tomarkdown/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/tomarkdown/methods/workers_ai_post_to_markdown + update: [] + delete: [] + replace: [] + to_markdown: + id: cloudflare.ai.to_markdown + name: to_markdown + title: To Markdown + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai~1tomarkdown~1supported/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/to_markdown/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ai_search: + id: cloudflare.ai.ai_search + name: ai_search + title: Ai Search + methods: + autorag_config_ai_search: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1ai-search/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/ai_search/methods/autorag_config_ai_search + update: [] + delete: [] + replace: [] + files: + id: cloudflare.ai.files + name: files + title: Files + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + jobs: + id: cloudflare.ai.jobs + name: jobs + title: Jobs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs~1{job_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + logs: + id: cloudflare.ai.logs + name: logs + title: Logs + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1jobs~1{job_id}~1logs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + search: + id: cloudflare.ai.search + name: search + title: Search + methods: + autorag_config_search: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1search/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/search/methods/autorag_config_search + update: [] + delete: [] + replace: [] + sync: + id: cloudflare.ai.sync + name: sync + title: Sync + methods: + autorag_config_sync: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1autorag~1rags~1{id}~1sync/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/sync/methods/autorag_config_sync' + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/ai_gateway.yaml b/providers/src/cloudflare/v00.00.00000/services/ai_gateway.yaml new file mode 100644 index 00000000..a97caf6a --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/ai_gateway.yaml @@ -0,0 +1,7630 @@ +openapi: 3.0.3 +info: + title: ai_gateway API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/ai-gateway/evaluation-types: + get: + operationId: aig-config-list-evaluators + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - in: query + name: order_by + schema: + default: mandatory + type: string + - in: query + name: order_by_direction + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + type: string + enable: + type: boolean + id: + type: string + mandatory: + type: boolean + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + type: + type: string + required: + - name + - type + - mandatory + - description + - enable + - id + - created_at + - modified_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of Evaluators + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Evaluators + tags: + - AI Gateway Evaluations + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - evaluation_types + method: list + /accounts/{account_id}/ai-gateway/gateways: + get: + description: Lists all AI Gateway evaluator types configured for the account. + operationId: aig-config-list-gateway + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: search + schema: + description: Search by id + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + authentication: + type: boolean + x-auditable: true + cache_invalidate_on_update: + type: boolean + x-auditable: true + cache_ttl: + minimum: 0 + nullable: true + type: integer + x-auditable: true + collect_logs: + type: boolean + x-auditable: true + created_at: + format: date-time + type: string + readOnly: true + dlp: + type: object + properties: + action: + enum: + - BLOCK + - FLAG + type: string + enabled: + type: boolean + profiles: + items: + type: string + type: array + policies: + items: + properties: + action: + enum: + - FLAG + - BLOCK + type: string + check: + items: + enum: + - REQUEST + - RESPONSE + type: string + type: array + enabled: + type: boolean + id: + type: string + profiles: + items: + type: string + type: array + required: + - id + - enabled + - action + - profiles + - check + type: object + type: array + required: + - enabled + id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + is_default: + type: boolean + x-auditable: true + log_management: + maximum: 10000000 + minimum: 10000 + nullable: true + type: integer + x-auditable: true + log_management_strategy: + enum: + - STOP_INSERTING + - DELETE_OLDEST + nullable: true + type: string + x-auditable: true + logpush: + type: boolean + x-auditable: true + logpush_public_key: + maxLength: 1024 + minLength: 16 + nullable: true + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + otel: + items: + properties: + authorization: + type: string + content_type: + default: json + enum: + - json + - protobuf + type: string + headers: + type: object + url: + type: string + required: + - url + - headers + - authorization + type: object + nullable: true + type: array + x-auditable: true + rate_limiting_interval: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_limit: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_technique: + enum: + - fixed + - sliding + nullable: true + type: string + x-auditable: true + retry_backoff: + description: Backoff strategy for retry delays + enum: + - constant + - linear + - exponential + nullable: true + type: string + x-auditable: true + retry_delay: + description: >- + Delay between retry attempts in milliseconds + (0-5000) + maximum: 5000 + minimum: 0 + nullable: true + type: integer + x-auditable: true + retry_max_attempts: + description: >- + Maximum number of retry attempts for failed requests + (1-5) + maximum: 5 + minimum: 1 + nullable: true + type: integer + x-auditable: true + store_id: + nullable: true + type: string + stripe: + nullable: true + properties: + authorization: + type: string + usage_events: + items: + properties: + payload: + type: string + required: + - payload + type: object + type: array + required: + - authorization + - usage_events + type: object + x-auditable: true + workers_ai_billing_mode: + default: postpaid + description: >- + Controls how Workers AI inference calls routed + through this gateway are billed. Only 'postpaid' is + currently supported. + enum: + - postpaid + type: string + x-auditable: true + zdr: + type: boolean + x-auditable: true + required: + - id + - rate_limiting_interval + - rate_limiting_limit + - collect_logs + - cache_ttl + - cache_invalidate_on_update + - created_at + - modified_at + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: List objects + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Gateways + tags: + - AI Gateway Gateways + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: [] + method: list + post: + description: Creates a new AI Gateway. + operationId: aig-config-create-gateway + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + authentication: + type: boolean + x-auditable: true + cache_invalidate_on_update: + type: boolean + x-auditable: true + cache_ttl: + minimum: 0 + nullable: true + type: integer + x-auditable: true + collect_logs: + type: boolean + x-auditable: true + id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + log_management: + maximum: 10000000 + minimum: 10000 + nullable: true + type: integer + x-auditable: true + log_management_strategy: + enum: + - STOP_INSERTING + - DELETE_OLDEST + nullable: true + type: string + x-auditable: true + logpush: + type: boolean + x-auditable: true + logpush_public_key: + maxLength: 1024 + minLength: 16 + nullable: true + type: string + x-auditable: true + rate_limiting_interval: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_limit: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_technique: + enum: + - fixed + - sliding + nullable: true + type: string + x-auditable: true + retry_backoff: + description: Backoff strategy for retry delays + enum: + - constant + - linear + - exponential + nullable: true + type: string + x-auditable: true + retry_delay: + description: Delay between retry attempts in milliseconds (0-5000) + maximum: 5000 + minimum: 0 + nullable: true + type: integer + x-auditable: true + retry_max_attempts: + description: Maximum number of retry attempts for failed requests (1-5) + maximum: 5 + minimum: 1 + nullable: true + type: integer + x-auditable: true + workers_ai_billing_mode: + default: postpaid + description: >- + Controls how Workers AI inference calls routed through this + gateway are billed. Only 'postpaid' is currently supported. + enum: + - postpaid + type: string + x-auditable: true + zdr: + type: boolean + x-auditable: true + required: + - id + - rate_limiting_interval + - rate_limiting_limit + - collect_logs + - cache_ttl + - cache_invalidate_on_update + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + authentication: + type: boolean + x-auditable: true + cache_invalidate_on_update: + type: boolean + x-auditable: true + cache_ttl: + minimum: 0 + nullable: true + type: integer + x-auditable: true + collect_logs: + type: boolean + x-auditable: true + created_at: + format: date-time + type: string + readOnly: true + dlp: + type: object + properties: + action: + enum: + - BLOCK + - FLAG + type: string + enabled: + type: boolean + profiles: + items: + type: string + type: array + policies: + items: + properties: + action: + enum: + - FLAG + - BLOCK + type: string + check: + items: + enum: + - REQUEST + - RESPONSE + type: string + type: array + enabled: + type: boolean + id: + type: string + profiles: + items: + type: string + type: array + required: + - id + - enabled + - action + - profiles + - check + type: object + type: array + required: + - enabled + id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + is_default: + type: boolean + x-auditable: true + log_management: + maximum: 10000000 + minimum: 10000 + nullable: true + type: integer + x-auditable: true + log_management_strategy: + enum: + - STOP_INSERTING + - DELETE_OLDEST + nullable: true + type: string + x-auditable: true + logpush: + type: boolean + x-auditable: true + logpush_public_key: + maxLength: 1024 + minLength: 16 + nullable: true + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + otel: + items: + properties: + authorization: + type: string + content_type: + default: json + enum: + - json + - protobuf + type: string + headers: + type: object + url: + type: string + required: + - url + - headers + - authorization + type: object + nullable: true + type: array + x-auditable: true + rate_limiting_interval: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_limit: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_technique: + enum: + - fixed + - sliding + nullable: true + type: string + x-auditable: true + retry_backoff: + description: Backoff strategy for retry delays + enum: + - constant + - linear + - exponential + nullable: true + type: string + x-auditable: true + retry_delay: + description: Delay between retry attempts in milliseconds (0-5000) + maximum: 5000 + minimum: 0 + nullable: true + type: integer + x-auditable: true + retry_max_attempts: + description: >- + Maximum number of retry attempts for failed requests + (1-5) + maximum: 5 + minimum: 1 + nullable: true + type: integer + x-auditable: true + store_id: + nullable: true + type: string + stripe: + nullable: true + properties: + authorization: + type: string + usage_events: + items: + properties: + payload: + type: string + required: + - payload + type: object + type: array + required: + - authorization + - usage_events + type: object + x-auditable: true + workers_ai_billing_mode: + default: postpaid + description: >- + Controls how Workers AI inference calls routed through + this gateway are billed. Only 'postpaid' is currently + supported. + enum: + - postpaid + type: string + x-auditable: true + zdr: + type: boolean + x-auditable: true + required: + - id + - rate_limiting_interval + - rate_limiting_limit + - collect_logs + - cache_ttl + - cache_invalidate_on_update + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the created Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Gateway + tags: + - AI Gateway Gateways + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: [] + method: create + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets: + get: + description: Lists all AI Gateway evaluator types configured for the account. + operationId: aig-config-list-dataset + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: name + schema: + type: string + x-auditable: true + - in: query + name: enable + schema: + type: boolean + x-auditable: true + - in: query + name: search + schema: + description: Search by id, name, filters + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - created_at + - modified_at + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: List objects + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Datasets + tags: + - AI Gateway Datasets + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - datasets + method: list + post: + description: Creates a new AI Gateway. + operationId: aig-config-create-dataset + parameters: + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + name: + type: string + x-auditable: true + required: + - name + - filters + - enable + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the created Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Dataset + tags: + - AI Gateway Datasets + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - datasets + method: create + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}: + delete: + description: Deletes an AI Gateway dataset. + operationId: aig-config-delete-dataset + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the Object if it was successfully deleted + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Dataset + tags: + - AI Gateway Datasets + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - datasets + method: delete + get: + description: Retrieves details for a specific AI Gateway dataset. + operationId: aig-config-fetch-dataset + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a single object if found + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch a Dataset + tags: + - AI Gateway Datasets + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - datasets + method: get + put: + description: Updates an existing AI Gateway dataset. + operationId: aig-config-update-dataset + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + name: + type: string + x-auditable: true + required: + - name + - filters + - enable + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Dataset + tags: + - AI Gateway Datasets + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - datasets + method: update + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations: + get: + description: Lists all AI Gateway evaluator types configured for the account. + operationId: aig-config-list-evaluations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: name + schema: + type: string + x-auditable: true + - in: query + name: processed + schema: + type: boolean + x-auditable: true + - in: query + name: search + schema: + description: Search by id, name + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + datasets: + items: + properties: + account_id: + type: string + account_tag: + type: string + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - account_id + - account_tag + - created_at + - modified_at + type: object + type: array + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + processed: + type: boolean + x-auditable: true + results: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + evaluation_id: + type: string + evaluation_type_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + result: + type: string + status: + type: number + status_description: + type: string + total_logs: + type: number + required: + - evaluation_id + - evaluation_type_id + - result + - total_logs + - status + - status_description + - id + - created_at + - modified_at + type: object + type: array + total_logs: + type: number + x-auditable: true + required: + - id + - gateway_id + - name + - created_at + - modified_at + - datasets + - results + - processed + - total_logs + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: List objects + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Evaluations + tags: + - AI Gateway Evaluations + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - evaluations + method: list + post: + description: Creates a new AI Gateway. + operationId: aig-config-create-evaluations + parameters: + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + dataset_ids: + items: + type: string + maxItems: 5 + minItems: 1 + type: array + evaluation_type_ids: + items: + type: string + type: array + name: + type: string + x-auditable: true + required: + - name + - dataset_ids + - evaluation_type_ids + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + datasets: + items: + properties: + account_id: + type: string + account_tag: + type: string + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - account_id + - account_tag + - created_at + - modified_at + type: object + type: array + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + processed: + type: boolean + x-auditable: true + results: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + evaluation_id: + type: string + evaluation_type_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + result: + type: string + status: + type: number + status_description: + type: string + total_logs: + type: number + required: + - evaluation_id + - evaluation_type_id + - result + - total_logs + - status + - status_description + - id + - created_at + - modified_at + type: object + type: array + total_logs: + type: number + x-auditable: true + required: + - id + - gateway_id + - name + - created_at + - modified_at + - datasets + - results + - processed + - total_logs + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the created Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Evaluation + tags: + - AI Gateway Evaluations + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - evaluations + method: create + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}: + delete: + description: Deletes an AI Gateway dataset. + operationId: aig-config-delete-evaluations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + datasets: + items: + properties: + account_id: + type: string + account_tag: + type: string + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - account_id + - account_tag + - created_at + - modified_at + type: object + type: array + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + processed: + type: boolean + x-auditable: true + results: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + evaluation_id: + type: string + evaluation_type_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + result: + type: string + status: + type: number + status_description: + type: string + total_logs: + type: number + required: + - evaluation_id + - evaluation_type_id + - result + - total_logs + - status + - status_description + - id + - created_at + - modified_at + type: object + type: array + total_logs: + type: number + x-auditable: true + required: + - id + - gateway_id + - name + - created_at + - modified_at + - datasets + - results + - processed + - total_logs + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the Object if it was successfully deleted + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Evaluation + tags: + - AI Gateway Evaluations + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - evaluations + method: delete + get: + description: Retrieves details for a specific AI Gateway dataset. + operationId: aig-config-fetch-evaluations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + datasets: + items: + properties: + account_id: + type: string + account_tag: + type: string + created_at: + format: date-time + type: string + readOnly: true + enable: + type: boolean + x-auditable: true + filters: + items: + properties: + key: + enum: + - created_at + - request_content_type + - response_content_type + - success + - cached + - provider + - model + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + type: string + x-auditable: true + operator: + enum: + - eq + - contains + - lt + - gt + type: string + x-auditable: true + value: + items: + type: string + type: array + x-auditable: true + required: + - key + - operator + - value + type: object + type: array + x-auditable: true + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + required: + - gateway_id + - name + - filters + - enable + - id + - account_id + - account_tag + - created_at + - modified_at + type: object + type: array + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + x-auditable: true + processed: + type: boolean + x-auditable: true + results: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + evaluation_id: + type: string + evaluation_type_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + result: + type: string + status: + type: number + status_description: + type: string + total_logs: + type: number + required: + - evaluation_id + - evaluation_type_id + - result + - total_logs + - status + - status_description + - id + - created_at + - modified_at + type: object + type: array + total_logs: + type: number + x-auditable: true + required: + - id + - gateway_id + - name + - created_at + - modified_at + - datasets + - results + - processed + - total_logs + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a single object if found + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch a Evaluation + tags: + - AI Gateway Evaluations + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - evaluations + method: get + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs: + delete: + operationId: aig-config-delete-gateway-logs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - in: query + name: order_by + schema: + default: created_at + enum: + - created_at + - provider + - model + - model_type + - success + - cached + - cost + - tokens_in + - tokens_out + - duration + - feedback + type: string + - in: query + name: order_by_direction + schema: + default: asc + enum: + - asc + - desc + type: string + - in: query + name: filters + schema: + items: + properties: + key: + enum: + - id + - created_at + - request_content_type + - response_content_type + - request_type + - success + - cached + - provider + - model + - model_type + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + - event_id + - metadata.key + - metadata.value + - authentication + - wholesale + - compatibilityMode + - dlp_action + type: string + operator: + enum: + - eq + - neq + - contains + - lt + - gt + type: string + value: + items: + type: string + type: array + required: + - key + - operator + - value + type: object + type: array + explode: true + - in: query + name: limit + schema: + default: 10000 + maximum: 10000 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + success: + type: boolean + required: + - success + type: object + description: Returns if the delete was successful + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Gateway Logs + tags: + - AI Gateway Logs + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - logs + method: delete + get: + operationId: aig-config-list-gateway-logs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - in: query + name: search + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 1 + type: integer + - in: query + name: order_by + schema: + default: created_at + enum: + - created_at + - provider + - model + - model_type + - success + - cached + type: string + - in: query + name: order_by_direction + schema: + default: desc + enum: + - asc + - desc + type: string + - in: query + name: filters + schema: + items: + properties: + key: + enum: + - id + - created_at + - request_content_type + - response_content_type + - request_type + - success + - cached + - provider + - model + - model_type + - cost + - tokens + - tokens_in + - tokens_out + - duration + - feedback + - event_id + - metadata.key + - metadata.value + - authentication + - wholesale + - compatibilityMode + - dlp_action + type: string + operator: + enum: + - eq + - neq + - contains + - lt + - gt + type: string + value: + items: + type: string + type: array + required: + - key + - operator + - value + type: object + type: array + explode: true + - in: query + name: meta_info + schema: + type: boolean + - in: query + name: direction + schema: + deprecated: true + enum: + - asc + - desc + type: string + - in: query + name: start_date + schema: + deprecated: true + format: date-time + type: string + - in: query + name: end_date + schema: + deprecated: true + format: date-time + type: string + - in: query + name: min_cost + schema: + deprecated: true + type: number + - in: query + name: max_cost + schema: + deprecated: true + type: number + - in: query + name: min_tokens_in + schema: + deprecated: true + type: number + - in: query + name: max_tokens_in + schema: + deprecated: true + type: number + - in: query + name: min_tokens_out + schema: + deprecated: true + type: number + - in: query + name: max_tokens_out + schema: + deprecated: true + type: number + - in: query + name: min_total_tokens + schema: + deprecated: true + type: number + - in: query + name: max_total_tokens + schema: + deprecated: true + type: number + - in: query + name: min_duration + schema: + deprecated: true + type: number + - in: query + name: max_duration + schema: + deprecated: true + type: number + - in: query + name: feedback + schema: + deprecated: true + type: number + enum: + - 0 + - in: query + name: success + schema: + deprecated: true + type: boolean + - in: query + name: cached + schema: + deprecated: true + type: boolean + - in: query + name: model + schema: + deprecated: true + type: string + - in: query + name: model_type + schema: + deprecated: true + type: string + - in: query + name: provider + schema: + deprecated: true + type: string + - in: query + name: request_content_type + schema: + deprecated: true + type: string + - in: query + name: response_content_type + schema: + deprecated: true + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + cached: + type: boolean + cost: + type: number + created_at: + format: date-time + type: string + readOnly: true + custom_cost: + type: boolean + duration: + type: integer + id: + type: string + metadata: + type: string + model: + type: string + model_type: + type: string + x-stainless-naming: + python: + property_name: ai_model_type + path: + type: string + provider: + type: string + request_content_type: + type: string + request_type: + type: string + response_content_type: + type: string + status_code: + type: integer + step: + type: integer + success: + type: boolean + tokens_in: + nullable: true + type: integer + tokens_out: + nullable: true + type: integer + required: + - id + - created_at + - provider + - model + - path + - duration + - success + - cached + - tokens_in + - tokens_out + type: object + type: array + result_info: + properties: + count: + type: number + max_cost: + type: number + max_duration: + type: number + max_tokens_in: + type: number + max_tokens_out: + type: number + max_total_tokens: + type: number + min_cost: + type: number + min_duration: + type: number + min_tokens_in: + type: number + min_tokens_out: + type: number + min_total_tokens: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of Gateway Logs + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Gateway Logs + tags: + - AI Gateway Logs + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - logs + method: list + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}: + get: + description: Retrieves detailed information for a specific AI Gateway log entry. + operationId: aig-config-get-gateway-log-detail + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + cached: + type: boolean + cost: + type: number + created_at: + format: date-time + type: string + readOnly: true + custom_cost: + type: boolean + duration: + type: integer + id: + type: string + metadata: + type: string + model: + type: string + model_type: + type: string + x-stainless-naming: + python: + property_name: ai_model_type + path: + type: string + provider: + type: string + request_content_type: + type: string + request_head: + type: string + request_head_complete: + type: boolean + request_size: + type: integer + request_type: + type: string + response_content_type: + type: string + response_head: + type: string + response_head_complete: + type: boolean + response_size: + type: integer + status_code: + type: integer + step: + type: integer + success: + type: boolean + tokens_in: + nullable: true + type: integer + tokens_out: + nullable: true + type: integer + required: + - id + - created_at + - provider + - model + - path + - duration + - success + - cached + - tokens_in + - tokens_out + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the log details + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Gateway Log Detail + tags: + - AI Gateway Logs + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - logs + method: get + patch: + description: Updates metadata for an AI Gateway log entry. + operationId: aig-config-patch-gateway-log + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + feedback: + maximum: 1 + minimum: -1 + nullable: true + type: number + metadata: + nullable: true + type: object + score: + maximum: 100 + minimum: 0 + nullable: true + type: number + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the log details + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Gateway Log + tags: + - AI Gateway Logs + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - logs + method: edit + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/request: + get: + description: Retrieves the original request payload for an AI Gateway log entry. + operationId: aig-config-get-gateway-log-request + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Returns the request body from a specific log + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Gateway Log Request + tags: + - AI Gateway Logs + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - logs + method: request + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/response: + get: + description: Retrieves the response payload for an AI Gateway log entry. + operationId: aig-config-get-gateway-log-response + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + description: Returns the response body from a specific log + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Gateway Log Response + tags: + - AI Gateway Logs + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - logs + method: response + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs: + get: + description: Lists all AI Gateway evaluator types configured for the account. + operationId: aig-config-list-providers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + alias: + type: string + default_config: + type: boolean + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + provider_slug: + type: string + rate_limit: + type: number + rate_limit_period: + default: 60 + type: number + secret_id: + type: string + secret_preview: + type: string + required: + - id + - provider_slug + - secret_preview + - default_config + - gateway_id + - modified_at + - alias + - secret_id + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: List objects + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Provider Configs + tags: + - AI Gateway Provider Configs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - provider_configs + method: list + post: + description: Creates a new AI Gateway. + operationId: aig-config-create-providers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + alias: + type: string + default_config: + type: boolean + provider_slug: + type: string + rate_limit: + type: number + rate_limit_period: + default: 60 + type: number + secret: + type: string + secret_id: + type: string + required: + - provider_slug + - default_config + - alias + - secret_id + - secret + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + alias: + type: string + default_config: + type: boolean + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + provider_slug: + type: string + rate_limit: + type: number + rate_limit_period: + default: 60 + type: number + secret_id: + type: string + secret_preview: + type: string + required: + - id + - provider_slug + - secret_preview + - default_config + - gateway_id + - modified_at + - alias + - secret_id + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the created Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Provider Configs + tags: + - AI Gateway Provider Configs + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - provider_configs + method: create + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs/{id}: + delete: + description: Deletes an AI Gateway dataset. + operationId: aig-config-delete-providers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + alias: + type: string + default_config: + type: boolean + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + provider_slug: + type: string + rate_limit: + type: number + rate_limit_period: + default: 60 + type: number + secret_id: + type: string + secret_preview: + type: string + required: + - id + - provider_slug + - secret_preview + - default_config + - gateway_id + - modified_at + - alias + - secret_id + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the Object if it was successfully deleted + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Provider Configs + tags: + - AI Gateway Provider Configs + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + description: Updates an existing AI Gateway dataset. + operationId: aig-config-update-providers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + secret: + type: string + required: + - secret + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + alias: + type: string + default_config: + type: boolean + gateway_id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + provider_slug: + type: string + rate_limit: + type: number + rate_limit_period: + default: 60 + type: number + secret_id: + type: string + secret_preview: + type: string + required: + - id + - provider_slug + - secret_preview + - default_config + - gateway_id + - modified_at + - alias + - secret_id + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Provider Configs + tags: + - AI Gateway Provider Configs + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes: + get: + description: List all AI Gateway Dynamic Routes. + operationId: aig-config-list-gateway-dynamic-routes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + order_by: + type: string + order_by_direction: + type: string + page: + type: number + per_page: + type: number + routes: + items: + properties: + account_tag: + type: string + created_at: + format: date-time + type: string + readOnly: true + deployment: + properties: + created_at: + type: string + readOnly: true + deployment_id: + type: string + version_id: + type: string + required: + - deployment_id + - version_id + - created_at + type: object + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + version: + properties: + active: + enum: + - 'true' + - 'false' + type: string + created_at: + type: string + readOnly: true + data: + type: string + version_id: + type: string + required: + - version_id + - data + - active + - created_at + type: object + required: + - id + - name + - elements + - created_at + - modified_at + - account_tag + - gateway_id + - version + - deployment + type: object + type: array + required: + - routes + - page + - per_page + - order_by + - order_by_direction + type: object + success: + type: boolean + required: + - success + - data + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all AI Gateway Dynamic Routes. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: list + post: + description: Create a new AI Gateway Dynamic Route. + operationId: aig-config-post-gateway-dynamic-route + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + name: + type: string + required: + - name + - elements + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + deployment: + properties: + created_at: + type: string + readOnly: true + deployment_id: + type: string + version_id: + type: string + required: + - deployment_id + - version_id + - created_at + type: object + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + version: + properties: + active: + enum: + - 'true' + - 'false' + type: string + created_at: + type: string + readOnly: true + data: + type: string + version_id: + type: string + required: + - version_id + - data + - active + - created_at + type: object + required: + - id + - name + - elements + - created_at + - modified_at + - gateway_id + - version + - deployment + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new AI Gateway Dynamic Route. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: create + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}: + delete: + description: Delete an AI Gateway Dynamic Route. + operationId: aig-config-delete-gateway-dynamic-route + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + required: + - id + - name + - elements + - created_at + - modified_at + - gateway_id + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an AI Gateway Dynamic Route. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: delete + get: + description: Get an AI Gateway Dynamic Route. + operationId: aig-config-get-gateway-dynamic-route + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + deployment: + properties: + created_at: + type: string + readOnly: true + deployment_id: + type: string + version_id: + type: string + required: + - deployment_id + - version_id + - created_at + type: object + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + version: + properties: + active: + enum: + - 'true' + - 'false' + type: string + created_at: + type: string + readOnly: true + data: + type: string + version_id: + type: string + required: + - version_id + - data + - active + - created_at + type: object + required: + - id + - name + - elements + - created_at + - modified_at + - gateway_id + - version + - deployment + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an AI Gateway Dynamic Route. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: get + patch: + description: Update an AI Gateway Dynamic Route. + operationId: aig-config-update-gateway-dynamic-route + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + type: string + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + route: + properties: + account_tag: + type: string + created_at: + format: date-time + type: string + readOnly: true + deployment: + properties: + created_at: + type: string + readOnly: true + deployment_id: + type: string + version_id: + type: string + required: + - deployment_id + - version_id + - created_at + type: object + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + version: + properties: + active: + enum: + - 'true' + - 'false' + type: string + created_at: + type: string + readOnly: true + data: + type: string + version_id: + type: string + required: + - version_id + - data + - active + - created_at + type: object + required: + - id + - name + - elements + - created_at + - modified_at + - account_tag + - gateway_id + - version + - deployment + type: object + success: + type: boolean + required: + - success + - route + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + route: + properties: + account_tag: + type: string + created_at: + format: date-time + type: string + readOnly: true + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + required: + - id + - name + - elements + - created_at + - modified_at + - account_tag + - gateway_id + type: object + success: + type: boolean + required: + - success + - route + type: object + description: Input Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an AI Gateway Dynamic Route. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: update + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments: + get: + description: List all AI Gateway Dynamic Route Deployments. + operationId: aig-config-list-gateway-dynamic-route-deployments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + deployments: + items: + properties: + created_at: + type: string + readOnly: true + deployment_id: + type: string + version_id: + type: string + required: + - deployment_id + - version_id + - created_at + type: object + type: array + order_by: + type: string + order_by_direction: + type: string + page: + type: number + per_page: + type: number + required: + - deployments + - page + - per_page + - order_by + - order_by_direction + type: object + success: + type: boolean + required: + - success + - data + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all AI Gateway Dynamic Route Deployments. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: list_deployments + post: + description: Create a new AI Gateway Dynamic Route Deployment. + operationId: aig-config-post-gateway-dynamic-route-deployment + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + version_id: + type: string + required: + - version_id + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + required: + - id + - name + - elements + - created_at + - modified_at + - gateway_id + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new AI Gateway Dynamic Route Deployment. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: create_deployment + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions: + get: + description: List all AI Gateway Dynamic Route Versions. + operationId: aig-config-list-gateway-dynamic-route-versions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + order_by: + type: string + order_by_direction: + type: string + page: + type: number + per_page: + type: number + versions: + items: + properties: + active: + enum: + - 'true' + - 'false' + type: string + created_at: + type: string + readOnly: true + data: + type: string + version_id: + type: string + required: + - version_id + - data + - active + - created_at + type: object + type: array + required: + - versions + - page + - per_page + - order_by + - order_by_direction + type: object + success: + type: boolean + required: + - success + - data + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all AI Gateway Dynamic Route Versions. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: list_versions + post: + description: Create a new AI Gateway Dynamic Route Version. + operationId: aig-config-post-gateway-dynamic-route-version + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + required: + - elements + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + required: + - id + - name + - elements + - created_at + - modified_at + - gateway_id + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new AI Gateway Dynamic Route Version. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: create_version + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions/{version_id}: + get: + description: Get an AI Gateway Dynamic Route Version. + operationId: aig-config-get-gateway-dynamic-route-version + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: version_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + active: + enum: + - 'true' + - 'false' + type: string + created_at: + type: string + readOnly: true + data: + type: string + elements: + items: + type: object + properties: + id: + type: string + outputs: + properties: + next: + properties: + elementId: + type: string + required: + - elementId + type: object + required: + - next + type: object + type: + enum: + - start + type: string + properties: + properties: + conditions: + type: object + type: object + required: + - id + - outputs + - type + type: array + gateway_id: + type: string + id: + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + type: string + version_id: + type: string + required: + - id + - name + - elements + - created_at + - modified_at + - gateway_id + - version_id + - data + - active + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Success + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an AI Gateway Dynamic Route Version. + tags: + - AI Gateway Dynamic Routes + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - dynamic_routing + method: get_version + /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/url/{provider}: + get: + description: Retrieves the endpoint URL for an AI Gateway. + operationId: aig-config-get-gateway-url + parameters: + - name: gateway_id + in: path + required: true + description: The AI Gateway ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: provider + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: string + success: + type: boolean + required: + - success + - result + type: object + description: Returns the log details + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Gateway URL + tags: + - AI Gateway Gateways + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: + - urls + method: get + /accounts/{account_id}/ai-gateway/gateways/{id}: + delete: + description: Deletes an AI Gateway dataset. + operationId: aig-config-delete-gateway + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + authentication: + type: boolean + x-auditable: true + cache_invalidate_on_update: + type: boolean + x-auditable: true + cache_ttl: + minimum: 0 + nullable: true + type: integer + x-auditable: true + collect_logs: + type: boolean + x-auditable: true + created_at: + format: date-time + type: string + readOnly: true + dlp: + type: object + properties: + action: + enum: + - BLOCK + - FLAG + type: string + enabled: + type: boolean + profiles: + items: + type: string + type: array + policies: + items: + properties: + action: + enum: + - FLAG + - BLOCK + type: string + check: + items: + enum: + - REQUEST + - RESPONSE + type: string + type: array + enabled: + type: boolean + id: + type: string + profiles: + items: + type: string + type: array + required: + - id + - enabled + - action + - profiles + - check + type: object + type: array + required: + - enabled + id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + is_default: + type: boolean + x-auditable: true + log_management: + maximum: 10000000 + minimum: 10000 + nullable: true + type: integer + x-auditable: true + log_management_strategy: + enum: + - STOP_INSERTING + - DELETE_OLDEST + nullable: true + type: string + x-auditable: true + logpush: + type: boolean + x-auditable: true + logpush_public_key: + maxLength: 1024 + minLength: 16 + nullable: true + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + otel: + items: + properties: + authorization: + type: string + content_type: + default: json + enum: + - json + - protobuf + type: string + headers: + type: object + url: + type: string + required: + - url + - headers + - authorization + type: object + nullable: true + type: array + x-auditable: true + rate_limiting_interval: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_limit: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_technique: + enum: + - fixed + - sliding + nullable: true + type: string + x-auditable: true + retry_backoff: + description: Backoff strategy for retry delays + enum: + - constant + - linear + - exponential + nullable: true + type: string + x-auditable: true + retry_delay: + description: Delay between retry attempts in milliseconds (0-5000) + maximum: 5000 + minimum: 0 + nullable: true + type: integer + x-auditable: true + retry_max_attempts: + description: >- + Maximum number of retry attempts for failed requests + (1-5) + maximum: 5 + minimum: 1 + nullable: true + type: integer + x-auditable: true + store_id: + nullable: true + type: string + stripe: + nullable: true + properties: + authorization: + type: string + usage_events: + items: + properties: + payload: + type: string + required: + - payload + type: object + type: array + required: + - authorization + - usage_events + type: object + x-auditable: true + workers_ai_billing_mode: + default: postpaid + description: >- + Controls how Workers AI inference calls routed through + this gateway are billed. Only 'postpaid' is currently + supported. + enum: + - postpaid + type: string + x-auditable: true + zdr: + type: boolean + x-auditable: true + required: + - id + - rate_limiting_interval + - rate_limiting_limit + - collect_logs + - cache_ttl + - cache_invalidate_on_update + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the Object if it was successfully deleted + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Gateway + tags: + - AI Gateway Gateways + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: [] + method: delete + get: + description: Retrieves details for a specific AI Gateway dataset. + operationId: aig-config-fetch-gateway + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + authentication: + type: boolean + x-auditable: true + cache_invalidate_on_update: + type: boolean + x-auditable: true + cache_ttl: + minimum: 0 + nullable: true + type: integer + x-auditable: true + collect_logs: + type: boolean + x-auditable: true + created_at: + format: date-time + type: string + readOnly: true + dlp: + type: object + properties: + action: + enum: + - BLOCK + - FLAG + type: string + enabled: + type: boolean + profiles: + items: + type: string + type: array + policies: + items: + properties: + action: + enum: + - FLAG + - BLOCK + type: string + check: + items: + enum: + - REQUEST + - RESPONSE + type: string + type: array + enabled: + type: boolean + id: + type: string + profiles: + items: + type: string + type: array + required: + - id + - enabled + - action + - profiles + - check + type: object + type: array + required: + - enabled + id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + is_default: + type: boolean + x-auditable: true + log_management: + maximum: 10000000 + minimum: 10000 + nullable: true + type: integer + x-auditable: true + log_management_strategy: + enum: + - STOP_INSERTING + - DELETE_OLDEST + nullable: true + type: string + x-auditable: true + logpush: + type: boolean + x-auditable: true + logpush_public_key: + maxLength: 1024 + minLength: 16 + nullable: true + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + otel: + items: + properties: + authorization: + type: string + content_type: + default: json + enum: + - json + - protobuf + type: string + headers: + type: object + url: + type: string + required: + - url + - headers + - authorization + type: object + nullable: true + type: array + x-auditable: true + rate_limiting_interval: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_limit: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_technique: + enum: + - fixed + - sliding + nullable: true + type: string + x-auditable: true + retry_backoff: + description: Backoff strategy for retry delays + enum: + - constant + - linear + - exponential + nullable: true + type: string + x-auditable: true + retry_delay: + description: Delay between retry attempts in milliseconds (0-5000) + maximum: 5000 + minimum: 0 + nullable: true + type: integer + x-auditable: true + retry_max_attempts: + description: >- + Maximum number of retry attempts for failed requests + (1-5) + maximum: 5 + minimum: 1 + nullable: true + type: integer + x-auditable: true + store_id: + nullable: true + type: string + stripe: + nullable: true + properties: + authorization: + type: string + usage_events: + items: + properties: + payload: + type: string + required: + - payload + type: object + type: array + required: + - authorization + - usage_events + type: object + x-auditable: true + workers_ai_billing_mode: + default: postpaid + description: >- + Controls how Workers AI inference calls routed through + this gateway are billed. Only 'postpaid' is currently + supported. + enum: + - postpaid + type: string + x-auditable: true + zdr: + type: boolean + x-auditable: true + required: + - id + - rate_limiting_interval + - rate_limiting_limit + - collect_logs + - cache_ttl + - cache_invalidate_on_update + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a single object if found + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch a Gateway + tags: + - AI Gateway Gateways + x-api-token-group: + - AI Gateway Write + - AI Gateway Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: [] + method: get + put: + description: Updates an existing AI Gateway dataset. + operationId: aig-config-update-gateway + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + authentication: + type: boolean + x-auditable: true + cache_invalidate_on_update: + type: boolean + x-auditable: true + cache_ttl: + minimum: 0 + nullable: true + type: integer + x-auditable: true + collect_logs: + type: boolean + x-auditable: true + dlp: + type: object + properties: + action: + enum: + - BLOCK + - FLAG + type: string + enabled: + type: boolean + profiles: + items: + type: string + type: array + policies: + items: + properties: + action: + enum: + - FLAG + - BLOCK + type: string + check: + items: + enum: + - REQUEST + - RESPONSE + type: string + type: array + enabled: + type: boolean + id: + type: string + profiles: + items: + type: string + type: array + required: + - id + - enabled + - action + - profiles + - check + type: object + type: array + required: + - enabled + log_management: + maximum: 10000000 + minimum: 10000 + nullable: true + type: integer + x-auditable: true + log_management_strategy: + enum: + - STOP_INSERTING + - DELETE_OLDEST + nullable: true + type: string + x-auditable: true + logpush: + type: boolean + x-auditable: true + logpush_public_key: + maxLength: 1024 + minLength: 16 + nullable: true + type: string + x-auditable: true + otel: + items: + properties: + authorization: + type: string + content_type: + default: json + enum: + - json + - protobuf + type: string + headers: + type: object + url: + type: string + required: + - url + - headers + - authorization + type: object + nullable: true + type: array + x-auditable: true + rate_limiting_interval: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_limit: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_technique: + enum: + - fixed + - sliding + nullable: true + type: string + x-auditable: true + retry_backoff: + description: Backoff strategy for retry delays + enum: + - constant + - linear + - exponential + nullable: true + type: string + x-auditable: true + retry_delay: + description: Delay between retry attempts in milliseconds (0-5000) + maximum: 5000 + minimum: 0 + nullable: true + type: integer + x-auditable: true + retry_max_attempts: + description: Maximum number of retry attempts for failed requests (1-5) + maximum: 5 + minimum: 1 + nullable: true + type: integer + x-auditable: true + store_id: + nullable: true + type: string + stripe: + nullable: true + properties: + authorization: + type: string + usage_events: + items: + properties: + payload: + type: string + required: + - payload + type: object + type: array + required: + - authorization + - usage_events + type: object + x-auditable: true + workers_ai_billing_mode: + default: postpaid + description: >- + Controls how Workers AI inference calls routed through this + gateway are billed. Only 'postpaid' is currently supported. + enum: + - postpaid + type: string + x-auditable: true + zdr: + type: boolean + x-auditable: true + required: + - rate_limiting_interval + - rate_limiting_limit + - collect_logs + - cache_ttl + - cache_invalidate_on_update + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + authentication: + type: boolean + x-auditable: true + cache_invalidate_on_update: + type: boolean + x-auditable: true + cache_ttl: + minimum: 0 + nullable: true + type: integer + x-auditable: true + collect_logs: + type: boolean + x-auditable: true + created_at: + format: date-time + type: string + readOnly: true + dlp: + type: object + properties: + action: + enum: + - BLOCK + - FLAG + type: string + enabled: + type: boolean + profiles: + items: + type: string + type: array + policies: + items: + properties: + action: + enum: + - FLAG + - BLOCK + type: string + check: + items: + enum: + - REQUEST + - RESPONSE + type: string + type: array + enabled: + type: boolean + id: + type: string + profiles: + items: + type: string + type: array + required: + - id + - enabled + - action + - profiles + - check + type: object + type: array + required: + - enabled + id: + description: gateway id + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + is_default: + type: boolean + x-auditable: true + log_management: + maximum: 10000000 + minimum: 10000 + nullable: true + type: integer + x-auditable: true + log_management_strategy: + enum: + - STOP_INSERTING + - DELETE_OLDEST + nullable: true + type: string + x-auditable: true + logpush: + type: boolean + x-auditable: true + logpush_public_key: + maxLength: 1024 + minLength: 16 + nullable: true + type: string + x-auditable: true + modified_at: + format: date-time + type: string + readOnly: true + otel: + items: + properties: + authorization: + type: string + content_type: + default: json + enum: + - json + - protobuf + type: string + headers: + type: object + url: + type: string + required: + - url + - headers + - authorization + type: object + nullable: true + type: array + x-auditable: true + rate_limiting_interval: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_limit: + minimum: 0 + nullable: true + type: integer + x-auditable: true + rate_limiting_technique: + enum: + - fixed + - sliding + nullable: true + type: string + x-auditable: true + retry_backoff: + description: Backoff strategy for retry delays + enum: + - constant + - linear + - exponential + nullable: true + type: string + x-auditable: true + retry_delay: + description: Delay between retry attempts in milliseconds (0-5000) + maximum: 5000 + minimum: 0 + nullable: true + type: integer + x-auditable: true + retry_max_attempts: + description: >- + Maximum number of retry attempts for failed requests + (1-5) + maximum: 5 + minimum: 1 + nullable: true + type: integer + x-auditable: true + store_id: + nullable: true + type: string + stripe: + nullable: true + properties: + authorization: + type: string + usage_events: + items: + properties: + payload: + type: string + required: + - payload + type: object + type: array + required: + - authorization + - usage_events + type: object + x-auditable: true + workers_ai_billing_mode: + default: postpaid + description: >- + Controls how Workers AI inference calls routed through + this gateway are billed. Only 'postpaid' is currently + supported. + enum: + - postpaid + type: string + x-auditable: true + zdr: + type: boolean + x-auditable: true + required: + - id + - rate_limiting_interval + - rate_limiting_limit + - collect_logs + - cache_ttl + - cache_invalidate_on_update + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Gateway + tags: + - AI Gateway Gateways + x-api-token-group: + - AI Gateway Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.aig + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ai_gateway + resource_chain: [] + method: update +components: + schemas: {} + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + evaluation_types: + id: cloudflare.ai_gateway.evaluation_types + name: evaluation_types + title: Evaluation Types + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-gateway~1evaluation-types/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/evaluation_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + gateways: + id: cloudflare.ai_gateway.gateways + name: gateways + title: Gateways + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-gateway~1gateways/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-gateway~1gateways/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gateways/methods/get' + - $ref: '#/components/x-stackQL-resources/gateways/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/gateways/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/gateways/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/gateways/methods/update' + datasets: + id: cloudflare.ai_gateway.datasets + name: datasets + title: Datasets + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1datasets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1datasets/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1datasets~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1datasets~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1datasets~1{id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/datasets/methods/get' + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/datasets/methods/update' + evaluations: + id: cloudflare.ai_gateway.evaluations + name: evaluations + title: Evaluations + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1evaluations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1evaluations/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1evaluations~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1evaluations~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/evaluations/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/evaluations/methods/delete' + replace: [] + logs: + id: cloudflare.ai_gateway.logs + name: logs + title: Logs + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1logs/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1logs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1logs~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1logs~1{id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + list_logs_request: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1logs~1{id}~1request/get + response: + mediaType: application/json + openAPIDocKey: '200' + list_logs_response: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1logs~1{id}~1response/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/get' + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/logs/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/logs/methods/delete' + replace: [] + provider_configs: + id: cloudflare.ai_gateway.provider_configs + name: provider_configs + title: Provider Configs + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1provider_configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1provider_configs/post + response: + mediaType: application/json + openAPIDocKey: '200' + aig_config_delete_providers: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1provider_configs~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + aig_config_update_providers: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1provider_configs~1{id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_configs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/provider_configs/methods/create' + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/provider_configs/methods/aig_config_delete_providers + replace: + - $ref: >- + #/components/x-stackQL-resources/provider_configs/methods/aig_config_update_providers + dynamic_routing: + id: cloudflare.ai_gateway.dynamic_routing + name: dynamic_routing + title: Dynamic Routing + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dynamic_routing/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dynamic_routing/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dynamic_routing/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/dynamic_routing/methods/delete' + replace: [] + gateways_routes: + id: cloudflare.ai_gateway.gateways_routes + name: gateways_routes + title: Gateways Routes + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/gateways_routes/methods/get_by_account + insert: [] + update: [] + delete: [] + replace: [] + routes_deployments: + id: cloudflare.ai_gateway.routes_deployments + name: routes_deployments + title: Routes Deployments + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_deployment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes_deployments/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/routes_deployments/methods/create_deployment + update: [] + delete: [] + replace: [] + routes_versions: + id: cloudflare.ai_gateway.routes_versions + name: routes_versions + title: Routes Versions + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_version: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}~1versions/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1routes~1{id}~1versions~1{version_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/routes_versions/methods/get_by_account + - $ref: '#/components/x-stackQL-resources/routes_versions/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/routes_versions/methods/create_version + update: [] + delete: [] + replace: [] + urls: + id: cloudflare.ai_gateway.urls + name: urls + title: Urls + methods: + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1ai-gateway~1gateways~1{gateway_id}~1url~1{provider}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/urls/methods/get' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/aisearch.yaml b/providers/src/cloudflare/v00.00.00000/services/aisearch.yaml new file mode 100644 index 00000000..3c3ed6c5 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/aisearch.yaml @@ -0,0 +1,16124 @@ +openapi: 3.0.3 +info: + title: aisearch API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/ai-search/instances: + get: + description: List instances. + operationId: ai-search-list-instances + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter instances whose id contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter instances whose id contains this string (case-insensitive). + type: string + - description: Filter by namespace. + in: query + name: namespace + schema: + description: Filter by namespace. + type: string + - description: Field to order results by. + in: query + name: order_by + schema: + default: created_at + description: Field to order results by. + enum: + - created_at + type: string + - description: Order direction. + in: query + name: order_by_direction + schema: + default: desc + description: Order direction. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List instances. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: list + post: + description: Create a new instance. + operationId: ai-search-create-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the new instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Max instances reached. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: create + /accounts/{account_id}/ai-search/instances/{id}: + delete: + description: Delete instance. + operationId: ai-search-delete-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the deleted instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: delete + get: + description: Read instance. + operationId: ai-search-fetch-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: read + put: + description: Update instance. + operationId: ai-search-update-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + summarization: + default: false + type: boolean + x-auditable: true + summarization_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + system_prompt_ai_search: + nullable: true + type: string + x-auditable: true + system_prompt_index_summarization: + nullable: true + type: string + x-auditable: true + system_prompt_rewrite_query: + nullable: true + type: string + x-auditable: true + token_id: + format: uuid + type: string + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: update + /accounts/{account_id}/ai-search/instances/{id}/chat/completions: + post: + description: Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. + operationId: ai-search-instance-chat-completion + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + stream: + type: boolean + required: + - messages + type: object + responses: + '200': + content: + application/json: + schema: + properties: + choices: + items: + properties: + index: + type: integer + message: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + required: + - message + type: object + type: array + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + id: + type: string + model: + type: string + object: + type: string + required: + - choices + - chunks + type: object + description: Returns the chat completions results with retrieved files. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Chat Completions + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: chat_completions + /accounts/{account_id}/ai-search/instances/{id}/jobs: + get: + description: Lists indexing jobs for an AI Search instance. + operationId: ai-search-instance-list-jobs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Jobs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Jobs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + - jobs + method: list + post: + description: Creates a new indexing job for an AI Search instance. + operationId: ai-search-instance-create-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + maxLength: 255 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search job id. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Sync in cooldown. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new job + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + - jobs + method: create + /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}: + get: + description: Retrieves details for a specific AI Search indexing job. + operationId: ai-search-instance-get-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Job Details. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Job Details + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + - jobs + method: get + patch: + description: Updates the status of an AI Search indexing job. + operationId: ai-search-instance-change-job-status + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + enum: + - cancel + type: string + required: + - action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated AI Search Job. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job cannot be cancelled. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Change Job Status + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs: + get: + description: Lists log entries for an AI Search indexing job. + operationId: ai-search-instance-list-job-logs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 500 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + type: number + readOnly: true + id: + type: integer + message: + type: string + message_type: + type: integer + required: + - id + - message + - message_type + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Job Logs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Job Logs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + - jobs + method: logs + /accounts/{account_id}/ai-search/instances/{id}/search: + post: + description: Executes a semantic search query against an AI Search instance to find relevant indexed content. + operationId: ai-search-instance-search + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + query: + description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." + minLength: 1 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + search_query: + type: string + required: + - search_query + - chunks + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the search results. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: search + /accounts/{account_id}/ai-search/instances/{id}/stats: + get: + description: Retrieves usage statistics for AI Search instances. + operationId: ai-search-stats + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + completed: + type: integer + engine: + description: Engine-specific metadata. Present only for managed (v3) instances. + properties: + r2: + description: R2 bucket storage usage in bytes. + properties: + metadataSizeBytes: + type: integer + objectCount: + type: integer + payloadSizeBytes: + type: integer + required: + - payloadSizeBytes + - metadataSizeBytes + - objectCount + type: object + vectorize: + description: Vectorize index metadata (dimensions, vector count). + properties: + dimensions: + type: integer + vectorsCount: + type: integer + required: + - vectorsCount + - dimensions + type: object + type: object + error: + type: integer + file_embed_errors: + type: object + index_source_errors: + type: object + last_activity: + format: date-time + type: string + outdated: + type: integer + queued: + type: integer + running: + type: integer + skipped: + type: integer + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search stats. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Stats + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - instances + method: stats + /accounts/{account_id}/ai-search/namespaces: + get: + description: List namespaces. + operationId: ai-search-list-namespaces + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter namespaces whose name or description contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter namespaces whose name or description contains this string (case-insensitive). + maxLength: 256 + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of namespaces. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List namespaces. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + method: list + post: + description: Create a new namespace. + operationId: ai-search-create-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Namespace created. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Max namespaces reached. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace already exists. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + method: create + /accounts/{account_id}/ai-search/namespaces/{name}: + delete: + description: Delete namespace. + operationId: ai-search-delete-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Namespace deleted. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not empty. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + method: delete + get: + description: Read namespace. + operationId: ai-search-fetch-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Namespace details. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + method: read + put: + description: Update namespace. + operationId: ai-search-update-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + description: Optional description for the namespace. Max 256 characters. + maxLength: 256 + nullable: true + type: string + name: + type: string + required: + - name + - created_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Returns the updated namespace. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Cannot modify default namespace. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Namespace not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + method: update + /accounts/{account_id}/ai-search/namespaces/{name}/chat/completions: + post: + description: Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response. + operationId: ai-search-namespace-multi-instance-chat-completion + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + instance_ids: + items: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + minItems: 1 + type: array + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + required: + - instance_ids + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + stream: + type: boolean + required: + - messages + - ai_search_options + type: object + responses: + '200': + content: + application/json: + schema: + properties: + choices: + items: + properties: + index: + type: integer + message: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + required: + - message + type: object + type: array + chunks: + items: + properties: + id: + type: string + instance_id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + - instance_id + type: object + type: array + errors: + items: + properties: + instance_id: + type: string + message: + type: string + required: + - instance_id + - message + type: object + type: array + id: + type: string + model: + type: string + object: + type: string + required: + - choices + - chunks + type: object + description: Returns the chat completion result with merged chunks from all instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Multi-Instance Chat Completions + tags: + - AI Search Account Search + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + method: chat_completions + /accounts/{account_id}/ai-search/namespaces/{name}/instances: + get: + description: List instances. + operationId: ai-search-namespace-list-instances + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter instances whose id contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter instances whose id contains this string (case-insensitive). + type: string + - description: Filter by namespace. + in: query + name: namespace + schema: + description: Filter by namespace. + type: string + - description: Field to order results by. + in: query + name: order_by + schema: + default: created_at + description: Field to order results by. + enum: + - created_at + type: string + - description: Order direction. + in: query + name: order_by_direction + schema: + default: desc + description: Order direction. + enum: + - asc + - desc + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List instances. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: list + post: + description: Create a new instance. + operationId: ai-search-namespace-create-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the new instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Max instances reached. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: create + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}: + delete: + description: Delete instance. + operationId: ai-search-namespace-delete-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the deleted instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: delete + get: + description: Read instance. + operationId: ai-search-namespace-fetch-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: read + patch: + description: "Moves an instance from its current namespace to the specified target namespace. Use 'default' as new_namespace to move the instance back to the default namespace. Fails with 400 if the target namespace already has an instance with the same id (ids must be unique within a namespace \u2014 the same id can exist in different namespaces)." + operationId: ai-search-move-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + new_namespace: + description: Target namespace to move the instance into. + type: string + required: + - new_namespace + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Instance moved. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search with this name already exist. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Move an instance to a different namespace. + tags: + - AI Search Namespaces + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + description: Update instance. + operationId: ai-search-namespace-update-instance + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk: + default: true + type: boolean + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + summarization: + default: false + type: boolean + x-auditable: true + summarization_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + system_prompt_ai_search: + nullable: true + type: string + x-auditable: true + system_prompt_index_summarization: + nullable: true + type: string + x-auditable: true + system_prompt_rewrite_query: + nullable: true + type: string + x-auditable: true + token_id: + format: uuid + type: string + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ai_gateway_id: + nullable: true + type: string + x-auditable: true + ai_search_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + cache: + default: true + type: boolean + x-auditable: true + cache_threshold: + default: close_enough + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + x-auditable: true + chunk_overlap: + default: 10 + maximum: 30 + minimum: 0 + type: integer + x-auditable: true + chunk_size: + minimum: 64 + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + custom_metadata: + items: + properties: + data_type: + enum: + - text + - number + - boolean + - datetime + type: string + field_name: + maxLength: 64 + minLength: 1 + type: string + required: + - field_name + - data_type + type: object + maxItems: 5 + type: array + x-auditable: true + embedding_model: + enum: + - '@cf/qwen/qwen3-embedding-0.6b' + - '@cf/baai/bge-m3' + - '@cf/baai/bge-large-en-v1.5' + - '@cf/google/embeddinggemma-300m' + - google-ai-studio/gemini-embedding-001 + - google-ai-studio/gemini-embedding-2-preview + - openai/text-embedding-3-small + - openai/text-embedding-3-large + - '' + - null + nullable: true + type: string + x-auditable: true + enable: + default: true + type: boolean + x-auditable: true + engine_version: + default: 3 + readOnly: true + type: number + fusion_method: + default: rrf + enum: + - max + - rrf + type: string + x-auditable: true + hybrid_search_enabled: + default: false + deprecated: true + description: "Deprecated \u2014 use index_method instead." + type: boolean + x-auditable: true + id: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + index_method: + default: + keyword: false + vector: true + description: Controls which storage backends are used during indexing. Defaults to vector-only. + properties: + keyword: + description: Enable keyword (BM25) storage backend. + type: boolean + vector: + description: Enable vector (embedding) storage backend. + type: boolean + required: + - vector + - keyword + type: object + x-auditable: true + indexing_options: + nullable: true + properties: + keyword_tokenizer: + default: porter + description: Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter. + enum: + - porter + - trigram + type: string + type: object + x-auditable: true + last_activity: + format: date-time + nullable: true + readOnly: true + type: string + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + x-auditable: true + metadata: + properties: + created_from_aisearch_wizard: + type: boolean + search_for_agents: + properties: + hostname: + type: string + zone_id: + type: string + zone_name: + type: string + required: + - zone_id + - zone_name + - hostname + type: object + worker_domain: + type: string + type: object + x-auditable: true + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + namespace: + nullable: true + readOnly: true + type: string + paused: + default: false + type: boolean + x-auditable: true + public_endpoint_id: + nullable: true + readOnly: true + type: string + public_endpoint_params: + properties: + authorized_hosts: + items: + type: string + type: array + chat_completions_endpoint: + properties: + disabled: + default: false + description: Disable chat completions endpoint for this public endpoint + type: boolean + type: object + enabled: + default: false + type: boolean + mcp: + properties: + description: + default: Finds exactly what you're looking for + type: string + disabled: + default: false + description: Disable MCP endpoint for this public endpoint + type: boolean + type: object + rate_limit: + properties: + period_ms: + maximum: 3600000 + minimum: 60000 + type: integer + requests: + minimum: 1 + type: integer + technique: + enum: + - fixed + - sliding + type: string + type: object + search_endpoint: + properties: + disabled: + default: false + description: Disable search endpoint for this public endpoint + type: boolean + type: object + type: object + x-auditable: true + reranking: + default: false + type: boolean + x-auditable: true + reranking_model: + enum: + - '@cf/baai/bge-reranker-base' + - '' + - null + nullable: true + type: string + x-auditable: true + retrieval_options: + nullable: true + properties: + boost_by: + description: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + type: object + x-auditable: true + rewrite_model: + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + - '' + - null + nullable: true + type: string + x-auditable: true + rewrite_query: + default: false + type: boolean + x-auditable: true + score_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + source: + nullable: true + type: string + x-auditable: true + source_params: + nullable: true + properties: + exclude_items: + description: 'List of path patterns to exclude. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /admin/** matches /admin/users and /admin/settings/advanced)' + items: + type: string + maxItems: 10 + type: array + include_items: + description: 'List of path patterns to include. Uses micromatch glob syntax: * matches within a path segment, ** matches across path segments (e.g., /blog/** matches /blog/post and /blog/2024/post)' + items: + type: string + maxItems: 10 + type: array + prefix: + type: string + r2_jurisdiction: + default: default + type: string + web_crawler: + default: + parse_type: sitemap + properties: + crawl_options: + properties: + depth: + maximum: 100000 + minimum: 1 + type: number + include_external_links: + default: false + type: boolean + include_subdomains: + default: false + type: boolean + max_age: + maximum: 604800 + minimum: 0 + type: number + source: + default: all + enum: + - all + - sitemaps + - links + type: string + type: object + parse_options: + properties: + content_selector: + description: List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. + items: + properties: + path: + description: 'Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.' + maxLength: 200 + type: string + selector: + description: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors. + maxLength: 200 + type: string + required: + - path + - selector + type: object + maxItems: 10 + type: array + include_headers: + type: object + include_images: + default: false + type: boolean + specific_sitemaps: + description: List of specific sitemap URLs to use for crawling. Only valid when parse_type is 'sitemap'. + items: + format: uri + type: string + maxItems: 10 + type: array + use_browser_rendering: + default: false + type: boolean + type: object + parse_type: + default: sitemap + enum: + - sitemap + - feed-rss + - crawl + type: string + store_options: + properties: + r2_jurisdiction: + default: default + type: string + storage_id: + type: string + storage_type: + $ref: '#/components/schemas/r2SippyProvider' + required: + - storage_id + type: object + type: object + type: object + x-auditable: true + status: + default: waiting + readOnly: true + type: string + sync_interval: + default: 21600 + description: 'Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).' + x-auditable: true + type: number + enum: + - 900 + token_id: + format: uuid + type: string + x-auditable: true + type: + enum: + - r2 + - web-crawler + - null + nullable: true + type: string + x-auditable: true + required: + - id + - created_at + - modified_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update instance. + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: update + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions: + post: + description: Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses. + operationId: ai-search-namespace-instance-chat-completion + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + stream: + type: boolean + required: + - messages + type: object + responses: + '200': + content: + application/json: + schema: + properties: + choices: + items: + properties: + index: + type: integer + message: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + required: + - message + type: object + type: array + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + id: + type: string + model: + type: string + object: + type: string + required: + - choices + - chunks + type: object + description: Returns the chat completions results with retrieved files. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Chat Completions + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: chat_completions + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items: + get: + description: Lists indexed items in an AI Search instance. + operationId: ai-search-namespace-instance-list-items + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + - in: query + name: search + schema: + maxLength: 256 + type: string + - description: Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at. + in: query + name: sort_by + schema: + default: status + description: Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at. + enum: + - status + - modified_at + type: string + - in: query + name: status + schema: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + type: string + - description: Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com". + in: query + name: source + schema: + description: Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com". + maxLength: 512 + type: string + - description: 'JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}' + in: query + name: metadata_filter + schema: + description: 'JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}' + maxLength: 2048 + type: string + - description: Filter items by their unique ID. Returns at most one item. + in: query + name: item_id + schema: + description: Filter items by their unique ID. Returns at most one item. + maxLength: 64 + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + default: 20 + maximum: 50 + minimum: 5 + type: integer + total_count: + type: integer + required: + - count + - page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns the AI Search items. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Items List. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: list + post: + description: Uploads a file to a managed AI Search instance via multipart/form-data (max 4MB). + operationId: ai-search-namespace-instance-upload-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + description: The file to upload (max 4MB). Filename must not exceed 128 characters. + format: binary + type: string + metadata: + description: JSON string of custom metadata key-value pairs. + type: string + wait_for_completion: + default: false + description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. + type: boolean + required: + - file + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Item uploaded successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Invalid metadata format. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: upload + put: + description: Creates or updates an indexed item in an AI Search instance. + operationId: ai-search-namespace-instance-create-or-update-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + key: + description: Item key / filename. Must not exceed 128 characters. + type: string + next_action: + enum: + - INDEX + type: string + wait_for_completion: + default: false + description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. + type: boolean + required: + - key + - next_action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Item detail. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Filename exceeds maximum length. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to sync item. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create or Update Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: create_or_update + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}: + delete: + description: Deletes a file from a managed AI Search instance and triggers a reindex. + operationId: ai-search-namespace-instance-delete-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + key: + type: string + required: + - key + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Item deleted successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: This operation requires a managed instance. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: delete + get: + description: Retrieves a specific indexed item from an AI Search instance. + operationId: ai-search-namespace-instance-get-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Item detail. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: get + patch: + description: Syncs an item to an AI Search instance index. + operationId: ai-search-namespace-instance-sync-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + next_action: + enum: + - INDEX + type: string + wait_for_completion: + default: false + description: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in `running` state and the background alarm continues polling. Defaults to false. + type: boolean + required: + - next_action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + checksum: + readOnly: true + type: string + chunks_count: + nullable: true + readOnly: true + type: integer + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + error: + readOnly: true + type: string + file_size: + nullable: true + readOnly: true + type: number + x-auditable: true + id: + readOnly: true + type: string + key: + readOnly: true + type: string + last_seen_at: + format: date-time + readOnly: true + type: string + namespace: + readOnly: true + type: string + next_action: + enum: + - INDEX + - DELETE + - null + nullable: true + readOnly: true + type: string + source_id: + description: Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items. + nullable: true + readOnly: true + type: string + status: + enum: + - queued + - running + - completed + - error + - skipped + - outdated + readOnly: true + type: string + required: + - id + - key + - status + - next_action + - checksum + - namespace + - chunks_count + - file_size + - source_id + - last_seen_at + - created_at + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Item detail. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to sync item. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Sync Item. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: sync + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks: + get: + description: Lists chunks for a specific item in an AI Search instance, including their text content. + operationId: ai-search-namespace-instance-list-item-chunks + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: limit + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: offset + schema: + default: 0 + minimum: 0 + type: integer + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + end_byte: + type: number + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + start_byte: + type: number + text: + type: string + required: + - id + - text + - item + type: object + type: array + result_info: + properties: + count: + type: integer + limit: + type: integer + offset: + type: integer + total: + type: integer + required: + - count + - total + - limit + - offset + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns the AI Search item chunks with text content. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Item Chunks. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: chunks + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download: + get: + description: Downloads the raw file content for a specific item from the managed AI Search instance storage. + operationId: ai-search-namespace-instance-get-item-content + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/octet-stream: + schema: + type: object + properties: + contents: + type: string + description: Raw file content. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Content download not available for external source items. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Download Item Content. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: download + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs: + get: + description: Lists processing logs for a specific item in an AI Search instance. + operationId: ai-search-namespace-instance-logs-item + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: path + name: item_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: limit + schema: + default: 50 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: cursor + schema: + maxLength: 512 + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + action: + type: string + chunkCount: + nullable: true + type: integer + errorType: + nullable: true + type: string + fileKey: + type: string + message: + nullable: true + type: string + processingTimeMs: + nullable: true + type: integer + timestamp: + format: date-time + type: string + required: + - timestamp + - action + - message + - fileKey + - chunkCount + - processingTimeMs + - errorType + type: object + type: array + result_info: + properties: + count: + type: integer + cursor: + nullable: true + type: string + per_page: + type: integer + truncated: + type: boolean + required: + - count + - per_page + - cursor + - truncated + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns the AI Search item logs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Item not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Item Logs. + tags: + - AI Search Instances Items + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - items + method: logs + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs: + get: + description: Lists indexing jobs for an AI Search instance. + operationId: ai-search-namespace-instance-list-jobs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 0 + type: integer + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Jobs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Jobs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - jobs + method: list + post: + description: Creates a new indexing job for an AI Search instance. + operationId: ai-search-namespace-instance-create-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + maxLength: 255 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search job id. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Sync in cooldown. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new job + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - jobs + method: create + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}: + get: + description: Retrieves details for a specific AI Search indexing job. + operationId: ai-search-namespace-instance-get-job + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a AI Search Job Details. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Job Details + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - jobs + method: get + patch: + description: Updates the status of an AI Search indexing job. + operationId: ai-search-namespace-instance-change-job-status + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + enum: + - cancel + type: string + required: + - action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + description: + type: string + end_reason: + type: string + ended_at: + type: string + id: + type: string + x-auditable: true + last_seen_at: + type: string + source: + enum: + - user + - schedule + type: string + x-auditable: true + started_at: + type: string + required: + - id + - source + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated AI Search Job. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job cannot be cancelled. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Job not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Change Job Status + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - jobs + method: update + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs: + get: + description: Lists log entries for an AI Search indexing job. + operationId: ai-search-namespace-instance-list-job-logs + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 500 + minimum: 0 + type: integer + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + type: number + readOnly: true + id: + type: integer + message: + type: string + message_type: + type: integer + required: + - id + - message + - message_type + - created_at + type: object + type: array + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - page + - per_page + - total_count + type: object + success: + type: boolean + required: + - success + - result + - result_info + type: object + description: Returns a list of AI Search Job Logs. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search not found. + '503': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Unable to connect to ai search. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Job Logs + tags: + - AI Search Instances Jobs + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + - jobs + method: logs + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search: + post: + description: Executes a semantic search query against an AI Search instance to find relevant indexed content. + operationId: ai-search-namespace-instance-search + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + query: + description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." + minLength: 1 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + chunks: + items: + properties: + id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + type: object + type: array + search_query: + type: string + required: + - search_query + - chunks + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the search results. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: search + /accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats: + get: + description: Retrieves usage statistics for AI Search instances. + operationId: ai-search-namespace-stats + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + completed: + type: integer + engine: + description: Engine-specific metadata. Present only for managed (v3) instances. + properties: + r2: + description: R2 bucket storage usage in bytes. + properties: + metadataSizeBytes: + type: integer + objectCount: + type: integer + payloadSizeBytes: + type: integer + required: + - payloadSizeBytes + - metadataSizeBytes + - objectCount + type: object + vectorize: + description: Vectorize index metadata (dimensions, vector count). + properties: + dimensions: + type: integer + vectorsCount: + type: integer + required: + - vectorsCount + - dimensions + type: object + type: object + error: + type: integer + file_embed_errors: + type: object + index_source_errors: + type: object + last_activity: + format: date-time + type: string + outdated: + type: integer + queued: + type: integer + running: + type: integer + skipped: + type: integer + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the AI Search stats. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Stats + tags: + - AI Search Instances + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + - instances + method: stats + /accounts/{account_id}/ai-search/namespaces/{name}/search: + post: + operationId: ai-search-namespace-multi-instance-search + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_search_options: + properties: + cache: + properties: + cache_threshold: + enum: + - super_strict_match + - close_enough + - flexible_friend + - anything_goes + type: string + enabled: + type: boolean + type: object + instance_ids: + items: + description: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. + maxLength: 64 + minLength: 1 + type: string + x-auditable: true + minItems: 1 + type: array + query_rewrite: + properties: + enabled: + type: boolean + model: + type: string + enum: + - '@cf/meta/llama-3.3-70b-instruct-fp8-fast' + - '@cf/zai-org/glm-4.7-flash' + - '@cf/meta/llama-3.1-8b-instruct-fast' + - '@cf/meta/llama-3.1-8b-instruct-fp8' + - '@cf/meta/llama-4-scout-17b-16e-instruct' + - '@cf/qwen/qwen3-30b-a3b-fp8' + - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b' + - '@cf/moonshotai/kimi-k2-instruct' + - '@cf/google/gemma-3-12b-it' + - '@cf/google/gemma-4-26b-a4b-it' + - '@cf/moonshotai/kimi-k2.5' + - anthropic/claude-3-7-sonnet + - anthropic/claude-sonnet-4 + - anthropic/claude-opus-4 + - anthropic/claude-3-5-haiku + - cerebras/qwen-3-235b-a22b-instruct + - cerebras/qwen-3-235b-a22b-thinking + - cerebras/llama-3.3-70b + - cerebras/llama-4-maverick-17b-128e-instruct + - cerebras/llama-4-scout-17b-16e-instruct + - cerebras/gpt-oss-120b + - google-ai-studio/gemini-2.5-flash + - google-ai-studio/gemini-2.5-pro + - grok/grok-4 + - groq/llama-3.3-70b-versatile + - groq/llama-3.1-8b-instant + - openai/gpt-5 + - openai/gpt-5-mini + - openai/gpt-5-nano + rewrite_prompt: + type: string + type: object + reranking: + properties: + enabled: + type: boolean + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + model: + type: string + enum: + - '@cf/baai/bge-reranker-base' + type: object + retrieval: + properties: + boost_by: + description: Metadata fields to boost search results by. Overrides the instance-level boost_by config. Direction defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom_metadata field. + items: + properties: + direction: + description: "Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'not_exists' = boost chunks that lack the field. Optional \uFFFD\uFFFD\uFFFD defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields." + enum: + - asc + - desc + - exists + - not_exists + type: string + field: + description: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custom_metadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/not_exists. + maxLength: 64 + minLength: 1 + type: string + required: + - field + type: object + maxItems: 3 + type: array + context_expansion: + default: 0 + maximum: 3 + minimum: 0 + type: integer + filters: + type: object + fusion_method: + enum: + - max + - rrf + type: string + keyword_match_mode: + default: and + description: Controls which documents are candidates for BM25 scoring. 'and' restricts candidates to documents containing all query terms; 'or' includes any document containing at least one term, ranked by BM25 relevance. Defaults to 'and'. + enum: + - and + - or + type: string + match_threshold: + default: 0.4 + maximum: 1 + minimum: 0 + type: number + max_num_results: + default: 10 + maximum: 50 + minimum: 1 + type: integer + retrieval_type: + enum: + - vector + - keyword + - hybrid + type: string + return_on_failure: + default: true + type: boolean + type: object + required: + - instance_ids + type: object + messages: + items: + properties: + content: + nullable: true + type: string + role: + enum: + - system + - developer + - user + - assistant + - tool + type: string + required: + - role + - content + type: object + minItems: 1 + type: array + query: + description: "A simple text query string. Alternative to 'messages' \u2014 provide either this or 'messages', not both." + minLength: 1 + type: string + required: + - ai_search_options + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + chunks: + items: + properties: + id: + type: string + instance_id: + type: string + item: + properties: + key: + type: string + metadata: + type: object + timestamp: + type: number + required: + - key + type: object + score: + maximum: 1 + minimum: 0 + type: number + scoring_details: + properties: + fusion_method: + enum: + - rrf + - max + type: string + keyword_rank: + type: number + keyword_score: + minimum: 0 + type: number + reranking_score: + maximum: 1 + minimum: 0 + type: number + vector_rank: + type: number + vector_score: + maximum: 1 + minimum: 0 + type: number + type: object + text: + type: string + type: + type: string + required: + - id + - type + - score + - text + - instance_id + type: object + type: array + errors: + items: + properties: + instance_id: + type: string + message: + type: string + required: + - instance_id + - message + type: object + type: array + search_query: + type: string + required: + - search_query + - chunks + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the merged search results from all instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Multi-Instance Search + tags: + - AI Search Account Search + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - namespaces + method: search + /accounts/{account_id}/ai-search/tokens: + get: + description: List tokens. + operationId: ai-search-list-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number (1-indexed). + in: query + name: page + schema: + default: 1 + description: Page number (1-indexed). + maximum: 100 + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + maximum: 100 + minimum: 1 + type: integer + - description: Filter tokens whose name contains this string (case-insensitive). + in: query + name: search + schema: + description: Filter tokens whose name contains this string (case-insensitive). + maxLength: 256 + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + type: array + result_info: + properties: + count: + type: number + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - page + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + - result_info + type: object + description: List of tokens. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List tokens. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - tokens + method: list + post: + description: Create a new token. + operationId: ai-search-create-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + cf_api_id: + type: string + cf_api_key: + type: string + writeOnly: true + x-sensitive: true + legacy: + default: true + type: boolean + name: + type: string + required: + - name + - cf_api_id + - cf_api_key + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Token created. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - tokens + method: create + /accounts/{account_id}/ai-search/tokens/{id}: + delete: + description: Delete token. + operationId: ai-search-delete-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Token deleted. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token not found. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token in use by instances. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - tokens + method: delete + get: + description: Read token. + operationId: ai-search-fetch-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Token details. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - tokens + method: read + put: + description: Update token. + operationId: ai-search-update-tokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + cf_api_id: + type: string + cf_api_key: + type: string + writeOnly: true + x-sensitive: true + legacy: + default: true + type: boolean + name: + type: string + required: + - name + - cf_api_id + - cf_api_key + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + cf_api_id: + type: string + x-auditable: true + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true + type: string + enabled: + default: true + type: boolean + x-auditable: true + id: + format: uuid + type: string + x-auditable: true + legacy: + default: true + readOnly: true + type: boolean + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + nullable: true + readOnly: true + type: string + name: + type: string + x-auditable: true + required: + - id + - name + - cf_api_id + - created_at + - modified_at + type: object + success: + enum: + - true + type: boolean + required: + - success + - result + type: object + description: Returns the updated token. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Ai search instance invalid token. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Token not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update token. + tags: + - AI Search Tokens + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.ai-search + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: aisearch + resource_chain: + - tokens + method: update +components: + schemas: + r2SippyProvider: + enum: + - r2 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + instances: + id: cloudflare.aisearch.instances + name: instances + title: Instances + methods: + list_by_account_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + ai_search_move_instance: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/instances/methods/list_by_account_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_by_account' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_by_account' + replace: + - $ref: '#/components/x-stackQL-resources/instances/methods/update_by_account' + chat_completions: + id: cloudflare.aisearch.chat_completions + name: chat_completions + title: Chat Completions + methods: + chat_completions_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1chat~1completions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + chat_completions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1chat~1completions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/chat_completions/methods/chat_completions_by_account' + - $ref: '#/components/x-stackQL-resources/chat_completions/methods/chat_completions' + update: [] + delete: [] + replace: [] + jobs: + id: cloudflare.aisearch.jobs + name: jobs + title: Jobs + methods: + list_by_account_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1jobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1jobs~1{job_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + ai_search_instance_change_job_status: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1jobs~1{job_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1jobs~1{job_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list_by_account_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_by_account' + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update' + - $ref: '#/components/x-stackQL-resources/jobs/methods/ai_search_instance_change_job_status' + delete: [] + replace: [] + jobs_logs: + id: cloudflare.aisearch.jobs_logs + name: jobs_logs + title: Jobs Logs + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1jobs~1{job_id}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs_logs/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + instances_search: + id: cloudflare.aisearch.instances_search + name: instances_search + title: Instances Search + methods: + search_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1search/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/instances_search/methods/search_by_account' + update: [] + delete: [] + replace: [] + instances_stats: + id: cloudflare.aisearch.instances_stats + name: instances_stats + title: Instances Stats + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1instances~1{id}~1stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances_stats/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + namespaces: + id: cloudflare.aisearch.namespaces + name: namespaces + title: Namespaces + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/get' + - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/update' + namespace_instances: + id: cloudflare.aisearch.namespace_instances + name: namespace_instances + title: Namespace Instances + methods: + list_by_account_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespace_instances/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/namespace_instances/methods/list_by_account_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/namespace_instances/methods/create_by_account' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/namespace_instances/methods/delete_by_account' + replace: + - $ref: '#/components/x-stackQL-resources/namespace_instances/methods/update_by_account' + namespace_instance_chat_completions: + id: cloudflare.aisearch.namespace_instance_chat_completions + name: namespace_instance_chat_completions + title: Namespace Instance Chat Completions + methods: + chat_completions_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1chat~1completions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/namespace_instance_chat_completions/methods/chat_completions_by_account' + update: [] + delete: [] + replace: [] + instances_items: + id: cloudflare.aisearch.instances_items + name: instances_items + title: Instances Items + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances_items/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + items: + id: cloudflare.aisearch.items + name: items + title: Items + methods: + upload: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items~1{item_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items~1{item_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sync: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items~1{item_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/items/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/items/methods/upload' + update: + - $ref: '#/components/x-stackQL-resources/items/methods/sync' + delete: + - $ref: '#/components/x-stackQL-resources/items/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/items/methods/create_or_update' + item_chunks: + id: cloudflare.aisearch.item_chunks + name: item_chunks + title: Item Chunks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items~1{item_id}~1chunks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/item_chunks/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + items_download: + id: cloudflare.aisearch.items_download + name: items_download + title: Items Download + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items~1{item_id}~1download/get' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/items_download/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + item_logs: + id: cloudflare.aisearch.item_logs + name: item_logs + title: Item Logs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1items~1{item_id}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/item_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + namespaces_instance_jobs: + id: cloudflare.aisearch.namespaces_instance_jobs + name: namespaces_instance_jobs + title: Namespaces Instance Jobs + methods: + list_by_account_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1jobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1jobs~1{job_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces_instance_jobs/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/namespaces_instance_jobs/methods/list_by_account_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/namespaces_instance_jobs/methods/create_by_account' + update: [] + delete: [] + replace: [] + namespaces_instance_job_logs: + id: cloudflare.aisearch.namespaces_instance_job_logs + name: namespaces_instance_job_logs + title: Namespaces Instance Job Logs + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1jobs~1{job_id}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces_instance_job_logs/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + namespaces_instance_search: + id: cloudflare.aisearch.namespaces_instance_search + name: namespaces_instance_search + title: Namespaces Instance Search + methods: + search_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1search/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/namespaces_instance_search/methods/search_by_account' + update: [] + delete: [] + replace: [] + namespaces_instance_stats: + id: cloudflare.aisearch.namespaces_instance_stats + name: namespaces_instance_stats + title: Namespaces Instance Stats + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1instances~1{id}~1stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces_instance_stats/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + namespaces_search: + id: cloudflare.aisearch.namespaces_search + name: namespaces_search + title: Namespaces Search + methods: + search: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1namespaces~1{name}~1search/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/namespaces_search/methods/search' + update: [] + delete: [] + replace: [] + tokens: + id: cloudflare.aisearch.tokens + name: tokens + title: Tokens + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1tokens/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1tokens/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1tokens~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1tokens~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1ai-search~1tokens~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens/methods/get' + - $ref: '#/components/x-stackQL-resources/tokens/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tokens/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tokens/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/tokens/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/alerting.yaml b/providers/src/cloudflare/v00.00.00000/services/alerting.yaml new file mode 100644 index 00000000..731bfedc --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/alerting.yaml @@ -0,0 +1,3040 @@ +openapi: 3.0.3 +info: + title: alerting API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/alerting/v3/available_alerts: + get: + description: Gets a list of all alert types for which an account is eligible. + operationId: notification-alert-types-get-alert-types + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaAlertsResponseCollection' + description: Get Alert Types response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: Get Alert Types response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Alert Types + tags: + - Notification Alert Types + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-stackql-sdk: + service: alerting + resource_chain: + - available_alerts + method: list + /accounts/{account_id}/alerting/v3/destinations/eligible: + get: + description: >- + Get a list of all delivery mechanism types for which an account is + eligible. + operationId: notification-mechanism-eligibility-get-delivery-mechanism-eligibility + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasResponseCollection' + description: Get delivery mechanism eligibility response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: Get delivery mechanism eligibility response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get delivery mechanism eligibility + tags: + - Notification Mechanism Eligibility + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - eligible + method: get + /accounts/{account_id}/alerting/v3/destinations/pagerduty: + delete: + description: Deletes all the PagerDuty Services connected to the account. + operationId: notification-destinations-with-pager-duty-delete-pager-duty-services + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasApiResponseCommon' + description: Delete PagerDuty Services response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: Delete PagerDuty Services response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete PagerDuty Services + tags: + - Notification destinations with PagerDuty + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - pagerduty + method: delete + get: + description: Get a list of all configured PagerDuty services. + operationId: notification-destinations-with-pager-duty-list-pager-duty-services + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaComponentsSchemasResponseCollection' + description: List PagerDuty services response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: List PagerDuty services response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List PagerDuty services + tags: + - Notification destinations with PagerDuty + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - pagerduty + method: get + /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect: + post: + description: Creates a new token for integrating with PagerDuty. + operationId: notification-destinations-with-pager-duty-connect-pager-duty + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSensitiveIdResponse' + description: Token for PagerDuty integration + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + description: Create a token for PagerDuty integration failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create PagerDuty integration token + tags: + - Notification destinations with PagerDuty + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - pagerduty + method: create + /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}: + get: + description: Links PagerDuty with the account using the integration token. + operationId: notification-destinations-with-pager-duty-connect-pager-duty-token + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaIdResponse' + description: Create a Notification policy response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + description: Create a Notification policy response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Connect PagerDuty + tags: + - Notification destinations with PagerDuty + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - pagerduty + method: link + /accounts/{account_id}/alerting/v3/destinations/webhooks: + get: + description: Gets a list of all configured webhook destinations. + operationId: notification-webhooks-list-webhooks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaWebhooksComponentsSchemasResponseCollection + description: List webhooks response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/aaaWebhooks' + type: array + required: + - success + - errors + - messages + - success + - errors + - messages + type: object + description: List webhooks response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List webhooks + tags: + - Notification webhooks + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - webhooks + method: list + post: + description: Creates a new webhook destination. + operationId: notification-webhooks-create-a-webhook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + $ref: '#/components/schemas/aaaComponentsSchemasName' + secret: + $ref: '#/components/schemas/aaaSecret' + url: + $ref: '#/components/schemas/aaaUrl' + required: + - name + - url + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaIdResponse' + description: Create a webhook response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + description: Create a webhook response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a webhook + tags: + - Notification webhooks + x-api-token-group: + - Notifications Write + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - webhooks + method: create + /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}: + delete: + description: Delete a configured webhook destination. + operationId: notification-webhooks-delete-a-webhook + parameters: + - in: path + name: webhook_id + schema: + $ref: '#/components/schemas/aaaWebhookId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasApiResponseCommon' + description: Delete a webhook response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: Delete a webhook response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a webhook + tags: + - Notification webhooks + x-api-token-group: + - Notifications Write + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - webhooks + method: delete + get: + description: Get details for a single webhooks destination. + operationId: notification-webhooks-get-a-webhook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: webhook_id + schema: + $ref: '#/components/schemas/aaaWebhookId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasSingleResponse' + description: Get a webhook response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/aaaWebhooks' + required: + - success + - errors + - messages + - success + - errors + - messages + description: Get a webhook response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a webhook + tags: + - Notification webhooks + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - webhooks + method: get + put: + description: Update a webhook destination. + operationId: notification-webhooks-update-a-webhook + parameters: + - in: path + name: webhook_id + schema: + $ref: '#/components/schemas/aaaWebhookId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + $ref: '#/components/schemas/aaaComponentsSchemasName' + secret: + $ref: '#/components/schemas/aaaSecret' + url: + $ref: '#/components/schemas/aaaUrl' + required: + - name + - url + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaIdResponse' + description: Update a webhook response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + description: Update a webhook response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a webhook + tags: + - Notification webhooks + x-api-token-group: + - Notifications Write + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: alerting + resource_chain: + - destinations + - webhooks + method: update + /accounts/{account_id}/alerting/v3/history: + get: + description: >- + Gets a list of history records for notifications sent to an account. The + records are displayed for last `x` number of days based on the zone plan + (free = 30, pro = 30, biz = 30, ent = 90). + operationId: notification-history-list-history + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: per_page + schema: + $ref: '#/components/schemas/aaaPerPage' + - in: query + name: before + schema: + $ref: '#/components/schemas/aaaBefore' + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: since + schema: + description: >- + Limit the returned results to history records newer than the + specified date. This must be a timestamp that conforms to RFC3339. + format: date-time + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaHistoryComponentsSchemasResponseCollection + description: List History response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/aaaSchemasResultInfo' + type: object + result: + items: + $ref: '#/components/schemas/aaaHistory' + type: array + required: + - success + - errors + - messages + - success + - errors + - messages + description: List History response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List History + tags: + - Notification History + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-stackql-sdk: + service: alerting + resource_chain: + - history + method: list + /accounts/{account_id}/alerting/v3/policies: + get: + description: Get a list of all Notification policies. + operationId: notification-policies-list-notification-policies + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaPoliciesComponentsSchemasResponseCollection + description: List Notification policies response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: List Notification policies response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Notification policies + tags: + - Notification policies + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-stackql-sdk: + service: alerting + resource_chain: + - policies + method: list + post: + description: Creates a new Notification policy. + operationId: notification-policies-create-a-notification-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + alert_interval: + $ref: '#/components/schemas/aaaAlertInterval' + alert_type: + $ref: '#/components/schemas/aaaAlertType' + description: + $ref: '#/components/schemas/aaaSchemasDescription' + enabled: + $ref: '#/components/schemas/aaaEnabled' + filters: + $ref: '#/components/schemas/aaaFilters' + mechanisms: + $ref: '#/components/schemas/aaaMechanisms' + name: + $ref: '#/components/schemas/aaaSchemasName' + required: + - name + - alert_type + - enabled + - mechanisms + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaIdResponse' + description: Create a Notification policy response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + description: Create a Notification policy response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Notification policy + tags: + - Notification policies + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - policies + method: create + /accounts/{account_id}/alerting/v3/policies/{policy_id}: + delete: + description: Delete a Notification policy. + operationId: notification-policies-delete-a-notification-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaApiResponseCollection' + description: Delete a Notification policy response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/aaaSchemasResultInfo' + required: + - success + - errors + - messages + - success + - errors + - messages + description: Delete a Notification policy response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Notification policy + tags: + - Notification policies + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - policies + method: delete + get: + description: Get details for a single policy. + operationId: notification-policies-get-a-notification-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSingleResponse' + description: Get a Notification policy response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/aaaPolicies' + required: + - success + - errors + - messages + - success + - errors + - messages + description: Get a Notification policy response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Notification policy + tags: + - Notification policies + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-stackql-sdk: + service: alerting + resource_chain: + - policies + method: get + put: + description: Update a Notification policy. + operationId: notification-policies-update-a-notification-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + alert_interval: + $ref: '#/components/schemas/aaaAlertInterval' + alert_type: + $ref: '#/components/schemas/aaaAlertType' + description: + $ref: '#/components/schemas/aaaSchemasDescription' + enabled: + $ref: '#/components/schemas/aaaEnabled' + filters: + $ref: '#/components/schemas/aaaFilters' + mechanisms: + $ref: '#/components/schemas/aaaMechanisms' + name: + $ref: '#/components/schemas/aaaSchemasName' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaIdResponse' + description: Update a Notification policy response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + description: Update a Notification policy response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Notification policy + tags: + - Notification policies + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - policies + method: update + /accounts/{account_id}/alerting/v3/policies/{policy_id}/email/unsubscribe: + get: + description: >- + Shows details for unsubscribing an email address from a notification + policy. + operationId: notification-policies-show-email-unsubscribe-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - in: query + name: email + schema: + format: email + type: string + - in: query + name: token + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaUnsubscribeEmailSingleResponse' + text/html: + schema: + type: string + description: Show email unsubscribe details response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: Show email unsubscribe details response failure + security: [] + summary: Show email unsubscribe details + tags: + - Notification policies + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + post: + description: Unsubscribes an email address from a notification policy. + operationId: notification-policies-unsubscribe-email-from-notification-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - in: query + name: email + schema: + format: email + type: string + - in: query + name: token + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaUnsubscribeEmailPostSingleResponse' + text/html: + schema: + type: string + description: Unsubscribe email from Notification policy response + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaComponentsSchemasApiResponseCommonFailure + description: Unsubscribe email from Notification policy response failure + security: [] + summary: Unsubscribe email from a Notification policy + tags: + - Notification policies + /accounts/{account_id}/alerting/v3/silences: + get: + description: Gets a list of silences for an account. + operationId: notification-silences-list-silences + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaSilencesComponentsSchemasResponseCollection + description: List Silences response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/aaaSilence' + type: array + required: + - success + - errors + - messages + - success + - errors + - messages + type: object + description: List Silences response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Silences + tags: + - Notification Silences + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-stackql-sdk: + service: alerting + resource_chain: + - silences + method: update + post: + description: Creates a new silence for an account. + operationId: notification-silences-create-silences + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/aaaSilenceCreateRequest' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasApiResponseCommon' + description: Create Silences response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/aaaSilence' + type: array + required: + - success + - errors + - messages + - success + - errors + - messages + type: object + description: Create Silences response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Silences + tags: + - Notification Silences + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - silences + method: create + put: + description: Updates existing silences for an account. + operationId: notification-silences-update-silences + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/aaaSilenceUpdateRequest' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaSilencesComponentsSchemasResponseCollection + description: Update Silences response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/aaaSilence' + type: array + required: + - success + - errors + - messages + - success + - errors + - messages + type: object + description: Update Silences response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Silences + tags: + - Notification Silences + x-api-token-group: + - Notifications Write + - Account Settings Write + /accounts/{account_id}/alerting/v3/silences/{silence_id}: + delete: + description: Deletes an existing silence for an account. + operationId: notification-silences-delete-silences + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: silence_id + schema: + $ref: '#/components/schemas/aaaSilenceId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasApiResponseCommon' + description: Delete Silence response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/aaaSilence' + required: + - success + - errors + - messages + - success + - errors + - messages + type: object + description: Delete Silence response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Silence + tags: + - Notification Silences + x-api-token-group: + - Notifications Write + - Account Settings Write + x-stackql-sdk: + service: alerting + resource_chain: + - silences + method: delete + get: + description: Gets a specific silence for an account. + operationId: notification-silences-get-silence + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: silence_id + schema: + $ref: '#/components/schemas/aaaSilenceId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/aaaSilenceComponentsSchemasResponseCollection + description: Get Silence response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/aaaSilence' + required: + - success + - errors + - messages + - success + - errors + - messages + type: object + description: Get Silence response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Silence + tags: + - Notification Silences + x-api-token-group: + - 'Zero Trust: PII Read' + - Notifications Write + - Notifications Read + - Account Settings Write + - Account Settings Read + x-stackql-sdk: + service: alerting + resource_chain: + - silences + method: get +components: + schemas: + aaaAccountId: + description: The account id + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + aaaAlertBody: + description: Message body included in the notification sent. + example: SSL certificate has expired + type: string + aaaAlertInterval: + description: >- + Optional specification of how often to re-alert from the same incident, + not support on all alert types. + example: 30m + type: string + x-auditable: true + aaaAlertType: + description: >- + Refers to which event will trigger a Notification dispatch. You can use + the endpoint to get available alert types which then will give you a + list of possible values. + enum: + - abuse_report_alert + - access_custom_certificate_expiration_type + - advanced_ddos_attack_l4_alert + - advanced_ddos_attack_l7_alert + - advanced_http_alert_error + - bgp_hijack_notification + - billing_usage_alert + - block_notification_block_removed + - block_notification_new_block + - block_notification_review_rejected + - bot_traffic_basic_alert + - brand_protection_alert + - brand_protection_digest + - clickhouse_alert_fw_anomaly + - clickhouse_alert_fw_ent_anomaly + - cloudforce_one_request_notification + - cni_maintenance_notification + - custom_analytics + - custom_bot_detection_alert + - custom_ssl_certificate_event_type + - dedicated_ssl_certificate_event_type + - device_connectivity_anomaly_alert + - dos_attack_l4 + - dos_attack_l7 + - expiring_service_token_alert + - failing_logpush_job_disabled_alert + - fbm_auto_advertisement + - fbm_dosd_attack + - fbm_volumetric_attack + - health_check_status_notification + - hostname_aop_custom_certificate_expiration_type + - http_alert_edge_error + - http_alert_origin_error + - image_notification + - image_resizing_notification + - incident_alert + - load_balancing_health_alert + - load_balancing_pool_enablement_alert + - logo_match_alert + - magic_tunnel_health_check_event + - magic_wan_tunnel_health + - maintenance_event_notification + - mtls_certificate_store_certificate_expiration_type + - pages_event_alert + - radar_notification + - real_origin_monitoring + - scriptmonitor_alert_new_code_change_detections + - scriptmonitor_alert_new_hosts + - scriptmonitor_alert_new_malicious_hosts + - scriptmonitor_alert_new_malicious_scripts + - scriptmonitor_alert_new_malicious_url + - scriptmonitor_alert_new_max_length_resource_url + - scriptmonitor_alert_new_resources + - secondary_dns_all_primaries_failing + - secondary_dns_primaries_failing + - secondary_dns_warning + - secondary_dns_zone_successfully_updated + - secondary_dns_zone_validation_warning + - security_insights_alert + - sentinel_alert + - stream_live_notifications + - synthetic_test_latency_alert + - synthetic_test_low_availability_alert + - traffic_anomalies_alert + - tunnel_health_event + - tunnel_update_event + - universal_ssl_event_type + - web_analytics_metrics_update + - zone_aop_custom_certificate_expiration_type + example: universal_ssl_event_type + type: string + x-auditable: true + aaaAlertsResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + example: + Origin Monitoring: + - description: High levels of 5xx HTTP errors at your origin. + display_name: Origin Error Rate Alert + filter_options: + - AvailableValues: null + ComparisonOperator: '==' + Key: zones + Range: 1-n + - AvailableValues: + - Description: Service-Level Objective of 99.7 + ID: '99.7' + - Description: Service-Level Objective of 99.8 + ID: '99.8' + ComparisonOperator: '>=' + Key: slo + Range: 0-1 + type: http_alert_origin_error + type: object + required: + - success + - errors + - messages + type: object + aaaApiResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/aaaSchemasResultInfo' + required: + - success + - errors + - messages + aaaBefore: + description: >- + Limit the returned results to history records older than the specified + date. This must be a timestamp that conforms to RFC3339. + example: '2022-05-20T20:29:58.679897Z' + format: date-time + type: string + aaaComponentsSchemasApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + type: object + aaaComponentsSchemasDescription: + description: Description of the notification policy (if present). + example: >- + Universal Certificate validation status, issuance, renewal, and + expiration notices + type: string + aaaComponentsSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + required: + - message + type: object + uniqueItems: true + type: array + aaaComponentsSchemasName: + description: >- + The name of the webhook destination. This will be included in the + request body when you receive a webhook notification. + example: Slack Webhook + type: string + x-auditable: true + aaaComponentsSchemasResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/aaaPagerduty' + type: array + required: + - success + - errors + - messages + type: object + aaaComponentsSchemasType: + description: Type of webhook endpoint. + enum: + - datadog + - discord + - feishu + - gchat + - generic + - opsgenie + - slack + - splunk + example: slack + type: string + x-auditable: true + aaaCreatedAt: + description: Timestamp of when the webhook destination was created. + example: '2020-10-26T18:25:04.532316Z' + format: date-time + readOnly: true + type: string + x-auditable: true + aaaEnabled: + default: true + description: Whether or not the Notification policy is enabled. + example: true + type: boolean + x-auditable: true + aaaFilters: + description: >- + Optional filters that allow you to be alerted only on a subset of events + for that alert type based on some criteria. This is only available for + select alert types. See alert type documentation for more details. + example: + slo: + - '99.9' + properties: + actions: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + affected_asns: + description: Used for configuring radar_notification + items: + type: string + x-auditable: true + type: array + affected_components: + description: Used for configuring incident_alert + items: + type: string + x-auditable: true + type: array + affected_locations: + description: Used for configuring radar_notification + items: + type: string + x-auditable: true + type: array + airport_code: + description: Used for configuring maintenance_event_notification + items: + type: string + x-auditable: true + type: array + alert_trigger_preferences: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + alert_trigger_preferences_value: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + enabled: + description: Used for configuring load_balancing_pool_enablement_alert + items: + minItems: 1 + type: string + x-auditable: true + type: array + environment: + description: Used for configuring pages_event_alert + items: + minItems: 1 + type: string + x-auditable: true + type: array + event: + description: Used for configuring pages_event_alert + items: + minItems: 1 + type: string + x-auditable: true + type: array + event_source: + description: Used for configuring load_balancing_health_alert + items: + type: string + x-auditable: true + type: array + event_type: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + group_by: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + health_check_id: + description: Used for configuring health_check_status_notification + items: + type: string + x-auditable: true + type: array + incident_impact: + description: Used for configuring incident_alert + items: + enum: + - INCIDENT_IMPACT_NONE + - INCIDENT_IMPACT_MINOR + - INCIDENT_IMPACT_MAJOR + - INCIDENT_IMPACT_CRITICAL + type: string + x-auditable: true + type: array + input_id: + description: Used for configuring stream_live_notifications + items: + type: string + x-auditable: true + type: array + insight_class: + description: Used for configuring security_insights_alert + items: + type: string + x-auditable: true + type: array + limit: + description: Used for configuring billing_usage_alert + items: + minItems: 1 + type: string + x-auditable: true + type: array + logo_tag: + description: Used for configuring logo_match_alert + items: + type: string + x-auditable: true + type: array + megabits_per_second: + description: Used for configuring advanced_ddos_attack_l4_alert + items: + type: string + x-auditable: true + type: array + new_health: + description: Used for configuring load_balancing_health_alert + items: + type: string + x-auditable: true + type: array + new_status: + description: Used for configuring tunnel_health_event + items: + type: string + x-auditable: true + type: array + packets_per_second: + description: Used for configuring advanced_ddos_attack_l4_alert + items: + type: string + x-auditable: true + type: array + pool_id: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + pop_names: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + product: + description: Used for configuring billing_usage_alert + items: + minItems: 1 + type: string + x-auditable: true + type: array + project_id: + description: Used for configuring pages_event_alert + items: + minItems: 1 + type: string + x-auditable: true + type: array + protocol: + description: Used for configuring advanced_ddos_attack_l4_alert + items: + type: string + x-auditable: true + type: array + query_tag: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + requests_per_second: + description: Used for configuring advanced_ddos_attack_l7_alert + items: + type: string + x-auditable: true + type: array + selectors: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + services: + description: Used for configuring clickhouse_alert_fw_ent_anomaly + items: + minItems: 1 + type: string + x-auditable: true + type: array + slo: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + status: + description: Used for configuring health_check_status_notification + items: + minItems: 1 + type: string + x-auditable: true + type: array + target_hostname: + description: Used for configuring advanced_ddos_attack_l7_alert + items: + type: string + x-auditable: true + type: array + target_ip: + description: Used for configuring advanced_ddos_attack_l4_alert + items: + type: string + x-auditable: true + type: array + target_zone_name: + description: Used for configuring advanced_ddos_attack_l7_alert + items: + type: string + x-auditable: true + type: array + traffic_exclusions: + description: Used for configuring traffic_anomalies_alert + items: + enum: + - security_events + maxItems: 1 + type: string + x-auditable: true + type: array + tunnel_id: + description: Used for configuring tunnel_health_event + items: + type: string + x-auditable: true + type: array + tunnel_name: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + type: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + where: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + zones: + description: Usage depends on specific alert type + items: + type: string + x-auditable: true + type: array + type: object + aaaHistory: + properties: + alert_body: + $ref: '#/components/schemas/aaaAlertBody' + alert_type: + $ref: '#/components/schemas/aaaSchemasAlertType' + description: + $ref: '#/components/schemas/aaaComponentsSchemasDescription' + id: + $ref: '#/components/schemas/aaaUuid' + mechanism: + $ref: '#/components/schemas/aaaMechanism' + mechanism_type: + $ref: '#/components/schemas/aaaMechanismType' + name: + $ref: '#/components/schemas/aaaSchemasName' + policy_id: + $ref: '#/components/schemas/aaaPolicyId' + sent: + $ref: '#/components/schemas/aaaSent' + type: object + aaaHistoryComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/aaaSchemasResultInfo' + example: + count: 1 + page: 1 + per_page: 20 + type: object + result: + items: + $ref: '#/components/schemas/aaaHistory' + type: array + required: + - success + - errors + - messages + aaaIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + required: + - success + - errors + - messages + aaaLastFailure: + description: >- + Timestamp of the last time an attempt to dispatch a notification to this + webhook failed. + example: '2020-10-26T18:25:04.532316Z' + format: date-time + readOnly: true + type: string + x-auditable: true + aaaLastSuccess: + description: >- + Timestamp of the last time Cloudflare was able to successfully dispatch + a notification using this webhook. + example: '2020-10-26T18:25:04.532316Z' + format: date-time + readOnly: true + type: string + x-auditable: true + aaaMechanism: + description: The mechanism to which the notification has been dispatched. + example: test@example.com + type: string + x-auditable: true + aaaMechanismType: + description: >- + The type of mechanism to which the notification has been dispatched. + This can be email/pagerduty/webhook based on the mechanism configured. + enum: + - email + - pagerduty + - webhook + example: email + type: string + aaaMechanisms: + description: >- + List of IDs that will be used when dispatching a notification. IDs for + email type will be the email address. + properties: + email: + items: + properties: + id: + description: The email address + type: string + x-auditable: true + type: object + type: array + pagerduty: + items: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + type: array + webhooks: + items: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + type: object + type: array + type: object + aaaName: + description: The name of the pagerduty service. + example: My PagerDuty Service + type: string + x-auditable: true + aaaPagerduty: + properties: + id: + $ref: '#/components/schemas/aaaUuid' + name: + $ref: '#/components/schemas/aaaName' + type: object + aaaPerPage: + default: 25 + description: Number of items per page. + maximum: 1000 + minimum: 5 + type: number + aaaPolicies: + properties: + alert_interval: + $ref: '#/components/schemas/aaaAlertInterval' + alert_type: + $ref: '#/components/schemas/aaaAlertType' + created: + $ref: '#/components/schemas/aaaTimestamp' + description: + $ref: '#/components/schemas/aaaSchemasDescription' + enabled: + $ref: '#/components/schemas/aaaEnabled' + filters: + $ref: '#/components/schemas/aaaFilters' + id: + $ref: '#/components/schemas/aaaPolicyId' + mechanisms: + $ref: '#/components/schemas/aaaMechanisms' + modified: + $ref: '#/components/schemas/aaaTimestamp' + name: + $ref: '#/components/schemas/aaaSchemasName' + type: object + aaaPoliciesComponentsSchemasResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/aaaPolicies' + type: array + required: + - success + - errors + - messages + type: object + aaaPolicyId: + description: The unique identifier of a notification policy + example: 0da2b59ef118439d8097bdfb215203c9 + maxLength: 32 + type: string + x-auditable: true + aaaSchemasAlertType: + description: Type of notification that has been dispatched. + example: universal_ssl_event_type + type: string + aaaSchemasApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + aaaSchemasDescription: + description: Optional description for the Notification policy. + example: Something describing the policy. + type: string + x-auditable: true + aaaSchemasName: + description: Name of the policy. + example: SSL Notification Event Policy + type: string + x-auditable: true + aaaSchemasResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + type: object + aaaSchemasResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + aaaSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/aaaWebhooks' + required: + - success + - errors + - messages + aaaSecret: + description: >- + Optional secret that will be passed in the `cf-webhook-auth` header when + dispatching generic webhook notifications or formatted for supported + destinations. Secrets are not returned in any API response body. + type: string + writeOnly: true + x-sensitive: true + aaaSensitiveIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/aaaToken' + type: object + required: + - success + - errors + - messages + aaaSent: + description: Timestamp of when the notification was dispatched in ISO 8601 format. + example: '2021-10-08T17:52:17.571336Z' + format: date-time + type: string + aaaSilence: + properties: + created_at: + description: When the silence was created. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + readOnly: true + end_time: + description: When the silence ends. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + id: + $ref: '#/components/schemas/aaaSilenceId' + policy_id: + $ref: '#/components/schemas/aaaPolicyId' + start_time: + description: When the silence starts. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + updated_at: + description: When the silence was modified. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + readOnly: true + type: object + aaaSilenceComponentsSchemasResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/aaaSilence' + required: + - success + - errors + - messages + type: object + aaaSilenceCreateRequest: + properties: + end_time: + description: When the silence ends. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + policy_id: + $ref: '#/components/schemas/aaaPolicyId' + start_time: + description: When the silence starts. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + type: object + aaaSilenceId: + description: Silence ID + example: f878e90c23f44126ae3cfc399f646977 + maxLength: 32 + type: string + x-auditable: true + aaaSilenceUpdateRequest: + properties: + end_time: + description: When the silence ends. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + id: + $ref: '#/components/schemas/aaaSilenceId' + start_time: + description: When the silence starts. + example: '2022-01-01T00:00:00Z' + type: string + x-auditable: true + type: object + aaaSilencesComponentsSchemasResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/aaaSilence' + type: array + required: + - success + - errors + - messages + type: object + aaaSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/aaaPolicies' + required: + - success + - errors + - messages + aaaTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + aaaToken: + description: token in form of UUID + example: a313ba7d3e464c0ea40808fafbc3816a + maxLength: 32 + type: string + x-sensitive: true + aaaUnsubscribeEmail: + description: >- + Response body for the GET show-unsubscribe-details endpoint. All fields + are populated. + properties: + account_id: + $ref: '#/components/schemas/aaaAccountId' + email: + format: email + type: string + id: + $ref: '#/components/schemas/aaaPolicyId' + name: + $ref: '#/components/schemas/aaaSchemasName' + token: + type: string + x-sensitive: true + type: object + aaaUnsubscribeEmailPost: + description: >- + Response body for the POST unsubscribe endpoint. name and token are not + returned. + properties: + account_id: + $ref: '#/components/schemas/aaaAccountId' + email: + format: email + type: string + id: + $ref: '#/components/schemas/aaaPolicyId' + type: object + aaaUnsubscribeEmailPostSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/aaaUnsubscribeEmailPost' + required: + - success + - errors + - messages + aaaUnsubscribeEmailSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/aaaUnsubscribeEmail' + required: + - success + - errors + - messages + aaaUrl: + description: The POST endpoint to call when dispatching a notification. + example: https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd + type: string + aaaUuid: + description: UUID + example: f174e90afafe4643bbbc4a0ed4fc8415 + maxLength: 32 + type: string + x-auditable: true + aaaWebhookId: + description: The unique identifier of a webhook + example: b115d5ec15c641ee8b7692c449b5227b + maxLength: 32 + type: string + x-auditable: true + aaaWebhooks: + properties: + created_at: + $ref: '#/components/schemas/aaaCreatedAt' + readOnly: true + id: + $ref: '#/components/schemas/aaaWebhookId' + last_failure: + $ref: '#/components/schemas/aaaLastFailure' + last_success: + $ref: '#/components/schemas/aaaLastSuccess' + name: + $ref: '#/components/schemas/aaaComponentsSchemasName' + secret: + $ref: '#/components/schemas/aaaSecret' + type: + $ref: '#/components/schemas/aaaComponentsSchemasType' + url: + $ref: '#/components/schemas/aaaUrl' + type: object + aaaWebhooksComponentsSchemasResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + messages: + $ref: '#/components/schemas/aaaComponentsSchemasMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/aaaWebhooks' + type: array + required: + - success + - errors + - messages + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + available_alerts: + id: cloudflare.alerting.available_alerts + name: available_alerts + title: Available Alerts + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1available_alerts/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/available_alerts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + eligability: + id: cloudflare.alerting.eligability + name: eligability + title: Eligability + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1eligible/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/eligability/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + pagerduty: + id: cloudflare.alerting.pagerduty + name: pagerduty + title: Pagerduty + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1pagerduty/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1pagerduty/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1pagerduty~1connect/post + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1pagerduty~1connect~1{token_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pagerduty/methods/get' + - $ref: '#/components/x-stackQL-resources/pagerduty/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pagerduty/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/pagerduty/methods/delete' + replace: [] + webhooks: + id: cloudflare.alerting.webhooks + name: webhooks + title: Webhooks + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1webhooks/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1webhooks/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1webhooks~1{webhook_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1webhooks~1{webhook_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1destinations~1webhooks~1{webhook_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/get' + - $ref: '#/components/x-stackQL-resources/webhooks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/update' + history: + id: cloudflare.alerting.history + name: history + title: History + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1alerting~1v3~1history/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/history/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + policies: + id: cloudflare.alerting.policies + name: policies + title: Policies + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1alerting~1v3~1policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1alerting~1v3~1policies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1policies~1{policy_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1policies~1{policy_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1policies~1{policy_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/policies/methods/update' + unsubscribe: + id: cloudflare.alerting.unsubscribe + name: unsubscribe + title: Unsubscribe + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1policies~1{policy_id}~1email~1unsubscribe/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + notification_policies_unsubscribe_email_from_notification_policy: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1policies~1{policy_id}~1email~1unsubscribe/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/unsubscribe/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/unsubscribe/methods/notification_policies_unsubscribe_email_from_notification_policy + update: [] + delete: [] + replace: [] + silences: + id: cloudflare.alerting.silences + name: silences + title: Silences + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1alerting~1v3~1silences/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1alerting~1v3~1silences/post' + response: + mediaType: application/json + openAPIDocKey: '200' + notification_silences_update_silences: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1alerting~1v3~1silences/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1silences~1{silence_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1alerting~1v3~1silences~1{silence_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/silences/methods/get' + - $ref: '#/components/x-stackQL-resources/silences/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/silences/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/silences/methods/delete' + replace: + - $ref: >- + #/components/x-stackQL-resources/silences/methods/notification_silences_update_silences diff --git a/providers/src/cloudflare/v00.00.00000/services/api_gateway.yaml b/providers/src/cloudflare/v00.00.00000/services/api_gateway.yaml new file mode 100644 index 00000000..db0b0567 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/api_gateway.yaml @@ -0,0 +1,5168 @@ +openapi: 3.0.3 +info: + title: api_gateway API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/api_gateway/configuration: + get: + description: >- + Gets the current API Shield configuration settings for a zone, including + validation behavior and enforcement mode. + operationId: >- + api-shield-settings-retrieve-information-about-specific-configuration-properties + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldConfigurationSingleResponse' + description: >- + Retrieve information about specific configuration properties + response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Retrieve information about specific configuration properties + response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve information about specific configuration properties + tags: + - API Shield Settings + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: >- + Ensures that the configuration is written or retrieved in normalized + fashion + in: query + name: normalize + schema: + type: boolean + x-stackql-sdk: + service: api_gateway + resource_chain: + - configurations + method: get + put: + description: >- + Updates API Shield configuration settings for a zone. Can modify + validation strictness, enforcement mode, and other global settings. + operationId: api-shield-settings-set-configuration-properties + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldConfiguration' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldConfigurationSingleResponse' + description: Set configuration properties response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Retrieve information about specific configuration properties + response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update configuration properties + tags: + - API Shield Settings + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: >- + Ensures that the configuration is written or retrieved in normalized + fashion + in: query + name: normalize + schema: + type: boolean + x-stackql-sdk: + service: api_gateway + resource_chain: + - configurations + method: update + /zones/{zone_id}/api_gateway/discovery: + get: + description: >- + Retrieve the most up to date view of discovered operations, rendered as + OpenAPI schemas + operationId: >- + api-shield-api-discovery-retrieve-discovered-operations-on-a-zone-as-openapi + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldSchemaResponseDiscovery' + description: >- + Retrieve discovered operations on a zone, rendered as OpenAPI + schemas response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + schemas: + items: + $ref: '#/components/schemas/apiShieldOpenapi' + type: array + timestamp: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + required: + - timestamp + - schemas + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: >- + Retrieve discovered operations on a zone, rendered as OpenAPI + schemas response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve discovered operations on a zone rendered as OpenAPI schemas + tags: + - API Shield API Discovery + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - discovery + method: get + /zones/{zone_id}/api_gateway/discovery/operations: + get: + description: Retrieve the most up to date view of discovered operations + operationId: api-shield-api-discovery-retrieve-discovered-operations-on-a-zone + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - in: query + name: host + schema: + description: Filter results to only include the specified hosts. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: method + schema: + description: Filter results to only include the specified HTTP methods. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: endpoint + schema: + description: Filter results to only include endpoints containing this pattern. + type: string + - in: query + name: direction + schema: + description: Direction to order results. + enum: + - asc + - desc + type: string + - in: query + name: order + schema: + description: Field to order by + enum: + - host + - method + - endpoint + - traffic_stats.requests + - traffic_stats.last_updated + type: string + - in: query + name: diff + schema: + description: >- + When `true`, only return API Discovery results that are not saved + into API Shield Endpoint Management + type: boolean + - description: >- + Filter results to only include discovery results sourced from a + particular discovery engine * `ML` - Discovered operations that were + sourced using ML API Discovery * `SessionIdentifier` - Discovered + operations that were sourced using Session Identifier API Discovery + in: query + name: origin + schema: + $ref: '#/components/schemas/apiShieldApiDiscoveryOrigin' + - description: >- + Filter results to only include discovery results in a particular + state. States are as follows * `review` - Discovered operations that + are not saved into API Shield Endpoint Management * `saved` - + Discovered operations that are already saved into API Shield + Endpoint Management * `ignored` - Discovered operations that have + been marked as ignored + in: query + name: state + schema: + $ref: '#/components/schemas/apiShieldApiDiscoveryState' + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldDiscoveryOperation' + type: array + required: + - success + - errors + - messages + - result + description: Retrieve discovered operations on a zone response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve discovered operations on a zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve discovered operations on a zone + tags: + - API Shield API Discovery + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: api_gateway + resource_chain: + - discovery + - operations + method: list + patch: + description: Update the `state` on one or more discovered operations + operationId: api-shield-api-patch-discovered-operations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiDiscoveryPatchMultipleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPatchDiscoveriesResponse' + description: Patch discovered operations response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Patch discovered operations response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch discovered operations + tags: + - API Shield API Discovery + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - discovery + - operations + method: bulk_edit + /zones/{zone_id}/api_gateway/discovery/operations/{operation_id}: + patch: + description: Update the `state` on a discovered operation + operationId: api-shield-api-patch-discovered-operation + requestBody: + content: + application/json: + schema: + properties: + state: + $ref: '#/components/schemas/apiShieldApiDiscoveryStatePatch' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPatchDiscoveryResponse' + description: Patch discovered operation response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Patch discovered operation response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch discovered operation + tags: + - API Shield API Discovery + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the discovered operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldSchemasUuid' + required: true + /zones/{zone_id}/api_gateway/expression-template/fallthrough: + post: + description: >- + Creates an expression template fallthrough rule for API Shield. Used for + configuring default behavior when no other expression templates match. + operationId: api-shield-expression-templates-fallthrough + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldRequestExpressionTemplatesFallthrough + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/apiShieldResponseExpressionTemplatesFallthrough + required: + - success + - errors + - messages + - result + type: object + description: Generate fallthrough WAF expression template response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Generate fallthrough WAF expression template failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Generate fallthrough WAF expression template from a set of API hosts + tags: + - API Shield WAF Expression Templates + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - expression_template + - fallthrough + method: create + /zones/{zone_id}/api_gateway/labels: + get: + description: Retrieve all labels + operationId: api-shield-labels-get-labels + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - in: query + name: order + schema: + description: Field to order by + enum: + - name + - description + - created_at + - last_updated + - mapped_resources.operations + type: string + - in: query + name: direction + schema: + description: Direction to order results. + enum: + - asc + - desc + type: string + - description: Filter for labels with source + in: query + name: source + schema: + $ref: '#/components/schemas/apiShieldLabelSource' + - description: >- + Filter for labels where the name or description matches using + substring match + in: query + name: filter + schema: + type: string + - description: Include `mapped_resources` for each label + in: query + name: with_mapped_resource_counts + schema: + default: false + type: boolean + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldFullLabel' + type: array + required: + - success + - errors + - messages + - result + description: Retrieve all labels response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve all labels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve all labels + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + method: list + /zones/{zone_id}/api_gateway/labels/managed/{name}: + get: + description: Retrieve managed label + operationId: api-shield-labels-get-managed-label + parameters: + - description: Include `mapped_resources` for each label + in: query + name: with_mapped_resource_counts + schema: + default: false + type: boolean + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldFullManagedLabel' + required: + - success + - errors + - messages + - result + type: object + description: Retrieve managed label response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve managed label response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve managed label + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + - managed + method: get + /zones/{zone_id}/api_gateway/labels/managed/{name}/resources/operation: + put: + description: Replace all operations(s) attached to a managed label + operationId: api-shield-labels-replace-operations-attached-to-managed-label + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldReplaceOperationsAttachedToLabelRequest + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldFullManagedLabel' + required: + - success + - errors + - messages + - result + type: object + description: Replace all operations(s) attached to a managed label response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Replace all operations(s) attached to a managed label failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Replace operation(s) attached to a managed label + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + - managed + - resources + - operation + method: update + /zones/{zone_id}/api_gateway/labels/user: + delete: + operationId: api-shield-labels-delete-user-labels + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldLabel' + type: array + required: + - success + - errors + - messages + - result + description: Delete user labels response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Delete user labels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete user labels + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + post: + operationId: api-shield-labels-create-user-labels + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/apiShieldLabelRequest' + type: array + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldLabel' + type: array + required: + - success + - errors + - messages + - result + description: Create user labels response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Create user labels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create user labels + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + /zones/{zone_id}/api_gateway/labels/user/{name}: + delete: + description: Delete user label + operationId: api-shield-delete-user-label + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldLabel' + required: + - success + - errors + - messages + - result + type: object + description: Delete user label response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Delete label response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete user label + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + - user + method: delete + get: + description: Retrieve user label + operationId: api-shield-labels-get-user-label + parameters: + - description: Include `mapped_resources` for each label + in: query + name: with_mapped_resource_counts + schema: + default: false + type: boolean + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldFullLabel' + required: + - success + - errors + - messages + - result + type: object + description: Retrieve user label response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve user label response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve user label + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + - user + method: get + patch: + description: Update certain fields on a label + operationId: api-shield-patch-user-label + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPatchLabelRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldLabel' + required: + - success + - errors + - messages + - result + type: object + description: Patch label response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Patch label response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch user label + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + - user + method: edit + put: + description: Update all fields on a label + operationId: api-shield-put-user-label + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPutLabelRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldLabel' + required: + - success + - errors + - messages + - result + type: object + description: Update label response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Update label response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update user label + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + - user + method: update + /zones/{zone_id}/api_gateway/labels/user/{name}/resources/operation: + put: + description: Replace all operations(s) attached to a user label + operationId: api-shield-labels-replace-operations-attached-to-user-label + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldReplaceOperationsAttachedToLabelRequest + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldFullLabel' + required: + - success + - errors + - messages + - result + type: object + description: Replace all operations(s) attached to a user label response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Replace all operations(s) attached to a user label failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Replace operation(s) attached to a user label + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: name + in: path + required: true + description: Resource name. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - labels + - user + - resources + - operation + method: update + /zones/{zone_id}/api_gateway/operations: + delete: + description: >- + Bulk removes multiple API operations from API Shield endpoint management + in a single request. Efficient for cleaning up unused endpoints. + operationId: api-shield-endpoint-management-delete-multiple-operations + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommon' + description: Delete multiple operations response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Delete multiple operations response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete multiple operations + tags: + - API Shield Endpoint Management + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + method: bulk_delete + get: + description: >- + Lists all API operations tracked by API Shield for a zone with + pagination. Returns operation details including method, path, and + feature configurations. + operationId: >- + api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - in: query + name: order + schema: + description: >- + Field to order by. When requesting a feature, the feature keys are + available for ordering as well, e.g., + `thresholds.suggested_threshold`. + enum: + - method + - host + - endpoint + - thresholds.$key + type: string + - in: query + name: direction + schema: + description: Direction to order results. + enum: + - asc + - desc + type: string + - in: query + name: host + schema: + description: Filter results to only include the specified hosts. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: method + schema: + description: Filter results to only include the specified HTTP methods. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: endpoint + schema: + description: Filter results to only include endpoints containing this pattern. + type: string + - description: >- + Add feature(s) to the results. The feature name that is given here + corresponds to the resulting feature object. Have a look at the + top-level object description for more details on the specific + meaning. + in: query + name: feature + schema: + items: + enum: + - thresholds + - parameter_schemas + - schema_info + type: string + type: array + uniqueItems: true + explode: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldMultipleOperationResponsePaginated + description: Retrieve information about all operations on a zone response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve information about all operations on a zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve information about all operations on a zone + tags: + - API Shield Endpoint Management + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + method: list + post: + description: >- + Add one or more operations to a zone. Endpoints can contain path + variables. Host, method, endpoint will be normalized to a canoncial form + when creating an operation and must be unique on the zone. Inserting an + operation that matches an existing one will return the record of the + already existing operation and update its last_updated date. + operationId: api-shield-endpoint-management-add-operations-to-a-zone + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/apiShieldBasicOperation' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldMultipleOperationResponse' + description: Add operations to a zone response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Add operations to a zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add operations to a zone + tags: + - API Shield Endpoint Management + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + /zones/{zone_id}/api_gateway/operations/item: + post: + description: >- + Add one operation to a zone. Endpoints can contain path variables. Host, + method, endpoint will be normalized to a canoncial form when creating an + operation and must be unique on the zone. Inserting an operation that + matches an existing one will return the record of the already existing + operation and update its last_updated date. + operationId: api-shield-endpoint-management-add-operation-to-a-zone + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldBasicOperation' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldSingleOperationResponse' + description: Add one operation to a zone response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Add one operation to a zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add one operation to a zone + tags: + - API Shield Endpoint Management + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + method: create + /zones/{zone_id}/api_gateway/operations/labels: + delete: + description: Bulk remove label(s) on operation(s) in endpoint management + operationId: api-shield-operations-bulk-delete-labels-to-operations + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/apiShieldOperationWithLabelsOnly' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Bulk remove label(s) on operation(s) in endpoint management response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Bulk remove label(s) on operation(s) in endpoint management response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Bulk remove label(s) on operation(s) in endpoint management + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + post: + description: Bulk attach label(s) on operation(s) in endpoint management + operationId: api-shield-operations-bulk-post-labels-to-operations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldBulkPostLabelsOnOperationRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/apiShieldOperationWithLabelsOnly' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Bulk attach label(s) on operation(s) in endpoint management response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Bulk attach label(s) on operation(s) in endpoint management response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Bulk attach label(s) on operation(s) in endpoint management + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + put: + description: Bulk replace label(s) on operation(s) in endpoint management + operationId: api-shield-operations-bulk-put-labels-to-operations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldBulkPutLabelsOnOperationRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/apiShieldOperationWithLabelsOnly' + type: array + required: + - success + - errors + - messages + - result + type: object + description: >- + Bulk replace label(s) on operation(s) in endpoint management + response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Bulk replace label(s) on operation(s) in endpoint management + response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Bulk replace label(s) on operation(s) in endpoint management + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + /zones/{zone_id}/api_gateway/operations/schema_validation: + patch: + deprecated: true + description: Updates multiple operation-level schema validation settings on the zone + operationId: api-shield-schema-validation-update-multiple-operation-level-settings + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldOldOperationSchemaValidationSettingsMultipleRequest + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/apiShieldOldOperationSchemaValidationSettingsMultipleRequest + required: + - success + - errors + - messages + - result + type: object + description: Update multiple operation-level schema validation settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Update multiple operation-level schema validation settings response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update multiple operation-level schema validation settings + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Domain API Gateway + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + - schema_validation + method: edit + /zones/{zone_id}/api_gateway/operations/{operation_id}: + delete: + description: >- + Removes a single API operation from API Shield endpoint management. The + operation will no longer be tracked or protected by API Shield rules. + operationId: api-shield-endpoint-management-delete-an-operation + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommon' + description: Delete an operation response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Delete an operation response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an operation + tags: + - API Shield Endpoint Management + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + method: delete + get: + description: >- + Gets detailed information about a specific API operation in API Shield, + including its schema validation settings and traffic statistics. + operationId: api-shield-endpoint-management-retrieve-information-about-an-operation + parameters: + - description: >- + Add feature(s) to the results. The feature name that is given here + corresponds to the resulting feature object. Have a look at the + top-level object description for more details on the specific + meaning. + in: query + name: feature + schema: + items: + enum: + - thresholds + - parameter_schemas + - schema_info + type: string + type: array + uniqueItems: true + explode: true + - description: >- + When true, includes OpenAPI schemas (both uploaded and learned) for + the operation in the response. Due to the conversion overhead, this + parameter is only supported on single-operation retrieval. + in: query + name: with_schemas + schema: + default: false + type: boolean + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldSingleOperationResponse' + description: Retrieve information about an operation response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve information about an operation response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve information about an operation + tags: + - API Shield Endpoint Management + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + method: get + /zones/{zone_id}/api_gateway/operations/{operation_id}/labels: + delete: + description: Remove label(s) on an operation in endpoint management + operationId: api-shield-operations-delete-labels-from-operation + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldOperationWithLabelsOnly' + required: + - success + - errors + - messages + - result + type: object + description: Remove label(s) on an operation in endpoint management response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Remove label(s) on an operation in endpoint management response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Remove label(s) on an operation in endpoint management + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + - labels + method: delete + post: + description: Attach label(s) on an operation in endpoint management + operationId: api-shield-operations-post-labels-to-operation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPostLabelsOnOperationRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldOperationWithLabelsOnly' + required: + - success + - errors + - messages + - result + type: object + description: Attach label(s) on an operation in endpoint management response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Attach label(s) on an operation in endpoint management response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Attach label(s) on an operation in endpoint management + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + - labels + method: create + put: + description: Replace label(s) on an operation in endpoint management + operationId: api-shield-operations-put-labels-to-operation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPutLabelsOnOperationRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldOperationWithLabelsOnly' + required: + - success + - errors + - messages + - result + type: object + description: Replace label(s) on an operation in endpoint management response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: >- + Replace label(s) on an operation in endpoint management response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Replace label(s) on an operation in endpoint management + tags: + - API Shield Labels + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + - labels + method: update + /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation: + get: + deprecated: true + description: Retrieves operation-level schema validation settings on the zone + operationId: api-shield-schema-validation-retrieve-operation-level-settings + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldOldOperationSchemaValidationSettings + description: Operation-level schema validation settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Operation-level schema validation settings response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve operation-level schema validation settings + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + - schema_validation + method: get + put: + deprecated: true + description: Updates operation-level schema validation settings on the zone + operationId: api-shield-schema-validation-update-operation-level-settings + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldOldOperationSchemaValidationSettingsModifyRequest + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldOldOperationSchemaValidationSettings + description: Update operation-level schema validation settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Update operation-level schema validation settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update operation-level schema validation settings + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Domain API Gateway + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - operations + - schema_validation + method: update + /zones/{zone_id}/api_gateway/schemas: + get: + operationId: >- + api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas + parameters: + - in: query + name: host + schema: + description: Receive schema only for the given host(s). + items: + type: string + type: array + uniqueItems: true + explode: true + - description: >- + Add feature(s) to the results. The feature name that is given here + corresponds to the resulting feature object. Have a look at the + top-level object description for more details on the specific + meaning. + in: query + name: feature + schema: + items: + enum: + - thresholds + - parameter_schemas + - schema_info + type: string + type: array + uniqueItems: true + explode: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldSchemaResponseWithThresholds' + description: Retrieve operations and features as OpenAPI schemas response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve operations and features as OpenAPI schemas response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve operations and features as OpenAPI schemas + tags: + - API Shield Endpoint Management + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: api_gateway + resource_chain: + - schemas + method: list + /zones/{zone_id}/api_gateway/settings/schema_validation: + get: + deprecated: true + description: >- + Retrieves zone level schema validation settings currently set on the + zone + operationId: api-shield-schema-validation-retrieve-zone-level-settings + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldOldZoneSchemaValidationSettings' + description: Zone level schema validation settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Zone level schema validation settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve zone level schema validation settings + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - settings + - schema_validation + method: get + patch: + deprecated: true + description: Updates zone level schema validation settings on the zone + operationId: api-shield-schema-validation-patch-zone-level-settings + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/apiShieldOldZoneSchemaValidationSettingsPatch + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldOldZoneSchemaValidationSettings' + description: Update zone level schema validation settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Update zone level schema validation settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update zone level schema validation settings + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Domain API Gateway + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - settings + - schema_validation + method: edit + put: + deprecated: true + description: Updates zone level schema validation settings on the zone + operationId: api-shield-schema-validation-update-zone-level-settings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldOldZoneSchemaValidationSettingsPut' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldOldZoneSchemaValidationSettings' + description: Update zone level schema validation settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Update zone level schema validation settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update zone level schema validation settings + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Domain API Gateway + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - settings + - schema_validation + method: update + /zones/{zone_id}/api_gateway/user_schemas: + get: + deprecated: true + description: >- + Lists all OpenAPI schemas uploaded to API Shield for the zone, including + their validation status and associated operations. + operationId: api-shield-schema-validation-retrieve-information-about-all-schemas + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - description: Omit the source-files of schemas and only retrieve their meta-data. + in: query + name: omit_source + schema: + default: false + type: boolean + - in: query + name: validation_enabled + schema: + $ref: '#/components/schemas/apiShieldOldValidationEnabled' + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldOldPublicSchema' + type: array + required: + - success + - errors + - messages + - result + description: Retrieve information about all schemas on a zone response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve information about all schemas on a zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve information about all schemas on a zone + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + x-stackql-sdk: + service: api_gateway + resource_chain: + - user_schemas + method: list + post: + deprecated: true + operationId: api-shield-schema-validation-post-schema + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + description: Schema file bytes + format: binary + type: string + kind: + $ref: '#/components/schemas/apiShieldOldKind' + name: + description: Name of the schema + type: string + validation_enabled: + description: Flag whether schema is enabled for validation. + enum: + - 'true' + - 'false' + type: string + required: + - file + - kind + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldOldSchemaUploadResponse' + required: + - success + - errors + - messages + - result + type: object + description: Upload a schema response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldOldSchemaUploadFailure' + description: Upload a schema response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload a schema to a zone + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Domain API Gateway + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: api_gateway + resource_chain: + - user_schemas + method: create + /zones/{zone_id}/api_gateway/user_schemas/hosts: + get: + deprecated: true + description: >- + Lists all unique hosts found in uploaded OpenAPI schemas for the zone. + Useful for understanding which domains have schema coverage. + operationId: api-shield-schema-validation-retrieve-user-schema-hosts + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/apiShieldOldResponseUserSchemasHosts + type: array + required: + - success + - errors + - messages + description: Retrieve schema hosts in a zone response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve schema hosts in a zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve schema hosts in a zone + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + x-stackql-sdk: + service: api_gateway + resource_chain: + - user_schemas + - hosts + method: list + /zones/{zone_id}/api_gateway/user_schemas/{schema_id}: + delete: + deprecated: true + description: >- + Permanently removes an uploaded OpenAPI schema from API Shield schema + validation. Operations using this schema will lose their validation + rules. + operationId: api-shield-schema-delete-a-schema + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseSingle' + description: Delete a schema response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Delete a schema response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a schema + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Domain API Gateway + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the schema-ID + in: path + name: schema_id + schema: + format: uuid + maxLength: 36 + readOnly: true + type: string + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - user_schemas + method: delete + get: + deprecated: true + description: >- + Gets detailed information about a specific uploaded OpenAPI schema, + including its contents and validation configuration. + operationId: api-shield-schema-validation-retrieve-information-about-specific-schema + parameters: + - description: Omit the source-files of schemas and only retrieve their meta-data. + in: query + name: omit_source + schema: + default: false + type: boolean + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the schema-ID + in: path + name: schema_id + schema: + format: uuid + maxLength: 36 + readOnly: true + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldOldPublicSchema' + required: + - success + - errors + - messages + - result + type: object + description: Retrieve information about a specific schema on a zone response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve information about a specific schema zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve information about a specific schema on a zone + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + x-stackql-sdk: + service: api_gateway + resource_chain: + - user_schemas + method: get + patch: + deprecated: true + description: >- + Activates schema validation for an uploaded OpenAPI schema. Requests to + matching endpoints will be validated against the schema definitions. + operationId: api-shield-schema-validation-enable-validation-for-a-schema + requestBody: + content: + application/json: + schema: + properties: + validation_enabled: + description: Flag whether schema is enabled for validation. + type: boolean + x-auditable: true + enum: + - true + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldOldPublicSchema' + required: + - success + - errors + - messages + - result + type: object + description: Enable validation for a schema response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Enable validation for a schema response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Enable validation for a schema + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Domain API Gateway + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the schema-ID + in: path + name: schema_id + schema: + format: uuid + maxLength: 36 + readOnly: true + type: string + required: true + x-stackql-sdk: + service: api_gateway + resource_chain: + - user_schemas + method: edit + /zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations: + get: + deprecated: true + description: >- + Retrieves all operations from the schema. Operations that already exist + in API Shield Endpoint Management will be returned as full operations. + operationId: api-shield-schema-validation-extract-operations-from-schema + parameters: + - description: >- + Add feature(s) to the results. The feature name that is given here + corresponds to the resulting feature object. Have a look at the + top-level object description for more details on the specific + meaning. + in: query + name: feature + schema: + items: + enum: + - thresholds + - parameter_schemas + - schema_info + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: host + schema: + description: Filter results to only include the specified hosts. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: method + schema: + description: Filter results to only include the specified HTTP methods. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: endpoint + schema: + description: Filter results to only include endpoints containing this pattern. + type: string + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - description: >- + Filter results by whether operations exist in API Shield Endpoint + Management or not. `new` will just return operations from the schema + that do not exist in API Shield Endpoint Management. `existing` will + just return operations from the schema that already exist in API + Shield Endpoint Management. + in: query + name: operation_status + schema: + enum: + - new + - existing + type: string + - description: Identifier for the schema-ID + in: path + name: schema_id + schema: + format: uuid + maxLength: 36 + readOnly: true + type: string + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + type: object + properties: + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + method: + $ref: '#/components/schemas/apiShieldMethod' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + features: + $ref: '#/components/schemas/apiShieldOperationFeatures' + required: + - endpoint + - host + - method + type: array + required: + - success + - errors + - messages + - result + description: Retrieve all operations from a schema response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Retrieve all operations from a schema response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve all operations from a schema. + tags: + - API Shield Schema Validation 2.0 + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stainless-deprecation-message: >- + Use [Schema Validation + API](https://developers.cloudflare.com/api/resources/schema_validation/) + instead. + x-stackql-sdk: + service: api_gateway + resource_chain: + - user_schemas + - operations + method: list +components: + schemas: + apiShieldApiDiscoveryOrigin: + description: >- + * `ML` - Discovered operation was sourced using ML API Discovery * + `SessionIdentifier` - Discovered operation was sourced using Session + Identifier API Discovery * `LabelDiscovery` - Discovered operation was + identified to have a specific label + enum: + - ML + - SessionIdentifier + - LabelDiscovery + type: string + x-auditable: true + apiShieldApiDiscoveryPatchMultipleRequest: + example: + 3818d821-5901-4147-a474-f5f5aec1d54e: + state: ignored + b17c8043-99a0-4202-b7d9-8f7cdbee02cd: + state: review + type: object + apiShieldApiDiscoveryState: + description: >- + State of operation in API Discovery * `review` - Operation is not saved + into API Shield Endpoint Management * `saved` - Operation is saved into + API Shield Endpoint Management * `ignored` - Operation is marked as + ignored + enum: + - review + - saved + - ignored + type: string + x-auditable: true + apiShieldApiDiscoveryStatePatch: + description: >- + Mark state of operation in API Discovery * `review` - Mark operation as + for review * `ignored` - Mark operation as ignored + enum: + - review + - ignored + type: string + x-auditable: true + apiShieldApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + apiShieldApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/apiShieldMessages' + messages: + example: [] + $ref: '#/components/schemas/apiShieldMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + apiShieldApiResponseSingle: + type: object + $ref: '#/components/schemas/apiShieldApiResponseCommon' + apiShieldAuthIdCharacteristics: + items: + type: object + description: Auth ID Characteristic + properties: + name: + description: >- + The name of the characteristic field, i.e., the header or cookie + name. + example: authorization + maxLength: 128 + type: string + x-auditable: true + type: + description: The type of characteristic. + enum: + - header + - cookie + example: header + type: string + x-auditable: true + required: + - name + - type + maxItems: 10 + type: array + uniqueItems: true + apiShieldAuthIdTokens: + description: The total number of auth-ids seen across this calculation. + readOnly: true + type: integer + x-auditable: true + apiShieldBasicOperation: + properties: + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + method: + $ref: '#/components/schemas/apiShieldMethod' + required: + - method + - host + - endpoint + type: object + apiShieldBulkPostLabelsOnOperationRequest: + properties: + managed: + properties: + labels: + description: List of managed label names. + items: + $ref: '#/components/schemas/apiShieldLabelName' + minItems: 1 + type: array + type: object + selector: + $ref: '#/components/schemas/apiShieldOperationIdSelector' + user: + properties: + labels: + description: List of user label names. + items: + $ref: '#/components/schemas/apiShieldLabelName' + minItems: 1 + type: array + type: object + required: + - selector + type: object + apiShieldBulkPutLabelsOnOperationRequest: + properties: + managed: + description: Managed labels to replace for all affected operations + properties: + labels: + description: >- + List of managed label names. Providing an empty array will + result in all managed labels being removed from all affected + operations + items: + $ref: '#/components/schemas/apiShieldLabelName' + type: array + required: + - labels + type: object + selector: + $ref: '#/components/schemas/apiShieldOperationIdSelector' + user: + description: User labels to replace for all affected operations + properties: + labels: + description: >- + List of user label names. Providing an empty array will result + in all user labels being removed from all affected operations + items: + $ref: '#/components/schemas/apiShieldLabelName' + type: array + required: + - labels + type: object + required: + - selector + - user + - managed + type: object + apiShieldConfidenceIntervalsBounds: + description: Upper and lower bound for percentile estimate + properties: + lower: + description: Lower bound for percentile estimate + example: 20.5 + type: number + x-auditable: true + upper: + description: Upper bound for percentile estimate + example: 30.4 + type: number + x-auditable: true + readOnly: true + type: object + apiShieldConfiguration: + properties: + auth_id_characteristics: + $ref: '#/components/schemas/apiShieldAuthIdCharacteristics' + required: + - auth_id_characteristics + type: object + apiShieldConfigurationSingleResponse: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/apiShieldConfiguration' + required: + - success + - errors + - messages + - result + type: object + apiShieldDataPoints: + description: The number of data points used for the threshold suggestion calculation. + readOnly: true + type: integer + x-auditable: true + apiShieldDiscoveryOperation: + properties: + features: + $ref: '#/components/schemas/apiShieldTrafficStats' + id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + origin: + description: API discovery engine(s) that discovered this operation + items: + $ref: '#/components/schemas/apiShieldApiDiscoveryOrigin' + type: array + state: + $ref: '#/components/schemas/apiShieldApiDiscoveryState' + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + method: + $ref: '#/components/schemas/apiShieldMethod' + required: + - id + - last_updated + - state + - origin + - method + - host + - endpoint + type: object + apiShieldEndpoint: + description: >- + The endpoint which can contain path parameter templates in curly braces, + each will be replaced from left to right with {varN}, starting with + {var1}, during insertion. This will further be Cloudflare-normalized + upon insertion. See: + https://developers.cloudflare.com/rules/normalization/how-it-works/. + example: /api/v1/users/{var1} + format: uri-template + maxLength: 4096 + type: string + x-auditable: true + apiShieldFullLabel: + type: object + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/apiShieldLabelDescription' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + metadata: + $ref: '#/components/schemas/apiShieldLabelMetadata' + name: + $ref: '#/components/schemas/apiShieldLabelName' + source: + $ref: '#/components/schemas/apiShieldLabelSource' + mapped_resources: + $ref: '#/components/schemas/apiShieldLabelMappedResources' + required: + - name + - description + - metadata + - source + - last_updated + - created_at + apiShieldFullManagedLabel: + type: object + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/apiShieldLabelDescription' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + metadata: + $ref: '#/components/schemas/apiShieldLabelMetadata' + name: + $ref: '#/components/schemas/apiShieldLabelName' + source: + $ref: '#/components/schemas/apiShieldLabelSource' + example: managed + mapped_resources: + $ref: '#/components/schemas/apiShieldLabelMappedResources' + required: + - name + - description + - metadata + - source + - last_updated + - created_at + apiShieldHost: + description: RFC3986-compliant host. + example: www.example.com + format: hostname + maxLength: 255 + type: string + x-auditable: true + apiShieldLabel: + type: object + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/apiShieldLabelDescription' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + metadata: + $ref: '#/components/schemas/apiShieldLabelMetadata' + name: + $ref: '#/components/schemas/apiShieldLabelName' + source: + $ref: '#/components/schemas/apiShieldLabelSource' + required: + - name + - description + - metadata + - source + - last_updated + - created_at + apiShieldLabelDescription: + description: The description of the label + example: All endpoints that deal with logins + type: string + x-auditable: true + apiShieldLabelMappedResources: + description: Provides counts of what resources are linked to this label + example: + operations: 29 + type: object + apiShieldLabelMetadata: + description: Metadata for the label + example: + foo: bar + type: object + apiShieldLabelName: + description: The name of the label + example: login + type: string + x-auditable: true + apiShieldLabelRequest: + properties: + description: + $ref: '#/components/schemas/apiShieldLabelDescription' + metadata: + $ref: '#/components/schemas/apiShieldLabelMetadata' + name: + $ref: '#/components/schemas/apiShieldLabelName' + required: + - name + type: object + apiShieldLabelSource: + description: >- + * `user` - label is owned by the user * `managed` - label is owned by + cloudflare + enum: + - user + - managed + type: string + x-auditable: true + apiShieldMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + apiShieldMethod: + description: The HTTP method used to access the endpoint. + enum: + - GET + - POST + - HEAD + - OPTIONS + - PUT + - DELETE + - CONNECT + - PATCH + - TRACE + example: GET + type: string + x-auditable: true + apiShieldMultipleOperationResponse: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/apiShieldOperation' + type: array + required: + - success + - errors + - messages + - result + type: object + apiShieldMultipleOperationResponsePaginated: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldOperation' + type: array + required: + - success + - errors + - messages + - result + apiShieldOldKind: + description: Kind of schema + enum: + - openapi_v3 + example: openapi_v3 + type: string + x-auditable: true + apiShieldOldOperationMitigationAction: + description: >- + When set, this applies a mitigation action to this operation - `log` log + request when request does not conform to schema for this operation - + `block` deny access to the site when request does not conform to schema + for this operation - `none` will skip mitigation for this operation - + `null` indicates that no operation level mitigation is in place, see + Zone Level Schema Validation Settings for mitigation action that will be + applied + enum: + - log + - block + - none + - null + example: block + nullable: true + type: string + x-auditable: true + apiShieldOldOperationSchemaValidationSettings: + properties: + mitigation_action: + $ref: '#/components/schemas/apiShieldOldOperationMitigationAction' + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + type: object + apiShieldOldOperationSchemaValidationSettingsModifyRequest: + properties: + mitigation_action: + $ref: '#/components/schemas/apiShieldOldOperationMitigationAction' + type: object + apiShieldOldOperationSchemaValidationSettingsMultipleRequest: + example: + 3818d821-5901-4147-a474-f5f5aec1d54e: + mitigation_action: log + b17c8043-99a0-4202-b7d9-8f7cdbee02cd: + mitigation_action: block + type: object + apiShieldOldPublicSchema: + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + kind: + $ref: '#/components/schemas/apiShieldOldKind' + name: + description: Name of the schema + example: petstore schema + type: string + x-auditable: true + schema_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + source: + description: Source of the schema + example: + type: string + x-auditable: true + validation_enabled: + $ref: '#/components/schemas/apiShieldOldValidationEnabled' + required: + - schema_id + - name + - kind + - created_at + type: object + apiShieldOldResponseUserSchemasHosts: + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + hosts: + description: Hosts serving the schema, e.g zone.host.com + items: + type: string + type: array + name: + description: Name of the schema + example: petstore schema + type: string + x-auditable: true + schema_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + required: + - schema_id + - name + - hosts + - created_at + type: object + apiShieldOldSchemaUploadDetailsErrorsCritical: + properties: + critical: + description: Diagnostic critical error events that occurred during processing. + items: + $ref: '#/components/schemas/apiShieldOldSchemaUploadLogEvent' + type: array + errors: + description: Diagnostic error events that occurred during processing. + items: + $ref: '#/components/schemas/apiShieldOldSchemaUploadLogEvent' + type: array + type: object + apiShieldOldSchemaUploadDetailsWarningsOnly: + properties: + warnings: + description: >- + Diagnostic warning events that occurred during processing. These + events are non-critical errors found within the schema. + items: + $ref: '#/components/schemas/apiShieldOldSchemaUploadLogEvent' + type: array + type: object + apiShieldOldSchemaUploadFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/apiShieldMessages' + messages: + example: [] + $ref: '#/components/schemas/apiShieldMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + upload_details: + $ref: '#/components/schemas/apiShieldOldSchemaUploadDetailsErrorsCritical' + required: + - success + - errors + - messages + - result + type: object + apiShieldOldSchemaUploadLogEvent: + properties: + code: + description: Code that identifies the event that occurred. + example: 28 + type: integer + x-auditable: true + locations: + description: >- + JSONPath location(s) in the schema where these events were + encountered. See + [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) + for JSONPath specification. + items: + description: >- + JSONPath location in the schema where these events were + encountered. See + [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) + for JSONPath specification. + example: .paths["/user/{username}"].put + type: string + x-auditable: true + type: array + message: + description: Diagnostic message that describes the event. + example: 'unsupported media type: application/octet-stream' + type: string + x-auditable: true + required: + - code + type: object + apiShieldOldSchemaUploadResponse: + properties: + schema: + $ref: '#/components/schemas/apiShieldOldPublicSchema' + upload_details: + $ref: '#/components/schemas/apiShieldOldSchemaUploadDetailsWarningsOnly' + required: + - schema + type: object + apiShieldOldValidationDefaultMitigationAction: + description: >- + The default mitigation action used when there is no mitigation action + defined on the operation Mitigation actions are as follows: * `log` - + log request when request does not conform to schema * `block` - deny + access to the site when request does not conform to schema A special + value of of `none` will skip running schema validation entirely for the + request when there is no mitigation action defined on the operation + enum: + - none + - log + - block + example: block + type: string + x-auditable: true + apiShieldOldValidationDefaultMitigationActionPatch: + description: >- + The default mitigation action used when there is no mitigation action + defined on the operation Mitigation actions are as follows: * `log` - + log request when request does not conform to schema * `block` - deny + access to the site when request does not conform to schema A special + value of of `none` will skip running schema validation entirely for the + request when there is no mitigation action defined on the operation + `null` will have no effect. + enum: + - none + - log + - block + - null + example: block + nullable: true + type: string + x-auditable: true + apiShieldOldValidationEnabled: + description: Flag whether schema is enabled for validation. + type: boolean + x-auditable: true + apiShieldOldValidationOverrideMitigationAction: + description: >- + When set, this overrides both zone level and operation level mitigation + actions. - `none` will skip running schema validation entirely for the + request - `null` indicates that no override is in place + enum: + - none + - null + nullable: true + type: string + x-auditable: true + apiShieldOldValidationOverrideMitigationActionPatch: + description: >- + When set, this overrides both zone level and operation level mitigation + actions. - `none` will skip running schema validation entirely for the + request To clear any override, use the special value `disable_override` + `null` will have no effect. + enum: + - none + - disable_override + - null + example: none + nullable: true + type: string + x-auditable: true + apiShieldOldValidationOverrideMitigationActionWrite: + description: >- + When set, this overrides both zone level and operation level mitigation + actions. - `none` will skip running schema validation entirely for the + request - `null` indicates that no override is in place To clear any + override, use the special value `disable_override` or `null` + enum: + - none + - disable_override + - null + example: none + nullable: true + type: string + x-auditable: true + apiShieldOldZoneSchemaValidationSettings: + properties: + validation_default_mitigation_action: + $ref: '#/components/schemas/apiShieldOldValidationDefaultMitigationAction' + validation_override_mitigation_action: + $ref: '#/components/schemas/apiShieldOldValidationOverrideMitigationAction' + type: object + apiShieldOldZoneSchemaValidationSettingsPatch: + properties: + validation_default_mitigation_action: + $ref: >- + #/components/schemas/apiShieldOldValidationDefaultMitigationActionPatch + validation_override_mitigation_action: + $ref: >- + #/components/schemas/apiShieldOldValidationOverrideMitigationActionPatch + type: object + apiShieldOldZoneSchemaValidationSettingsPut: + properties: + validation_default_mitigation_action: + $ref: '#/components/schemas/apiShieldOldValidationDefaultMitigationAction' + validation_override_mitigation_action: + $ref: >- + #/components/schemas/apiShieldOldValidationOverrideMitigationActionWrite + required: + - validation_default_mitigation_action + type: object + apiShieldOpenapi: + description: A OpenAPI 3.0.0 compliant schema. + example: + info: + title: OpenAPI JSON schema for www.example.com + version: '1.0' + openapi: 3.0.0 + paths: + ... Further paths ...: {} + /api/v1/users/{var1}: + get: + parameters: + - in: path + name: var1 + schema: + type: string + servers: + - url: www.example.com + type: object + apiShieldOpenapiWithThresholds: + description: A OpenAPI 3.0.0 compliant schema. + example: + info: + title: OpenAPI JSON schema for www.example.com + version: '1.0' + openapi: 3.0.0 + paths: + ... Further paths ...: {} + /api/v1/users/{var1}: + get: + parameters: + - in: path + name: var1 + schema: + type: string + servers: + - url: www.example.com + type: object + apiShieldOperation: + properties: + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + method: + $ref: '#/components/schemas/apiShieldMethod' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + features: + $ref: '#/components/schemas/apiShieldOperationFeatures' + required: + - method + - host + - endpoint + - operation_id + - last_updated + type: object + apiShieldOperationFeatures: + readOnly: true + type: object + properties: + thresholds: + properties: + auth_id_tokens: + $ref: '#/components/schemas/apiShieldAuthIdTokens' + data_points: + $ref: '#/components/schemas/apiShieldDataPoints' + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + p50: + $ref: '#/components/schemas/apiShieldP50' + p90: + $ref: '#/components/schemas/apiShieldP90' + p99: + $ref: '#/components/schemas/apiShieldP99' + period_seconds: + $ref: '#/components/schemas/apiShieldPeriodSeconds' + requests: + $ref: '#/components/schemas/apiShieldRequests' + suggested_threshold: + $ref: '#/components/schemas/apiShieldSuggestedThreshold' + type: object + parameter_schemas: + properties: + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + parameter_schemas: + $ref: '#/components/schemas/apiShieldParameterSchemasDefinition' + type: object + api_routing: + description: API Routing settings on endpoint. + properties: + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + route: + description: Target route. + example: https://api.example.com/api/service + type: string + x-auditable: true + type: object + confidence_intervals: + properties: + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + suggested_threshold: + properties: + confidence_intervals: + properties: + p90: + $ref: '#/components/schemas/apiShieldConfidenceIntervalsBounds' + p95: + $ref: '#/components/schemas/apiShieldConfidenceIntervalsBounds' + p99: + $ref: '#/components/schemas/apiShieldConfidenceIntervalsBounds' + type: object + mean: + description: Suggested threshold. + example: 25.5 + type: number + x-auditable: true + type: object + type: object + schema_info: + properties: + active_schema: + description: Schema active on endpoint. + properties: + created_at: + $ref: '#/components/schemas/apiShieldTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + is_learned: + description: True if schema is Cloudflare-provided. + example: true + type: boolean + x-auditable: true + name: + description: Schema file name. + example: >- + api-endpoints-8694824bf5c04d019edcbf399c03c103-api-discovery.example.com-thresholds.json + type: string + x-auditable: true + type: object + learned_available: + description: >- + True if a Cloudflare-provided learned schema is available for + this endpoint. + example: true + type: boolean + x-auditable: true + mitigation_action: + description: Action taken on requests failing validation. + enum: + - none + - log + - block + example: block + nullable: true + type: string + x-auditable: true + type: object + required: + - last_updated + example: + api_routing: + last_updated: '2014-01-01T05:20:00.12345Z' + route: https://api.example.com/api/service + apiShieldOperationIdSelector: + description: Operation IDs selector + properties: + include: + properties: + operation_ids: + items: + $ref: '#/components/schemas/apiShieldSchemasUuid' + minItems: 1 + type: array + required: + - operation_ids + type: object + required: + - include + type: object + apiShieldOperationSchemaFragment: + description: >- + An OpenAPI operation object fragment containing schema information for + an operation. May include parameter definitions, request body + specifications, and a component schema extension. + nullable: true + properties: + parameters: + description: >- + OpenAPI parameter objects describing path, query, header, or cookie + parameters. + items: + type: object + type: array + requestBody: + description: OpenAPI request body object describing the expected request payload. + type: object + type: object + apiShieldOperationSchemas: + description: >- + OpenAPI JSON schemas for an operation, including both user-uploaded and + Cloudflare-learned schemas. + properties: + learned: + $ref: '#/components/schemas/apiShieldOperationSchemaFragment' + uploaded: + $ref: '#/components/schemas/apiShieldOperationSchemaFragment' + readOnly: true + type: object + apiShieldOperationWithLabelsOnly: + properties: + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + method: + $ref: '#/components/schemas/apiShieldMethod' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + labels: + items: + $ref: '#/components/schemas/apiShieldLabel' + type: array + required: + - method + - host + - endpoint + - operation_id + - last_updated + type: object + apiShieldP50: + description: The p50 quantile of requests (in period_seconds). + readOnly: true + type: integer + x-auditable: true + apiShieldP90: + description: The p90 quantile of requests (in period_seconds). + readOnly: true + type: integer + x-auditable: true + apiShieldP99: + description: The p99 quantile of requests (in period_seconds). + readOnly: true + type: integer + x-auditable: true + apiShieldParameterSchemasDefinition: + description: An operation schema object containing a response. + example: + parameters: + - description: >- + Sufficient requests have been observed for this parameter to + provide high confidence in this parameter schema. + in: path + name: var1 + schema: + maximum: 10 + minimum: 1 + type: integer + responses: null + properties: + parameters: + description: An array containing the learned parameter schemas. + example: + - description: >- + Sufficient requests have been observed for this parameter to + provide high confidence in this parameter schema. + in: path + name: var1 + schema: + maximum: 10 + minimum: 1 + type: integer + items: + type: object + readOnly: true + type: array + responses: + description: >- + An empty response object. This field is required to yield a valid + operation schema. + nullable: true + readOnly: true + type: object + readOnly: true + type: object + apiShieldPatchDiscoveriesResponse: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/apiShieldApiDiscoveryPatchMultipleRequest' + required: + - success + - errors + - messages + - result + type: object + apiShieldPatchDiscoveryResponse: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + state: + $ref: '#/components/schemas/apiShieldApiDiscoveryState' + type: object + required: + - success + - errors + - messages + - result + type: object + apiShieldPatchLabelRequest: + properties: + description: + $ref: '#/components/schemas/apiShieldLabelDescription' + metadata: + $ref: '#/components/schemas/apiShieldLabelMetadata' + type: object + apiShieldPeriodSeconds: + description: The period over which this threshold is suggested. + readOnly: true + type: integer + x-auditable: true + apiShieldPostLabelsOnOperationRequest: + properties: + managed: + description: List of managed label names. + items: + $ref: '#/components/schemas/apiShieldLabelName' + minItems: 1 + type: array + user: + description: List of user label names. + items: + $ref: '#/components/schemas/apiShieldLabelName' + minItems: 1 + type: array + type: object + apiShieldPutLabelRequest: + properties: + description: + $ref: '#/components/schemas/apiShieldLabelDescription' + metadata: + $ref: '#/components/schemas/apiShieldLabelMetadata' + type: object + apiShieldPutLabelsOnOperationRequest: + properties: + managed: + description: >- + List of managed label names. Omitting this property or passing an + empty array will result in all managed labels being removed from the + operation + items: + $ref: '#/components/schemas/apiShieldLabelName' + type: array + user: + description: >- + List of user label names. Omitting this property or passing an empty + array will result in all user labels being removed from the + operation + items: + $ref: '#/components/schemas/apiShieldLabelName' + type: array + type: object + apiShieldReplaceOperationsAttachedToLabelRequest: + properties: + selector: + $ref: '#/components/schemas/apiShieldOperationIdSelector' + required: + - selector + type: object + apiShieldRequestExpressionTemplatesFallthrough: + properties: + hosts: + description: List of hosts to be targeted in the expression + example: + - '{zone}.domain1.tld' + - domain2.tld + items: + type: string + x-auditable: true + type: array + required: + - hosts + type: object + apiShieldRequests: + description: The estimated number of requests covered by these calculations. + readOnly: true + type: integer + x-auditable: true + apiShieldResponseExpressionTemplatesFallthrough: + properties: + expression: + description: WAF Expression for fallthrough + example: (cf.api_gateway.fallthrough_detected) + type: string + x-auditable: true + title: + description: Title for the expression + example: Fallthrough Expression for [zone.domain.tld] + type: string + x-auditable: true + required: + - title + - expression + type: object + apiShieldSchemaResponseDiscovery: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + schemas: + items: + $ref: '#/components/schemas/apiShieldOpenapi' + type: array + timestamp: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + required: + - timestamp + - schemas + type: object + required: + - success + - errors + - messages + - result + type: object + apiShieldSchemaResponseWithThresholds: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + schemas: + items: + $ref: '#/components/schemas/apiShieldOpenapiWithThresholds' + type: array + timestamp: + type: string + x-auditable: true + type: object + required: + - success + - errors + - messages + - result + type: object + apiShieldSchemasTimestamp: + $ref: '#/components/schemas/apiShieldTimestamp' + readOnly: true + type: string + x-auditable: true + apiShieldSchemasUuid: + minLength: 36 + type: string + x-auditable: true + $ref: '#/components/schemas/apiShieldUuid' + apiShieldSingleOperationResponse: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + method: + $ref: '#/components/schemas/apiShieldMethod' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + features: + $ref: '#/components/schemas/apiShieldOperationFeatures' + schemas: + $ref: '#/components/schemas/apiShieldOperationSchemas' + required: + - method + - host + - endpoint + - operation_id + - last_updated + type: object + required: + - success + - errors + - messages + - result + type: object + apiShieldSuggestedThreshold: + description: >- + The suggested threshold in requests done by the same auth_id or + period_seconds. + readOnly: true + type: integer + x-auditable: true + apiShieldTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + apiShieldTrafficStats: + properties: + traffic_stats: + properties: + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + period_seconds: + description: The period in seconds these statistics were computed over + example: 3600 + readOnly: true + type: integer + x-auditable: true + requests: + description: The average number of requests seen during this period + example: 1987.06 + format: float + readOnly: true + type: number + x-auditable: true + required: + - period_seconds + - requests + - last_updated + type: object + readOnly: true + type: object + apiShieldUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + configurations: + id: cloudflare.api_gateway.configurations + name: configurations + title: Configurations + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1configuration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.auth_id_characteristics + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1configuration/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configurations/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/configurations/methods/update' + discovery: + id: cloudflare.api_gateway.discovery + name: discovery + title: Discovery + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1discovery/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/discovery/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + discovery_operations: + id: cloudflare.api_gateway.discovery_operations + name: discovery_operations + title: Discovery Operations + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1discovery~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/discovery_operations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + operations: + id: cloudflare.api_gateway.operations + name: operations + title: Operations + methods: + bulk_edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1discovery~1operations/patch + response: + mediaType: application/json + openAPIDocKey: '200' + api_shield_api_patch_discovered_operation: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1discovery~1operations~1{operation_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1user_schemas~1{schema_id}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/api_shield_api_patch_discovered_operation + - $ref: '#/components/x-stackQL-resources/operations/methods/bulk_edit' + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + - $ref: '#/components/x-stackQL-resources/operations/methods/bulk_delete' + replace: [] + fallthrough: + id: cloudflare.api_gateway.fallthrough + name: fallthrough + title: Fallthrough + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1expression-template~1fallthrough/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/fallthrough/methods/create' + update: [] + delete: [] + replace: [] + labels: + id: cloudflare.api_gateway.labels + name: labels + title: Labels + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + api_shield_operations_bulk_delete_labels_to_operations: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations~1labels/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + api_shield_operations_bulk_post_labels_to_operations: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations~1labels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + api_shield_operations_bulk_put_labels_to_operations: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations~1labels/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}~1labels/delete + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}~1labels/post + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}~1labels/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/labels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/create' + - $ref: >- + #/components/x-stackQL-resources/labels/methods/api_shield_operations_bulk_post_labels_to_operations + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/labels/methods/api_shield_operations_bulk_delete_labels_to_operations + replace: + - $ref: '#/components/x-stackQL-resources/labels/methods/update' + - $ref: >- + #/components/x-stackQL-resources/labels/methods/api_shield_operations_bulk_put_labels_to_operations + managed: + id: cloudflare.api_gateway.managed + name: managed + title: Managed + methods: + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1labels~1managed~1{name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/managed/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + managed_resources_operation: + id: cloudflare.api_gateway.managed_resources_operation + name: managed_resources_operation + title: Managed Resources Operation + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1labels~1managed~1{name}~1resources~1operation/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/managed_resources_operation/methods/update + user: + id: cloudflare.api_gateway.user + name: user + title: User + methods: + api_shield_labels_delete_user_labels: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1labels~1user/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + api_shield_labels_create_user_labels: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1labels~1user/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1labels~1user~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1labels~1user~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1labels~1user~1{name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1labels~1user~1{name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user/methods/get' + insert: + - $ref: >- + #/components/x-stackQL-resources/user/methods/api_shield_labels_create_user_labels + update: + - $ref: '#/components/x-stackQL-resources/user/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/user/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/user/methods/api_shield_labels_delete_user_labels + replace: + - $ref: '#/components/x-stackQL-resources/user/methods/update' + user_resources_operation: + id: cloudflare.api_gateway.user_resources_operation + name: user_resources_operation + title: User Resources Operation + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1labels~1user~1{name}~1resources~1operation/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/user_resources_operation/methods/update + api_gateway_operations: + id: cloudflare.api_gateway.api_gateway_operations + name: api_gateway_operations + title: Api Gateway Operations + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + api_shield_endpoint_management_add_operations_to_a_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_gateway_operations/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/api_gateway_operations/methods/api_shield_endpoint_management_add_operations_to_a_zone + update: [] + delete: [] + replace: [] + operations_item: + id: cloudflare.api_gateway.operations_item + name: operations_item + title: Operations Item + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations~1item/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/operations_item/methods/create' + update: [] + delete: [] + replace: [] + operations_schema_validation: + id: cloudflare.api_gateway.operations_schema_validation + name: operations_schema_validation + title: Operations Schema Validation + methods: + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1schema_validation/patch + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}~1schema_validation/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}~1schema_validation/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/operations_schema_validation/methods/list_by_zone + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/operations_schema_validation/methods/edit + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/operations_schema_validation/methods/update_by_zone + schemas: + id: cloudflare.api_gateway.schemas + name: schemas + title: Schemas + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + settings_schema_validation: + id: cloudflare.api_gateway.settings_schema_validation + name: settings_schema_validation + title: Settings Schema Validation + methods: + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1settings~1schema_validation/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1settings~1schema_validation/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1settings~1schema_validation/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/settings_schema_validation/methods/list_by_zone + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/settings_schema_validation/methods/edit + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/settings_schema_validation/methods/update_by_zone + user_schemas: + id: cloudflare.api_gateway.user_schemas + name: user_schemas + title: User Schemas + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1user_schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1user_schemas/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1user_schemas~1{schema_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1user_schemas~1{schema_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1api_gateway~1user_schemas~1{schema_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/user_schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/user_schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/user_schemas/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/user_schemas/methods/delete' + replace: [] + hosts: + id: cloudflare.api_gateway.hosts + name: hosts + title: Hosts + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1user_schemas~1hosts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hosts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/api_shield.yaml b/providers/src/cloudflare/v00.00.00000/services/api_shield.yaml deleted file mode 100644 index a8d06bd7..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/api_shield.yaml +++ /dev/null @@ -1,927 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: API Shield Endpoint Management - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - api_shield - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - schema_response_discovery: - allOf: - - $ref: '#/components/schemas/default_response' - - properties: - result: - properties: - schemas: - items: - $ref: '#/components/schemas/openapi' - type: array - timestamp: - type: string - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - default_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - errors: - items: {} - type: array - messages: - items: {} - type: array - openapi: - description: A OpenAPI 3.0.0 compliant schema. - example: - info: - title: OpenAPI JSON schema for www.example.com - version: '1.0' - openapi: 3.0.0 - paths: - ... Further paths ...: {} - '/api/v1/users/{var1}': - get: - parameters: - - in: path - name: var1 - required: true - schema: - type: string - servers: - - url: www.example.com - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - collection_response_paginated: - anyOf: - - allOf: - - $ref: '#/components/schemas/collection_response' - - properties: - result_info: - properties: - count: - description: Total results returned based on your search parameters. - example: 1 - type: number - page: - description: Current page within paginated list of results. - example: 1 - type: number - per_page: - description: Number of results per page of results. - example: 20 - type: number - total_count: - description: Total results available without any search parameters. - example: 500 - type: number - type: object - - properties: - result: - items: - $ref: '#/components/schemas/api-shield' - type: array - - $ref: '#/components/schemas/collection_response' - collection_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - errors: - items: {} - type: array - messages: - items: {} - type: array - result: - items: - allOf: - - $ref: '#/components/schemas/api-shield' - - properties: - features: {} - type: array - api-shield: - allOf: - - $ref: '#/components/schemas/operation' - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - operation: - properties: - endpoint: - $ref: '#/components/schemas/endpoint' - features: - $ref: '#/components/schemas/features' - host: - $ref: '#/components/schemas/host' - last_updated: - $ref: '#/components/schemas/timestamp' - method: - $ref: '#/components/schemas/method' - operation_id: - $ref: '#/components/schemas/operation_id' - required: - - operation_id - - method - - host - - endpoint - - last_updated - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - endpoint: - description: 'The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.' - example: '/api/v1/users/{var1}' - format: uri-template - maxLength: 4096 - pattern: ^/.*$ - type: string - features: - anyOf: - - $ref: '#/components/schemas/thresholds' - readOnly: true - type: object - host: - description: RFC3986-compliant host. - example: www.example.com - format: hostname - maxLength: 255 - type: string - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - method: - description: The HTTP method used to access the endpoint. - enum: - - GET - - POST - - HEAD - - OPTIONS - - PUT - - DELETE - - CONNECT - - PATCH - - TRACE - example: GET - type: string - operation_id: - description: The ID that identifies the API operation. - thresholds: - properties: - thresholds: - properties: - auth_id_tokens: - $ref: '#/components/schemas/auth_id_tokens' - data_points: - $ref: '#/components/schemas/data_points' - last_updated: - $ref: '#/components/schemas/timestamp' - p50: - $ref: '#/components/schemas/p50' - p90: - $ref: '#/components/schemas/p90' - p99: - $ref: '#/components/schemas/p99' - period_seconds: - $ref: '#/components/schemas/period_seconds' - requests: - $ref: '#/components/schemas/requests' - suggested_threshold: - $ref: '#/components/schemas/suggested_threshold' - type: object - readOnly: true - required: - - period_seconds - - suggested_threshold - - p50 - - p90 - - p99 - - requests - - auth_id_tokens - - data_points - - last_updated - type: object - auth_id_tokens: - description: The total number of auth-ids seen across this calculation. - readOnly: true - type: integer - data_points: - description: The number of data points used for the threshold suggestion calculation. - readOnly: true - type: integer - p50: - description: The p50 quantile of requests (in period_seconds). - readOnly: true - type: integer - p90: - description: The p90 quantile of requests (in period_seconds). - readOnly: true - type: integer - p99: - description: The p99 quantile of requests (in period_seconds). - readOnly: true - type: integer - period_seconds: - description: The period over which this threshold is suggested. - readOnly: true - type: integer - requests: - description: The estimated number of requests covered by these calculations. - readOnly: true - type: integer - suggested_threshold: - description: The suggested threshold in requests done by the same auth_id or period_seconds. - readOnly: true - type: integer - schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - errors: - items: {} - type: array - messages: - items: {} - type: array - result: - $ref: '#/components/schemas/api-shield' - schema_response_with_thresholds: - allOf: - - $ref: '#/components/schemas/default_response' - - properties: - result: - properties: - schemas: - items: - $ref: '#/components/schemas/openapiwiththresholds' - type: array - timestamp: - type: string - type: object - openapiwiththresholds: - description: A OpenAPI 3.0.0 compliant schema. - example: - info: - title: OpenAPI JSON schema for www.example.com - version: '1.0' - openapi: 3.0.0 - paths: - ... Further paths ...: {} - '/api/v1/users/{var1}': - get: - parameters: - - in: path - name: var1 - required: true - schema: - type: string - servers: - - url: www.example.com - type: object - single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - errors: - items: {} - type: array - messages: - items: {} - type: array - result: - $ref: '#/components/schemas/configuration' - configuration: - properties: - auth_id_characteristics: - $ref: '#/components/schemas/characteristics' - type: object - characteristics: - items: - properties: - name: - $ref: '#/components/schemas/characteristics_components-schemas-name' - type: - $ref: '#/components/schemas/schemas-type' - required: - - type - - name - type: object - maxItems: 10 - type: array - uniqueItems: true - characteristics_components-schemas-name: - description: 'The name of the characteristic field, i.e., the header or cookie name.' - example: authorization - maxLength: 128 - type: string - schemas-type: - description: The type of characteristic. - enum: - - header - - cookie - example: header - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_api_gateway_discovery: - id: cloudflare.api_shield.zones_api_gateway_discovery - name: zones_api_gateway_discovery - title: Zones Api Gateway Discovery - methods: - endpoint_management_retrieve_api_discovery_results_for_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1discovery/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _endpoint_management_retrieve_api_discovery_results_for_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1discovery/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_api_gateway_operations: - id: cloudflare.api_shield.zones_api_gateway_operations - name: zones_api_gateway_operations - title: Zones Api Gateway Operations - methods: - endpoint_management_retrieve_information_about_all_operations_on_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _endpoint_management_retrieve_information_about_all_operations_on_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - endpoint_management_add_operations_to_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations/post' - response: - mediaType: application/json - openAPIDocKey: '200' - endpoint_management_delete_an_operation: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - endpoint_management_retrieve_information_about_an_operation: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _endpoint_management_retrieve_information_about_an_operation: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1operations~1{operation_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_api_gateway_operations/methods/endpoint_management_delete_an_operation' - zones_api_gateway_schemas: - id: cloudflare.api_shield.zones_api_gateway_schemas - name: zones_api_gateway_schemas - title: Zones Api Gateway Schemas - methods: - endpoint_management_retrieve_operations_and_features_as_open_api_schemas: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1schemas/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _endpoint_management_retrieve_operations_and_features_as_open_api_schemas: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1schemas/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_api_gateway_configuration: - id: cloudflare.api_shield.zones_api_gateway_configuration - name: zones_api_gateway_configuration - title: Zones Api Gateway Configuration - methods: - settings_retrieve_information_about_specific_configuration_properties: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1configuration/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _settings_retrieve_information_about_specific_configuration_properties: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1configuration/get' - response: - mediaType: application/json - openAPIDocKey: '200' - settings_set_configuration_properties: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1api_gateway~1configuration/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] -paths: - '/zones/{zone_id}/api_gateway/discovery': - get: - description: Retrieve the most up to date view of API Discovery on a zone. - operationId: api-shield-endpoint-management-retrieve-api-discovery-results-for-a-zone - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schema_response_discovery' - description: Retrieve API Discovery results for a zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schema_response_discovery' - - $ref: '#/components/schemas/api-response-common-failure' - description: Retrieve API Discovery results for a zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Retrieve API Discovery results for a zone - tags: - - API Shield Endpoint Management - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.read - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_id}/api_gateway/operations': - get: - operationId: api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/collection_response_paginated' - description: Retrieve information about all operations on a zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/collection_response_paginated' - - $ref: '#/components/schemas/api-response-common-failure' - description: Retrieve information about all operations on a zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Retrieve information about all operations on a zone - tags: - - API Shield Endpoint Management - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.read - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: 'Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.' - operationId: api-shield-endpoint-management-add-operations-to-a-zone - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - items: - properties: - endpoint: - $ref: '#/components/schemas/endpoint' - host: - $ref: '#/components/schemas/host' - method: - $ref: '#/components/schemas/method' - type: object - required: - - host - - method - - endpoint - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/collection_response' - description: Add operations to a zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add operations to a zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add operations to a zone - tags: - - API Shield Endpoint Management - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.create - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_id}/api_gateway/operations/{operation_id}': - delete: - operationId: api-shield-endpoint-management-delete-an-operation - parameters: - - in: path - name: operation_id - required: true - schema: - $ref: '#/components/schemas/operation_id' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/default_response' - description: Delete an operation response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/default_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an operation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete an operation - tags: - - API Shield Endpoint Management - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.delete - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - operationId: api-shield-endpoint-management-retrieve-information-about-an-operation - parameters: - - in: path - name: operation_id - required: true - schema: - $ref: '#/components/schemas/operation_id' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-single_response' - description: Retrieve information about an operation response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Retrieve information about an operation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Retrieve information about an operation - tags: - - API Shield Endpoint Management - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.read - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_id}/api_gateway/schemas': - get: - operationId: api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schema_response_with_thresholds' - description: Retrieve operations and features as OpenAPI schemas response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schema_response_with_thresholds' - - $ref: '#/components/schemas/api-response-common-failure' - description: Retrieve operations and features as OpenAPI schemas response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Retrieve operations and features as OpenAPI schemas - tags: - - API Shield Endpoint Management - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.read - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_id}/api_gateway/configuration': - get: - operationId: api-shield-settings-retrieve-information-about-specific-configuration-properties - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response' - description: Retrieve information about specific configuration properties response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Retrieve information about specific configuration properties response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Retrieve information about specific configuration properties - tags: - - API Shield Settings - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.read - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - operationId: api-shield-settings-set-configuration-properties - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/configuration' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/default_response' - description: Set configuration properties response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/default_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set configuration properties response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set configuration properties - tags: - - API Shield Settings - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.zone.api-gateway.update - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false diff --git a/providers/src/cloudflare/v00.00.00000/services/argo.yaml b/providers/src/cloudflare/v00.00.00000/services/argo.yaml index c30813b7..6cf330c7 100644 --- a/providers/src/cloudflare/v00.00.00000/services/argo.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/argo.yaml @@ -1,48 +1,366 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Argo Analytics for Geolocation - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - argo + title: argo API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/argo/smart_routing: + get: + description: Retrieves the value of Argo Smart Routing enablement setting. + operationId: argo-smart-routing-get-argo-smart-routing-setting + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/argoConfigApiResponseSingle' + description: Get Argo Smart Routing enablement setting response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/argoConfigApiResponseCommonFailure' + description: Get Argo Smart Routing enablement setting failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Argo Smart Routing setting + tags: + - Argo Smart Routing + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPermissionsRequired: + enum: + - '#zone_settings:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: argo + resource_chain: + - smart_routing + method: get + patch: + description: Configures the value of the Argo Smart Routing enablement setting. + operationId: argo-smart-routing-patch-argo-smart-routing-setting + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/argoConfigPatch' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/argoConfigApiResponseSingle' + description: Patch Argo Smart Routing enablement setting response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/argoConfigApiResponseCommonFailure' + description: Patch Argo Smart Routing enablement setting failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Argo Smart Routing setting + tags: + - Argo Smart Routing + x-api-token-group: + - Zone Settings Write + x-cfPermissionsRequired: + enum: + - '#zone_settings:read' + - '#zone_settings:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: argo + resource_chain: + - smart_routing + method: edit + /zones/{zone_id}/argo/tiered_caching: + get: + description: >- + Tiered Cache works by dividing Cloudflare's data centers into a + hierarchy of lower-tiers and upper-tiers. If content is not cached in + lower-tier data centers (generally the ones closest to a visitor), the + lower-tier must ask an upper-tier to see if it has the content. If the + upper-tier does not have the content, only the upper-tier can ask the + origin for content. This practice improves bandwidth efficiency by + limiting the number of data centers that can ask the origin for content, + which reduces origin load and makes websites more cost-effective to + operate. Additionally, Tiered Cache concentrates connections to origin + servers so they come from a small number of data centers rather than the + full set of network locations. This results in fewer open connections + using server resources. + operationId: tiered-caching-get-tiered-caching-setting + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + editable: + $ref: '#/components/schemas/cacheRulesEditable' + id: + description: The identifier of the caching setting. + type: string + x-auditable: true + enum: + - tiered_caching + modified_on: + $ref: '#/components/schemas/cacheRulesModifiedOn' + description: Last time this setting was modified. + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: Value of the Tiered Cache zone setting. + type: string + x-auditable: true + default: 'off' + enum: + - 'on' + - 'off' + required: + - id + - value + - editable + - id + - value + type: object + title: Tiered Cache + required: + - success + - errors + - messages + description: Get Tiered Caching setting response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Get Tiered Caching setting response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Tiered Caching setting + tags: + - Tiered Caching + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: argo + resource_chain: + - tiered_caching + method: get + patch: + description: >- + Tiered Cache works by dividing Cloudflare's data centers into a + hierarchy of lower-tiers and upper-tiers. If content is not cached in + lower-tier data centers (generally the ones closest to a visitor), the + lower-tier must ask an upper-tier to see if it has the content. If the + upper-tier does not have the content, only the upper-tier can ask the + origin for content. This practice improves bandwidth efficiency by + limiting the number of data centers that can ask the origin for content, + which reduces origin load and makes websites more cost-effective to + operate. Additionally, Tiered Cache concentrates connections to origin + servers so they come from a small number of data centers rather than the + full set of network locations. This results in fewer open connections + using server resources. + operationId: tiered-caching-patch-tiered-caching-setting + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cacheRulesPatch' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + editable: + $ref: '#/components/schemas/cacheRulesEditable' + id: + description: The identifier of the caching setting. + type: string + x-auditable: true + enum: + - tiered_caching + modified_on: + $ref: '#/components/schemas/cacheRulesModifiedOn' + description: Last time this setting was modified. + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: Value of the Tiered Cache zone setting. + type: string + x-auditable: true + default: 'off' + enum: + - 'on' + - 'off' + required: + - id + - value + - editable + - id + - value + type: object + title: Tiered Cache + required: + - success + - errors + - messages + description: Patch Tiered Caching setting response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Patch Tiered Caching setting response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Tiered Caching setting + tags: + - Tiered Caching + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: argo + resource_chain: + - tiered_caching + method: edit components: schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - schemas-response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - api-response-common-failure: + argoConfigApiResponseCommonFailure: properties: errors: - allOf: - - $ref: '#/components/schemas/messages' example: - code: 7003 message: No route for the URI minLength: 1 + $ref: '#/components/schemas/argoConfigMessages' messages: - allOf: - - $ref: '#/components/schemas/messages' example: [] + $ref: '#/components/schemas/argoConfigMessages' result: enum: - null nullable: true + type: object success: - description: Whether the API call was successful + description: Describes a failed API response. enum: - false example: false @@ -53,44 +371,16 @@ components: - messages - result type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: + argoConfigApiResponseSingle: properties: errors: - $ref: '#/components/schemas/messages' + $ref: '#/components/schemas/argoConfigMessages' messages: - $ref: '#/components/schemas/messages' + $ref: '#/components/schemas/argoConfigMessages' result: - anyOf: - - type: object - - items: {} - type: array - - type: string + $ref: '#/components/schemas/argoConfigResultObject' success: - description: Whether the API call was successful + description: Describes a successful API response. enum: - true example: true @@ -101,646 +391,225 @@ components: - messages - result type: object - patch: - description: Update enablement of Argo Smart Routing + argoConfigEditable: + description: Specifies if the setting is editable. + type: boolean + x-auditable: true + argoConfigMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + argoConfigModifiedOn: + description: Specifies the time when the setting was last modified. + format: date-time + type: string + x-auditable: true + argoConfigPatch: + description: Configures the enablement of Argo Smart Routing. + properties: + value: + $ref: '#/components/schemas/argoConfigSettingValue' + required: + - value + type: object + argoConfigResultObject: properties: + editable: + $ref: '#/components/schemas/argoConfigEditable' + id: + $ref: '#/components/schemas/argoConfigSettingId' + modified_on: + $ref: '#/components/schemas/argoConfigModifiedOn' + readOnly: true value: - $ref: '#/components/schemas/schemas-value' + $ref: '#/components/schemas/argoConfigSettingValue' required: + - id - value + - editable type: object - schemas-value: - description: Enables Argo Smart Routing. + argoConfigSettingId: + description: Specifies the identifier of the Argo Smart Routing setting. + type: string + x-auditable: true + argoConfigSettingValue: + description: Specifies the enablement value of Argo Smart Routing. enum: - 'on' - 'off' example: 'on' type: string - tunnel_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/argo-tunnel' - type: array - type: object - argo-tunnel: + x-auditable: true + cacheRulesApiResponseCommonFailure: properties: - connections: - description: Connections between cloudflared and the Cloudflare edge that are serving this tunnel. + errors: + example: + - code: 7003 + message: No route for the URI + items: + type: object + minLength: 1 + type: array + $ref: '#/components/schemas/cacheRulesMessages' + messages: + example: [] items: - $ref: '#/components/schemas/argo-tunnel_components-schemas-connection' + type: object type: array - created_at: - description: 'Timestamps when the tunnel was created, formatted in RFC 3339.' - deleted_at: - description: 'If present, indicates tunnel was deleted at the given date (formatted in RFC 3339). If absent, tunnel has not been deleted.' - example: '2009-11-10T23:00:00Z' - format: date-time + $ref: '#/components/schemas/cacheRulesMessages' + result: + enum: + - null nullable: true - type: string - id: - $ref: '#/components/schemas/tunnel_id' - name: - $ref: '#/components/schemas/tunnel_name' - required: - - id - - name - - created_at - - connections - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - argo-tunnel_components-schemas-connection: - properties: - colo_name: - description: Short ID for the colo this connection is connected to. - example: DFW - type: string - is_pending_reconnect: - description: 'Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If this field is true, the connection has disconnected but is still being tracked for these optimized reconnects. If false, the connection is still actively serving.' + type: object + success: + description: Whether the API call was successful. + enum: + - false example: false type: boolean - uuid: - $ref: '#/components/schemas/uuid' - tunnel_id: - description: UUID of the tunnel. - example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true - type: string - tunnel_name: - description: A user-friendly name chosen when the tunnel is created. Cannot be empty. - example: blog + required: + - success + - errors + - messages + - result + type: object + cacheRulesEditable: + description: Whether the setting is editable. + type: boolean + x-auditable: true + cacheRulesMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + cacheRulesModifiedOn: + description: The time when the setting was last modified. + format: date-time type: string - result_info: + x-auditable: true + cacheRulesPatch: + description: Update enablement of Tiered Caching. properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number + value: + $ref: '#/components/schemas/cacheRulesValue' + required: + - value type: object - uuid: - description: UUID - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true + cacheRulesValue: + description: Enables Tiered Caching. + enum: + - 'on' + - 'off' + example: 'on' type: string - tunnel_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - argo-tunnel_components-schemas-empty_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - type: object + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: type: object - responses: {} + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. api_key: in: header name: X-Auth-Key type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. api_token: scheme: bearer type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - zones_analytics_latency: - id: cloudflare.argo.zones_analytics_latency - name: zones_analytics_latency - title: Zones Analytics Latency + smart_routing: + id: cloudflare.argo.smart_routing + name: smart_routing + title: Smart Routing methods: - analytics_for_zone_argo_analytics_for_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1latency/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _analytics_for_zone_argo_analytics_for_a_zone: + list: operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1latency/get' - response: - mediaType: application/json - openAPIDocKey: '200' - analytics_for_geolocation_argo_analytics_for_a_zone_at_different_po_ps: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1latency~1colos/get' + $ref: '#/paths/~1zones~1{zone_id}~1argo~1smart_routing/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - _analytics_for_geolocation_argo_analytics_for_a_zone_at_different_po_ps: + edit: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1latency~1colos/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_smart_routing: - id: cloudflare.argo.zones_smart_routing - name: zones_smart_routing - title: Zones Smart Routing - methods: - smart_routing_get_argo_smart_routing_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1argo~1smart_routing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _smart_routing_get_argo_smart_routing_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1argo~1smart_routing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - smart_routing_patch_argo_smart_routing_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1argo~1smart_routing/patch' + $ref: '#/paths/~1zones~1{zone_id}~1argo~1smart_routing/patch' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones_smart_routing/methods/smart_routing_get_argo_smart_routing_setting' + - $ref: '#/components/x-stackQL-resources/smart_routing/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/smart_routing/methods/edit' delete: [] - accounts_tunnels: - id: cloudflare.argo.accounts_tunnels - name: accounts_tunnels - title: Accounts Tunnels + replace: [] + tiered_caching: + id: cloudflare.argo.tiered_caching + name: tiered_caching + title: Tiered Caching methods: - tunnel_list_argo_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1tunnels/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _tunnel_list_argo_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1tunnels/get' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_create_argo_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1tunnels/post' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_delete_argo_tunnel: + list: operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1tunnels~1{tunnel_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_get_argo_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1tunnels~1{tunnel_id}/get' + $ref: '#/paths/~1zones~1{zone_id}~1argo~1tiered_caching/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - _tunnel_get_argo_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1tunnels~1{tunnel_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_clean_up_argo_tunnel_connections: + edit: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1tunnels~1{tunnel_id}~1connections/delete' + $ref: '#/paths/~1zones~1{zone_id}~1argo~1tiered_caching/patch' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/accounts_tunnels/methods/tunnel_list_argo_tunnels' - - $ref: '#/components/x-stackQL-resources/accounts_tunnels/methods/tunnel_get_argo_tunnel' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_tunnels/methods/tunnel_create_argo_tunnel' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_tunnels/methods/tunnel_delete_argo_tunnel' -paths: - '/zones/{zone_identifier}/analytics/latency/colos': - get: - operationId: argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_single' - description: Argo Analytics for a zone at different PoPs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Argo Analytics for a zone at different PoPs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Argo Analytics for a zone at different PoPs - tags: - - Argo Analytics for Geolocation - x-cfPermissionsRequired: - enum: - - '#analytics:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/analytics/latency': - get: - operationId: argo-analytics-for-zone-argo-analytics-for-a-zone - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_single' - description: Argo Analytics for a zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Argo Analytics for a zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Argo Analytics for a zone - tags: - - Argo Analytics for Zone - x-cfPermissionsRequired: - enum: - - '#analytics:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/argo/smart_routing': - get: - operationId: argo-smart-routing-get-argo-smart-routing-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_single' - description: Get Argo Smart Routing setting response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Argo Smart Routing setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Argo Smart Routing setting - tags: - - Argo Smart Routing - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Updates enablement of Argo Smart Routing. - operationId: argo-smart-routing-patch-argo-smart-routing-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/patch' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_single' - description: Patch Argo Smart Routing setting response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Argo Smart Routing setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Patch Argo Smart Routing setting - tags: - - Argo Smart Routing - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/tunnels': - get: - deprecated: true - description: 'List, search and filter an account''s Argo Tunnels.' - operationId: argo-tunnel-list-argo-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_response_collection' - description: List Argo Tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Argo Tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Argo Tunnels - tags: - - Argo Tunnel - x-cfDeprecation: - $ref: '#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation' - post: - deprecated: true - description: Create an Argo Tunnel in an account. - operationId: argo-tunnel-create-argo-tunnel - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/tunnel_name' - tunnel_secret: - description: '32 or more bytes, encoded as a base64 string. The Create Argo Tunnel endpoint sets this as the tunnel''s password. Anyone wishing to run the tunnel needs this password.' - example: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg= - type: string - required: - - name - - tunnel_secret - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_response_single' - description: Create Argo Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Argo Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Argo Tunnel - tags: - - Argo Tunnel - x-cfDeprecation: - $ref: '#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation' - '/accounts/{account_identifier}/tunnels/{tunnel_id}': - delete: - deprecated: true - description: Delete an Argo Tunnel from an account. - operationId: argo-tunnel-delete-argo-tunnel - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_response_single' - description: Delete Argo Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Argo Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Argo Tunnel - tags: - - Argo Tunnel - x-cfDeprecation: - $ref: '#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation' - get: - deprecated: true - description: Get the details of an Argo Tunnel from an account. - operationId: argo-tunnel-get-argo-tunnel - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_response_single' - description: Get Argo Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Argo Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Argo Tunnel - tags: - - Argo Tunnel - x-cfDeprecation: - $ref: '#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation' - '/accounts/{account_identifier}/tunnels/{tunnel_id}/connections': - delete: - deprecated: true - description: Remove stale connection resources from an Argo Tunnel. - operationId: argo-tunnel-clean-up-argo-tunnel-connections - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/argo-tunnel_components-schemas-empty_response' - description: Clean Up Argo Tunnel Connections response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/argo-tunnel_components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Clean Up Argo Tunnel Connections response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Clean Up Argo Tunnel Connections - tags: - - Argo Tunnel - x-cfDeprecation: - $ref: '#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation' + - $ref: '#/components/x-stackQL-resources/tiered_caching/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/tiered_caching/methods/edit' + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/audit_logs.yaml b/providers/src/cloudflare/v00.00.00000/services/audit_logs.yaml new file mode 100644 index 00000000..51eaecd1 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/audit_logs.yaml @@ -0,0 +1,381 @@ +openapi: 3.0.3 +info: + title: audit_logs API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/audit_logs: + get: + description: >- + Gets a list of audit logs for an account. Can be filtered by who made + the change, on which zone, and the timeframe of the change. + operationId: audit-logs-get-account-audit-logs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: id + schema: + description: Finds a specific log by its ID. + type: string + - in: query + name: export + schema: + description: Indicates that this request is an export of logs in CSV format. + type: boolean + - in: query + name: action.type + schema: + description: Filters by the action type. + type: string + - in: query + name: actor.ip + schema: + description: >- + Filters by the IP address of the request that made the change by + specific IP address or valid CIDR Range. + type: string + - in: query + name: actor.email + schema: + description: Filters by the email address of the actor that made the change. + format: email + type: string + - in: query + name: since + schema: + type: string + format: date + description: >- + Limits the returned results to logs newer than the specified date. + A `full-date` that conforms to RFC3339. + - in: query + name: before + schema: + type: string + format: date + description: >- + Limits the returned results to logs older than the specified date. + A `full-date` that conforms to RFC3339. + - in: query + name: zone.name + schema: + description: Filters by the name of the zone associated to the change. + type: string + - in: query + name: direction + schema: + default: desc + description: Changes the direction of the chronological sorting. + enum: + - desc + - asc + type: string + - in: query + name: per_page + schema: + default: 100 + description: Sets the number of results to return per page. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: page + schema: + default: 1 + description: Defines which page of results to return. + minimum: 1 + type: number + - in: query + name: hide_user_logs + schema: + default: false + description: Indicates whether or not to hide user level audit logs. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaAuditLogsResponseCollection_2' + description: Get account audit logs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/result' + description: Get account audit logs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get account audit logs + tags: + - Audit Logs + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: audit_logs + resource_chain: [] + method: list +components: + schemas: + aaaAuditLogs: + properties: + action: + properties: + result: + description: A boolean that indicates if the action attempted was successful. + example: true + type: boolean + type: + description: A short string that describes the action that was performed. + example: change_setting + type: string + type: object + actor: + properties: + email: + description: The email of the user that performed the action. + example: michelle@example.com + format: email + type: string + id: + description: >- + The ID of the actor that performed the action. If a user + performed the action, this will be their User ID. + example: f6b5de0326bb5182b8a4840ee01ec774 + type: string + ip: + description: The IP address of the request that performed the action. + example: 198.41.129.166 + type: string + type: + description: >- + The type of actor, whether a User, Cloudflare Admin, or an + Automated System. + enum: + - user + - admin + - Cloudflare + example: user + type: string + type: object + id: + description: A string that uniquely identifies the audit log. + example: d5b0f326-1232-4452-8858-1089bd7168ef + type: string + interface: + description: The source of the event. + example: API + type: string + metadata: + description: >- + An object which can lend more context to the action being logged. + This is a flexible value and varies between different actions. + example: + name: security_level + type: firewall + value: high + zone_name: example.com + type: object + newValue: + description: The new value of the resource that was modified. + example: low + type: string + oldValue: + description: The value of the resource before it was modified. + example: high + type: string + owner: + properties: + id: + $ref: '#/components/schemas/aaaIdentifier' + type: object + resource: + properties: + id: + description: An identifier for the resource that was affected by the action. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + type: + description: >- + A short string that describes the resource that was affected by + the action. + example: zone + type: string + type: object + when: + description: >- + A UTC RFC3339 timestamp that specifies when the action being logged + occured. + example: '2017-04-26T17:31:07Z' + format: date-time + type: string + type: object + aaaAuditLogsResponseCollection_2: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaMessages' + messages: + $ref: '#/components/schemas/aaaMessages' + result: + items: + $ref: '#/components/schemas/aaaAuditLogs' + type: array + success: + example: true + type: boolean + required: + - errors + - success + - messages + aaaIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + aaaMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + result: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/aaaMessages' + messages: + $ref: '#/components/schemas/aaaMessages' + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + result: + items: + $ref: '#/components/schemas/aaaAuditLogs' + type: array + required: + - errors + - messages + - success + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + audit_logs: + id: cloudflare.audit_logs.audit_logs + name: audit_logs + title: Audit Logs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1audit_logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/billing.yaml b/providers/src/cloudflare/v00.00.00000/services/billing.yaml new file mode 100644 index 00000000..08b58e37 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/billing.yaml @@ -0,0 +1,1466 @@ +openapi: 3.0.3 +info: + title: billing API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/billing/profile: + get: + deprecated: true + description: Gets the current billing profile for the account. + operationId: account-billing-profile-(-deprecated)-billing-profile-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billSubsApiBillingResponseSingle' + description: Billing Profile Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + properties: + account_type: + type: string + address: + type: string + address2: + type: string + balance: + type: string + card_expiry_month: + type: integer + card_expiry_year: + type: integer + card_number: + type: string + city: + type: string + company: + type: string + country: + type: string + created_on: + format: date-time + type: string + readOnly: true + device_data: + type: string + edited_on: + format: date-time + type: string + enterprise_billing_email: + type: string + x-auditable: true + enterprise_primary_email: + type: string + x-auditable: true + first_name: + type: string + id: + $ref: >- + #/components/schemas/billSubsApiComponentsSchemasIdentifier + is_partner: + type: boolean + last_name: + type: string + next_bill_date: + format: date-time + type: string + payment_address: + type: string + payment_address2: + type: string + payment_city: + type: string + payment_country: + type: string + payment_email: + type: string + payment_first_name: + type: string + payment_gateway: + type: string + payment_last_name: + type: string + payment_nonce: + type: string + payment_state: + type: string + payment_zipcode: + type: string + primary_email: + type: string + x-auditable: true + state: + type: string + tax_id_type: + type: string + telephone: + type: string + use_legacy: + type: boolean + validation_code: + type: string + vat: + type: string + zipcode: + type: string + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Billing Profile Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Billing Profile Details + tags: + - Account Billing Profile + x-api-token-group: + - Billing Write + - Billing Read + x-cfPermissionsRequired: + enum: + - '#billing:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: billing + resource_chain: + - profiles + method: get + /accounts/{account_id}/billing/usage/paygo: + get: + description: >- + Returns billable usage data for PayGo (self-serve) accounts. When no + query parameters are provided, returns usage for the current billing + period. This endpoint is currently in alpha and access is restricted to + select accounts. While in alpha, the endpoint may get breaking changes. + operationId: billable-usage-get-paygo-account-usage + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Defines the start date for the usage query (e.g., 2025-02-01). + in: query + name: from + schema: + format: date + type: string + - description: Defines the end date for the usage query (e.g., 2025-03-01). + in: query + name: to + schema: + format: date + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billableUsageApiUsageResponse' + description: Indicates PayGo account usage data was successfully retrieved. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/billableUsageApiApiResponseCommonFailure' + description: Indicates the request failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get PayGo Account Billable Usage (Alpha) + tags: + - Billable Usage + x-api-token-group: + - Billing Write + - Billing Read + x-cfPlanAvailability: + business: true + enterprise: false + free: true + pro: true + x-stackql-sdk: + service: billing + resource_chain: + - usage + method: paygo + /accounts/{account_id}/pay-per-crawl/crawler/stripe: + delete: + description: Deletes the stripe config for a crawler. + operationId: pay-per-crawl.crawlerDeleteStripeConfig + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiNoResultResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Deletes the stripe config for a crawler + tags: + - ppc_stripe + x-api-token-group: + - Account Settings Write + get: + description: Gets the stripe config for a crawler. + operationId: pay-per-crawl.crawlerGetStripeConfig + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlGetStripeConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Gets the stripe config for a crawler + tags: + - ppc_stripe + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + post: + description: Creates the stripe config for a crawler. + operationId: pay-per-crawl.crawlerCreateStripeConfig + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlCreateStripeConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Creates the stripe config for a crawler + tags: + - ppc_stripe + x-api-token-group: + - Account Settings Write + /accounts/{account_id}/pay-per-crawl/publisher/stripe: + delete: + description: Deletes the stripe config for a publisher. + operationId: pay-per-crawl.publisherDeleteStripeConfig + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiNoResultResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Deletes the stripe config for a publisher + tags: + - ppc_stripe + x-api-token-group: + - Account Settings Write + get: + description: Gets the stripe config for a publisher. + operationId: pay-per-crawl.publisherGetStripeConfig + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlGetStripeConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Gets the stripe config for a publisher + tags: + - ppc_stripe + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + post: + description: Creates the stripe config for a publisher. + operationId: pay-per-crawl.publisherCreateStripeConfig + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlCreateStripeConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Creates the stripe config for a publisher + tags: + - ppc_stripe + x-api-token-group: + - Account Settings Write + /accounts/{account_id}/pay-per-crawl/zones_can_be_enabled: + patch: + description: >- + Allows an account admin to set the can_be_enabled setting on a list of + zones. + operationId: pay-per-crawl.setZonesCanBeEnabled + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlZonesCanBeEnabledPayload' + description: Data for setting flag on zones + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiNoResultResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Set can_be_enabled setting on zones + tags: + - ppc_config + x-api-token-group: + - Account Settings Write + /accounts/{account_id}/pay-per-crawl/zones_can_be_enabled/query: + post: + description: >- + Provided a list of pay-per-crawl configured zones this method will + return whether they can enable PPC or not. + operationId: pay-per-crawl.queryZonesCanBeEnabled + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlZonesCanBeEnabledPayload' + description: Data for setting flag on zones + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlQueryZonesCanBeEnabledResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Gets the can_be_enabled zone setting + tags: + - ppc_config + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + /zones/{zone_id}/pay-per-crawl/configuration: + get: + description: >- + Gets the pay-per-crawl config for a zone including the bot + configuration. + operationId: pay-per-crawl.getConfig + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlGetConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Get the pay-per-crawl config + tags: + - ppc_config + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + patch: + description: Changes the pay-per-crawl config for a zone. + operationId: pay-per-crawl.patchConfig + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlDaricConfig' + description: Data for setting flag on zones + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlGetConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Changes pay-per-crawl config for a zone + tags: + - ppc_config + x-api-token-group: + - Zone Settings Write + post: + description: Creates the pay-per-crawl config for a zone. + operationId: pay-per-crawl.createConfig + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlDaricConfig' + description: Data for setting flag on zones + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlGetConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/payPerCrawlApiErrorResponse' + description: Bad Request + security: + - api_email: [] + api_key: [] + summary: Creates pay-per-crawl config for a zone + tags: + - ppc_config + x-api-token-group: + - Zone Settings Write +components: + schemas: + billSubsApiBillingResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + properties: + account_type: + example: type + type: string + address: + example: 123 Main Street + type: string + address2: + example: Apt 1 + type: string + balance: + example: '0' + type: string + card_expiry_month: + example: 12 + type: integer + card_expiry_year: + example: 2099 + type: integer + card_number: + example: '4242424242424242' + type: string + city: + example: Anytown + type: string + company: + example: Company + type: string + country: + example: Anycountry + type: string + created_on: + example: '2014-03-01T12:21:59.3456Z' + format: date-time + type: string + readOnly: true + device_data: + example: sample_data + type: string + edited_on: + example: '2014-03-01T12:21:59.3456Z' + format: date-time + type: string + enterprise_billing_email: + example: johndoe@gmail.com + type: string + x-auditable: true + enterprise_primary_email: + example: johndoe@gmail.com + type: string + x-auditable: true + first_name: + example: John + type: string + id: + $ref: '#/components/schemas/billSubsApiComponentsSchemasIdentifier' + is_partner: + example: false + type: boolean + last_name: + example: Doe + type: string + next_bill_date: + example: '2014-03-01T12:21:59.3456Z' + format: date-time + type: string + payment_address: + example: 123 Main Street + type: string + payment_address2: + example: Apt 1 + type: string + payment_city: + example: Anytown + type: string + payment_country: + example: Anycountry + type: string + payment_email: + example: johndoe@gmail.com + type: string + payment_first_name: + example: John + type: string + payment_gateway: + example: gateway + type: string + payment_last_name: + example: Doe + type: string + payment_nonce: + example: abc123 + type: string + payment_state: + example: state + type: string + payment_zipcode: + example: '12345' + type: string + primary_email: + example: johndoe@gmail.com + type: string + x-auditable: true + state: + example: AnyState + type: string + tax_id_type: + example: type + type: string + telephone: + example: '1234567899' + type: string + use_legacy: + example: false + type: boolean + validation_code: + example: '1111' + type: string + vat: + example: GB123456789 + type: string + zipcode: + example: '12345' + type: string + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + billSubsApiComponentsSchemasIdentifier: + description: Billing item identifier tag. + example: b69a9f3492637782896352daae219e7d + maxLength: 32 + readOnly: true + type: string + x-auditable: true + billSubsApiMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + billableUsageApiApiResponseCommonFailure: + description: Represents a failed API response. + properties: + errors: + description: Contains error details describing why the request failed. + example: + - code: 1183 + message: >- + Invalid request parameters: Please ensure all required + parameters are included and correctly formatted. + items: + $ref: '#/components/schemas/billableUsageApiMessage' + minItems: 1 + type: array + messages: + description: Contains informational notices about the response. + items: + $ref: '#/components/schemas/billableUsageApiMessage' + nullable: true + type: array + result: + description: Contains the response payload (always null on failure). + nullable: true + type: object + success: + description: Indicates whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + billableUsageApiMessage: + description: Represents an API notice or error detail. + properties: + code: + description: Identifies the error or notice type. + type: integer + message: + description: Describes the error or notice. + type: string + required: + - message + type: object + billableUsageApiUsageRecord: + description: Represents a single billable usage record. + properties: + BillingCurrency: + description: Specifies the billing currency code (ISO 4217). + example: USD + type: string + BillingPeriodStart: + description: Indicates the start of the billing period. + example: '2025-02-01T00:00:00Z' + format: date-time + type: string + ChargePeriodEnd: + description: Indicates the end of the charge period. + example: '2025-02-02T00:00:00Z' + format: date-time + type: string + ChargePeriodStart: + description: Indicates the start of the charge period. + example: '2025-02-01T00:00:00Z' + format: date-time + type: string + ConsumedQuantity: + description: Specifies the quantity consumed during this charge period. + example: 150000 + type: number + ConsumedUnit: + description: Specifies the unit of measurement for consumed quantity. + example: Requests + type: string + ContractedCost: + description: Specifies the cost for this charge period in the billing currency. + example: 0.75 + type: number + CumulatedContractedCost: + description: >- + Specifies the cumulated cost for the billing period in the billing + currency. + example: 2.25 + type: number + CumulatedPricingQuantity: + description: Specifies the cumulated pricing quantity for the billing period. + example: 4500000 + type: integer + PricingQuantity: + description: Specifies the pricing quantity for this charge period. + example: 150000 + type: integer + ServiceName: + description: Identifies the Cloudflare service. + example: Workers Standard + type: string + required: + - ChargePeriodStart + - ChargePeriodEnd + - BillingPeriodStart + - ServiceName + - ConsumedQuantity + - ConsumedUnit + - PricingQuantity + - CumulatedPricingQuantity + - ContractedCost + - CumulatedContractedCost + - BillingCurrency + type: object + billableUsageApiUsageResponse: + description: Represents a successful response containing billable usage records. + properties: + errors: + description: Contains error details if the request failed. + items: + $ref: '#/components/schemas/billableUsageApiMessage' + nullable: true + type: array + messages: + description: Contains informational notices about the response. + items: + $ref: '#/components/schemas/billableUsageApiMessage' + nullable: true + type: array + result: + description: Contains the array of billable usage records. + items: + $ref: '#/components/schemas/billableUsageApiUsageRecord' + type: array + success: + description: Indicates whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + payPerCrawlApiErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/payPerCrawlRESTError' + type: array + result: {} + success: + type: boolean + type: object + payPerCrawlApiNoResultResponse: + properties: + errors: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + messages: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + result_info: + $ref: '#/components/schemas/payPerCrawlResultInfo' + success: + type: boolean + type: object + payPerCrawlCreateStripeConfigResponse: + properties: + errors: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + messages: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + result: + $ref: '#/components/schemas/payPerCrawlStripeConnectResp' + result_info: + $ref: '#/components/schemas/payPerCrawlResultInfo' + success: + type: boolean + type: object + payPerCrawlDaricConfig: + properties: + bot_overrides: + type: object + enabled: + type: boolean + price_usd_microcents: + type: integer + type: object + payPerCrawlDaricZoneCanBeEnabled: + properties: + can_be_enabled: + type: boolean + id: + type: string + type: object + payPerCrawlErrorSource: + properties: + pointer: + type: string + type: object + payPerCrawlGetConfigResponse: + properties: + errors: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + messages: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + result: + $ref: '#/components/schemas/payPerCrawlDaricConfig' + result_info: + $ref: '#/components/schemas/payPerCrawlResultInfo' + success: + type: boolean + type: object + payPerCrawlGetStripeConfigResponse: + properties: + errors: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + messages: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + result: + $ref: '#/components/schemas/payPerCrawlStripeConnection' + result_info: + $ref: '#/components/schemas/payPerCrawlResultInfo' + success: + type: boolean + type: object + payPerCrawlMsg: + properties: + code: + type: integer + documentation_url: + type: string + error_chain: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + message: + type: string + meta: + description: >- + Meta object containing non-standard meta-information about the + error. This field must be an object or null! + source: + $ref: '#/components/schemas/payPerCrawlSource' + type: object + payPerCrawlQueryZonesCanBeEnabledResponse: + properties: + errors: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + messages: + items: + $ref: '#/components/schemas/payPerCrawlMsg' + type: array + result: + $ref: '#/components/schemas/payPerCrawlZonesCanBeEnabledPayload' + result_info: + $ref: '#/components/schemas/payPerCrawlResultInfo' + success: + type: boolean + type: object + payPerCrawlRESTError: + properties: + code: + type: integer + documentation_url: + type: string + error: + type: string + source: + $ref: '#/components/schemas/payPerCrawlErrorSource' + type: object + payPerCrawlResultInfo: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + total_pages: + description: >- + TotalPages is a pointer so that if TotalPages == 0 we return that + there are indeed 0 pages. omitempty would have removed the field + otherwise. This is important as a customer may be relying on always + reading this property and it should not be absent just because it is + 0, only absent if a value is never provided. + type: integer + type: object + payPerCrawlSource: + properties: + parameter: + description: >- + Parameter is a string indicating which URI query parameter caused + the error. + type: string + parameter_value_index: + description: >- + ParameterPosition indicates position of parameter value which caused + the error, for cases when there are multiple values for the same + parameter. + type: integer + pointer: + description: >- + Pointer is a JSON Pointer [RFC6901] to the associated entity in the + request document e.g. "/data" for a primary data object, or + "/data/attributes/title" for a specific attribute. + items: + type: string + type: array + type: object + payPerCrawlStripeConnectResp: + properties: + url: + type: string + type: object + payPerCrawlStripeConnection: + properties: + connect_status: + type: string + stripe_account_id: + type: string + type: object + payPerCrawlZonesCanBeEnabledPayload: + properties: + zones: + items: + $ref: '#/components/schemas/payPerCrawlDaricZoneCanBeEnabled' + type: array + type: object + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + profiles: + id: cloudflare.billing.profiles + name: profiles + title: Profiles + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1billing~1profile/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/profiles/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + usage: + id: cloudflare.billing.usage + name: usage + title: Usage + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1billing~1usage~1paygo/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/usage/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + crawler_stripe: + id: cloudflare.billing.crawler_stripe + name: crawler_stripe + title: Crawler Stripe + methods: + pay_per_crawl_crawler_delete_stripe_config: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1crawler~1stripe/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1crawler~1stripe/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + pay_per_crawl_crawler_create_stripe_config: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1crawler~1stripe/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/crawler_stripe/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/crawler_stripe/methods/pay_per_crawl_crawler_create_stripe_config + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/crawler_stripe/methods/pay_per_crawl_crawler_delete_stripe_config + replace: [] + publisher_stripe: + id: cloudflare.billing.publisher_stripe + name: publisher_stripe + title: Publisher Stripe + methods: + pay_per_crawl_publisher_delete_stripe_config: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1publisher~1stripe/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1publisher~1stripe/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + pay_per_crawl_publisher_create_stripe_config: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1publisher~1stripe/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/publisher_stripe/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/publisher_stripe/methods/pay_per_crawl_publisher_create_stripe_config + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/publisher_stripe/methods/pay_per_crawl_publisher_delete_stripe_config + replace: [] + accounts: + id: cloudflare.billing.accounts + name: accounts + title: Accounts + methods: + set_pay_per_crawl_zones: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1zones_can_be_enabled/patch + response: + mediaType: application/json + openAPIDocKey: '200' + query_pay_per_crawl_zones: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pay-per-crawl~1zones_can_be_enabled~1query/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + configuration: + id: cloudflare.billing.configuration + name: configuration + title: Configuration + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pay-per-crawl~1configuration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + pay_per_crawl_patch_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pay-per-crawl~1configuration/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + pay_per_crawl_create_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pay-per-crawl~1configuration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configuration/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/configuration/methods/pay_per_crawl_create_config + update: + - $ref: >- + #/components/x-stackQL-resources/configuration/methods/pay_per_crawl_patch_config + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/bot_management.yaml b/providers/src/cloudflare/v00.00.00000/services/bot_management.yaml new file mode 100644 index 00000000..427c3ba0 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/bot_management.yaml @@ -0,0 +1,943 @@ +openapi: 3.0.3 +info: + title: bot_management API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/bot_management: + get: + description: Retrieve a zone's Bot Management Config + operationId: bot-management-for-a-zone-get-config + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/botManagementBotManagementResponseBody' + description: Bot Management config response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/botManagementMessages' + messages: + $ref: '#/components/schemas/botManagementMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + type: object + title: Bot Fight Mode + properties: + ai_bots_protection: + $ref: '#/components/schemas/botManagementAiBotsProtection' + cf_robots_variant: + $ref: '#/components/schemas/botManagementCfRobotsVariant' + content_bots_protection: + $ref: >- + #/components/schemas/botManagementContentBotsProtection + crawler_protection: + $ref: '#/components/schemas/botManagementCrawlerProtection' + enable_js: + $ref: '#/components/schemas/botManagementEnableJs' + is_robots_txt_managed: + $ref: '#/components/schemas/botManagementIsRobotsTxtManaged' + using_latest_model: + $ref: '#/components/schemas/botManagementUsingLatestModel' + fight_mode: + $ref: '#/components/schemas/botManagementFightMode' + stale_zone_configuration: + description: >- + A read-only field that shows which unauthorized + settings are currently active on the zone. These + settings typically result from upgrades or downgrades. + properties: + optimize_wordpress: + $ref: >- + #/components/schemas/botManagementOptimizeWordpressTurnedOn + sbfm_definitely_automated: + $ref: >- + #/components/schemas/botManagementSbfmDefinitelyAutomatedTurnedOn + sbfm_likely_automated: + $ref: >- + #/components/schemas/botManagementSbfmLikelyAutomatedTurnedOn + sbfm_static_resource_protection: + $ref: >- + #/components/schemas/botManagementSbfmStaticResourceProtectionTurnedOn + sbfm_verified_bots: + $ref: >- + #/components/schemas/botManagementSbfmVerifiedBotsTurnedOn + suppress_session_score: + $ref: >- + #/components/schemas/botManagementSuppressSessionScoreTurnedOff + readOnly: true + title: stale_zone_configuration + type: object + optimize_wordpress: + $ref: '#/components/schemas/botManagementOptimizeWordpress' + sbfm_definitely_automated: + $ref: >- + #/components/schemas/botManagementSbfmDefinitelyAutomated + sbfm_static_resource_protection: + $ref: >- + #/components/schemas/botManagementSbfmStaticResourceProtection + sbfm_verified_bots: + $ref: '#/components/schemas/botManagementSbfmVerifiedBots' + sbfm_likely_automated: + $ref: '#/components/schemas/botManagementSbfmLikelyAutomated' + auto_update_model: + $ref: '#/components/schemas/botManagementAutoUpdateModel' + bm_cookie_enabled: + $ref: '#/components/schemas/botManagementBmCookieEnabled' + suppress_session_score: + $ref: '#/components/schemas/botManagementSuppressSessionScore' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Bot Management config response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zone Bot Management Config + tags: + - Bot Settings + x-api-token-group: + - Bot Management Write + - Bot Management Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: bot_management + resource_chain: [] + method: get + put: + description: >- + Updates the Bot Management configuration for a zone. This API is used to + update: - **Bot Fight Mode** - **Super Bot Fight Mode** - **Bot + Management for Enterprise** See [Bot + Plans](https://developers.cloudflare.com/bots/plans/) for more + information on the different plans \ If you recently upgraded or + downgraded your plan, refer to the following examples to clean up old + configurations. Copy and paste the example body to remove old zone + configurations based on your current plan. **Clean up configuration for + Bot Fight Mode plan:** ```json { "sbfm_likely_automated": "allow", + "sbfm_definitely_automated": "allow", "sbfm_verified_bots": "allow", + "sbfm_static_resource_protection": false, "optimize_wordpress": false, + "suppress_session_score": false } ``` **Clean up configuration for SBFM + Pro plan:** ```json { "sbfm_likely_automated": "allow", "fight_mode": + false } ``` **Clean up configuration for SBFM Biz plan:** ```json { + "fight_mode": false } ``` **Clean up configuration for BM Enterprise + Subscription plan:** It is strongly recommended that you ensure you have + [custom rules](https://developers.cloudflare.com/waf/custom-rules/) in + place to protect your zone before disabling the SBFM rules. Without + these protections, your zone is vulnerable to attacks. ```json { + "sbfm_likely_automated": "allow", "sbfm_definitely_automated": "allow", + "sbfm_verified_bots": "allow", "sbfm_static_resource_protection": false, + "optimize_wordpress": false, "fight_mode": false } ``` + operationId: bot-management-for-a-zone-update-config + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/botManagementConfigSingle' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/botManagementBotManagementResponseBody' + description: Update Bot Management response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/botManagementMessages' + messages: + $ref: '#/components/schemas/botManagementMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + type: object + title: Bot Fight Mode + properties: + ai_bots_protection: + $ref: '#/components/schemas/botManagementAiBotsProtection' + cf_robots_variant: + $ref: '#/components/schemas/botManagementCfRobotsVariant' + content_bots_protection: + $ref: >- + #/components/schemas/botManagementContentBotsProtection + crawler_protection: + $ref: '#/components/schemas/botManagementCrawlerProtection' + enable_js: + $ref: '#/components/schemas/botManagementEnableJs' + is_robots_txt_managed: + $ref: '#/components/schemas/botManagementIsRobotsTxtManaged' + using_latest_model: + $ref: '#/components/schemas/botManagementUsingLatestModel' + fight_mode: + $ref: '#/components/schemas/botManagementFightMode' + stale_zone_configuration: + description: >- + A read-only field that shows which unauthorized + settings are currently active on the zone. These + settings typically result from upgrades or downgrades. + properties: + optimize_wordpress: + $ref: >- + #/components/schemas/botManagementOptimizeWordpressTurnedOn + sbfm_definitely_automated: + $ref: >- + #/components/schemas/botManagementSbfmDefinitelyAutomatedTurnedOn + sbfm_likely_automated: + $ref: >- + #/components/schemas/botManagementSbfmLikelyAutomatedTurnedOn + sbfm_static_resource_protection: + $ref: >- + #/components/schemas/botManagementSbfmStaticResourceProtectionTurnedOn + sbfm_verified_bots: + $ref: >- + #/components/schemas/botManagementSbfmVerifiedBotsTurnedOn + suppress_session_score: + $ref: >- + #/components/schemas/botManagementSuppressSessionScoreTurnedOff + readOnly: true + title: stale_zone_configuration + type: object + optimize_wordpress: + $ref: '#/components/schemas/botManagementOptimizeWordpress' + sbfm_definitely_automated: + $ref: >- + #/components/schemas/botManagementSbfmDefinitelyAutomated + sbfm_static_resource_protection: + $ref: >- + #/components/schemas/botManagementSbfmStaticResourceProtection + sbfm_verified_bots: + $ref: '#/components/schemas/botManagementSbfmVerifiedBots' + sbfm_likely_automated: + $ref: '#/components/schemas/botManagementSbfmLikelyAutomated' + auto_update_model: + $ref: '#/components/schemas/botManagementAutoUpdateModel' + bm_cookie_enabled: + $ref: '#/components/schemas/botManagementBmCookieEnabled' + suppress_session_score: + $ref: '#/components/schemas/botManagementSuppressSessionScore' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Bot Management response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Zone Bot Management Config + tags: + - Bot Settings + x-api-token-group: + - Bot Management Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: bot_management + resource_chain: [] + method: update + /zones/{zone_id}/bot_management/feedback: + get: + description: >- + Returns all feedback reports previously submitted for the specified + zone. Feedback reports help improve detection by sharing samples of + traffic that were misclassified as bots or humans. + operationId: bot-management-zone-feedback-list + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/botManagementFeedbackReport' + type: array + description: List of feedback reports + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/botManagementApiResponseCommonFailure' + description: Feedback list failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List zone feedback reports + tags: + - Feedback + x-api-token-group: + - Bot Management Feedback Report Write + - Bot Management Feedback Report Read + - Bot Management Write + - Bot Management Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + post: + description: >- + Submit a feedback report for the specified zone. Use `type` to indicate + whether the report is a false positive (good traffic flagged as bot) or + a false negative (bot traffic missed). Furthermore, you can also use + `expression` as a wirefilter to identify the affected traffic sample. + See more accepted API fields and expression types at + https://developers.cloudflare.com/bots/concepts/feedback-loop/#api-fields + and + https://developers.cloudflare.com/bots/concepts/feedback-loop/#expression-fields, + respectively. + operationId: bot-management-zone-feedback-create + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/botManagementFeedbackReport' + responses: + '201': + description: Feedback report created + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/botManagementApiResponseCommonFailure' + description: Feedback creation failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Submit a feedback report + tags: + - Feedback + x-api-token-group: + - Bot Management Feedback Report Write + - Bot Management Feedback Report Read + - Bot Management Write + - Bot Management Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false +components: + schemas: + botManagementAiBotsProtection: + description: >- + Enable rule to block AI Scrapers and Crawlers. Please note the value + `only_on_ad_pages` is currently not available for Enterprise customers. + enum: + - block + - disabled + - only_on_ad_pages + example: block + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/botManagementMessages' + messages: + example: [] + $ref: '#/components/schemas/botManagementMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + botManagementAutoUpdateModel: + description: >- + Automatically update to the newest bot detection models created by + Cloudflare as they are released. [Learn + more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes) + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementBmCookieEnabled: + description: >- + Indicates that the bot management cookie can be placed on end user + devices accessing the site. Defaults to true + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementBotManagementResponseBody: + type: object + properties: + errors: + $ref: '#/components/schemas/botManagementMessages' + messages: + $ref: '#/components/schemas/botManagementMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + title: Bot Fight Mode + properties: + ai_bots_protection: + $ref: '#/components/schemas/botManagementAiBotsProtection' + cf_robots_variant: + $ref: '#/components/schemas/botManagementCfRobotsVariant' + content_bots_protection: + $ref: '#/components/schemas/botManagementContentBotsProtection' + crawler_protection: + $ref: '#/components/schemas/botManagementCrawlerProtection' + enable_js: + $ref: '#/components/schemas/botManagementEnableJs' + is_robots_txt_managed: + $ref: '#/components/schemas/botManagementIsRobotsTxtManaged' + using_latest_model: + $ref: '#/components/schemas/botManagementUsingLatestModel' + fight_mode: + $ref: '#/components/schemas/botManagementFightMode' + stale_zone_configuration: + description: >- + A read-only field that shows which unauthorized settings are + currently active on the zone. These settings typically result + from upgrades or downgrades. + properties: + optimize_wordpress: + $ref: '#/components/schemas/botManagementOptimizeWordpressTurnedOn' + sbfm_definitely_automated: + $ref: >- + #/components/schemas/botManagementSbfmDefinitelyAutomatedTurnedOn + sbfm_likely_automated: + $ref: >- + #/components/schemas/botManagementSbfmLikelyAutomatedTurnedOn + sbfm_static_resource_protection: + $ref: >- + #/components/schemas/botManagementSbfmStaticResourceProtectionTurnedOn + sbfm_verified_bots: + $ref: '#/components/schemas/botManagementSbfmVerifiedBotsTurnedOn' + suppress_session_score: + $ref: >- + #/components/schemas/botManagementSuppressSessionScoreTurnedOff + readOnly: true + title: stale_zone_configuration + type: object + optimize_wordpress: + $ref: '#/components/schemas/botManagementOptimizeWordpress' + sbfm_definitely_automated: + $ref: '#/components/schemas/botManagementSbfmDefinitelyAutomated' + sbfm_static_resource_protection: + $ref: '#/components/schemas/botManagementSbfmStaticResourceProtection' + sbfm_verified_bots: + $ref: '#/components/schemas/botManagementSbfmVerifiedBots' + sbfm_likely_automated: + $ref: '#/components/schemas/botManagementSbfmLikelyAutomated' + auto_update_model: + $ref: '#/components/schemas/botManagementAutoUpdateModel' + bm_cookie_enabled: + $ref: '#/components/schemas/botManagementBmCookieEnabled' + suppress_session_score: + $ref: '#/components/schemas/botManagementSuppressSessionScore' + required: + - success + - errors + - messages + botManagementCfRobotsVariant: + description: Specifies the Robots Access Control License variant to use. + enum: + - 'off' + - policy_only + example: policy_only + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementConfigSingle: + type: object + title: Bot Fight Mode + properties: + ai_bots_protection: + $ref: '#/components/schemas/botManagementAiBotsProtection' + cf_robots_variant: + $ref: '#/components/schemas/botManagementCfRobotsVariant' + content_bots_protection: + $ref: '#/components/schemas/botManagementContentBotsProtection' + crawler_protection: + $ref: '#/components/schemas/botManagementCrawlerProtection' + enable_js: + $ref: '#/components/schemas/botManagementEnableJs' + is_robots_txt_managed: + $ref: '#/components/schemas/botManagementIsRobotsTxtManaged' + using_latest_model: + $ref: '#/components/schemas/botManagementUsingLatestModel' + fight_mode: + $ref: '#/components/schemas/botManagementFightMode' + stale_zone_configuration: + description: >- + A read-only field that shows which unauthorized settings are + currently active on the zone. These settings typically result from + upgrades or downgrades. + properties: + optimize_wordpress: + $ref: '#/components/schemas/botManagementOptimizeWordpressTurnedOn' + sbfm_definitely_automated: + $ref: >- + #/components/schemas/botManagementSbfmDefinitelyAutomatedTurnedOn + sbfm_likely_automated: + $ref: '#/components/schemas/botManagementSbfmLikelyAutomatedTurnedOn' + sbfm_static_resource_protection: + $ref: >- + #/components/schemas/botManagementSbfmStaticResourceProtectionTurnedOn + sbfm_verified_bots: + $ref: '#/components/schemas/botManagementSbfmVerifiedBotsTurnedOn' + suppress_session_score: + $ref: '#/components/schemas/botManagementSuppressSessionScoreTurnedOff' + readOnly: true + title: stale_zone_configuration + type: object + optimize_wordpress: + $ref: '#/components/schemas/botManagementOptimizeWordpress' + sbfm_definitely_automated: + $ref: '#/components/schemas/botManagementSbfmDefinitelyAutomated' + sbfm_static_resource_protection: + $ref: '#/components/schemas/botManagementSbfmStaticResourceProtection' + sbfm_verified_bots: + $ref: '#/components/schemas/botManagementSbfmVerifiedBots' + sbfm_likely_automated: + $ref: '#/components/schemas/botManagementSbfmLikelyAutomated' + auto_update_model: + $ref: '#/components/schemas/botManagementAutoUpdateModel' + bm_cookie_enabled: + $ref: '#/components/schemas/botManagementBmCookieEnabled' + suppress_session_score: + $ref: '#/components/schemas/botManagementSuppressSessionScore' + botManagementContentBotsProtection: + description: >- + Enable rule to block content bots. When enabled, blocks automated + traffic with low bot scores, excluding safe verified bot categories. + Exceptions should be managed via skip rules. + enum: + - block + - disabled + example: disabled + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementCrawlerProtection: + description: Enable rule to punish AI Scrapers and Crawlers via a link maze. + enum: + - enabled + - disabled + example: enabled + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementEnableJs: + description: >- + Use lightweight, invisible JavaScript detections to improve Bot + Management. [Learn more about JavaScript + Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementFeedbackReport: + properties: + created_at: + format: date-time + readOnly: true + type: string + description: + type: string + expression: + description: Wirefilter expression describing the traffic being reported. + type: string + first_request_seen_at: + format: date-time + type: string + last_request_seen_at: + format: date-time + type: string + requests: + format: int64 + type: integer + requests_by_attribute: + $ref: '#/components/schemas/botManagementRequestsByAttribute' + requests_by_score: + $ref: '#/components/schemas/botManagementRequestsByScore' + requests_by_score_src: + $ref: '#/components/schemas/botManagementRequestsByScoreSrc' + subtype: + type: string + type: + $ref: '#/components/schemas/botManagementFeedbackType' + required: + - type + - description + - expression + - first_request_seen_at + - last_request_seen_at + - requests + - requests_by_score + - requests_by_score_src + - requests_by_attribute + type: object + botManagementFeedbackType: + description: Type of feedback report. + enum: + - false_positive + - false_negative + example: false_positive + type: string + botManagementFightMode: + description: Whether to enable Bot Fight Mode. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementIsRobotsTxtManaged: + default: false + description: >- + Enable cloudflare managed robots.txt. If an existing robots.txt is + detected, then managed robots.txt will be prepended to the existing + robots.txt. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + botManagementOptimizeWordpress: + description: Whether to optimize Super Bot Fight Mode protections for Wordpress. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementOptimizeWordpressTurnedOn: + description: Indicates that the zone's wordpress optimization for SBFM is turned on. + title: optimize_wordpress + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementRequestsByAttribute: + description: >- + Top attributes contributing to the feedback sample. Keys include + topASNs, topCountries, topHosts, topIPs, topJA3Hashes, topJA4s, + topPaths, topUserAgents. + type: object + botManagementRequestsByScore: + description: Map of bot scores (1-99) to request counts. Sum must equal `requests`. + type: object + botManagementRequestsByScoreSrc: + description: Map of score source to request counts. Sum must equal `requests`. + type: object + botManagementSbfmDefinitelyAutomated: + description: >- + Super Bot Fight Mode (SBFM) action to take on definitely automated + requests. + enum: + - allow + - block + - managed_challenge + example: allow + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementSbfmDefinitelyAutomatedTurnedOn: + description: >- + Indicates that the zone's definitely automated requests are being + blocked or challenged. + title: sbfm_definitely_automated + type: string + x-auditable: true + botManagementSbfmLikelyAutomated: + description: Super Bot Fight Mode (SBFM) action to take on likely automated requests. + enum: + - allow + - block + - managed_challenge + example: allow + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementSbfmLikelyAutomatedTurnedOn: + description: >- + Indicates that the zone's likely automated requests are being blocked or + challenged. + title: sbfm_likely_automated + type: string + x-auditable: true + botManagementSbfmStaticResourceProtection: + description: >- + Super Bot Fight Mode (SBFM) to enable static resource protection. Enable + if static resources on your application need bot protection. Note: + Static resource protection can also result in legitimate traffic being + blocked. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementSbfmStaticResourceProtectionTurnedOn: + description: Indicates that the zone's static resource protection is turned on. + title: sbfm_static_resource_protection + type: string + x-auditable: true + botManagementSbfmVerifiedBots: + description: Super Bot Fight Mode (SBFM) action to take on verified bots requests. + enum: + - allow + - block + example: allow + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementSbfmVerifiedBotsTurnedOn: + description: Indicates that the zone's verified bot requests are being blocked. + title: sbfm_verified_bots + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementSuppressSessionScore: + description: >- + Whether to disable tracking the highest bot score for a session in the + Bot Management cookie. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementSuppressSessionScoreTurnedOff: + description: Indicates that the zone's session score tracking is disabled. + title: suppress_session_score + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + botManagementUsingLatestModel: + description: >- + A read-only field that indicates whether the zone currently is running + the latest ML model. + example: true + readOnly: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + bot_management: + id: cloudflare.bot_management.bot_management + name: bot_management + title: Bot Management + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1bot_management/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1bot_management/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bot_management/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/bot_management/methods/update' + feedback: + id: cloudflare.bot_management.feedback + name: feedback + title: Feedback + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1bot_management~1feedback/get' + response: + mediaType: application/json + openAPIDocKey: '200' + bot_management_zone_feedback_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1bot_management~1feedback/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feedback/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/feedback/methods/bot_management_zone_feedback_create + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/botnet_feed.yaml b/providers/src/cloudflare/v00.00.00000/services/botnet_feed.yaml new file mode 100644 index 00000000..adc974be --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/botnet_feed.yaml @@ -0,0 +1,465 @@ +openapi: 3.0.3 +info: + title: botnet_feed API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/botnet_feed/asn/{asn_id}/day_report: + get: + description: >- + Gets all the data the botnet tracking database has for a given ASN + registered to user account for given date. If no date is given, it will + return results for the previous day. + operationId: botnet-threat-feed-get-day-report + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: asn_id + schema: + $ref: '#/components/schemas/dosAsn' + required: true + - in: query + name: date + schema: + $ref: '#/components/schemas/dosTimestamp' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + cidr: + type: string + date: + format: date-time + type: string + offense_count: + type: integer + type: object + required: + - success + - errors + - messages + description: Get botnet feed report for day + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get botnet feed report for day response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get daily report + tags: + - Botnet Threat Feed + x-api-token-group: + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + x-stackql-sdk: + service: botnet_feed + resource_chain: + - asn + method: day_report + /accounts/{account_id}/botnet_feed/asn/{asn_id}/full_report: + get: + description: >- + Gets all the data the botnet threat feed tracking database has for a + given ASN registered to user account. + operationId: botnet-threat-feed-get-full-report + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: asn_id + schema: + $ref: '#/components/schemas/dosAsn' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + cidr: + type: string + date: + format: date-time + type: string + offense_count: + type: integer + type: object + required: + - success + - errors + - messages + description: Get full botnet feed report + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get full botnet feed report response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get full report + tags: + - Botnet Threat Feed + x-api-token-group: + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + x-stackql-sdk: + service: botnet_feed + resource_chain: + - asn + method: full_report + /accounts/{account_id}/botnet_feed/configs/asn: + get: + description: >- + Gets a list of all ASNs registered for a user for the DDoS Botnet Feed + API. + operationId: botnet-threat-feed-list-asn + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + asn: + type: integer + type: object + required: + - success + - errors + - messages + description: Get list of ASNs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get list of ASNs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get list of ASNs + tags: + - Botnet Threat Feed + x-api-token-group: + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + x-stackql-sdk: + service: botnet_feed + resource_chain: + - configs + - asn + method: get + /accounts/{account_id}/botnet_feed/configs/asn/{asn_id}: + delete: + description: Delete an ASN from botnet threat feed for a given user. + operationId: botnet-threat-feed-delete-asn + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: asn_id + schema: + $ref: '#/components/schemas/dosAsn' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + asn: + type: integer + type: object + required: + - success + - errors + - messages + description: Delete ASN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete ASN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an ASN + tags: + - Botnet Threat Feed + x-api-token-group: + - DDoS Botnet Feed Write + x-stackql-sdk: + service: botnet_feed + resource_chain: + - configs + - asn + method: delete +components: + schemas: + dosApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/dosMessages' + messages: + example: [] + $ref: '#/components/schemas/dosMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + dosAsn: + type: integer + dosMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dosTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + asn_day_report: + id: cloudflare.botnet_feed.asn_day_report + name: asn_day_report + title: Asn Day Report + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1botnet_feed~1asn~1{asn_id}~1day_report/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asn_day_report/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + asn_full_report: + id: cloudflare.botnet_feed.asn_full_report + name: asn_full_report + title: Asn Full Report + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1botnet_feed~1asn~1{asn_id}~1full_report/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asn_full_report/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + asn: + id: cloudflare.botnet_feed.asn + name: asn + title: Asn + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1botnet_feed~1configs~1asn/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1botnet_feed~1configs~1asn~1{asn_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asn/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/asn/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/brand_protection.yaml b/providers/src/cloudflare/v00.00.00000/services/brand_protection.yaml new file mode 100644 index 00000000..1d5b321a --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/brand_protection.yaml @@ -0,0 +1,1548 @@ +openapi: 3.0.3 +info: + title: brand_protection API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/brand-protection/logo-matches: + get: + description: Return matches for logo queries based on ID + parameters: + - explode: true + in: query + name: logo_id + schema: + items: + type: string + type: array + style: form + - in: query + name: offset + schema: + type: string + - in: query + name: limit + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiLogoMatch' + description: OK + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Read matches for logo queries by ID + tags: + - logo_match + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - logo_matches + method: get + operationId: get_accounts_account_id_brand_protection_logo_matches + /accounts/{account_id}/brand-protection/logo-matches/download: + get: + description: Return matches as CSV for logo queries based on ID + parameters: + - explode: true + in: query + name: logo_id + schema: + items: + type: string + type: array + style: form + - in: query + name: offset + schema: + type: string + - in: query + name: limit + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiLogoMatch' + description: OK + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Download matches for logo queries by ID + tags: + - logo_match + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - logo_matches + method: download + operationId: get_accounts_account_id_brand_protection_logo_matches_download + /accounts/{account_id}/brand-protection/logos: + post: + description: Return new saved logo queries created from image files + parameters: + - in: query + name: tag + schema: + type: string + - in: query + name: match_type + schema: + type: string + - in: query + name: threshold + schema: + type: number + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/brandProtectionApiImageFile' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiLogo' + description: Created + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Create new saved logo queries from image files + tags: + - logo_match + x-api-token-group: + - Intel Write + x-stackql-sdk: + service: brand_protection + resource_chain: + - logos + method: create + operationId: post_accounts_account_id_brand_protection_logos + /accounts/{account_id}/brand-protection/logos/{logo_id}: + delete: + description: Return a success message after deleting saved logo queries by ID + responses: + '204': + description: No Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Delete saved logo queries by ID + tags: + - logo_match + x-api-token-group: + - Intel Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: logo_id + schema: + minLength: 1 + type: string + required: true + x-stackql-sdk: + service: brand_protection + resource_chain: + - logos + method: delete + operationId: delete_accounts_account_id_brand_protection_logos_logo_id + /accounts/{account_id}/brand-protection/matches: + get: + description: Return matches for string queries based on ID + parameters: + - in: query + name: id + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: include_domain_id + schema: + type: boolean + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiQueryMatch' + description: OK + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Read matches for string queries by ID + tags: + - domain_search + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - matches + method: get + operationId: get_accounts_account_id_brand_protection_matches + /accounts/{account_id}/brand-protection/matches/download: + get: + description: Return matches as CSV for string queries based on ID + parameters: + - in: query + name: id + schema: + type: string + - in: query + name: offset + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: include_domain_id + schema: + type: boolean + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiQueryMatch' + description: OK + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Download matches for string queries by ID + tags: + - domain_search + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - matches + method: download + operationId: get_accounts_account_id_brand_protection_matches_download + /accounts/{account_id}/brand-protection/queries: + delete: + description: Return a success message after deleting saved string queries by ID + parameters: + - in: query + name: id + schema: + type: string + - in: query + name: tag + schema: + type: string + - in: query + name: scan + schema: + type: boolean + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '204': + description: No Content + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Delete saved string queries by ID + tags: + - domain_search + x-api-token-group: + - Intel Write + x-stackql-sdk: + service: brand_protection + resource_chain: + - queries + method: delete + operationId: delete_accounts_account_id_brand_protection_queries + post: + description: Return a success message after creating new saved string queries + parameters: + - in: query + name: id + schema: + type: string + - in: query + name: tag + schema: + type: string + - in: query + name: scan + schema: + type: boolean + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiQuery' + responses: + '204': + description: No Content + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Create new saved string queries + tags: + - domain_search + x-api-token-group: + - Intel Write + x-stackql-sdk: + service: brand_protection + resource_chain: + - queries + method: create + operationId: post_accounts_account_id_brand_protection_queries + /accounts/{account_id}/brand-protection/queries/bulk: + post: + description: Return a success message after creating new saved string queries in bulk + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiQueryBulk' + responses: + '204': + description: No Content + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Unprocessable Content + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Create new saved string queries in bulk + tags: + - domain_search + x-api-token-group: + - Intel Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: brand_protection + resource_chain: + - queries + method: bulk + operationId: post_accounts_account_id_brand_protection_queries_bulk + /accounts/{account_id}/brand-protection/submit: + post: + description: Return new URL submissions + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiURLSubmit' + description: Created + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Create new URL submissions + tags: + - brand_protection + x-api-token-group: + - Intel Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: brand_protection + resource_chain: [] + method: submit + operationId: post_accounts_account_id_brand_protection_submit + /accounts/{account_id}/brand-protection/url-info: + get: + description: Return submitted URLs based on ID + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiURLInfo' + description: OK + default: + content: + application/json: + schema: + $ref: '#/components/schemas/brandProtectionApiError' + description: Default error response + security: + - api_token: [] + summary: Read submitted URLs by ID + tags: + - brand_protection + x-api-token-group: + - Intel Write + - Intel Read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: brand_protection + resource_chain: [] + method: url_info + operationId: get_accounts_account_id_brand_protection_url_info + /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches: + get: + description: >- + Get paginated list of domain matches for one or more brand protection + queries. When multiple query_ids are provided (comma-separated), matches + are deduplicated across queries and each match includes a match_details + array with per-match query metadata and individual dismissed state. + operationId: get_DomainMatchList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: offset + schema: + default: '0' + type: string + - in: query + name: limit + schema: + default: '50' + type: string + - in: query + name: query_id + schema: + description: >- + Query ID or comma-separated list of Query IDs. When multiple IDs + are provided, matches are deduplicated across queries and each + match includes a match_details array with per-match query metadata + and dismissed state. + items: + type: string + type: array + explode: true + - in: query + name: include_domain_id + schema: + default: 'false' + type: string + - in: query + name: include_dismissed + schema: + type: string + - in: query + name: domain_search + schema: + description: Filter matches by domain name (substring match) + type: string + - in: query + name: orderBy + schema: + description: 'Column to sort by. Options: ''domain'', ''first_seen'', or ''registrar''' + enum: + - domain + - first_seen + - registrar + type: string + - in: query + name: order + schema: + description: 'Sort order. Options: ''asc'' (ascending) or ''desc'' (descending)' + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + matches: + items: + properties: + dismissed: + description: >- + Whether the match is dismissed. Only present for + single-query requests. For multi-query requests, use + the dismissed field in each match_details entry. + type: boolean + domain: + type: string + first_seen: + type: string + match_details: + description: >- + Per-match detail objects with query metadata and + individual dismissed state. Only present when + multiple query_ids are requested. + items: + properties: + dismissed: + description: >- + Individual dismissed state for this specific + match. + type: boolean + match_id: + type: integer + query_id: + type: integer + query_tag: + description: Tag associated with the query, if one exists. + nullable: true + type: string + required: + - query_id + - query_tag + - match_id + - dismissed + type: object + type: array + public_scans: + nullable: true + properties: + submission_id: + type: string + required: + - submission_id + type: object + registrar: + nullable: true + type: string + scan_status: + type: string + scan_submission_id: + nullable: true + type: integer + source: + nullable: true + type: string + required: + - domain + - first_seen + - public_scans + - scan_status + - scan_submission_id + - source + - registrar + type: object + type: array + total: + minimum: 0 + type: integer + required: + - matches + - total + type: object + description: Successfully retrieved query matches + security: + - api_token: [] + summary: List saved query matches + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - v2 + - matches + method: get + /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries: + get: + description: Get all saved brand protection queries for an account + operationId: get_GetDomainQueries + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: id + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + created: + type: string + parameters: + nullable: true + properties: + max_time: + type: string + min_time: + type: string + string_matches: + items: + properties: + max_edit_distance: + maximum: 1 + minimum: 0 + type: number + pattern: + minLength: 1 + type: string + required: + - pattern + - max_edit_distance + type: object + type: array + required: + - string_matches + type: object + query_id: + type: integer + query_tag: + type: string + scan: + type: boolean + updated: + type: string + required: + - query_id + - query_tag + - scan + - parameters + - created + - updated + type: object + type: array + description: Successfully retrieved queries + security: + - api_token: [] + summary: Get queries + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - v2 + - queries + method: get + /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/matches: + get: + description: >- + Get paginated list of logo matches for a specific brand protection logo + query + operationId: get_LogoMatchList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: offset + schema: + default: '0' + type: string + - in: query + name: limit + schema: + default: '50' + type: string + - in: query + name: query_id + schema: + minLength: 1 + type: string + - in: query + name: download + schema: + type: string + - in: query + name: orderBy + schema: + description: >- + Column to sort by. Options: 'matchedAt', 'domain', + 'similarityScore', or 'registrar' + enum: + - matchedAt + - domain + - similarityScore + - registrar + type: string + - in: query + name: order + schema: + description: 'Sort order. Options: ''asc'' (ascending) or ''desc'' (descending)' + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + matches: + items: + properties: + content_type: + type: string + domain: + nullable: true + type: string + id: + type: integer + image_data: + type: string + matched_at: + nullable: true + type: string + query_id: + type: integer + registrar: + nullable: true + type: string + similarity_score: + type: number + url_scan_id: + nullable: true + type: string + required: + - id + - query_id + - url_scan_id + - similarity_score + - matched_at + - domain + - registrar + type: object + type: array + total: + minimum: 0 + type: integer + required: + - matches + - total + type: object + description: Successfully retrieved logo matches + security: + - api_token: [] + summary: List logo matches + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - v2 + - logo_matches + method: get + /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries: + get: + description: >- + Get all saved brand protection logo queries for an account. Optionally + specify id to get a single query. Set download=true to include + base64-encoded image data. + operationId: get_GetLogoQueries + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Optional query ID to retrieve a specific logo query + in: query + name: id + schema: + description: Optional query ID to retrieve a specific logo query + type: string + - description: If true, include base64-encoded image data in the response + in: query + name: download + schema: + description: If true, include base64-encoded image data in the response + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + content_type: + description: MIME type of the image (only present when download=true) + type: string + id: + type: integer + image_data: + description: >- + Base64-encoded image data (only present when + download=true) + type: string + r2_path: + type: string + similarity_threshold: + type: number + tag: + type: string + uploaded_at: + nullable: true + type: string + required: + - id + - tag + - r2_path + - similarity_threshold + - uploaded_at + type: object + type: array + description: Successfully retrieved logo queries + security: + - api_token: [] + summary: Get logo queries + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: brand_protection + resource_chain: + - v2 + - logos + method: get + post: + description: >- + Create a new saved brand protection logo query for visual similarity + matching + operationId: post_InsertLogoQuery + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + image_data: + description: >- + Base64 encoded image data. Can include data URI prefix + (e.g., 'data:image/png;base64,...') or just the base64 + string. + minLength: 1 + type: string + search_lookback: + default: true + description: >- + If true, search historic scanned images for matches above + the similarity threshold + type: boolean + similarity_threshold: + description: Minimum similarity score (0-1) required for visual matches + maximum: 1 + minimum: 0 + type: number + tag: + description: Unique identifier for the logo query + minLength: 1 + type: string + required: + - tag + - image_data + - similarity_threshold + type: object + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + query_id: + type: integer + success: + type: boolean + required: + - success + - message + type: object + description: Logo query inserted successfully + security: + - api_token: [] + summary: Insert logo query + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: brand_protection + resource_chain: + - v2 + - logos + method: create + /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}: + delete: + description: >- + Delete a saved brand protection logo query. Returns 404 if the query ID + doesn't exist. + operationId: delete_DeleteLogoQuery + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: query_id + schema: + minLength: 1 + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + success: + type: boolean + required: + - success + - message + type: object + description: Logo query deleted successfully + security: + - api_token: [] + summary: Delete logo query + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: brand_protection + resource_chain: + - v2 + - logos + method: delete +components: + schemas: + brandProtectionApiError: + properties: + code: + description: Error code + type: integer + errors: + description: Errors + type: object + message: + description: Error message + type: string + status: + description: Error name + type: string + type: object + brandProtectionApiImageFile: + properties: + image: + format: binary + type: string + type: object + brandProtectionApiLogo: + properties: + id: + type: integer + tag: + type: string + upload_path: + type: string + type: object + brandProtectionApiLogoMatch: + properties: + matches: + items: + type: object + type: array + total: + type: integer + type: object + brandProtectionApiQuery: + properties: + max_time: + format: date-time + nullable: true + type: string + min_time: + format: date-time + nullable: true + type: string + scan: + type: boolean + string_matches: {} + tag: + type: string + type: object + brandProtectionApiQueryBulk: + properties: + queries: + items: + type: object + type: array + type: object + brandProtectionApiQueryMatch: + properties: + matches: + items: + type: object + type: array + total: + type: integer + type: object + brandProtectionApiURLInfo: + properties: + result: + items: + type: object + type: array + type: object + brandProtectionApiURLSubmit: + properties: + skipped_urls: + items: + type: object + type: array + submitted_urls: + items: + type: object + type: array + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + brand_protection_logo_matches: + id: cloudflare.brand_protection.brand_protection_logo_matches + name: brand_protection_logo_matches + title: Brand Protection Logo Matches + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1brand-protection~1logo-matches/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/brand_protection_logo_matches/methods/list + insert: [] + update: [] + delete: [] + replace: [] + logo_matches_download: + id: cloudflare.brand_protection.logo_matches_download + name: logo_matches_download + title: Logo Matches Download + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1brand-protection~1logo-matches~1download/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/logo_matches_download/methods/list + insert: [] + update: [] + delete: [] + replace: [] + brand_protection_logos: + id: cloudflare.brand_protection.brand_protection_logos + name: brand_protection_logos + title: Brand Protection Logos + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1brand-protection~1logos/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1brand-protection~1logos~1{logo_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/brand_protection_logos/methods/create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/brand_protection_logos/methods/delete_by_account + replace: [] + brand_protection_matches: + id: cloudflare.brand_protection.brand_protection_matches + name: brand_protection_matches + title: Brand Protection Matches + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1brand-protection~1matches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/brand_protection_matches/methods/list + insert: [] + update: [] + delete: [] + replace: [] + matches_download: + id: cloudflare.brand_protection.matches_download + name: matches_download + title: Matches Download + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1brand-protection~1matches~1download/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/matches_download/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + queries: + id: cloudflare.brand_protection.queries + name: queries + title: Queries + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1brand-protection~1queries/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1brand-protection~1queries~1bulk/post + response: + mediaType: application/json + openAPIDocKey: '204' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1domain~1queries/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/queries/methods/delete' + replace: [] + brand_protection: + id: cloudflare.brand_protection.brand_protection + name: brand_protection + title: Brand Protection + methods: + create_queries: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1brand-protection~1queries/post' + response: + mediaType: application/json + openAPIDocKey: '204' + submit: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1brand-protection~1submit/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + url_info: + id: cloudflare.brand_protection.url_info + name: url_info + title: Url Info + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1brand-protection~1url-info/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/url_info/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + domain_matches: + id: cloudflare.brand_protection.domain_matches + name: domain_matches + title: Domain Matches + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1domain~1matches/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.matches + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domain_matches/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + logo_matches: + id: cloudflare.brand_protection.logo_matches + name: logo_matches + title: Logo Matches + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1logo~1matches/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.matches + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logo_matches/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + logos: + id: cloudflare.brand_protection.logos + name: logos + title: Logos + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1logo~1queries/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logos/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + logo_queries: + id: cloudflare.brand_protection.logo_queries + name: logo_queries + title: Logo Queries + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1logo~1queries/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1logo~1queries~1{query_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/logo_queries/methods/create' + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/logo_queries/methods/delete_by_account + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/browser_rendering.yaml b/providers/src/cloudflare/v00.00.00000/services/browser_rendering.yaml new file mode 100644 index 00000000..1488a908 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/browser_rendering.yaml @@ -0,0 +1,6058 @@ +openapi: 3.0.3 +info: + title: browser_rendering API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/browser-rendering/content: + post: + description: Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour. + operationId: brapi-post_Content + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Cache TTL default is 5s. Set to 0 to disable. + in: query + name: cacheTTL + schema: + default: 5 + description: Cache TTL default is 5s. Set to 0 to disable. + maximum: 86400 + minimum: 0 + type: number + requestBody: + content: + application/json: + schema: + type: object + properties: + actionTimeout: + description: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. + maximum: 120000 + type: number + addScriptTag: + description: Adds a `' - description: Retreieve embed Code HTML response - 4xx: - content: - application/json: - schema: - allOf: - - example: '' - - $ref: '#/components/schemas/api-response-common-failure' - description: Retreieve embed Code HTML response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Retreieve embed Code HTML - tags: - - Stream Videos - '/accounts/{account_identifier}/stream/{identifier}/token': - post: - description: 'Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values.' - operationId: stream-videos-create-signed-url-tokens-for-videso - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/videos_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/components-schemas-account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/signed_token_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/signed_token_response' - description: Create signed URL tokens for videso response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/signed_token_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create signed URL tokens for videso response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create signed URL tokens for videso - tags: - - Stream Videos - '/accounts/{account_identifier}/stream/watermarks': - get: - description: Lists all watermark profiles for an account. - operationId: stream-watermark-profile-list-watermark-profiles - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/watermark_response_collection' - description: List watermark profiles response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/watermark_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List watermark profiles response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List watermark profiles - tags: - - Stream Watermark Profile - post: - description: Creates watermark profiles using a single `HTTP POST multipart/form-data` request. - operationId: stream-watermark-profile-create-watermark-profiles-via-basic-upload - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/components-schemas-account_identifier' - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/watermark_basic_upload' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/watermark_response_single' - description: Create watermark profiles via basic upload response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/watermark_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create watermark profiles via basic upload response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create watermark profiles via basic upload - tags: - - Stream Watermark Profile - '/accounts/{account_identifier}/stream/watermarks/{identifier}': - delete: - description: Deletes a watermark profile. - operationId: stream-watermark-profile-delete-watermark-profiles - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/watermarks_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - example: '' - type: string - description: Delete watermark profiles response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - example: '' - type: string - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete watermark profiles response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete watermark profiles - tags: - - Stream Watermark Profile - get: - description: Retrieves details for a single watermark profile. - operationId: stream-watermark-profile-watermark-profile-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/watermarks_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/watermark_response_single' - description: Watermark profile details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/watermark_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Watermark profile details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Watermark profile details - tags: - - Stream Watermark Profile - '/accounts/{account_identifier}/stream/webhook': - delete: - description: Deletes a webhook. - operationId: stream-webhook-delete-webhooks - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/webhook_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deleted_response' - description: Delete webhooks response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/deleted_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete webhooks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete webhooks - tags: - - Stream Webhook - get: - description: Retrieves a list of webhooks. - operationId: stream-webhook-view-webhooks - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/webhook_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/webhook_response_single' - description: View webhooks response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/webhook_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: View webhooks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: View webhooks - tags: - - Stream Webhook - put: - description: Creates a webhook notification. - operationId: stream-webhook-create-webhooks - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/webhook_components-schemas-account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/webhook_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/webhook_response_single' - description: Create webhooks response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/webhook_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create webhooks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create webhooks - tags: - - Stream Webhook diff --git a/providers/src/cloudflare/v00.00.00000/services/cloudflare_tunnel.yaml b/providers/src/cloudflare/v00.00.00000/services/cloudflare_tunnel.yaml deleted file mode 100644 index 2e469287..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/cloudflare_tunnel.yaml +++ /dev/null @@ -1,874 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Cloudflare Tunnel - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - cloudflare_tunnel - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - schemas-tunnel_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/tunnel' - type: array - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - tunnel: - description: Indicates the cloudflared enabled features for this Cloudflare Tunnel connection. - properties: - account_tag: - $ref: '#/components/schemas/common_components-schemas-identifier' - connections: - $ref: '#/components/schemas/connections' - conns_active_at: - $ref: '#/components/schemas/conns_active_at' - conns_inactive_at: - $ref: '#/components/schemas/conns_inactive_at' - created_at: - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-created_at' - deleted_at: - $ref: '#/components/schemas/schemas-deleted_at' - id: - $ref: '#/components/schemas/tunnel_id' - name: - $ref: '#/components/schemas/tunnel_name' - remote_config: - $ref: '#/components/schemas/remote_config' - status: - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-status' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - connections: - description: Connections between cloudflared and the Cloudflare edge that are serving this tunnel. - items: - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-connection' - type: array - conns_active_at: - description: 'If present, indicates the timestamp since the tunnel had at least 1 connection active (formatted in RFC 3339). If absent, tunnel is inactive.' - example: '2009-11-10T23:00:00Z' - format: date-time - nullable: true - type: string - conns_inactive_at: - description: 'If present, indicates since when the tunnel is without any connection established to the edge (formatted in RFC 3339). If absent, tunnel is active.' - example: '2009-11-10T23:00:00Z' - format: date-time - nullable: true - type: string - cloudflare-tunnel_components-schemas-created_at: - description: 'Timestamps when the resource was created, formatted in RFC 3339.' - example: '2021-01-25T18:22:34.317854Z' - format: date-time - type: string - schemas-deleted_at: - description: 'If present, indicates tunnel was deleted at the given date (formatted in RFC 3339). If absent, tunnel has not been deleted.' - example: '2009-11-10T23:00:00Z' - format: date-time - nullable: true - type: string - tunnel_id: - description: UUID of the tunnel. - example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true - type: string - tunnel_name: - description: A user-friendly name chosen when the tunnel is created. Cannot be empty. - example: blog - type: string - remote_config: - description: If the Cloudflare Tunnel's configuration is configured remotely (true) or locally on the origin machine (false). - example: true - type: boolean - cloudflare-tunnel_components-schemas-status: - description: 'The status of the tunnel. Could be "active", "inactive" or "degraded" (Active but not all connectors have 4 connections to the edge).' - example: active - type: string - cloudflare-tunnel_components-schemas-connection: - properties: - client_id: - description: UUID of the cloudflared instance. - client_version: - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-version' - colo_name: - description: Short ID for the colo this connection is connected to. - example: DFW - type: string - id: - $ref: '#/components/schemas/connection_id' - is_pending_reconnect: - description: 'Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If this field is true, the connection has disconnected but is still being tracked for these optimized reconnects. If false, the connection is still actively serving.' - example: false - type: boolean - opened_at: - description: 'Timestamp when the connection was established, formatted in RFC 3339.' - example: '2021-01-25T18:22:34.317854Z' - format: date-time - type: string - origin_ip: - description: The publicly perceived IP of the host running the cloudflared instance. - example: 85.12.78.6 - type: string - cloudflare-tunnel_components-schemas-version: - description: Indicates the cloudflared version used to establish this Cloudflare Tunnel connection. - example: 2022.7.1 - type: string - connection_id: - description: UUID of the tunnel's connection. - example: 1bedc50d-42b3-473c-b108-ff3d10c0d925 - maxLength: 36 - readOnly: true - type: string - schemas-tunnel_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/tunnel' - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - cloudflare-tunnel_components-schemas-empty_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - type: object - type: object - tunnel_connections_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/tunnel_connection' - type: array - type: object - tunnel_connection: - description: Indicates the cloudflared enabled features for this Cloudflare Tunnel connection. - properties: - arch: - $ref: '#/components/schemas/arch' - conns: - $ref: '#/components/schemas/connections' - features: - $ref: '#/components/schemas/schemas-features' - id: - $ref: '#/components/schemas/connection_id' - run_at: - $ref: '#/components/schemas/run_at' - version: - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-version' - type: object - arch: - description: Indicates the cloudflared OS architecture used to establish this Cloudflare Tunnel connection. - example: linux_amd64 - type: string - schemas-features: - description: Contents of a Cloudflare Tunnel. - items: - example: ha-origin - type: string - type: array - run_at: - description: Indicates when the tunnel connection was started (formatted in RFC 3339). - example: '2009-11-10T23:00:00Z' - format: date-time - type: string - tunnel_response_token: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: string - type: object - config_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_cfd_tunnel: - id: cloudflare.cloudflare_tunnel.accounts_cfd_tunnel - name: accounts_cfd_tunnel - title: Accounts Cfd Tunnel - methods: - list_cloudflare_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_cloudflare_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create_cloudflare_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_cloudflare_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get_cloudflare_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_cloudflare_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_cloudflare_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_cfd_tunnel/methods/list_cloudflare_tunnels' - - $ref: '#/components/x-stackQL-resources/accounts_cfd_tunnel/methods/get_cloudflare_tunnel' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_cfd_tunnel/methods/create_cloudflare_tunnel' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_cfd_tunnel/methods/delete_cloudflare_tunnel' - accounts_cfd_tunnel_connections: - id: cloudflare.cloudflare_tunnel.accounts_cfd_tunnel_connections - name: accounts_cfd_tunnel_connections - title: Accounts Cfd Tunnel Connections - methods: - clean_up_cloudflare_tunnel_connections: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1connections/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - list_cloudflare_tunnel_connections: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1connections/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_cloudflare_tunnel_connections: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1connections/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_cfd_tunnel_connections/methods/list_cloudflare_tunnel_connections' - insert: [] - update: [] - delete: [] - accounts_cfd_tunnel_token: - id: cloudflare.cloudflare_tunnel.accounts_cfd_tunnel_token - name: accounts_cfd_tunnel_token - title: Accounts Cfd Tunnel Token - methods: - get_cloudflare_tunnel_token: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1token/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _get_cloudflare_tunnel_token: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1token/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_cfd_tunnel_token/methods/get_cloudflare_tunnel_token' - insert: [] - update: [] - delete: [] - accounts_cfd_tunnel_configurations: - id: cloudflare.cloudflare_tunnel.accounts_cfd_tunnel_configurations - name: accounts_cfd_tunnel_configurations - title: Accounts Cfd Tunnel Configurations - methods: - configuration_get_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1configurations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _configuration_get_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1configurations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - configuration_put_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1cfd_tunnel~1{tunnel_id}~1configurations/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_cfd_tunnel_configurations/methods/configuration_get_configuration' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/cfd_tunnel': - get: - description: 'List, search and filter an account''s Cloudflare Tunnels.' - operationId: cloudflare-tunnel-list-cloudflare-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_response_collection' - description: List Cloudflare Tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Cloudflare Tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Cloudflare Tunnels - tags: - - Cloudflare Tunnel - post: - description: Create a Cloudflare Tunnel in an account. - operationId: cloudflare-tunnel-create-cloudflare-tunnel - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/tunnel_name' - tunnel_secret: - description: A secret encoded as a base64 string. The Create Cloudflare Tunnel endpoint sets this as the tunnel's password. Anyone wishing to run the tunnel needs this password. - example: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg= - type: string - required: - - name - - tunnel_secret - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_response_single' - description: Create Cloudflare Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Cloudflare Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Cloudflare Tunnel - tags: - - Cloudflare Tunnel - '/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}': - delete: - description: Delete a Cloudflare Tunnel from an account. - operationId: cloudflare-tunnel-delete-cloudflare-tunnel - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_response_single' - description: Delete Cloudflare Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Cloudflare Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Cloudflare Tunnel - tags: - - Cloudflare Tunnel - get: - description: Get the details of a Cloudflare Tunnel from an account. - operationId: cloudflare-tunnel-get-cloudflare-tunnel - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_response_single' - description: Get Cloudflare Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Cloudflare Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Cloudflare Tunnel - tags: - - Cloudflare Tunnel - patch: - description: Updates a Cloudflare Tunnel in an account. - operationId: cloudflare-tunnel-update-cloudflare-tunnel - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/tunnel_name' - tunnel_secret: - description: A secret encoded as a base64 string. The endpoint sets this as the tunnel's password. Anyone wishing to run the tunnel needs this password. - example: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg= - type: string - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_response_single' - description: Update Cloudflare Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Cloudflare Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Cloudflare Tunnel - tags: - - Cloudflare Tunnel - '/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/connections': - delete: - description: Remove stale connection resources from a Cloudflare Tunnel. - operationId: cloudflare-tunnel-clean-up-cloudflare-tunnel-connections - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-empty_response' - description: Clean Up Cloudflare Tunnel Connections response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Clean Up Cloudflare Tunnel Connections response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Clean Up Cloudflare Tunnel Connections - tags: - - Cloudflare Tunnel - get: - description: List all of the connection resources for a Cloudflare Tunnel. - operationId: cloudflare-tunnel-list-cloudflare-tunnel-connections - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_connections_response' - description: List Cloudflare Tunnel Connections response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_connections_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Cloudflare Tunnel Connections response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Cloudflare Tunnel Connections - tags: - - Cloudflare Tunnel - '/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/token': - get: - description: Gets the Tunnel for a previously created Cloudflare Tunnel. - operationId: cloudflare-tunnel-get-cloudflare-tunnel-token - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_response_token' - description: Get Cloudflare Tunnel Token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_response_token' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Cloudflare Tunnel Token response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Cloudflare Tunnel Token - tags: - - Cloudflare Tunnel - '/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/configurations': - get: - description: Get the configuration of a specific Cloudflare Tunnel. - operationId: cloudflare-tunnel-configuration-get-configuration - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/config_response_single' - description: Get Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/config_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Configuration - tags: - - Cloudflare Tunnel configuration - put: - description: Add or update a configuration for a cloudflared tunnel. - operationId: cloudflare-tunnel-configuration-put-configuration - parameters: - - in: path - name: tunnel_id - required: true - schema: - $ref: '#/components/schemas/tunnel_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - description: This is a json that conforms to the same syntax rules as the config.yaml. - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/config_response_single' - description: Put Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/config_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Put Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Put Configuration - tags: - - Cloudflare Tunnel configuration diff --git a/providers/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml b/providers/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml new file mode 100644 index 00000000..25ceca3a --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/cloudforce_one.yaml @@ -0,0 +1,15392 @@ +openapi: 3.0.3 +info: + title: cloudforce_one API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/cloudforce-one/binary: + post: + operationId: post_BinDBPost + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + description: The binary file content to upload. + format: binary + type: string + required: + - file + type: object + description: Binary file to be uploaded to the database. + responses: + '200': + content: + application/json: + schema: + properties: + content_type: + type: string + md5: + type: string + sha1: + type: string + sha256: + type: string + required: + - md5 + - sha1 + - sha256 + - content_type + type: object + description: Returns file information + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Posts a file to Binary Storage + tags: + - BinDB + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - binary_storage + method: create + /accounts/{account_id}/cloudforce-one/binary/{hash}: + get: + operationId: get_BinDBGetBinary + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: hash of the binary + in: path + name: hash + schema: + description: hash of the binary + type: string + required: true + responses: + '200': + description: Returns file information + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Retrieves a file from Binary Storage + tags: + - BinDB + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - binary_storage + method: get + /accounts/{account_id}/cloudforce-one/events: + get: + description: >- + Use `datasetId=all` or `datasetId=*` to query all event datasets for the + account (limited to 10). When `datasetId` is unspecified, events are + listed from the default Cloudforce One Threat Events dataset. To list + existing datasets, use the [`List + Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) + endpoint. + operationId: get_EventListGet + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: cursor + schema: + description: >- + Cursor for pagination. When provided, filters are embedded in the + cursor so you only need to pass cursor and pageSize. Returned in + the previous response's result_info.cursor field. Use cursor-based + pagination for deep pagination (beyond 100,000 records) or for + optimal performance. + type: string + - in: query + name: search + schema: + default: [] + items: + properties: + field: + description: >- + Event field to search on. Allowed: attacker, + attackerCountry, category, createdAt, date, event, + indicator, indicatorType, killChain, mitreAttack, tags, + targetCountry, targetIndustry, tlp, uuid. + type: string + op: + description: >- + Search operator. Use 'in' for bulk lookup of up to 100 + values at once, e.g. {field:'tags', op:'in', + value:['malware','apt']}. + enum: + - equals + - not + - gt + - gte + - lt + - lte + - like + - contains + - startsWith + - endsWith + - in + - find + type: string + value: + description: >- + Search value. String or number for most operators. Array for + 'in' operator (max 100 items). + type: string + items: + type: string + type: object + type: array + explode: true + - in: query + name: page + schema: + description: >- + Page number (1-indexed) for offset-based pagination. Limited to + offset of 100,000 records. For deep pagination, use cursor-based + pagination instead. + type: number + - in: query + name: pageSize + schema: + description: Number of results per page. Maximum 25,000. + type: number + - in: query + name: orderBy + schema: + type: string + - in: query + name: order + schema: + enum: + - asc + - desc + type: string + - in: query + name: datasetId + schema: + description: >- + Dataset IDs to query events from (array of UUIDs), or special + value 'all' or '*' to query all event datasets for the account. If + not provided, uses the default dataset. + items: + type: string + type: array + explode: true + - in: query + name: forceRefresh + schema: + type: boolean + - in: query + name: format + schema: + enum: + - json + - stix2 + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + attacker: + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + type: string + event: + type: string + hasChildren: + type: boolean + indicator: + type: string + indicatorType: + type: string + indicatorTypeId: + type: number + insight: + type: string + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + numReferenced: + type: number + numReferences: + type: number + rawId: + type: string + referenced: + items: + type: string + type: array + referencedIds: + items: + type: number + type: array + references: + items: + type: string + type: array + referencesIds: + items: + type: number + type: array + releasabilityId: + type: string + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + uuid: + type: string + required: + - uuid + - date + - targetCountry + - attacker + - attackerCountry + - targetIndustry + - rawId + - indicatorTypeId + - indicator + - event + - numReferenced + - numReferences + - tlp + - category + - indicatorType + - referenced + - references + - tags + - killChain + - mitreAttack + - mitreCapec + - referencedIds + - referencesIds + - hasChildren + - datasetId + type: object + type: array + description: Returns a list of events. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Filter and list events + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + method: list + /accounts/{account_id}/cloudforce-one/events/aggregate: + get: + description: >- + Aggregate threat events by one or more columns (e.g., attacker, + targetIndustry) with optional date filtering and daily grouping. + Supports multi-dimensional aggregation for cross-analysis. + operationId: get_EventAggregate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Column(s) to aggregate by - single column or comma-separated list + (e.g., 'attacker', 'targetIndustry', 'attacker,targetIndustry') + in: query + name: aggregateBy + schema: + description: >- + Column(s) to aggregate by - single column or comma-separated list + (e.g., 'attacker', 'targetIndustry', 'attacker,targetIndustry') + type: string + - description: >- + Dataset ID(s) to filter by. Can be a single dataset ID, + comma-separated list, or array. If not provided, uses default + dataset + in: query + name: datasetId + schema: + description: >- + Dataset ID(s) to filter by. Can be a single dataset ID, + comma-separated list, or array. If not provided, uses default + dataset + items: + type: string + type: array + explode: true + - description: Start date for filtering (ISO 8601 format, e.g., '2024-01-01') + in: query + name: startDate + schema: + description: Start date for filtering (ISO 8601 format, e.g., '2024-01-01') + type: string + - description: End date for filtering (ISO 8601 format, e.g., '2024-12-31') + in: query + name: endDate + schema: + description: End date for filtering (ISO 8601 format, e.g., '2024-12-31') + type: string + - description: Whether to group results by date (daily aggregation) + in: query + name: groupByDate + schema: + description: Whether to group results by date (daily aggregation) + type: boolean + - description: Maximum number of results to return + in: query + name: limit + schema: + default: 100 + description: Maximum number of results to return + type: number + responses: + '200': + content: + application/json: + schema: + properties: + aggregateBy: + description: Column(s) that were aggregated by + type: string + aggregations: + description: >- + Array of aggregation results with dynamic fields based on + aggregateBy columns + items: + type: object + properties: + count: + description: Number of events for this aggregation + type: number + date: + description: Date (if groupByDate is true) + type: string + required: + - count + type: array + dateRange: + description: Date range used for filtering + properties: + endDate: + type: string + startDate: + type: string + type: object + total: + description: Total number of events in the aggregation + type: number + required: + - aggregations + - total + - aggregateBy + type: object + description: Returns aggregated event data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: >- + Aggregate events by single or multiple columns with optional date + filtering + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/attackers: + get: + operationId: get_AttackerList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Array of dataset IDs to query attackers from. If not provided, uses + the default dataset. + in: query + name: datasetIds + schema: + description: >- + Array of dataset IDs to query attackers from. If not provided, + uses the default dataset. + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + description: Returns a list of attackers. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists attackers across multiple datasets + tags: + - Attacker + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - attackers + method: list + /accounts/{account_id}/cloudforce-one/events/categories: + get: + operationId: get_CategoryList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Array of dataset IDs to query categories from. If not provided, uses + the default dataset. + in: query + name: datasetIds + schema: + description: >- + Array of dataset IDs to query categories from. If not provided, + uses the default dataset. + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + items: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + uuid: + type: string + required: + - uuid + - name + - killChain + type: object + type: array + description: Returns a list of categories. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists categories across multiple datasets + tags: + - Category + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - categories + method: list + /accounts/{account_id}/cloudforce-one/events/categories/catalog: + get: + operationId: get_CategoryListComplete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + uuid: + type: string + required: + - uuid + - name + - killChain + type: object + type: array + description: Returns a list of categories. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists categories + tags: + - Category + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/categories/create: + post: + operationId: post_CategoryCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + required: + - name + - killChain + type: object + responses: + '200': + content: + application/json: + schema: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + uuid: + type: string + required: + - uuid + - name + - killChain + type: object + description: Returns the created category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates a new category + tags: + - Category + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - categories + method: create + /accounts/{account_id}/cloudforce-one/events/categories/{category_id}: + delete: + operationId: delete_CategoryDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Category UUID. + in: path + name: category_id + schema: + description: Category UUID. + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + uuid: + type: string + required: + - uuid + type: object + description: Returns the uuid of the deleted category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Deletes a category + tags: + - Category + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - categories + method: delete + get: + operationId: get_CategoryRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Category UUID. + in: path + name: category_id + schema: + description: Category UUID. + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + uuid: + type: string + required: + - uuid + - name + - killChain + type: object + description: Returns a category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Reads a category + tags: + - Category + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - categories + method: get + patch: + operationId: patch_CategoryUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Category UUID. + in: path + name: category_id + schema: + description: Category UUID. + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + uuid: + type: string + required: + - uuid + - name + - killChain + type: object + description: Returns the updated category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates a category + tags: + - Category + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - categories + method: edit + post: + operationId: post_CategoryUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Category UUID. + in: path + name: category_id + schema: + description: Category UUID. + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + name: + type: string + shortname: + type: string + uuid: + type: string + required: + - uuid + - name + - killChain + type: object + description: Returns the updated category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates a category + tags: + - Category + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/countries: + get: + operationId: get_CountryRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + result: + items: + properties: + alpha3: + type: string + name: + type: string + required: + - name + - alpha3 + type: object + type: array + success: + type: string + required: + - success + - result + type: object + type: array + description: Returns the long and short country code for every country. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Retrieves countries information for all countries + tags: + - Country + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - countries + method: list + /accounts/{account_id}/cloudforce-one/events/create: + post: + description: >- + To create a dataset, see the [`Create + Dataset`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/create/) + endpoint. When `datasetId` parameter is unspecified, it will be created + in a default dataset named `Cloudforce One Threat Events`. + operationId: post_EventCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + accountId: + type: number + attacker: + nullable: true + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + format: date-time + type: string + event: + type: string + indicator: + type: string + indicatorType: + type: string + indicators: + description: >- + Array of indicators for this event. Supports multiple + indicators per event for complex scenarios. + items: + properties: + indicatorType: + description: The type of indicator (e.g., DOMAIN, IP, JA3, HASH) + type: string + value: + description: >- + The indicator value (e.g., domain name, IP address, + hash) + type: string + required: + - value + - indicatorType + type: object + type: array + insight: + type: string + raw: + properties: + data: + nullable: true + type: object + source: + type: string + tlp: + type: string + required: + - data + type: object + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + required: + - date + - category + - event + - tlp + - raw + type: object + responses: + '200': + content: + application/json: + schema: + properties: + attacker: + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + type: string + event: + type: string + hasChildren: + type: boolean + indicator: + type: string + indicatorType: + type: string + indicatorTypeId: + type: number + insight: + type: string + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + numReferenced: + type: number + numReferences: + type: number + rawId: + type: string + referenced: + items: + type: string + type: array + referencedIds: + items: + type: number + type: array + references: + items: + type: string + type: array + referencesIds: + items: + type: number + type: array + releasabilityId: + type: string + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + uuid: + type: string + required: + - uuid + - date + - targetCountry + - attacker + - attackerCountry + - targetIndustry + - rawId + - indicatorTypeId + - indicator + - event + - numReferenced + - numReferences + - tlp + - category + - indicatorType + - referenced + - references + - tags + - killChain + - mitreAttack + - mitreCapec + - referencedIds + - referencesIds + - hasChildren + - datasetId + type: object + description: Returns the created event. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates a new event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/create/bulk: + post: + description: >- + The `datasetId` parameter must be defined. To list existing datasets + (and their IDs) in your account, use the [`List + Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) + endpoint. + operationId: post_EventCreateBulk + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + data: + items: + properties: + accountId: + type: number + attacker: + nullable: true + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + format: date-time + type: string + event: + type: string + indicator: + type: string + indicatorType: + type: string + indicators: + description: >- + Array of indicators for this event. Supports multiple + indicators per event for complex scenarios. + items: + properties: + indicatorType: + description: >- + The type of indicator (e.g., DOMAIN, IP, JA3, + HASH) + type: string + value: + description: >- + The indicator value (e.g., domain name, IP + address, hash) + type: string + required: + - value + - indicatorType + type: object + type: array + insight: + type: string + raw: + properties: + data: + nullable: true + type: object + source: + type: string + tlp: + type: string + required: + - data + type: object + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + required: + - date + - category + - event + - tlp + - raw + type: object + type: array + datasetId: + type: string + includeCreatedEvents: + description: >- + When true, response includes array of created event UUIDs + and shard IDs. Useful for tracking which events were created + and where. + type: boolean + required: + - data + - datasetId + type: object + responses: + '202': + content: + application/json: + schema: + description: >- + Detailed result of bulk event creation with auto-tag + management + properties: + createBulkEventsRequestId: + description: Correlation ID for async indicator processing + format: uuid + type: string + createdEvents: + description: >- + Array of created events with UUIDs and shard locations. + Only present when includeCreatedEvents=true + items: + properties: + eventIndex: + description: Original index in the input data array + type: number + shardId: + description: Dataset ID of the shard where the event was created + type: string + uuid: + description: UUID of the created event + format: uuid + type: string + required: + - eventIndex + - uuid + - shardId + type: object + type: array + createdEventsCount: + description: Number of events created + type: number + createdTagsCount: + description: Number of new tags created in SoT + type: number + errorCount: + description: Number of errors encountered + type: number + errors: + description: Array of error details + items: + properties: + error: + description: Error message + type: string + eventIndex: + description: Index of the event that caused the error + type: number + required: + - eventIndex + - error + type: object + type: array + queuedIndicatorsCount: + description: Number of indicators queued for async processing + type: number + required: + - createdEventsCount + - queuedIndicatorsCount + - createdTagsCount + - errorCount + type: object + description: Accepted. Events created; indicators queued for async processing. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates bulk events + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + method: bulk_create + /accounts/{account_id}/cloudforce-one/events/create/bulk/relationships: + post: + deprecated: true + description: This method is deprecated. Please use `event_create_bulk` instead + operationId: post_DOSEventCreateBulkWithRelationships + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + data: + items: + properties: + accountId: + type: number + attacker: + nullable: true + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + format: date-time + type: string + event: + type: string + indicator: + type: string + indicatorType: + type: string + indicators: + description: >- + Array of indicators for this event. Supports multiple + indicators per event for complex scenarios. + items: + properties: + indicatorType: + description: >- + The type of indicator (e.g., DOMAIN, IP, JA3, + HASH) + type: string + value: + description: >- + The indicator value (e.g., domain name, IP + address, hash) + type: string + required: + - value + - indicatorType + type: object + type: array + insight: + type: string + raw: + properties: + data: + nullable: true + type: object + source: + type: string + tlp: + type: string + required: + - data + type: object + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + required: + - date + - category + - event + - tlp + - raw + type: object + type: array + datasetId: + type: string + required: + - data + - datasetId + type: object + responses: + '200': + content: + application/json: + schema: + description: Result of bulk relationship creation operation + properties: + createdEventsCount: + description: Number of events created + type: number + createdIndicatorsCount: + description: Number of indicators created + type: number + createdRelationshipsCount: + description: Number of relationships created + type: number + errorCount: + description: Number of errors encountered + type: number + errors: + description: Array of error details + items: + properties: + error: + description: Error message + type: string + eventIndex: + description: Index of the event that caused the error + type: number + required: + - eventIndex + - error + type: object + type: array + required: + - createdEventsCount + - createdIndicatorsCount + - createdRelationshipsCount + - errorCount + type: object + description: Returns the number of created bulk events with relationships. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates bulk DOS event with relationships and indicators + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset: + get: + operationId: get_DatasetList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + isPublic: + type: boolean + name: + type: string + uuid: + type: string + required: + - uuid + - name + - isPublic + type: object + type: array + description: Returns a list of dataset in an account. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists all datasets in an account + tags: + - Dataset + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - datasets + method: list + /accounts/{account_id}/cloudforce-one/events/dataset/-/groups: + get: + description: List groups for an account + operationId: get_GroupList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + createdAt: + format: date-time + type: string + description: + type: string + name: + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - name + - description + - createdAt + - updatedAt + type: object + type: array + description: Returns the list of groups. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: List groups for an account + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + post: + description: Create a group + operationId: post_GroupCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + type: string + name: + type: string + required: + - name + - description + type: object + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + format: date-time + type: string + description: + type: string + name: + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - name + - description + - createdAt + - updatedAt + type: object + description: Returns the created group. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Create a group + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id}: + delete: + description: Delete a group for an account + operationId: delete_GroupDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + success: + type: boolean + type: object + description: Group deleted successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Delete a group for an account + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + get: + description: Read a group for an account + operationId: get_GroupRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + format: date-time + type: string + description: + type: string + members: + items: + properties: + accountId: + type: string + accountTag: + type: string + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - accountId + type: object + type: array + name: + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - name + - description + - createdAt + - updatedAt + - members + type: object + description: Return the group. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Read a group for an account + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + put: + description: Update a group + operationId: put_GroupUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + type: string + name: + type: string + required: + - name + - description + type: object + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + format: date-time + type: string + description: + type: string + name: + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - name + - description + - createdAt + - updatedAt + type: object + description: Returns the updated group. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Update a group + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id}/members: + get: + description: List group members + operationId: get_GroupMemberList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + accountId: + type: string + accountTag: + type: string + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - accountId + type: object + type: array + description: Returns the group members. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: List group members + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + post: + description: Create a group member + operationId: post_GroupMemberCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + accountId: + type: string + accountTag: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + accountId: + type: string + accountTag: + type: string + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - accountId + type: object + description: Returns the created group member. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Create a group member + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/-/groups/{group_id}/members/{member_id}: + delete: + description: Delete a group member + operationId: delete_GroupMemberDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - name: member_id + in: path + required: true + description: The account member ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + success: + type: boolean + type: object + description: Returns the created group member. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Delete a group member + tags: + - Groups + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/dataset/create: + post: + operationId: post_DatasetCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + isPublic: + description: >- + If true, then anyone can search the dataset. If false, then + its limited to the account. + type: boolean + name: + description: Used to describe the dataset within the account context. + minLength: 1 + type: string + required: + - name + - isPublic + type: object + responses: + '200': + content: + application/json: + schema: + properties: + isPublic: + type: boolean + name: + type: string + uuid: + type: string + required: + - uuid + - name + - isPublic + type: object + description: Returns dataset information. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates a dataset + tags: + - Dataset + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - datasets + method: create + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}: + delete: + description: Deletes a dataset given a datasetId. + operationId: delete_DatasetDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + name: + type: string + uuid: + type: string + required: + - uuid + - name + type: object + description: Returns the uuid and name of the deleted dataset. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Delete a dataset + tags: + - Dataset + x-api-token-group: + - Cloudforce One Write + get: + operationId: get_DatasetRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + isPublic: + type: boolean + name: + type: string + uuid: + type: string + required: + - uuid + - name + - isPublic + type: object + description: Returns a dataset. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Reads a dataset + tags: + - Dataset + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - datasets + method: get + patch: + operationId: patch_DatasetUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + isPublic: + description: >- + If true, then anyone can search the dataset. If false, then + its limited to the account. + type: boolean + name: + description: Used to describe the dataset within the account context. + minLength: 1 + type: string + required: + - name + - isPublic + type: object + responses: + '200': + content: + application/json: + schema: + properties: + isPublic: + type: boolean + name: + type: string + uuid: + type: string + required: + - uuid + - name + - isPublic + type: object + description: Returns dataset information. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates an existing dataset + tags: + - Dataset + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - datasets + method: edit + post: + operationId: post_DatasetUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + isPublic: + description: >- + If true, then anyone can search the dataset. If false, then + its limited to the account. + type: boolean + name: + description: Used to describe the dataset within the account context. + minLength: 1 + type: string + required: + - name + - isPublic + type: object + responses: + '200': + content: + application/json: + schema: + properties: + isPublic: + type: boolean + name: + type: string + uuid: + type: string + required: + - uuid + - name + - isPublic + type: object + description: Returns dataset information. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates an existing dataset + tags: + - Dataset + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/copy: + post: + operationId: post_EventCopyToNewDS + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - description: >- + If true, copies raw data to the destination dataset. Default is + false (raw data is stripped/not copied). + in: query + name: keepRawData + schema: + description: >- + If true, copies raw data to the destination dataset. Default is + false (raw data is stripped/not copied). + type: boolean + requestBody: + content: + application/json: + schema: + properties: + destDatasetId: + type: string + eventIds: + items: + type: string + type: array + required: + - destDatasetId + - eventIds + type: object + responses: + '200': + content: + application/json: + schema: + properties: + copied: + description: Number of events successfully copied + type: number + indicatorsCopied: + description: Number of indicators successfully copied + type: number + insertFailures: + description: Array of events that failed to insert into destination + items: + properties: + index: + description: Index of the event that failed to insert + type: number + reason: + description: Reason for the failure + type: string + required: + - index + - reason + type: object + type: array + relationshipsCopied: + description: Number of relationships successfully copied + type: number + required: + - copied + - indicatorsCopied + - relationshipsCopied + type: object + description: Returns the number of copied events + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Copies specified events from one dataset to another dataset + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/events/{event_id}: + get: + description: Retrieves a specific event by its UUID. + operationId: get_EventRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + attacker: + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + type: string + event: + type: string + hasChildren: + type: boolean + indicator: + type: string + indicatorType: + type: string + indicatorTypeId: + type: number + insight: + type: string + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + numReferenced: + type: number + numReferences: + type: number + rawId: + type: string + referenced: + items: + type: string + type: array + referencedIds: + items: + type: number + type: array + references: + items: + type: string + type: array + referencesIds: + items: + type: number + type: array + releasabilityId: + type: string + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + uuid: + type: string + required: + - uuid + - date + - targetCountry + - attacker + - attackerCountry + - targetIndustry + - rawId + - indicatorTypeId + - indicator + - event + - numReferenced + - numReferences + - tlp + - category + - indicatorType + - referenced + - references + - tags + - killChain + - mitreAttack + - mitreCapec + - referencedIds + - referencesIds + - hasChildren + - datasetId + type: object + description: Returns the event. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Reads an event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicatorTypes/create: + post: + description: >- + Creates a new indicator type and initializes its dedicated Durable + Object + operationId: post_IndicatorTypeCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + description: Optional description for the indicator type + type: string + indicatorType: + description: >- + The indicator type to create (e.g., 'DOMAIN', 'IP', 'URL', + 'HASH', 'EMAIL') + maxLength: 50 + minLength: 1 + type: string + required: + - indicatorType + type: object + responses: + '200': + content: + application/json: + schema: + properties: + durableObjectId: + type: string + indicatorType: + type: string + message: + type: string + required: + - indicatorType + - message + - durableObjectId + type: object + description: Indicator type created successfully + '400': + content: + application/json: + schema: + properties: + content: + properties: + application/json: + properties: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + required: + - schema + type: object + required: + - application/json + type: object + description: + type: string + required: + - description + - content + type: object + description: Bad Request + '500': + content: + application/json: + schema: + properties: + content: + properties: + application/json: + properties: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + required: + - schema + type: object + required: + - application/json + type: object + description: + type: string + required: + - description + - content + type: object + description: Internal Server Error + security: + - api_token: [] + summary: Create a new indicator type + tags: + - Indicators + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators: + get: + deprecated: true + description: >- + This method is deprecated. Please use /events/indicators to retrieve a + paginated list of indicators. + operationId: get_IndicatorListLegacy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - in: query + name: page + schema: + type: number + - in: query + name: pageSize + schema: + type: number + - description: Filter by indicator value (substring match) + in: query + name: name + schema: + description: Filter by indicator value (substring match) + type: string + - in: query + name: indicatorType + schema: + type: string + - description: >- + Filter indicators by related event UUID(s). Multiple UUIDs can be + provided by repeating the parameter. + in: query + name: relatedEvent + schema: + description: >- + Filter indicators by related event UUID(s). Multiple UUIDs can be + provided by repeating the parameter. + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + indicators: + items: + properties: + createdAt: + format: date-time + type: string + datasetId: + description: >- + The dataset ID this indicator belongs to. Included + in list responses. + type: string + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + properties: + categoryName: + type: string + uuid: + type: string + value: + type: string + type: object + type: array + updatedAt: + format: date-time + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - indicatorType + - value + - createdAt + - updatedAt + type: object + type: array + pagination: + properties: + page: + type: number + pageSize: + type: number + totalCount: + type: number + totalPages: + type: number + required: + - page + - pageSize + - totalCount + - totalPages + type: object + required: + - indicators + - pagination + type: object + description: Returns a list of indicators. + security: + - api_token: [] + summary: Lists indicators + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/bulk: + post: + description: >- + Creates multiple indicators at once with their respective types and + related datasets. + operationId: post_IndicatorCreateBulk + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + autoCreateType: + description: >- + Global flag to automatically create indicator types if they + don't exist. Individual indicators can override this with + their own autoCreateType flag. + type: boolean + indicators: + items: + properties: + autoCreateType: + description: >- + If true, automatically create the indicator type if it + doesn't exist. If false (default), throw an error when + the indicator type doesn't exist. + type: boolean + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + type: string + properties: + categoryName: + type: string + value: + type: string + required: + - value + type: array + value: + type: string + required: + - indicatorType + - value + type: object + type: array + required: + - indicators + type: object + responses: + '200': + content: + application/json: + schema: + description: Number of created indicators + type: number + description: Returns the number of created indicators. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates multiple indicators in bulk + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/create: + post: + description: Creates a new indicator with the specified type and related datasets. + operationId: post_IndicatorCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + autoCreateType: + description: >- + If true, automatically create the indicator type if it + doesn't exist. If false (default), throw an error when the + indicator type doesn't exist. + type: boolean + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + type: string + properties: + categoryName: + type: string + value: + type: string + required: + - value + type: array + value: + type: string + required: + - indicatorType + - value + type: object + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + format: date-time + type: string + datasetId: + description: >- + The dataset ID this indicator belongs to. Included in list + responses. + type: string + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + properties: + categoryName: + type: string + uuid: + type: string + value: + type: string + type: object + type: array + updatedAt: + format: date-time + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - indicatorType + - value + - createdAt + - updatedAt + type: object + description: Returns the created indicator. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates a new indicator + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/tags: + get: + description: >- + Returns all mirrored tags from the indicator dataset (DO mirror table). + No pagination. + operationId: get_IndicatorTagsList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: Array of mirror tag rows + items: + type: object + type: array + description: Returns an array of mirrored tags. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: List mirrored tags for an indicator dataset + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id}: + delete: + description: Deletes a specific indicator by its UUID. + operationId: delete_IndicatorDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - description: Indicator UUID. + in: path + name: indicator_id + schema: + description: Indicator UUID. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + success: + type: boolean + type: object + description: Indicator deleted successfully. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Deletes an indicator + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + get: + description: Retrieves a specific indicator by its UUID. + operationId: get_IndicatorRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - description: Indicator UUID. + in: path + name: indicator_id + schema: + description: Indicator UUID. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + format: date-time + type: string + datasetId: + description: >- + The dataset ID this indicator belongs to. Included in list + responses. + type: string + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + properties: + categoryName: + type: string + uuid: + type: string + value: + type: string + type: object + type: array + updatedAt: + format: date-time + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - indicatorType + - value + - createdAt + - updatedAt + type: object + description: Returns the indicator. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Reads an indicator + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + patch: + description: Updates an existing indicator's properties. + operationId: patch_IndicatorUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - description: Indicator UUID. + in: path + name: indicator_id + schema: + description: Indicator UUID. + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + type: string + properties: + categoryName: + type: string + value: + type: string + required: + - value + type: array + value: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + format: date-time + type: string + datasetId: + description: >- + The dataset ID this indicator belongs to. Included in list + responses. + type: string + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + properties: + categoryName: + type: string + uuid: + type: string + value: + type: string + type: object + type: array + updatedAt: + format: date-time + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - indicatorType + - value + - createdAt + - updatedAt + type: object + description: Returns the updated indicator. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates an indicator + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/move: + post: + operationId: post_EventMoveToNewDS + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - description: >- + If true, copies raw data to the destination dataset. Default is + false (raw data is stripped/not copied). Raw data is always deleted + from the source. + in: query + name: keepRawData + schema: + description: >- + If true, copies raw data to the destination dataset. Default is + false (raw data is stripped/not copied). Raw data is always + deleted from the source. + type: boolean + requestBody: + content: + application/json: + schema: + properties: + destDatasetId: + type: string + eventIds: + items: + type: string + type: array + required: + - destDatasetId + - eventIds + type: object + responses: + '200': + content: + application/json: + schema: + properties: + deletionFailures: + description: Array of source datasets where deletion failed + items: + properties: + datasetId: + description: Dataset ID where deletion failed + type: string + reason: + description: Reason for the deletion failure + type: string + required: + - datasetId + - reason + type: object + type: array + indicatorsCopied: + description: Number of indicators successfully copied + type: number + insertFailures: + description: Array of events that failed to insert into destination + items: + properties: + index: + description: Index of the event that failed to insert + type: number + reason: + description: Reason for the failure + type: string + required: + - index + - reason + type: object + type: array + moved: + description: Number of events successfully moved + type: number + relationshipsCopied: + description: Number of relationships successfully copied + type: number + required: + - moved + - indicatorsCopied + - relationshipsCopied + type: object + description: Returns the number of moved events + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Moves specified events from one dataset to another dataset + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/permissions: + get: + description: List permissions + operationId: get_PermissionList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + createdAt: + format: date-time + type: string + resourceId: + description: >- + The resource ID this permission applies to account_id or + group_id + type: string + resourceType: + enum: + - dataset + type: string + role: + enum: + - read + - write + type: string + subjectId: + type: string + subjectType: + enum: + - account + - group + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - subjectType + - subjectId + - role + - resourceType + - createdAt + - updatedAt + type: object + type: array + description: Returns the list of permissions. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: List permissions for dataset + tags: + - Permissions + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + post: + description: Create a permission + operationId: post_PermissionCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + role: + enum: + - read + - write + type: string + subjectId: + type: string + subjectType: + enum: + - account + - group + type: string + required: + - subjectType + - subjectId + - role + type: object + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + format: date-time + type: string + resourceId: + description: >- + The resource ID this permission applies to account_id or + group_id + type: string + resourceType: + enum: + - dataset + type: string + role: + enum: + - read + - write + type: string + subjectId: + type: string + subjectType: + enum: + - account + - group + type: string + updatedAt: + format: date-time + type: string + uuid: + type: string + required: + - uuid + - subjectType + - subjectId + - role + - resourceType + - createdAt + - updatedAt + type: object + description: Returns the created permission. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Create a permission for dataset + tags: + - Permissions + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/permissions/{grant_id}: + delete: + description: Delete a permission + operationId: delete_PermissionDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - in: path + name: grant_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + success: + type: boolean + type: object + description: Permission deleted successfully + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Delete a permission for dataset + tags: + - Permissions + x-api-token-group: + - Cloudforce One Write + put: + description: Update a permission + operationId: put_PermissionUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - in: path + name: grant_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + role: + enum: + - read + - write + type: string + required: + - role + type: object + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + success: + type: boolean + type: object + description: Permission updated successfully + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Update a permission for dataset + tags: + - Permissions + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/tags/{tag_uuid}/indicators: + get: + description: >- + Returns indicators associated with the provided tag UUID across all + indicator datasets, with pagination. + operationId: get_TagIndicatorsList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Tag UUID. + in: path + name: tag_uuid + schema: + description: Tag UUID. + type: string + required: true + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - in: query + name: page + schema: + type: number + - in: query + name: pageSize + schema: + type: number + - in: query + name: indicatorType + schema: + type: string + - description: >- + Filter indicators by related event UUID(s). Multiple UUIDs can be + provided by repeating the parameter. + in: query + name: relatedEvent + schema: + description: >- + Filter indicators by related event UUID(s). Multiple UUIDs can be + provided by repeating the parameter. + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + indicators: + items: + properties: + createdAt: + format: date-time + type: string + datasetId: + description: >- + The dataset ID this indicator belongs to. Included + in list responses. + type: string + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + properties: + categoryName: + type: string + uuid: + type: string + value: + type: string + type: object + type: array + updatedAt: + format: date-time + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - indicatorType + - value + - createdAt + - updatedAt + type: object + type: array + pagination: + properties: + page: + type: number + pageSize: + type: number + totalCount: + type: number + totalPages: + type: number + required: + - page + - pageSize + - totalCount + - totalPages + type: object + required: + - indicators + - pagination + type: object + description: Returns a paginated list of indicators. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: List indicators related to a tag + tags: + - Tag + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/targetIndustries: + get: + operationId: get_TargetIndustryListByDataset + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + description: Returns a list of target industries for the dataset. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists all target industries for a specific dataset + tags: + - Target Industry + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/datasets/populate: + post: + operationId: post_DatasetPopulate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + properties: + properties: + accountId: + properties: + type: + type: string + required: + - type + type: object + datasets: + properties: + items: + properties: + properties: + properties: + attackers: + properties: + properties: + properties: + created: + properties: + type: + type: string + required: + - type + type: object + errors: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + found: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + required: + - found + - created + - errors + type: object + type: + type: string + required: + - type + - properties + type: object + categories: + properties: + properties: + properties: + created: + properties: + type: + type: string + required: + - type + type: object + errors: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + found: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + required: + - found + - created + - errors + type: object + type: + type: string + required: + - type + - properties + type: object + datasetId: + properties: + type: + type: string + required: + - type + type: object + indicatorTypes: + properties: + properties: + properties: + created: + properties: + type: + type: string + required: + - type + type: object + errors: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + found: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + required: + - found + - created + - errors + type: object + type: + type: string + required: + - type + - properties + type: object + processingTimeMs: + properties: + type: + type: string + required: + - type + type: object + targetIndustries: + properties: + properties: + properties: + created: + properties: + type: + type: string + required: + - type + type: object + errors: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + found: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + required: + - found + - created + - errors + type: object + type: + type: string + required: + - type + - properties + type: object + totalProcessed: + properties: + type: + type: string + required: + - type + type: object + required: + - datasetId + - indicatorTypes + - targetIndustries + - categories + - attackers + - totalProcessed + - processingTimeMs + type: object + type: + type: string + required: + - type + - properties + type: object + type: + type: string + required: + - type + - items + type: object + errors: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + summary: + properties: + properties: + properties: + failedDatasets: + properties: + type: + type: string + required: + - type + type: object + successfulDatasets: + properties: + type: + type: string + required: + - type + type: object + totalDatasets: + properties: + type: + type: string + required: + - type + type: object + totalIndicatorTypes: + properties: + type: + type: string + required: + - type + type: object + totalProcessingTimeMs: + properties: + type: + type: string + required: + - type + type: object + required: + - totalDatasets + - successfulDatasets + - failedDatasets + - totalIndicatorTypes + - totalProcessingTimeMs + type: object + type: + type: string + required: + - type + - properties + type: object + required: + - accountId + - datasets + - summary + - errors + type: object + type: + type: string + required: + - type + - properties + type: object + description: Returns population results with counts and any errors + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: >- + Populate dataset-specific lookup tables from existing Events data with + batch processing + tags: + - Datasets + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/event_tag/{event_id}: + delete: + operationId: delete_EventTagDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + success: + type: boolean + required: + - success + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns success if operation succeeded. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Removes a tag from an event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - event_tags + method: delete + /accounts/{account_id}/cloudforce-one/events/event_tag/{event_id}/create: + post: + operationId: post_EventTagCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + tags: + items: + type: string + type: array + required: + - tags + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + success: + type: boolean + required: + - success + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns success if operation succeeded. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Adds a tag to an event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - event_tags + method: create + /accounts/{account_id}/cloudforce-one/events/graphql: + post: + description: >- + Execute GraphQL aggregations over threat events. Supports + multi-dimensional group-bys, optional date range filtering, and + multi-dataset aggregation. + operationId: post_EventGraphQL + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + nullable: true + type: object + errors: + items: + type: object + nullable: true + type: array + type: object + description: GraphQL response payload (data and errors). + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: GraphQL endpoint for event aggregation + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/indicator-types: + get: + operationId: get_IndicatorTypesList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Array of dataset IDs to query indicator types from. If not provided, + queries all datasets for the account. + in: query + name: datasetIds + schema: + description: >- + Array of dataset IDs to query indicator types from. If not + provided, queries all datasets for the account. + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + description: Returns a list of indicator types. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists indicator types across multiple datasets + tags: + - Indicator Types + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/indicatorTypes: + get: + deprecated: true + description: >- + This Method is deprecated. Please use + /events/dataset/:dataset_id/indicatorTypes instead. + operationId: get_LegacyIndicatorTypesList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + description: Returns a list of indicator types. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists all indicator types + tags: + - Indicator Types + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - indicator_types + method: list + /accounts/{account_id}/cloudforce-one/events/indicators: + get: + description: >- + Retrieves a paginated list of indicators across specified datasets. Use + datasetIds=all or datasetIds=* to query all datasets for the account. If + no datasetIds provided, uses the default dataset. + operationId: get_IndicatorList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Dataset IDs to query indicators from (array of UUIDs), or special + value 'all' or '*' to query all datasets. If not provided, uses the + default dataset. + in: query + name: datasetIds + schema: + description: >- + Dataset IDs to query indicators from (array of UUIDs), or special + value 'all' or '*' to query all datasets. If not provided, uses + the default dataset. + items: + type: string + type: array + explode: true + - in: query + name: page + schema: + type: number + - in: query + name: pageSize + schema: + type: number + - description: >- + Structured search as a JSON array of {field, op, value} objects. + Searchable fields: value, indicatorType. Supports operators: equals, + not, contains, startsWith, endsWith, gt, lt, gte, lte, like, in, + find. Use the 'in' operator with an array value to bulk-check up to + 100 indicators in a single request, e.g. + search=[{"field":"value","op":"in","value":["evil.com","bad.org"]}]. + Multiple conditions are AND'd together. Max 10 conditions per + request. + in: query + name: search + schema: + description: >- + Structured search as a JSON array of {field, op, value} objects. + Searchable fields: value, indicatorType. Supports operators: + equals, not, contains, startsWith, endsWith, gt, lt, gte, lte, + like, in, find. Use the 'in' operator with an array value to + bulk-check up to 100 indicators in a single request, e.g. + search=[{"field":"value","op":"in","value":["evil.com","bad.org"]}]. + Multiple conditions are AND'd together. Max 10 conditions per + request. + items: + properties: + field: + description: >- + The indicator field to search on. Allowed: value, + indicatorType. + enum: + - value + - indicatorType + type: string + op: + description: >- + Search operator. Use 'in' for bulk lookup of up to 100 + values at once, e.g. {field:'value', op:'in', + value:['evil.com','bad.org']}. + enum: + - equals + - not + - gt + - gte + - lt + - lte + - like + - contains + - startsWith + - endsWith + - in + - find + type: string + value: + description: >- + Search value. String for most operators. Array of strings + for 'in' operator (max 100 items). + type: string + items: + type: string + required: + - field + - op + - value + type: object + type: array + explode: true + - description: >- + Filter indicators by value using substring match (LIKE). Legacy + alternative to structured search. + in: query + name: name + schema: + description: >- + Filter indicators by value using substring match (LIKE). Legacy + alternative to structured search. + type: string + - in: query + name: indicatorType + schema: + type: string + - description: Filter by related event IDs + in: query + name: relatedEvents + schema: + description: Filter by related event IDs + items: + type: string + type: array + explode: true + - description: >- + Filter by tag values or UUIDs. Indicators must have at least one of + the specified tags (OR logic). Supports both tag UUID and tag value. + in: query + name: tags + schema: + description: >- + Filter by tag values or UUIDs. Indicators must have at least one + of the specified tags (OR logic). Supports both tag UUID and tag + value. + items: + type: string + type: array + explode: true + - description: >- + Filter indicators created on or after this date. Must use ISO 8601 + format (e.g., '2024-01-15T00:00:00Z'). + in: query + name: createdAfter + schema: + description: >- + Filter indicators created on or after this date. Must use ISO 8601 + format (e.g., '2024-01-15T00:00:00Z'). + format: date-time + type: string + - description: >- + Filter indicators created on or before this date. Must use ISO 8601 + format (e.g., '2024-12-31T23:59:59Z'). + in: query + name: createdBefore + schema: + description: >- + Filter indicators created on or before this date. Must use ISO + 8601 format (e.g., '2024-12-31T23:59:59Z'). + format: date-time + type: string + - description: >- + Limit the number of related events returned per indicator. Default: + 2. Set to 0 for none, -1 for all events. + in: query + name: relatedEventsLimit + schema: + description: >- + Limit the number of related events returned per indicator. + Default: 2. Set to 0 for none, -1 for all events. + type: number + - description: >- + Whether to include full tag details for each indicator. Defaults to + true. + in: query + name: includeTags + schema: + description: >- + Whether to include full tag details for each indicator. Defaults + to true. + type: boolean + - description: >- + Whether to compute accurate total count via COUNT(*). Defaults to + false for performance. When false, total_count is an approximation. + in: query + name: includeTotalCount + schema: + description: >- + Whether to compute accurate total count via COUNT(*). Defaults to + false for performance. When false, total_count is an + approximation. + type: boolean + - description: >- + Output format for indicator data. 'json' returns the default format, + 'stix2' returns STIX 2.1 Indicator SDOs. + in: query + name: format + schema: + description: >- + Output format for indicator data. 'json' returns the default + format, 'stix2' returns STIX 2.1 Indicator SDOs. + enum: + - json + - stix2 + type: string + responses: + '200': + content: + application/json: + schema: + properties: + properties: + properties: + indicators: + properties: + items: + properties: + createdAt: + format: date-time + type: string + datasetId: + description: >- + The dataset ID this indicator belongs to. + Included in list responses. + type: string + indicatorType: + type: string + relatedEvents: + items: + properties: + datasetId: + type: string + eventId: + type: string + required: + - datasetId + - eventId + type: object + type: array + tags: + items: + properties: + categoryName: + type: string + uuid: + type: string + value: + type: string + type: object + type: array + updatedAt: + format: date-time + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - indicatorType + - value + - createdAt + - updatedAt + type: object + type: + type: string + required: + - type + - items + type: object + pagination: + properties: + properties: + properties: + count: + properties: + type: + type: string + required: + - type + type: object + page: + properties: + type: + type: string + required: + - type + type: object + per_page: + properties: + type: + type: string + required: + - type + type: object + total_count: + properties: + type: + type: string + required: + - type + type: object + required: + - count + - page + - per_page + - total_count + type: object + type: + type: string + required: + - type + - properties + type: object + required: + - indicators + - pagination + type: object + type: + type: string + required: + - type + - properties + type: object + description: Returns a paginated list of indicators. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists indicators across multiple datasets + tags: + - Indicator + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/queries: + get: + description: Retrieve all saved event queries for the account + operationId: get_EventQueryList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + account_id: + description: Account ID + type: integer + alert_enabled: + description: Whether alerts are enabled + type: boolean + alert_rollup_enabled: + description: Whether alert rollup is enabled + type: boolean + created_at: + description: Creation timestamp + type: string + readOnly: true + custom_threat_feed_id: + description: Intel Indicator Feed ID (numeric) + nullable: true + type: integer + id: + description: Unique identifier for the saved query + type: integer + name: + description: Name of the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Whether rule is enabled + type: boolean + rule_list_id: + description: WAF rules list ID for blocking + type: string + rule_scope: + description: Scope for the rule + type: string + updated_at: + description: Last update timestamp + type: string + readOnly: true + user_email: + description: Email of the user who created the query + type: string + required: + - id + - account_id + - name + - user_email + - query_json + - alert_enabled + - alert_rollup_enabled + - rule_enabled + - created_at + - updated_at + type: object + type: array + description: Returns a list of event queries. + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: List all saved event queries + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/queries/create: + post: + description: Create a new saved event query for the account + operationId: post_EventQueryCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + alert_enabled: + description: Enable alerts for this query + type: boolean + alert_rollup_enabled: + description: Enable alert rollup for this query + type: boolean + name: + description: Unique name for the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Enable rule for this query + type: boolean + rule_scope: + description: Scope for the rule + type: string + required: + - name + - query_json + - alert_enabled + - alert_rollup_enabled + - rule_enabled + type: object + responses: + '200': + content: + application/json: + schema: + properties: + account_id: + description: Account ID + type: integer + alert_enabled: + description: Whether alerts are enabled + type: boolean + alert_rollup_enabled: + description: Whether alert rollup is enabled + type: boolean + created_at: + description: Creation timestamp + type: string + readOnly: true + custom_threat_feed_id: + description: Intel Indicator Feed ID (numeric) + nullable: true + type: integer + id: + description: Unique identifier for the saved query + type: integer + name: + description: Name of the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Whether rule is enabled + type: boolean + rule_list_id: + description: WAF rules list ID for blocking + type: string + rule_scope: + description: Scope for the rule + type: string + updated_at: + description: Last update timestamp + type: string + readOnly: true + user_email: + description: Email of the user who created the query + type: string + required: + - id + - account_id + - name + - user_email + - query_json + - alert_enabled + - alert_rollup_enabled + - rule_enabled + - created_at + - updated_at + type: object + description: Returns the created event query. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Create a saved event query + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/queries/{query_id}: + delete: + description: Delete a saved event query by its ID + operationId: delete_EventQueryDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Event query ID + in: path + name: query_id + schema: + description: Event query ID + type: integer + required: true + responses: + '200': + description: Event query deleted successfully. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Delete a saved event query + tags: + - Event + x-api-token-group: + - Cloudforce One Write + get: + description: Retrieve a saved event query by its ID + operationId: get_EventQueryRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Event query ID + in: path + name: query_id + schema: + description: Event query ID + type: integer + required: true + responses: + '200': + content: + application/json: + schema: + properties: + account_id: + description: Account ID + type: integer + alert_enabled: + description: Whether alerts are enabled + type: boolean + alert_rollup_enabled: + description: Whether alert rollup is enabled + type: boolean + created_at: + description: Creation timestamp + type: string + readOnly: true + custom_threat_feed_id: + description: Intel Indicator Feed ID (numeric) + nullable: true + type: integer + id: + description: Unique identifier for the saved query + type: integer + name: + description: Name of the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Whether rule is enabled + type: boolean + rule_list_id: + description: WAF rules list ID for blocking + type: string + rule_scope: + description: Scope for the rule + type: string + updated_at: + description: Last update timestamp + type: string + readOnly: true + user_email: + description: Email of the user who created the query + type: string + required: + - id + - account_id + - name + - user_email + - query_json + - alert_enabled + - alert_rollup_enabled + - rule_enabled + - created_at + - updated_at + type: object + description: Returns the event query. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Read a saved event query + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + patch: + description: Update an existing saved event query by its ID + operationId: patch_EventQueryUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Event query ID + in: path + name: query_id + schema: + description: Event query ID + type: integer + required: true + requestBody: + content: + application/json: + schema: + properties: + alert_enabled: + description: Enable alerts for this query + type: boolean + alert_rollup_enabled: + description: Enable alert rollup for this query + type: boolean + name: + description: Unique name for the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Enable rule for this query + type: boolean + rule_scope: + description: Scope for the rule + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + account_id: + description: Account ID + type: integer + alert_enabled: + description: Whether alerts are enabled + type: boolean + alert_rollup_enabled: + description: Whether alert rollup is enabled + type: boolean + created_at: + description: Creation timestamp + type: string + readOnly: true + custom_threat_feed_id: + description: Intel Indicator Feed ID (numeric) + nullable: true + type: integer + id: + description: Unique identifier for the saved query + type: integer + name: + description: Name of the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Whether rule is enabled + type: boolean + rule_list_id: + description: WAF rules list ID for blocking + type: string + rule_scope: + description: Scope for the rule + type: string + updated_at: + description: Last update timestamp + type: string + readOnly: true + user_email: + description: Email of the user who created the query + type: string + required: + - id + - account_id + - name + - user_email + - query_json + - alert_enabled + - alert_rollup_enabled + - rule_enabled + - created_at + - updated_at + type: object + description: Returns the updated event query. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Update a saved event query + tags: + - Event + x-api-token-group: + - Cloudforce One Write + post: + description: Update an existing saved event query by its ID + operationId: post_EventQueryUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Event query ID + in: path + name: query_id + schema: + description: Event query ID + type: integer + required: true + requestBody: + content: + application/json: + schema: + properties: + alert_enabled: + description: Enable alerts for this query + type: boolean + alert_rollup_enabled: + description: Enable alert rollup for this query + type: boolean + name: + description: Unique name for the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Enable rule for this query + type: boolean + rule_scope: + description: Scope for the rule + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + account_id: + description: Account ID + type: integer + alert_enabled: + description: Whether alerts are enabled + type: boolean + alert_rollup_enabled: + description: Whether alert rollup is enabled + type: boolean + created_at: + description: Creation timestamp + type: string + readOnly: true + custom_threat_feed_id: + description: Intel Indicator Feed ID (numeric) + nullable: true + type: integer + id: + description: Unique identifier for the saved query + type: integer + name: + description: Name of the saved query + type: string + query_json: + description: JSON string containing the query parameters + type: string + rule_enabled: + description: Whether rule is enabled + type: boolean + rule_list_id: + description: WAF rules list ID for blocking + type: string + rule_scope: + description: Scope for the rule + type: string + updated_at: + description: Last update timestamp + type: string + readOnly: true + user_email: + description: Email of the user who created the query + type: string + required: + - id + - account_id + - name + - user_email + - query_json + - alert_enabled + - alert_rollup_enabled + - rule_enabled + - created_at + - updated_at + type: object + description: Returns the updated event query. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Update a saved event query + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/raw/{dataset_id}/{event_id}: + get: + description: >- + Retrieves the raw data associated with an event. Searches across all + shards in the dataset. + operationId: get_EventRawReadDS + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + accountId: + type: number + created: + type: string + data: + type: string + id: + type: number + source: + type: string + tlp: + type: string + required: + - id + - accountId + - created + - data + - source + - tlp + type: object + description: Returns the raw event data. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Reads raw data for an event by UUID + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - datasets + method: raw + /accounts/{account_id}/cloudforce-one/events/relate/{event_id}: + delete: + operationId: delete_EventReferenceDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + success: + type: boolean + required: + - success + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns success if operation succeeded. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Removes an event reference + tags: + - Event + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - relate + method: delete + /accounts/{account_id}/cloudforce-one/events/relate/{event_id}/create: + post: + operationId: post_EventReferenceCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + events: + items: + type: string + type: array + required: + - events + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + success: + type: boolean + required: + - success + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns success if operation succeeded. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates event references for a event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/relationships/create: + post: + description: >- + Creates a directed relationship between two events. The relationship is + from parent to child with a specified type. + operationId: post_CreateEventRelationship + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + childIds: + description: >- + Array of UUIDs for child events. Single child = 1:1 + relationship, multiple = 1:many relationships + items: + format: uuid + type: string + minItems: 1 + type: array + datasetId: + description: Dataset identifier where the events are stored + type: string + parentId: + description: >- + UUID of the parent event that will be the source of the + relationship + format: uuid + type: string + relationshipType: + description: >- + Type of relationship to create between parent and child + events + enum: + - related_to + - caused_by + - attributed_to + type: string + required: + - parentId + - childIds + - relationshipType + - datasetId + type: object + responses: + '200': + content: + application/json: + schema: + properties: + childIds: + description: Array of child event UUIDs that were processed + items: + format: uuid + type: string + type: array + errors: + description: >- + Array of errors for relationships that failed to be + created (only present if some relationships failed) + items: + properties: + childId: + description: >- + UUID of the child event that failed to create a + relationship + format: uuid + type: string + error: + description: >- + Error message describing why the relationship + creation failed + type: string + errorType: + description: Type/category of the error that occurred + type: string + required: + - childId + - error + type: object + type: array + message: + description: Human-readable message describing the operation result + type: string + relationships: + description: Array of successfully created relationship objects + items: + properties: + childDatasetId: + description: Dataset ID where the child event resides + type: string + childId: + description: UUID of the child event in the relationship + format: uuid + type: string + parentDatasetId: + description: Dataset ID where the parent event resides + type: string + parentId: + description: UUID of the parent event in the relationship + format: uuid + type: string + relationshipType: + description: Type of relationship between the events + enum: + - related_to + - caused_by + - attributed_to + type: string + required: + - parentId + - childId + - relationshipType + - parentDatasetId + - childDatasetId + type: object + type: array + relationshipsCreated: + description: Number of relationships that were successfully created + type: number + success: + description: >- + Whether the relationship creation operation completed + successfully + type: boolean + required: + - success + - message + - relationships + type: object + description: Relationship created successfully + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Create a relationship between two events + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/tags: + get: + description: Returns all Source-of-Truth tags for an account. + operationId: get_TagList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + type: number + - in: query + name: pageSize + schema: + type: number + - in: query + name: search + schema: + type: string + - in: query + name: categoryUuid + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + pagination: + properties: + page: + type: number + pageSize: + type: number + totalCount: + type: number + totalPages: + type: number + required: + - page + - pageSize + - totalCount + - totalPages + type: object + tags: + items: + properties: + activeDuration: + type: string + actorCategory: + type: string + aliasGroupNames: + items: + type: string + type: array + aliasGroupNamesInternal: + items: + type: string + type: array + analyticPriority: + type: number + attributionConfidence: + type: string + attributionOrganization: + type: string + categoryName: + type: string + categoryUuid: + type: string + externalReferenceLinks: + items: + type: string + type: array + internalDescription: + type: string + motive: + type: string + opsecLevel: + type: string + originCountryISO: + type: string + priority: + type: number + sophisticationLevel: + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - value + type: object + type: array + required: + - tags + - pagination + type: object + description: Returns a paginated list of tags. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists all tags (SoT) + tags: + - Tag + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/tags/categories: + get: + description: Returns all Source-of-Truth tag categories for an account. + operationId: get_TagCategoryList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: search + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + categories: + items: + properties: + createdAt: + type: string + description: + type: string + name: + type: string + updatedAt: + type: string + uuid: + type: string + required: + - uuid + - name + type: object + type: array + required: + - categories + type: object + description: Returns a list of tag categories. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists all tag categories (SoT) + tags: + - TagCategory + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/tags/categories/create: + post: + description: Creates a new Source-of-Truth tag category for an account. + operationId: post_TagCategoryCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + type: string + name: + type: string + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + type: string + description: + type: string + name: + type: string + updatedAt: + type: string + uuid: + type: string + required: + - uuid + - name + type: object + description: Returns the created tag category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates a new tag category (SoT) + tags: + - TagCategory + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/tags/categories/{category_uuid}: + delete: + description: Deletes a Source-of-Truth tag category by UUID. + operationId: delete_TagCategoryDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Tag Category UUID. + in: path + name: category_uuid + schema: + description: Tag Category UUID. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + uuid: + type: string + required: + - uuid + type: object + description: Returns the uuid of the deleted tag category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Deletes a tag category (SoT) + tags: + - TagCategory + x-api-token-group: + - Cloudforce One Write + patch: + description: Updates a Source-of-Truth tag category by UUID. + operationId: patch_TagCategoryUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Tag Category UUID. + in: path + name: category_uuid + schema: + description: Tag Category UUID. + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + description: + type: string + name: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + createdAt: + type: string + description: + type: string + name: + type: string + updatedAt: + type: string + uuid: + type: string + required: + - uuid + - name + type: object + description: Returns the updated tag category. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates a tag category (SoT) + tags: + - TagCategory + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/tags/create: + post: + description: Creates a new tag to be used accross threat events. + operationId: post_TagCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + activeDuration: + type: string + actorCategory: + type: string + aliasGroupNames: + items: + type: string + type: array + aliasGroupNamesInternal: + items: + type: string + type: array + analyticPriority: + type: number + attributionConfidence: + type: string + attributionOrganization: + type: string + categoryUuid: + type: string + externalReferenceLinks: + items: + type: string + type: array + internalDescription: + type: string + motive: + type: string + opsecLevel: + type: string + originCountryISO: + type: string + priority: + type: number + sophisticationLevel: + type: string + value: + type: string + required: + - value + type: object + responses: + '200': + content: + application/json: + schema: + properties: + activeDuration: + type: string + actorCategory: + type: string + aliasGroupNames: + items: + type: string + type: array + aliasGroupNamesInternal: + items: + type: string + type: array + analyticPriority: + type: number + attributionConfidence: + type: string + attributionOrganization: + type: string + categoryName: + type: string + categoryUuid: + type: string + externalReferenceLinks: + items: + type: string + type: array + internalDescription: + type: string + motive: + type: string + opsecLevel: + type: string + originCountryISO: + type: string + priority: + type: number + sophisticationLevel: + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - value + type: object + description: Returns the created tag. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Creates a new tag + tags: + - Tag + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - tags + method: create + /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}: + delete: + description: Deletes a Source-of-Truth tag by UUID. + operationId: delete_TagDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Tag UUID. + in: path + name: tag_uuid + schema: + description: Tag UUID. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + uuid: + type: string + required: + - uuid + type: object + description: Returns the uuid of the deleted tag. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Deletes a tag (SoT) + tags: + - Tag + x-api-token-group: + - Cloudforce One Write + patch: + description: Updates a Source-of-Truth tag by UUID. + operationId: patch_TagUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Tag UUID. + in: path + name: tag_uuid + schema: + description: Tag UUID. + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + activeDuration: + type: string + actorCategory: + type: string + aliasGroupNames: + items: + type: string + type: array + aliasGroupNamesInternal: + items: + type: string + type: array + analyticPriority: + type: number + attributionConfidence: + type: string + attributionOrganization: + type: string + categoryUuid: + type: string + externalReferenceLinks: + items: + type: string + type: array + internalDescription: + type: string + motive: + type: string + opsecLevel: + type: string + originCountryISO: + type: string + priority: + type: number + sophisticationLevel: + type: string + value: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + activeDuration: + type: string + actorCategory: + type: string + aliasGroupNames: + items: + type: string + type: array + aliasGroupNamesInternal: + items: + type: string + type: array + analyticPriority: + type: number + attributionConfidence: + type: string + attributionOrganization: + type: string + categoryName: + type: string + categoryUuid: + type: string + externalReferenceLinks: + items: + type: string + type: array + internalDescription: + type: string + motive: + type: string + opsecLevel: + type: string + originCountryISO: + type: string + priority: + type: number + sophisticationLevel: + type: string + uuid: + type: string + value: + type: string + required: + - uuid + - value + type: object + description: Returns the updated tag. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates a tag (SoT) + tags: + - Tag + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/targetIndustries: + get: + operationId: get_TargetIndustryList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Array of dataset IDs to query target industries from. If not + provided, uses the default dataset. + in: query + name: datasetIds + schema: + description: >- + Array of dataset IDs to query target industries from. If not + provided, uses the default dataset. + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + description: Returns a list of target industries. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists target industries across multiple datasets + tags: + - Target Industry + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - target_industries + method: list + /accounts/{account_id}/cloudforce-one/events/targetIndustries/catalog: + get: + operationId: get_TargetIndustryListComplete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + items: + properties: + type: + type: string + required: + - type + type: object + type: + type: string + required: + - type + - items + type: object + description: Returns all target industries from industry map catalog. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Lists all target industries from industry map catalog + tags: + - Target Industry + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/update/bulk: + patch: + description: >- + Updates multiple events with the same field values. Maximum 100 events + per request. + operationId: patch_EventUpdateBulk + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + datasetId: + description: >- + Dataset ID containing the events to update. Required to + prevent cross-account modifications. + type: string + eventIds: + description: List of event UUIDs to update (1-100) + items: + type: string + maxItems: 100 + minItems: 1 + type: array + updates: + description: >- + Fields to update on all specified events. All fields + including 'insight' are supported, except 'date' which + requires shard migration. + properties: + attacker: + nullable: true + type: string + attackerCountry: + type: string + category: + type: string + createdAt: + format: date-time + type: string + event: + type: string + indicator: + type: string + indicatorType: + type: string + insight: + type: string + raw: + properties: + data: + nullable: true + type: object + source: + type: string + tlp: + type: string + type: object + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + type: object + required: + - eventIds + - datasetId + - updates + type: object + responses: + '200': + content: + application/json: + schema: + properties: + failedCount: + type: number + failures: + description: List of events that failed to update with error messages + items: + properties: + error: + type: string + eventId: + type: string + required: + - eventId + - error + type: object + type: array + updatedCount: + type: number + required: + - updatedCount + - failedCount + type: object + description: Returns the count of updated events and any failures. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Bulk update events + tags: + - Event + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/{dataset_id}/delete: + delete: + operationId: delete_EventDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - description: Array of Event IDs to delete. + in: query + name: eventIds + schema: + description: Array of Event IDs to delete. + items: + minLength: 1 + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + description: Number of deleted events + type: number + description: Returns the number of deleted events. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Deletes one or more events + tags: + - Event + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/events/{event_id}: + get: + deprecated: true + description: >- + This Method is deprecated. Please use + /events/dataset/:dataset_id/events/:event_id instead. + operationId: get_EventReadDeprecated + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + attacker: + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + type: string + event: + type: string + hasChildren: + type: boolean + indicator: + type: string + indicatorType: + type: string + indicatorTypeId: + type: number + insight: + type: string + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + numReferenced: + type: number + numReferences: + type: number + rawId: + type: string + referenced: + items: + type: string + type: array + referencedIds: + items: + type: number + type: array + references: + items: + type: string + type: array + referencesIds: + items: + type: number + type: array + releasabilityId: + type: string + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + uuid: + type: string + required: + - uuid + - date + - targetCountry + - attacker + - attackerCountry + - targetIndustry + - rawId + - indicatorTypeId + - indicator + - event + - numReferenced + - numReferences + - tlp + - category + - indicatorType + - referenced + - references + - tags + - killChain + - mitreAttack + - mitreCapec + - referencedIds + - referencesIds + - hasChildren + - datasetId + type: object + description: Returns an event. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Reads an event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + method: get + patch: + operationId: patch_EventUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + attacker: + nullable: true + type: string + attackerCountry: + type: string + category: + type: string + createdAt: + format: date-time + type: string + datasetId: + description: Dataset ID containing the event to update. + type: string + date: + format: date-time + type: string + event: + type: string + indicator: + type: string + indicatorType: + type: string + insight: + type: string + raw: + properties: + data: + nullable: true + type: object + source: + type: string + tlp: + type: string + type: object + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + required: + - datasetId + type: object + responses: + '200': + content: + application/json: + schema: + properties: + attacker: + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + type: string + event: + type: string + hasChildren: + type: boolean + indicator: + type: string + indicatorType: + type: string + indicatorTypeId: + type: number + insight: + type: string + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + numReferenced: + type: number + numReferences: + type: number + rawId: + type: string + referenced: + items: + type: string + type: array + referencedIds: + items: + type: number + type: array + references: + items: + type: string + type: array + referencesIds: + items: + type: number + type: array + releasabilityId: + type: string + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + uuid: + type: string + required: + - uuid + - date + - targetCountry + - attacker + - attackerCountry + - targetIndustry + - rawId + - indicatorTypeId + - indicator + - event + - numReferenced + - numReferences + - tlp + - category + - indicatorType + - referenced + - references + - tags + - killChain + - mitreAttack + - mitreCapec + - referencedIds + - referencesIds + - hasChildren + - datasetId + type: object + description: Returns the updated event. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates an event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + method: edit + post: + operationId: post_EventUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + attacker: + nullable: true + type: string + attackerCountry: + type: string + category: + type: string + createdAt: + format: date-time + type: string + datasetId: + description: Dataset ID containing the event to update. + type: string + date: + format: date-time + type: string + event: + type: string + indicator: + type: string + indicatorType: + type: string + insight: + type: string + raw: + properties: + data: + nullable: true + type: object + source: + type: string + tlp: + type: string + type: object + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + required: + - datasetId + type: object + responses: + '200': + content: + application/json: + schema: + properties: + attacker: + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + type: string + event: + type: string + hasChildren: + type: boolean + indicator: + type: string + indicatorType: + type: string + indicatorTypeId: + type: number + insight: + type: string + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + numReferenced: + type: number + numReferences: + type: number + rawId: + type: string + referenced: + items: + type: string + type: array + referencedIds: + items: + type: number + type: array + references: + items: + type: string + type: array + referencesIds: + items: + type: number + type: array + releasabilityId: + type: string + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + uuid: + type: string + required: + - uuid + - date + - targetCountry + - attacker + - attackerCountry + - targetIndustry + - rawId + - indicatorTypeId + - indicator + - event + - numReferenced + - numReferences + - tlp + - category + - indicatorType + - referenced + - references + - tags + - killChain + - mitreAttack + - mitreCapec + - referencedIds + - referencesIds + - hasChildren + - datasetId + type: object + description: Returns the updated event. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates an event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/{event_id}/raw/{raw_id}: + get: + operationId: get_EventRawRead + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + - description: Raw Event UUID. + in: path + name: raw_id + schema: + description: Raw Event UUID. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + accountId: + type: number + created: + type: string + data: + type: object + id: + type: string + source: + type: string + tlp: + type: string + required: + - accountId + - created + - data + - id + - source + - tlp + type: object + description: Returns the raw event. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Reads data for a raw event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - raw + method: get + patch: + operationId: patch_EventRawUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + - description: Raw Event UUID. + in: path + name: raw_id + schema: + description: Raw Event UUID. + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + data: + type: object + source: + type: string + tlp: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + data: + type: object + id: + type: string + required: + - id + - data + type: object + description: Returns the uuid of the updated raw event and its data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates a raw event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - threat_events + - raw + method: edit + post: + operationId: post_EventRawUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + - description: Raw Event UUID. + in: path + name: raw_id + schema: + description: Raw Event UUID. + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + data: + type: object + source: + type: string + tlp: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + data: + type: object + id: + type: string + required: + - id + - data + type: object + description: Returns the uuid of the updated raw event and its data. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Updates a raw event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/events/{event_id}/relationships: + get: + description: >- + The `event_id` must be defined (to list existing events (and their IDs), + use the [`Filter and List + Events`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/methods/list/) + endpoint). Also, must provide query parameters. + operationId: get_EventRelationships + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: event_id + in: path + required: true + description: The event ID. + schema: + type: string + - description: >- + The direction to traverse the graph. Defaults to 'both' to search + all. + in: query + name: direction + schema: + default: both + description: >- + The direction to traverse the graph. Defaults to 'both' to search + all. + enum: + - ancestors + - descendants + - both + type: string + - description: The maximum depth to traverse. Defaults to 5. + in: query + name: maxDepth + schema: + description: The maximum depth to traverse. Defaults to 5. + type: number + - description: An optional array of relationship types to filter by. + in: query + name: relationshipTypes + schema: + description: An optional array of relationship types to filter by. + type: string + items: + type: string + - description: An optional array of indicator type IDs to filter the results by. + in: query + name: indicatorTypeIds + schema: + description: An optional array of indicator type IDs to filter the results by. + items: + type: string + type: array + explode: true + - description: The dataset ID to search within. + in: query + name: datasetId + schema: + description: The dataset ID to search within. + type: string + - description: >- + Whether to include the starting event in the results. Defaults to + true. + in: query + name: includeParent + schema: + default: true + description: >- + Whether to include the starting event in the results. Defaults to + true. + type: boolean + - in: query + name: page + schema: + type: number + - in: query + name: pageSize + schema: + type: number + responses: + '200': + content: + application/json: + schema: + items: + properties: + attacker: + type: string + attackerCountry: + type: string + category: + type: string + datasetId: + type: string + date: + type: string + event: + type: string + hasChildren: + type: boolean + indicator: + type: string + indicatorType: + type: string + indicatorTypeId: + type: number + insight: + type: string + killChain: + type: number + mitreAttack: + items: + type: string + type: array + mitreCapec: + items: + type: string + type: array + numReferenced: + type: number + numReferences: + type: number + rawId: + type: string + referenced: + items: + type: string + type: array + referencedIds: + items: + type: number + type: array + references: + items: + type: string + type: array + referencesIds: + items: + type: number + type: array + releasabilityId: + type: string + tags: + items: + type: string + type: array + targetCountry: + type: string + targetIndustry: + type: string + tlp: + type: string + uuid: + type: string + required: + - uuid + - date + - targetCountry + - attacker + - attackerCountry + - targetIndustry + - rawId + - indicatorTypeId + - indicator + - event + - numReferenced + - numReferences + - tlp + - category + - indicatorType + - referenced + - references + - tags + - killChain + - mitreAttack + - mitreCapec + - referencedIds + - referencesIds + - hasChildren + - datasetId + type: object + type: array + description: Returns a list of events related to the specified starting event. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: Filter and list events related to specific event + tags: + - Event + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/requests: + post: + description: >- + Lists Cloudforce One intelligence requests with filtering and + pagination. + operationId: cloudforce-one-request-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestList' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: >- + #/components/schemas/cloudforceOneRequestsRequestListItem + type: array + required: + - success + - errors + - messages + type: object + description: List requests response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Create response failure. + security: + - api_email: [] + api_key: [] + summary: List Requests + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/requests/constants: + get: + description: >- + Retrieves constant values used in Cloudforce One requests, including + valid statuses and types. + operationId: cloudforce-one-request-constants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestConstants' + required: + - success + - errors + - messages + type: object + description: Get request constants response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Get request constants response failure. + security: + - api_email: [] + api_key: [] + summary: Get Request Priority, Status, and TLP constants + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + method: constants + /accounts/{account_id}/cloudforce-one/requests/new: + post: + description: >- + Creating a request adds the request into the Cloudforce One queue for + analysis. In addition to the content, a short title, type, priority, and + releasability should be provided. If one is not provided, a default will + be assigned. + operationId: cloudforce-one-request-new + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestItem' + required: + - success + - errors + - messages + type: object + description: Create request response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Create response failure. + security: + - api_email: [] + api_key: [] + summary: Create a New Request. + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + method: create + /accounts/{account_id}/cloudforce-one/requests/priority: + post: + description: Lists priority intelligence requests in Cloudforce One. + operationId: cloudforce-one-priority-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsPriorityList' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/cloudforceOneRequestsPriorityItem' + type: array + required: + - success + - errors + - messages + type: object + description: List priorities response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: List priorities response failure. + security: + - api_email: [] + api_key: [] + summary: List Priority Intelligence Requirements + tags: + - Priority Intelligence Requirements (PIR) + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/requests/priority/new: + post: + description: Creates a new priority intelligence request in Cloudforce One. + operationId: cloudforce-one-priority-new + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsPriorityEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsPriorityItem' + required: + - success + - errors + - messages + type: object + description: Create priority response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Create priority response failure. + security: + - api_email: [] + api_key: [] + summary: Create a New Priority Intelligence Requirement + tags: + - Priority Intelligence Requirements (PIR) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - priority + method: create + /accounts/{account_id}/cloudforce-one/requests/priority/quota: + get: + description: Retrieves quota usage for Cloudforce One priority requests. + operationId: cloudforce-one-priority-quota + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsQuota' + required: + - success + - errors + - messages + type: object + description: Get priority quota response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Get priority quota response failure. + security: + - api_email: [] + api_key: [] + summary: Get Priority Intelligence Requirement Quota + tags: + - Priority Intelligence Requirements (PIR) + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - priority + method: quota + /accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}: + delete: + description: Deletes a priority intelligence request from Cloudforce One. + operationId: cloudforce-one-priority-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: priority_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsApiResponseCommon' + description: Delete priority response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Delete priority response failure. + security: + - api_email: [] + api_key: [] + summary: Delete a Priority Intelligence Requirement + tags: + - Priority Intelligence Requirements (PIR) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - priority + method: delete + get: + description: Retrieves a specific priority intelligence request from Cloudforce One. + operationId: cloudforce-one-priority-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: priority_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestItem' + required: + - success + - errors + - messages + type: object + description: Get priority response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Get priority response failure. + security: + - api_email: [] + api_key: [] + summary: Get a Priority Intelligence Requirement + tags: + - Priority Intelligence Requirements (PIR) + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - priority + method: get + put: + description: Updates a priority intelligence request in Cloudforce One. + operationId: cloudforce-one-priority-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: priority_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsPriorityEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestItem' + required: + - success + - errors + - messages + type: object + description: Update priority response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Update priority response failure. + security: + - api_email: [] + api_key: [] + summary: Update a Priority Intelligence Requirement + tags: + - Priority Intelligence Requirements (PIR) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - priority + method: update + /accounts/{account_id}/cloudforce-one/requests/quota: + get: + description: Retrieves quota usage for Cloudforce One standard requests. + operationId: cloudforce-one-request-quota + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsQuota' + required: + - success + - errors + - messages + type: object + description: Get request quota response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Get request quota response failure. + security: + - api_email: [] + api_key: [] + summary: Get Request Quota + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + method: quota + /accounts/{account_id}/cloudforce-one/requests/types: + get: + description: Lists available request types for Cloudforce One intelligence requests. + operationId: cloudforce-one-request-types + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestTypes' + required: + - success + - errors + - messages + type: object + description: Get request types response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Get request types response failure. + security: + - api_email: [] + api_key: [] + summary: Get Request Types + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + method: types + /accounts/{account_id}/cloudforce-one/requests/{request_id}: + delete: + description: Deletes a Cloudforce One intelligence request and all associated data. + operationId: cloudforce-one-request-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsApiResponseCommon' + description: Delete request response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Delete request response failure. + security: + - api_email: [] + api_key: [] + summary: Delete a Request + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + method: delete + get: + description: Retrieves details for a specific Cloudforce One intelligence request. + operationId: cloudforce-one-request-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestItem' + required: + - success + - errors + - messages + type: object + description: Get request response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Get request response failure. + security: + - api_email: [] + api_key: [] + summary: Get a Request + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + method: get + put: + description: >- + Updating a request alters the request in the Cloudforce One queue. This + API may be used to update any attributes of the request after the + initial submission. Only fields that you choose to update need to be add + to the request body. + operationId: cloudforce-one-request-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestItem' + required: + - success + - errors + - messages + type: object + description: Update request response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Update request response failure. + security: + - api_email: [] + api_key: [] + summary: Update a Request + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + method: update + /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset: + post: + description: Lists assets attached to a Cloudforce One intelligence request. + operationId: cloudforce-one-request-asset-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestAssetList' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: >- + #/components/schemas/cloudforceOneRequestsRequestAssetItem + type: array + required: + - success + - errors + - messages + type: object + description: List request assets response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: List request assets response failure. + security: + - api_email: [] + api_key: [] + summary: List Request Assets + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/new: + post: + description: Uploads a new asset to a Cloudforce One intelligence request. + operationId: cloudforce-one-request-asset-new + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestAssetEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestAssetItem' + required: + - success + - errors + - messages + type: object + description: Create request asset response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Create request asset response failure. + security: + - api_email: [] + api_key: [] + summary: Create a New Request Asset + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}: + delete: + description: Removes an asset from a Cloudforce One intelligence request. + operationId: cloudforce-one-request-asset-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + - in: path + name: asset_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsApiResponseCommon' + description: Delete request asset response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Delete request asset response failure. + security: + - api_email: [] + api_key: [] + summary: Delete a Request Asset + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - assets + method: delete + get: + description: Retrieves an asset attached to a Cloudforce One intelligence request. + operationId: cloudforce-one-request-asset-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + - in: path + name: asset_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: >- + #/components/schemas/cloudforceOneRequestsRequestAssetItem + type: array + required: + - success + - errors + - messages + type: object + description: Get request asset response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Get request asset response failure. + security: + - api_email: [] + api_key: [] + summary: Get a Request Asset + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - assets + method: get + put: + description: Updates an asset in a Cloudforce One intelligence request. + operationId: cloudforce-one-request-asset-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + - in: path + name: asset_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestAssetEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneRequestsRequestAssetItem' + required: + - success + - errors + - messages + type: object + description: Update request asset response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Update request asset response failure. + security: + - api_email: [] + api_key: [] + summary: Update a Request Asset + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - assets + method: update + /accounts/{account_id}/cloudforce-one/requests/{request_id}/message: + post: + description: Lists messages in a Cloudforce One intelligence request conversation. + operationId: cloudforce-one-request-message-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestMessageList' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: >- + #/components/schemas/cloudforceOneRequestsRequestMessageItem + type: array + required: + - success + - errors + - messages + type: object + description: List request messages response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: List request messages response failure. + security: + - api_email: [] + api_key: [] + summary: List Request Messages + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new: + post: + description: Adds a message to a Cloudforce One intelligence request conversation. + operationId: cloudforce-one-request-message-new + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestMessageEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/cloudforceOneRequestsRequestMessageItem + required: + - success + - errors + - messages + type: object + description: Create request message response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Create request message response failure. + security: + - api_email: [] + api_key: [] + summary: Create a New Request Message + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - message + method: create + /accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}: + delete: + description: Removes a message from a Cloudforce One intelligence request thread. + operationId: cloudforce-one-request-message-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + - in: path + name: message_id + schema: + type: integer + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsApiResponseCommon' + description: Delete request message response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Delete request message response failure. + security: + - api_email: [] + api_key: [] + summary: Delete a Request Message + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - message + method: delete + put: + description: Updates a message in a Cloudforce One intelligence request thread. + operationId: cloudforce-one-request-message-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: request_id + schema: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + required: true + - in: path + name: message_id + schema: + type: integer + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRequestsRequestMessageEdit' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/cloudforceOneRequestsRequestMessageItem + required: + - success + - errors + - messages + type: object + description: Update request message response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOneRequestsApiResponseCommonFailure + description: Update request message response failure. + security: + - api_email: [] + api_key: [] + summary: Update a Request Message + tags: + - Request for Information (RFI) + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - requests + - message + method: update + /accounts/{account_id}/cloudforce-one/rules: + delete: + description: Delete all rules in an account. + operationId: cloudforce-one-delete-all-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneDeleteAllResponse' + description: All rules deleted. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all rules + tags: + - Rules + get: + description: List all rules for an account with optional filtering. + operationId: cloudforce-one-list-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Filter by namespace. Repeat the parameter to filter by multiple + namespaces (e.g. namespace=foo&namespace=bar). + in: query + name: namespace + schema: + description: >- + Filter by namespace. Repeat the parameter to filter by multiple + namespaces (e.g. namespace=foo&namespace=bar). + type: string + items: + type: string + - in: query + name: recursive + schema: + enum: + - 'true' + - 'false' + type: string + - in: query + name: search + schema: + type: string + - description: Filter by public visibility. + in: query + name: is_public + schema: + description: Filter by public visibility. + enum: + - 'true' + - 'false' + type: string + - in: query + name: limit + schema: + default: 50 + maximum: 100 + minimum: 1 + type: number + - in: query + name: offset + schema: + default: 0 + minimum: 0 + nullable: true + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRulesListResponse' + description: List of rules. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List rules + tags: + - Rules + post: + description: Create a new detection rule. + operationId: cloudforce-one-create-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneCreateRule' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRule' + description: Rule created (customer accounts). + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneApprovalPendingResponse' + description: Rule pending approval (internal accounts). + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Validation error. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a rule + tags: + - Rules + /accounts/{account_id}/cloudforce-one/rules/managed: + get: + description: Get DFP managed rule metadata (name and description) from YARA rules. + operationId: cloudforce-one-get-managed-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + metadata: + properties: + fetched_at: + type: string + total_rules: + type: number + required: + - total_rules + - fetched_at + type: object + rules: + items: + properties: + description: + type: string + name: + type: string + required: + - name + - description + type: object + type: array + required: + - rules + - metadata + type: object + description: Managed rules metadata. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get managed rules + tags: + - Rules + /accounts/{account_id}/cloudforce-one/rules/stats: + get: + description: Get statistics about rules for the dashboard. + operationId: cloudforce-one-get-rule-stats + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneStatsResponse' + description: Dashboard statistics. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get dashboard stats + tags: + - Rules + /accounts/{account_id}/cloudforce-one/rules/tree: + get: + description: Get the folder tree structure for rules navigation. + operationId: cloudforce-one-get-rule-tree + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneTreeResponse' + description: Folder tree structure. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get folder tree structure + tags: + - Rules + /accounts/{account_id}/cloudforce-one/rules/validate: + post: + description: Validate rule syntax, name uniqueness, namespace, and meta checks. + operationId: cloudforce-one-validate-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + content: + minLength: 1 + type: string + excludeRuleId: + format: uuid + type: string + name: + maxLength: 255 + minLength: 1 + type: string + namespaces: + items: + maxLength: 255 + minLength: 1 + type: string + minItems: 1 + type: array + required: + - name + - namespaces + - content + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneValidationResponse' + description: Validation result. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate rule with context + tags: + - Rules + /accounts/{account_id}/cloudforce-one/rules/{id}: + delete: + description: Delete an existing rule. + operationId: cloudforce-one-delete-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneSuccessResponse' + description: Rule deleted (customer accounts). + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneApprovalPendingResponse' + description: Deletion pending approval (internal accounts). + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Rule not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a rule + tags: + - Rules + get: + description: Get a single rule by ID. + operationId: cloudforce-one-get-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRule' + description: Rule details. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Rule not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a rule + tags: + - Rules + put: + description: Update an existing rule. + operationId: cloudforce-one-update-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneUpdateRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneRule' + description: Rule updated (customer accounts). + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneApprovalPendingResponse' + description: Update pending approval (internal accounts). + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Unauthorized. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneErrorResponse' + description: Rule not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a rule + tags: + - Rules + /accounts/{account_id}/cloudforce-one/scans/config: + get: + operationId: get_ConfigFetch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + messages: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/cloudforceOnePortScanApiScanConfig' + type: array + required: + - success + - errors + - messages + type: object + description: Returns all Scan Configs. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOnePortScanApiApiResponseCommonFailure + description: List Scan Configs failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Scan Configs + tags: + - Scans + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - scans + - config + method: list + post: + operationId: post_ConfigCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + frequency: + $ref: '#/components/schemas/cloudforceOnePortScanApiFrequency' + ips: + $ref: '#/components/schemas/cloudforceOnePortScanApiIps' + ports: + $ref: '#/components/schemas/cloudforceOnePortScanApiPorts' + required: + - ips + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + messages: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOnePortScanApiScanConfig' + required: + - success + - errors + - messages + type: object + description: Returns the created config. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOnePortScanApiApiResponseCommonFailure + description: Create a new Scan Config failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Scan Config + tags: + - Scans + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - scans + - config + method: create + /accounts/{account_id}/cloudforce-one/scans/config/{config_id}: + delete: + operationId: delete_DeleteScans + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Defines the Config ID. + in: path + name: config_id + schema: + description: Defines the Config ID. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + messages: + items: + type: string + type: array + result: + type: object + success: + type: boolean + required: + - success + - result + - messages + - errors + type: object + description: Delete a Scan Config. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOnePortScanApiApiResponseCommonFailure + description: Delete a Scan Config failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Scan Config + tags: + - Scans + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - scans + - config + method: delete + patch: + operationId: post_ConfigUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Defines the Config ID. + in: path + name: config_id + schema: + description: Defines the Config ID. + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + frequency: + $ref: '#/components/schemas/cloudforceOnePortScanApiFrequency' + ips: + $ref: '#/components/schemas/cloudforceOnePortScanApiIps' + ports: + $ref: '#/components/schemas/cloudforceOnePortScanApiPorts' + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + messages: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOnePortScanApiScanConfig' + required: + - success + - errors + - messages + type: object + description: Returns the updated config. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOnePortScanApiApiResponseCommonFailure + description: Update an Existing Scan Config failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an existing Scan Config + tags: + - Scans + x-api-token-group: + - Cloudforce One Write + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - scans + - config + method: edit + /accounts/{account_id}/cloudforce-one/scans/results/{config_id}: + get: + operationId: get_GetOpenPorts + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Defines the Config ID. + in: path + name: config_id + schema: + description: Defines the Config ID. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + messages: + items: + type: string + type: array + result: + properties: + 1.1.1.1: + items: + $ref: '#/components/schemas/cloudforceOnePortScanApiPort' + type: array + x-stainless-naming: + python: + property_name: one_one_one_one + argument_name: one_one_one_one + method_argument: one_one_one_one + go: + property_name: OneOneOneOne + argument_name: OneOneOneOne + method_argument: OneOneOneOne + required: + - 1.1.1.1 + type: object + success: + type: boolean + required: + - success + - result + - messages + - errors + type: object + description: Returns Current Open Ports. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/cloudforceOnePortScanApiApiResponseCommonFailure + description: Get the Latest Scan Result failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Latest Scan Result + tags: + - Scans + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + x-stackql-sdk: + service: cloudforce_one + resource_chain: + - scans + - results + method: get + /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/generate: + post: + description: >- + Generate a takedown letter from a template. Returns V4 JSON for text + format or a PDF binary for pdf format. + operationId: post_LetterGenerate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + fields: + properties: + discoveryDate: + type: string + domain: + maxLength: 500 + type: string + generationDate: + type: string + registrantEmail: + maxLength: 500 + type: string + registrar: + maxLength: 500 + type: string + resolutionByDate: + type: string + senderCompany: + maxLength: 500 + type: string + senderEmail: + maxLength: 500 + type: string + senderName: + maxLength: 500 + type: string + senderTitle: + maxLength: 500 + type: string + trademarkName: + maxLength: 500 + type: string + trademarkOwner: + maxLength: 500 + type: string + type: object + format: + default: text + enum: + - text + - pdf + type: string + templateId: + minLength: 1 + type: string + required: + - templateId + - fields + type: object + responses: + '200': + content: + application/json: + schema: + properties: + letter: + type: string + required: + - letter + type: object + application/pdf: + schema: + format: binary + type: string + description: >- + Letter generated successfully. When format=text, returns V4 JSON + with { result: { letter: string } }. When format=pdf, returns binary + with Content-Type: application/pdf. + security: + - api_token: [] + summary: Generate takedown letter + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates: + get: + description: >- + List all available takedown letter templates (system templates and + user-defined templates) + operationId: get_LetterTemplateList + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + templates: + items: + properties: + category: + type: string + createdAt: + nullable: true + type: string + description: + nullable: true + type: string + id: + type: string + name: + type: string + source: + enum: + - system + - user + type: string + updatedAt: + nullable: true + type: string + required: + - id + - source + - name + - category + - description + - createdAt + - updatedAt + type: object + type: array + required: + - templates + type: object + description: Templates listed successfully + security: + - api_token: [] + summary: List letter templates + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + post: + description: Create a new user-defined takedown letter template + operationId: post_LetterTemplateCreate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + body: + minLength: 1 + type: string + category: + maxLength: 100 + minLength: 1 + type: string + description: + maxLength: 1000 + type: string + name: + maxLength: 255 + minLength: 1 + type: string + required: + - name + - category + - body + type: object + responses: + '200': + content: + application/json: + schema: + properties: + body: + type: string + category: + type: string + createdAt: + nullable: true + type: string + description: + nullable: true + type: string + id: + type: string + name: + type: string + source: + enum: + - system + - user + type: string + updatedAt: + nullable: true + type: string + required: + - id + - source + - name + - category + - description + - body + - createdAt + - updatedAt + type: object + description: Template created successfully + security: + - api_token: [] + summary: Create letter template + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates/{template_id}: + delete: + description: >- + Delete a user-defined takedown letter template. System templates cannot + be deleted. + operationId: delete_LetterTemplateDelete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: template_id + schema: + minLength: 1 + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + message: + type: string + success: + type: boolean + required: + - success + - message + type: object + description: Template deleted successfully + security: + - api_token: [] + summary: Delete letter template + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + get: + description: Get a specific takedown letter template by ID + operationId: get_LetterTemplateGet + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: template_id + schema: + minLength: 1 + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + body: + type: string + category: + type: string + createdAt: + nullable: true + type: string + description: + nullable: true + type: string + id: + type: string + name: + type: string + source: + enum: + - system + - user + type: string + updatedAt: + nullable: true + type: string + required: + - id + - source + - name + - category + - description + - body + - createdAt + - updatedAt + type: object + description: Template retrieved successfully + security: + - api_token: [] + summary: Get letter template + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + put: + description: >- + Update a user-defined takedown letter template. System templates cannot + be modified. + operationId: put_LetterTemplateUpdate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: template_id + schema: + minLength: 1 + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + body: + minLength: 1 + type: string + category: + maxLength: 100 + minLength: 1 + type: string + description: + maxLength: 1000 + nullable: true + type: string + name: + maxLength: 255 + minLength: 1 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + body: + type: string + category: + type: string + createdAt: + nullable: true + type: string + description: + nullable: true + type: string + id: + type: string + name: + type: string + source: + enum: + - system + - user + type: string + updatedAt: + nullable: true + type: string + required: + - id + - source + - name + - category + - description + - body + - createdAt + - updatedAt + type: object + description: Template updated successfully + security: + - api_token: [] + summary: Update letter template + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/search: + post: + description: >- + Submit an image and find the n closest matches from the scanned images + index without creating any match records. Returns similarity scores and + metadata for each match. + operationId: post_SearchLogoSimilarity + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Include scanned images without domain metadata (historic data). + Default: false (only show images with domain) + in: query + name: showHistoric + schema: + default: 'false' + description: >- + Include scanned images without domain metadata (historic data). + Default: false (only show images with domain) + type: string + - description: If true, include base64-encoded image data in the response + in: query + name: download + schema: + description: If true, include base64-encoded image data in the response + type: string + requestBody: + content: + application/json: + schema: + properties: + image_data: + description: >- + Base64 encoded image data. Can include data URI prefix + (e.g., 'data:image/png;base64,...') or just the base64 + string. + minLength: 1 + type: string + score_threshold: + default: 0 + description: >- + Minimum similarity score threshold for matches (0-1, + default: 0) + maximum: 1 + minimum: 0 + type: number + top_k: + default: 10 + description: 'Number of closest matches to return (1-100, default: 10)' + maximum: 100 + minimum: 1 + type: integer + required: + - image_data + type: object + responses: + '200': + content: + application/json: + schema: + properties: + matches: + items: + properties: + account_id: + type: string + content_type: + description: >- + MIME type of the image (only present when + download=true) + type: string + domain: + type: string + image_data: + description: >- + Base64-encoded image data (only present when + download=true) + type: string + query_id: + type: integer + r2_path: + type: string + similarity_score: + type: number + similarity_threshold: + type: number + tag: + type: string + timestamp: + type: number + url_scan_id: + type: string + vector_id: + type: string + required: + - similarity_score + type: object + type: array + required: + - matches + type: object + description: Scanned images search completed successfully + security: + - api_token: [] + summary: Search scanned images + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + /accounts/{account_id}/cloudforce-one/v2/brand-protection/total-queries: + get: + description: >- + Get the total number of saved brand protection queries (domain + logo) + for an account + operationId: get_TotalQueries + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + properties: + total_queries: + minimum: 0 + type: integer + required: + - total_queries + type: object + type: array + description: Successfully retrieved total query count + security: + - api_token: [] + summary: Get total queries + tags: + - Brand Protection + x-api-token-group: + - Cloudforce One Write + - Cloudforce One Read + /accounts/{account_id}/cloudforce-one/v2/events/graphql: + post: + description: >- + Execute GraphQL aggregations over threat events. Supports + multi-dimensional group-bys, optional date range filtering, and + multi-dataset aggregation. + operationId: post_EventGraphQLV2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + nullable: true + type: object + errors: + items: + type: object + nullable: true + type: array + type: object + description: GraphQL response payload (data and errors). + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request. + security: + - api_token: [] + summary: GraphQL endpoint for event aggregation + tags: + - Event + x-api-token-group: + - Cloudforce One Write +components: + schemas: + cloudforceOneApprovalPendingResponse: + properties: + approval_id: + example: 1 + type: number + message: + example: Rule creation pending approval + type: string + required: + - approval_id + - message + type: object + cloudforceOneCreateRule: + properties: + actions: + items: + $ref: '#/components/schemas/cloudforceOneRuleAction' + type: array + content: + example: 'rule example { condition: true }' + minLength: 1 + type: string + description: + description: >- + Human-readable description of the rule. Auto-extracted from YARA + meta if present. + example: Detects malicious proxy workers + maxLength: 1000 + type: string + enabled: + default: true + description: Whether this rule is active for dice consumers. + example: true + type: boolean + is_public: + default: false + description: Whether this rule is visible to other internal accounts. + example: false + type: boolean + x-auditable: true + name: + example: block-malicious-workers + maxLength: 255 + minLength: 1 + type: string + x-auditable: true + namespaces: + example: + - yara/workers + items: + maxLength: 255 + minLength: 1 + type: string + minItems: 1 + type: array + x-auditable: true + required: + - name + - namespaces + - content + type: object + cloudforceOneDeleteAllResponse: + properties: + deleted: + example: 10 + type: number + required: + - deleted + type: object + cloudforceOneErrorResponse: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + cloudforceOnePortScanApiApiResponseCommonFailure: + properties: + errors: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + type: object + messages: + $ref: '#/components/schemas/cloudforceOnePortScanApiMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + type: object + cloudforceOnePortScanApiFrequency: + description: Defines the number of days between each scan (0 = One-off scan). + example: 7 + title: Frequency + type: number + cloudforceOnePortScanApiIps: + description: >- + Defines a list of IP addresses or CIDR blocks to scan. The maximum + number of total IP addresses allowed is 5000. + example: + - 1.1.1.1 + - 2606:4700:4700::1111 + items: + description: >- + Defines a list of IP addresses or CIDR blocks to scan. The maximum + number of total IP addresses allowed is 5000. + type: string + title: IP List + type: array + cloudforceOnePortScanApiMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + cloudforceOnePortScanApiPort: + properties: + number: + example: 8080 + type: number + proto: + example: tcp + type: string + status: + example: open + type: string + required: + - account_id + - ips + - frequency + title: Port + type: object + cloudforceOnePortScanApiPorts: + description: >- + Defines a list of ports to scan. Valid values are:"default", "all", or a + comma-separated list of ports or range of ports (e.g. ["1-80", "443"]). + "default" scans the 100 most commonly open ports. + example: + - default + items: + description: >- + Defines a list of ports to scan. Valid values are:"default", "all", or + a comma-separated list of ports or range of ports (e.g. ["1-80", + "443"]). "default" scans the 100 most commonly open ports. + type: string + title: Port List + type: array + cloudforceOnePortScanApiScanConfig: + properties: + account_id: + example: abcd1234abcd1234abcd1234abcd1234 + type: string + frequency: + $ref: '#/components/schemas/cloudforceOnePortScanApiFrequency' + id: + description: Defines the Config ID. + example: uuid + type: string + ips: + $ref: '#/components/schemas/cloudforceOnePortScanApiIps' + ports: + $ref: '#/components/schemas/cloudforceOnePortScanApiPorts' + required: + - id + - account_id + - ips + - frequency + - ports + title: Config + type: object + cloudforceOneRequestsApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + cloudforceOneRequestsApiResponseCommonFailure: + properties: + errors: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + properties: + code: + example: 10433 + type: integer + message: + example: request error + type: string + messages: + $ref: '#/components/schemas/cloudforceOneRequestsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + type: object + cloudforceOneRequestsAssetContent: + description: Asset file to upload. + example: '@/Users/me/example.docx' + type: string + cloudforceOneRequestsLabels: + description: List of labels. + example: + - DoS + - CVE + items: + type: string + title: Labels + type: array + x-auditable: true + cloudforceOneRequestsMessageContent: + description: Content of message. + example: Can you elaborate on the type of DoS that occurred? + type: string + x-auditable: true + cloudforceOneRequestsMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + cloudforceOneRequestsPriority: + enum: + - routine + - high + - urgent + title: Request Priority + type: string + x-auditable: true + cloudforceOneRequestsPriorityEdit: + properties: + labels: + $ref: '#/components/schemas/cloudforceOneRequestsLabels' + priority: + description: Priority. + example: 1 + type: integer + x-auditable: true + requirement: + description: Requirement. + example: DoS attacks carried out by CVEs + type: string + x-auditable: true + tlp: + $ref: '#/components/schemas/cloudforceOneRequestsTlp' + required: + - labels + - priority + - requirement + - tlp + title: Priority Editable Attributes + type: object + cloudforceOneRequestsPriorityItem: + properties: + created: + description: Priority creation time. + $ref: '#/components/schemas/cloudforceOneRequestsTime' + id: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + labels: + $ref: '#/components/schemas/cloudforceOneRequestsLabels' + priority: + description: Priority. + example: 1 + type: integer + x-auditable: true + requirement: + description: Requirement. + example: DoS attacks carried out by CVEs + type: string + x-auditable: true + tlp: + $ref: '#/components/schemas/cloudforceOneRequestsTlp' + updated: + description: Priority last updated time. + $ref: '#/components/schemas/cloudforceOneRequestsTime' + required: + - id + - created + - updated + - labels + - priority + - requirement + - tlp + title: Priority Item + type: object + cloudforceOneRequestsPriorityList: + properties: + page: + description: Page number of results. + type: integer + per_page: + description: Number of results per page. + example: 10 + type: integer + required: + - page + - per_page + title: Priority List Parameters + type: object + cloudforceOneRequestsQuota: + properties: + anniversary_date: + description: Anniversary date is when annual quota limit is refreshed. + example: '2022-04-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + quarter_anniversary_date: + description: >- + Quarter anniversary date is when quota limit is refreshed each + quarter. + example: '2022-04-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + quota: + description: Tokens for the quarter. + example: 120 + type: integer + x-auditable: true + remaining: + description: Tokens remaining for the quarter. + example: 64 + type: integer + x-auditable: true + title: Quota + type: object + cloudforceOneRequestsRequestAssetEdit: + properties: + source: + $ref: '#/components/schemas/cloudforceOneRequestsAssetContent' + title: Request Asset Editable Attributes + type: object + cloudforceOneRequestsRequestAssetItem: + properties: + created: + description: Defines the asset creation time. + example: '2022-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + description: + description: Asset description. + example: example description + type: string + x-auditable: true + file_type: + description: Asset file type. + example: docx + type: string + x-auditable: true + id: + description: Asset ID. + type: integer + x-auditable: true + name: + description: Asset name. + example: example.docx + type: string + x-auditable: true + required: + - id + - name + title: Request Asset Item + type: object + cloudforceOneRequestsRequestAssetList: + properties: + page: + description: Page number of results. + type: integer + per_page: + description: Number of results per page. + example: 10 + type: integer + required: + - page + - per_page + title: Request Asset List Parameters + type: object + cloudforceOneRequestsRequestConstants: + properties: + priority: + example: + - routine + - high + - urgent + items: + $ref: '#/components/schemas/cloudforceOneRequestsPriority' + type: array + status: + example: + - open + - accepted + - reported + - approved + - completed + - declined + items: + $ref: '#/components/schemas/cloudforceOneRequestsRequestStatus' + type: array + tlp: + example: + - clear + - green + - amber + - amber-strict + - red + items: + $ref: '#/components/schemas/cloudforceOneRequestsTlp' + type: array + title: Request Constants + type: object + cloudforceOneRequestsRequestContent: + description: Request content. + example: What regions were most effected by the recent DoS? + type: string + cloudforceOneRequestsRequestEdit: + properties: + content: + $ref: '#/components/schemas/cloudforceOneRequestsRequestContent' + priority: + description: Priority for analyzing the request. + example: routine + type: string + x-auditable: true + request_type: + $ref: '#/components/schemas/cloudforceOneRequestsRequestType' + summary: + $ref: '#/components/schemas/cloudforceOneRequestsRequestSummary' + tlp: + $ref: '#/components/schemas/cloudforceOneRequestsTlp' + title: Request Editable Parameters + type: object + cloudforceOneRequestsRequestItem: + properties: + completed: + $ref: '#/components/schemas/cloudforceOneRequestsTime' + content: + $ref: '#/components/schemas/cloudforceOneRequestsRequestContent' + created: + $ref: '#/components/schemas/cloudforceOneRequestsTime' + id: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + message_tokens: + description: Tokens for the request messages. + example: 1 + type: integer + x-auditable: true + priority: + $ref: '#/components/schemas/cloudforceOneRequestsTime' + readable_id: + $ref: '#/components/schemas/cloudforceOneRequestsRequestReadableId' + request: + $ref: '#/components/schemas/cloudforceOneRequestsRequestType' + status: + $ref: '#/components/schemas/cloudforceOneRequestsRequestStatus' + summary: + $ref: '#/components/schemas/cloudforceOneRequestsRequestSummary' + tlp: + $ref: '#/components/schemas/cloudforceOneRequestsTlp' + tokens: + description: Tokens for the request. + example: 16 + type: integer + x-auditable: true + updated: + $ref: '#/components/schemas/cloudforceOneRequestsTime' + required: + - id + - created + - updated + - content + - priority + - request + - summary + - tlp + title: Request Item + type: object + cloudforceOneRequestsRequestList: + properties: + completed_after: + description: Retrieve requests completed after this time. + example: '2022-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + completed_before: + description: Retrieve requests completed before this time. + example: '2024-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + created_after: + description: Retrieve requests created after this time. + example: '2022-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + created_before: + description: Retrieve requests created before this time. + example: '2024-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + page: + description: Page number of results. + type: integer + per_page: + description: Number of results per page. + example: 10 + type: integer + request_type: + $ref: '#/components/schemas/cloudforceOneRequestsRequestType' + sort_by: + description: Field to sort results by. + example: created + type: string + sort_order: + description: Sort order (asc or desc). + enum: + - asc + - desc + type: string + status: + $ref: '#/components/schemas/cloudforceOneRequestsRequestStatus' + required: + - page + - per_page + title: Request List Parameters + type: object + cloudforceOneRequestsRequestListItem: + properties: + completed: + description: Request completion time. + example: '2024-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + created: + description: Request creation time. + example: '2022-04-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + id: + $ref: '#/components/schemas/cloudforceOneRequestsUuid' + message_tokens: + description: Tokens for the request messages. + example: 16 + type: integer + x-auditable: true + priority: + $ref: '#/components/schemas/cloudforceOneRequestsPriority' + readable_id: + $ref: '#/components/schemas/cloudforceOneRequestsRequestReadableId' + request: + $ref: '#/components/schemas/cloudforceOneRequestsRequestType' + status: + $ref: '#/components/schemas/cloudforceOneRequestsRequestStatus' + summary: + $ref: '#/components/schemas/cloudforceOneRequestsRequestSummary' + tlp: + $ref: '#/components/schemas/cloudforceOneRequestsTlp' + tokens: + description: Tokens for the request. + type: integer + x-auditable: true + updated: + description: Request last updated time. + example: '2022-04-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + required: + - id + - created + - updated + - priority + - request + - summary + - tlp + title: Request List Item + type: object + cloudforceOneRequestsRequestMessageEdit: + properties: + content: + $ref: '#/components/schemas/cloudforceOneRequestsMessageContent' + title: Request Message Editable Attributes + type: object + cloudforceOneRequestsRequestMessageItem: + properties: + author: + description: Author of message. + example: user@domain.com + type: string + x-auditable: true + content: + $ref: '#/components/schemas/cloudforceOneRequestsMessageContent' + created: + description: Defines the message creation time. + example: '2022-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + id: + description: Message ID. + type: integer + x-auditable: true + is_follow_on_request: + description: Whether the message is a follow-on request. + type: boolean + x-auditable: true + updated: + description: Defines the message last updated time. + example: '2022-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + required: + - id + - updated + - content + - author + - is_follow_on_request + title: Request Message Item + type: object + cloudforceOneRequestsRequestMessageList: + properties: + after: + description: Retrieve mes ges created after this time. + $ref: '#/components/schemas/cloudforceOneRequestsTime' + before: + description: Retrieve messages created before this time. + example: '2024-01-01T00:00:00Z' + $ref: '#/components/schemas/cloudforceOneRequestsTime' + page: + description: Page number of results. + type: integer + per_page: + description: Number of results per page. + example: 10 + type: integer + sort_by: + description: Field to sort results by. + example: created + type: string + sort_order: + description: Sort order (asc or desc). + enum: + - asc + - desc + type: string + required: + - page + - per_page + title: Request Message List Parameters + type: object + cloudforceOneRequestsRequestReadableId: + description: Readable Request ID. + example: RFI-2022-000001 + title: Request Readable ID + type: string + x-auditable: true + cloudforceOneRequestsRequestStatus: + description: Request Status. + enum: + - open + - accepted + - reported + - approved + - completed + - declined + title: Request Status + type: string + x-auditable: true + cloudforceOneRequestsRequestSummary: + description: Brief description of the request. + example: DoS attack + type: string + x-auditable: true + cloudforceOneRequestsRequestType: + description: Requested information from request. + example: Victomology + type: string + x-auditable: true + cloudforceOneRequestsRequestTypes: + example: + - Indicators of Compromise + - Victomology + items: + description: Request Types. + type: string + x-auditable: true + title: Request Types + type: array + cloudforceOneRequestsTime: + example: '2022-04-01T05:20:00Z' + format: date-time + type: string + x-auditable: true + cloudforceOneRequestsTlp: + description: The CISA defined Traffic Light Protocol (TLP). + enum: + - clear + - amber + - amber-strict + - green + - red + title: TLP + type: string + x-auditable: true + cloudforceOneRequestsUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + cloudforceOneRule: + properties: + content: + example: 'rule example { condition: true }' + type: string + created_at: + example: 1679529600000 + type: number + x-auditable: true + readOnly: true + created_by: + example: user@example.com + type: string + x-auditable: true + description: + example: Detects malicious proxy workers + type: string + enabled: + description: Whether this rule is active for dice consumers. + example: true + type: boolean + id: + example: 550e8400-e29b-41d4-a716-446655440000 + format: uuid + type: string + x-auditable: true + is_public: + description: Whether this rule is visible to other internal accounts. + example: false + type: boolean + x-auditable: true + name: + example: block-malicious-workers + type: string + x-auditable: true + namespaces: + example: + - yara/workers + items: + type: string + type: array + x-auditable: true + updated_at: + example: 1679529600000 + type: number + x-auditable: true + readOnly: true + updated_by: + example: user@example.com + type: string + x-auditable: true + required: + - id + - name + - description + - namespaces + - content + - is_public + - enabled + - created_at + - updated_at + - created_by + - updated_by + type: object + cloudforceOneRuleAction: + properties: + action_config: + description: Action-specific configuration parameters. + type: object + action_type: + enum: + - alert_gchat + - webhook + - logging + - email + - pipeline + - remediation + - throttle + - delete + example: alert_gchat + type: string + enabled: + default: true + type: boolean + required: + - action_type + - action_config + type: object + cloudforceOneRulesListResponse: + properties: + rules: + items: + $ref: '#/components/schemas/cloudforceOneRule' + type: array + total: + example: 100 + type: number + required: + - rules + - total + type: object + cloudforceOneStatsResponse: + properties: + pending_approvals: + example: 5 + type: number + rules_by_namespace: + example: + yara/dns_record: 12 + yara/workers: 30 + type: object + total_rules: + example: 42 + type: number + required: + - total_rules + - rules_by_namespace + - pending_approvals + type: object + cloudforceOneSuccessResponse: + properties: + success: + example: true + type: boolean + required: + - success + type: object + cloudforceOneTreeNode: + properties: + children: + items: + $ref: '#/components/schemas/cloudforceOneTreeNode' + type: array + count: + example: 15 + type: number + name: + example: workers + type: string + path: + example: yara/workers + type: string + required: + - name + - path + - count + - children + type: object + cloudforceOneTreeResponse: + properties: + tree: + items: + $ref: '#/components/schemas/cloudforceOneTreeNode' + type: array + required: + - tree + type: object + cloudforceOneUpdateRule: + properties: + content: + example: 'rule example { condition: true }' + minLength: 1 + type: string + description: + description: >- + Human-readable description of the rule. Auto-extracted from YARA + meta if present. + example: Detects malicious proxy workers + maxLength: 1000 + type: string + enabled: + description: Whether this rule is active for dice consumers. + example: true + type: boolean + is_public: + description: Whether this rule is visible to other internal accounts. + example: false + type: boolean + x-auditable: true + name: + example: block-malicious-workers + maxLength: 255 + minLength: 1 + type: string + x-auditable: true + namespaces: + example: + - yara/workers + items: + maxLength: 255 + minLength: 1 + type: string + type: array + x-auditable: true + type: object + cloudforceOneValidationResponse: + properties: + error: + example: Invalid YARA syntax + type: string + valid: + example: true + type: boolean + required: + - valid + type: object + unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51: + properties: + error: + example: Not Found. + type: string + required: + - error + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + binary_storage: + id: cloudflare.cloudforce_one.binary_storage + name: binary_storage + title: Binary Storage + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1binary/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1binary~1{hash}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/binary_storage/methods/create' + update: [] + delete: [] + replace: [] + threat_events: + id: cloudflare.cloudforce_one.threat_events + name: threat_events + title: Threat Events + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + bulk_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1create~1bulk/post + response: + mediaType: application/json + openAPIDocKey: '202' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/threat_events/methods/get' + - $ref: '#/components/x-stackQL-resources/threat_events/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/threat_events/methods/bulk_create' + update: + - $ref: '#/components/x-stackQL-resources/threat_events/methods/edit' + delete: [] + replace: [] + aggregate: + id: cloudflare.cloudforce_one.aggregate + name: aggregate + title: Aggregate + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1aggregate/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.aggregations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/aggregate/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + attackers: + id: cloudflare.cloudforce_one.attackers + name: attackers + title: Attackers + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1attackers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/attackers/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + events_categories: + id: cloudflare.cloudforce_one.events_categories + name: events_categories + title: Events Categories + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + categories_catalog: + id: cloudflare.cloudforce_one.categories_catalog + name: categories_catalog + title: Categories Catalog + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1catalog/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/categories_catalog/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + events_categories_create: + id: cloudflare.cloudforce_one.events_categories_create + name: events_categories_create + title: Events Categories Create + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/events_categories_create/methods/create + update: [] + delete: [] + replace: [] + categories: + id: cloudflare.cloudforce_one.categories + name: categories + title: Categories + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1{category_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1{category_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1{category_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + post_category_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1categories~1{category_id}/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_tag_category_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags~1categories~1{category_uuid}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch_tag_category_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags~1categories~1{category_uuid}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/categories/methods/get' + insert: + - $ref: >- + #/components/x-stackQL-resources/categories/methods/post_category_update + update: + - $ref: '#/components/x-stackQL-resources/categories/methods/edit' + - $ref: >- + #/components/x-stackQL-resources/categories/methods/patch_tag_category_update + delete: + - $ref: '#/components/x-stackQL-resources/categories/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/categories/methods/delete_tag_category_delete + replace: [] + countries: + id: cloudflare.cloudforce_one.countries + name: countries + title: Countries + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1countries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/countries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + events_create: + id: cloudflare.cloudforce_one.events_create + name: events_create + title: Events Create + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + relationships: + id: cloudflare.cloudforce_one.relationships + name: relationships + title: Relationships + methods: + post_dosevent_create_bulk_with_relationships: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1create~1bulk~1relationships/post + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1relationships~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}~1relationships/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/relationships/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/relationships/methods/post_dosevent_create_bulk_with_relationships + update: [] + delete: [] + replace: [] + datasets: + id: cloudflare.cloudforce_one.datasets + name: datasets + title: Datasets + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + copy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1copy/post + response: + mediaType: application/json + openAPIDocKey: '200' + move: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1move/post + response: + mediaType: application/json + openAPIDocKey: '200' + populate: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1datasets~1populate/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/edit' + delete: [] + replace: [] + groups: + id: cloudflare.cloudforce_one.groups + name: groups + title: Groups + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups/get + response: + mediaType: application/json + openAPIDocKey: '200' + post_group_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_group_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups~1{group_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups~1{group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + put_group_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups~1{group_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/post_group_create' + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/groups/methods/delete_group_delete + replace: + - $ref: '#/components/x-stackQL-resources/groups/methods/put_group_update' + members: + id: cloudflare.cloudforce_one.members + name: members + title: Members + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups~1{group_id}~1members/get + response: + mediaType: application/json + openAPIDocKey: '200' + post_group_member_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups~1{group_id}~1members/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_group_member_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1-~1groups~1{group_id}~1members~1{member_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/members/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/members/methods/post_group_member_create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/members/methods/delete_group_member_delete + replace: [] + dataset: + id: cloudflare.cloudforce_one.dataset + name: dataset + title: Dataset + methods: + delete_dataset_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + post_dataset_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/dataset/methods/post_dataset_update + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/dataset/methods/delete_dataset_delete + replace: [] + events_dataset: + id: cloudflare.cloudforce_one.events_dataset + name: events_dataset + title: Events Dataset + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/events_dataset/methods/get_by_account + insert: [] + update: [] + delete: [] + replace: [] + events: + id: cloudflare.cloudforce_one.events + name: events + title: Events + methods: + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1events~1{event_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_graphql: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1graphql/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_relate: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1relate~1{event_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + delete_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{dataset_id}~1delete/delete + response: + mediaType: application/json + openAPIDocKey: '200' + post_event_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_graphql_v2: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1events~1graphql/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/events/methods/post_event_update' + update: [] + delete: [] + replace: [] + indicator_types: + id: cloudflare.cloudforce_one.indicator_types + name: indicator_types + title: Indicator Types + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicatorTypes~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1indicator-types/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indicator_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dataset_indicators: + id: cloudflare.cloudforce_one.dataset_indicators + name: dataset_indicators + title: Dataset Indicators + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicators/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.indicators + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/dataset_indicators/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + bulk: + id: cloudflare.cloudforce_one.bulk + name: bulk + title: Bulk + methods: + post_indicator_create_bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicators~1bulk/post + response: + mediaType: application/json + openAPIDocKey: '200' + patch_event_update_bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1update~1bulk/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bulk/methods/post_indicator_create_bulk + update: + - $ref: >- + #/components/x-stackQL-resources/bulk/methods/patch_event_update_bulk + delete: [] + replace: [] + indicators: + id: cloudflare.cloudforce_one.indicators + name: indicators + title: Indicators + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicators~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_indicator_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicators~1{indicator_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicators~1{indicator_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch_indicator_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicators~1{indicator_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indicators/methods/get' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/indicators/methods/patch_indicator_update + delete: + - $ref: >- + #/components/x-stackQL-resources/indicators/methods/delete_indicator_delete + replace: [] + indicators_tags: + id: cloudflare.cloudforce_one.indicators_tags + name: indicators_tags + title: Indicators Tags + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1indicators~1tags/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/indicators_tags/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + permissions: + id: cloudflare.cloudforce_one.permissions + name: permissions + title: Permissions + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1permissions/get + response: + mediaType: application/json + openAPIDocKey: '200' + post_permission_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1permissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_permission_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1permissions~1{grant_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + put_permission_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1permissions~1{grant_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/post_permission_create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/delete_permission_delete + replace: + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/put_permission_update + tags_indicators: + id: cloudflare.cloudforce_one.tags_indicators + name: tags_indicators + title: Tags Indicators + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1tags~1{tag_uuid}~1indicators/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.indicators + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/tags_indicators/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + dataset_target_industries: + id: cloudflare.cloudforce_one.dataset_target_industries + name: dataset_target_industries + title: Dataset Target Industries + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1dataset~1{dataset_id}~1targetIndustries/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/dataset_target_industries/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + event_tags: + id: cloudflare.cloudforce_one.event_tags + name: event_tags + title: Event Tags + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1event_tag~1{event_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1event_tag~1{event_id}~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/event_tags/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/event_tags/methods/delete' + replace: [] + indicator_types_indicator_types: + id: cloudflare.cloudforce_one.indicator_types_indicator_types + name: indicator_types_indicator_types + title: Indicator Types Indicator Types + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1indicatorTypes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/indicator_types_indicator_types/methods/list + insert: [] + update: [] + delete: [] + replace: [] + events_indicators: + id: cloudflare.cloudforce_one.events_indicators + name: events_indicators + title: Events Indicators + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1indicators/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/events_indicators/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + queries: + id: cloudflare.cloudforce_one.queries + name: queries + title: Queries + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1queries/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1queries~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_event_query_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1queries~1{query_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1queries~1{query_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch_event_query_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1queries~1{query_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + post_event_query_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1queries~1{query_id}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries/methods/get' + - $ref: '#/components/x-stackQL-resources/queries/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/queries/methods/post_event_query_update + update: + - $ref: >- + #/components/x-stackQL-resources/queries/methods/patch_event_query_update + delete: + - $ref: >- + #/components/x-stackQL-resources/queries/methods/delete_event_query_delete + replace: [] + events_raw: + id: cloudflare.cloudforce_one.events_raw + name: events_raw + title: Events Raw + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1raw~1{dataset_id}~1{event_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events_raw/methods/get_by_account' + insert: [] + update: [] + delete: [] + replace: [] + relate_create: + id: cloudflare.cloudforce_one.relate_create + name: relate_create + title: Relate Create + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1relate~1{event_id}~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + events_tags: + id: cloudflare.cloudforce_one.events_tags + name: events_tags + title: Events Tags + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tags + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/events_tags/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + tags_categories: + id: cloudflare.cloudforce_one.tags_categories + name: tags_categories + title: Tags Categories + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags~1categories/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.categories + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tags_categories_create: + id: cloudflare.cloudforce_one.tags_categories_create + name: tags_categories_create + title: Tags Categories Create + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags~1categories~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + tags: + id: cloudflare.cloudforce_one.tags + name: tags + title: Tags + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_tag_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags~1{tag_uuid}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch_tag_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1tags~1{tag_uuid}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tags/methods/patch_tag_update' + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete_tag_delete' + replace: [] + events_target_industries: + id: cloudflare.cloudforce_one.events_target_industries + name: events_target_industries + title: Events Target Industries + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1targetIndustries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/events_target_industries/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + target_industries_catalog: + id: cloudflare.cloudforce_one.target_industries_catalog + name: target_industries_catalog + title: Target Industries Catalog + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1targetIndustries~1catalog/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/target_industries_catalog/methods/list + insert: [] + update: [] + delete: [] + replace: [] + raw: + id: cloudflare.cloudforce_one.raw + name: raw + title: Raw + methods: + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}~1raw~1{raw_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}~1raw~1{raw_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + post_event_raw_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1events~1{event_id}~1raw~1{raw_id}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/raw/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/raw/methods/post_event_raw_update' + update: + - $ref: '#/components/x-stackQL-resources/raw/methods/edit' + delete: [] + replace: [] + cloudforce_one: + id: cloudflare.cloudforce_one.cloudforce_one + name: cloudforce_one + title: Cloudforce One + methods: + create_requests: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1requests/post' + response: + mediaType: application/json + openAPIDocKey: '200' + generate_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1letter~1generate/post + response: + mediaType: application/json + openAPIDocKey: '200' + search_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1logo~1search/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + requests_constants: + id: cloudflare.cloudforce_one.requests_constants + name: requests_constants + title: Requests Constants + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1constants/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/requests_constants/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + requests_new: + id: cloudflare.cloudforce_one.requests_new + name: requests_new + title: Requests New + methods: + new_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1new/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + requests: + id: cloudflare.cloudforce_one.requests + name: requests + title: Requests + methods: + create_priority: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1priority/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + create_asset: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1asset/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_message: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1message/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/requests/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/requests/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/requests/methods/update' + priority: + id: cloudflare.cloudforce_one.priority + name: priority + title: Priority + methods: + new: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1priority~1new/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1priority~1quota/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1priority~1{priority_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1priority~1{priority_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1priority~1{priority_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/priority/methods/get' + - $ref: '#/components/x-stackQL-resources/priority/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/priority/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/priority/methods/update' + requests_quota: + id: cloudflare.cloudforce_one.requests_quota + name: requests_quota + title: Requests Quota + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1quota/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/requests_quota/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + requests_types: + id: cloudflare.cloudforce_one.requests_types + name: requests_types + title: Requests Types + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1types/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/requests_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + assets: + id: cloudflare.cloudforce_one.assets + name: assets + title: Assets + methods: + new: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1asset~1new/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1asset~1{asset_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1asset~1{asset_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1asset~1{asset_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assets/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/assets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/assets/methods/update' + message_new: + id: cloudflare.cloudforce_one.message_new + name: message_new + title: Message New + methods: + new_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1message~1new/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + message: + id: cloudflare.cloudforce_one.message + name: message + title: Message + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1message~1{message_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1requests~1{request_id}~1message~1{message_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/message/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/message/methods/update' + rules: + id: cloudflare.cloudforce_one.rules + name: rules + title: Rules + methods: + cloudforce_one_delete_all_rules: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1rules/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rules + cloudforce_one_create_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '201' + validate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1rules~1validate/post + response: + mediaType: application/json + openAPIDocKey: '200' + cloudforce_one_delete_rule: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1rules~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1rules~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + cloudforce_one_update_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1rules~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get' + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/cloudforce_one_create_rule + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/cloudforce_one_delete_rule + - $ref: >- + #/components/x-stackQL-resources/rules/methods/cloudforce_one_delete_all_rules + replace: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/cloudforce_one_update_rule + managed: + id: cloudflare.cloudforce_one.managed + name: managed + title: Managed + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1rules~1managed/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rules + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/managed/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + stats: + id: cloudflare.cloudforce_one.stats + name: stats + title: Stats + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1rules~1stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stats/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + trees: + id: cloudflare.cloudforce_one.trees + name: trees + title: Trees + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cloudforce-one~1rules~1tree/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tree + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/trees/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + config: + id: cloudflare.cloudforce_one.config + name: config + title: Config + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1scans~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1scans~1config/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1scans~1config~1{config_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1scans~1config~1{config_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/config/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/config/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/config/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/config/methods/delete' + replace: [] + results: + id: cloudflare.cloudforce_one.results + name: results + title: Results + methods: + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1scans~1results~1{config_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/results/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + templates: + id: cloudflare.cloudforce_one.templates + name: templates + title: Templates + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1letter~1templates/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.templates + post_letter_template_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1letter~1templates/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_letter_template_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1letter~1templates~1{template_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1letter~1templates~1{template_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + put_letter_template_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1letter~1templates~1{template_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/templates/methods/get' + - $ref: '#/components/x-stackQL-resources/templates/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/post_letter_template_create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/delete_letter_template_delete + replace: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/put_letter_template_update + total_queries: + id: cloudflare.cloudforce_one.total_queries + name: total_queries + title: Total Queries + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cloudforce-one~1v2~1brand-protection~1total-queries/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/total_queries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/connectivity.yaml b/providers/src/cloudflare/v00.00.00000/services/connectivity.yaml new file mode 100644 index 00000000..b9ab66bf --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/connectivity.yaml @@ -0,0 +1,621 @@ +openapi: 3.0.3 +info: + title: connectivity API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/connectivity/directory/services: + get: + operationId: connectivity-services-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: type + schema: + nullable: true + type: string + $ref: '#/components/schemas/infraServiceType' + - description: Current page in the response + in: query + name: page + schema: + default: 1 + format: int32 + minimum: 1 + type: integer + - description: Max amount of entries returned per page + in: query + name: per_page + schema: + default: 1000 + format: int32 + maximum: 1000 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/infraConnectivityServiceArray' + required: + - success + - errors + - messages + description: Successfully retrieved Workers VPC connectivity services + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to retrieve Workers VPC connectivity services + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Workers VPC connectivity services + tags: + - Connectivity Services + x-stackql-sdk: + service: connectivity + resource_chain: + - directory + - services + method: list + post: + operationId: connectivity-services-post + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/infraServiceConfig' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/infraServiceConfig' + required: + - success + - errors + - messages + description: Successfully created Workers VPC connectivity service + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to create Workers VPC connectivity service + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Workers VPC connectivity service + tags: + - Connectivity Services + x-stackql-sdk: + service: connectivity + resource_chain: + - directory + - services + method: create + /accounts/{account_id}/connectivity/directory/services/{service_id}: + delete: + operationId: connectivity-services-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: service_id + schema: + format: uuid + type: string + required: true + responses: + '200': + description: Successfully deleted Workers VPC connectivity service + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to delete Workers VPC connectivity service + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Workers VPC connectivity service + tags: + - Connectivity Services + x-stackql-sdk: + service: connectivity + resource_chain: + - directory + - services + method: delete + get: + operationId: connectivity-services-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: service_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/infraServiceConfig' + required: + - success + - errors + - messages + description: Successfully retrieved Workers VPC connectivity service + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to retrieve Workers VPC connectivity service + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workers VPC connectivity service + tags: + - Connectivity Services + x-stackql-sdk: + service: connectivity + resource_chain: + - directory + - services + method: get + put: + operationId: connectivity-services-put + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: service_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/infraServiceConfig' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/infraServiceConfig' + required: + - success + - errors + - messages + description: Successfully updated Workers VPC connectivity service + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to update Workers VPC connectivity service + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Workers VPC connectivity service + tags: + - Connectivity Services + x-stackql-sdk: + service: connectivity + resource_chain: + - directory + - services + method: update +components: + schemas: + infraApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/infraMessages' + messages: + example: [] + $ref: '#/components/schemas/infraMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + infraApiTlsSettings: + description: >- + TLS settings for a connectivity service. If omitted, the default mode + (`verify_full`) is used. + properties: + cert_verification_mode: + description: >- + TLS certificate verification mode for the connection to the origin. + - `"verify_full"` — verify certificate chain and hostname (default) + - `"verify_ca"` — verify certificate chain only, skip hostname check + - `"disabled"` — do not verify the server certificate at all + example: verify_full + type: string + required: + - cert_verification_mode + type: object + infraConnectivityServiceArray: + items: + $ref: '#/components/schemas/infraServiceConfig' + type: array + infraMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + infraNetwork: + properties: + tunnel_id: + format: uuid + type: string + required: + - tunnel_id + type: object + infraResolverNetwork: + properties: + resolver_ips: + items: + type: string + nullable: true + type: array + tunnel_id: + format: uuid + type: string + required: + - tunnel_id + type: object + infraServiceConfig: + type: object + example: + host: + ipv4: 10.0.0.1 + network: + tunnel_id: 0191dce4-9ab4-7fce-b660-8e5dec5172da + http_port: 8080 + https_port: 8443 + name: web-app + type: http + properties: + created_at: + example: '2024-01-15T09:30:00Z' + format: date-time + readOnly: true + type: string + host: + $ref: '#/components/schemas/infraServiceHost' + name: + example: web-server + type: string + service_id: + example: 550e8400-e29b-41d4-a716-446655440000 + format: uuid + readOnly: true + type: string + tls_settings: + nullable: true + type: object + $ref: '#/components/schemas/infraApiTlsSettings' + type: + $ref: '#/components/schemas/infraServiceType' + updated_at: + example: '2024-01-15T10:45:00Z' + format: date-time + readOnly: true + type: string + http_port: + example: 8080 + format: int32 + minimum: 1 + nullable: true + type: integer + https_port: + example: 8443 + format: int32 + minimum: 1 + nullable: true + type: integer + app_protocol: + enum: + - postgresql + - mysql + example: postgresql + nullable: true + type: string + tcp_port: + example: 5432 + format: int32 + minimum: 1 + nullable: true + type: integer + required: + - host + - name + - type + infraServiceHost: + type: object + example: + ipv4: 10.0.0.1 + network: + tunnel_id: 0191dce4-9ab4-7fce-b660-8e5dec5172da + properties: + ipv4: + example: 10.0.0.1 + type: string + network: + $ref: '#/components/schemas/infraNetwork' + ipv6: + example: fe80::1 + type: string + hostname: + example: example.com + type: string + resolver_network: + $ref: '#/components/schemas/infraResolverNetwork' + required: [] + infraServiceType: + enum: + - tcp + - http + type: string + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + services: + id: cloudflare.connectivity.services + name: services + title: Services + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1connectivity~1directory~1services/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1connectivity~1directory~1services/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1connectivity~1directory~1services~1{service_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1connectivity~1directory~1services~1{service_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1connectivity~1directory~1services~1{service_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/services/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/content_scanning.yaml b/providers/src/cloudflare/v00.00.00000/services/content_scanning.yaml new file mode 100644 index 00000000..6f0baecd --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/content_scanning.yaml @@ -0,0 +1,705 @@ +openapi: 3.0.3 +info: + title: content_scanning API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/content-upload-scan/disable: + post: + description: Disable Content Scanning. + operationId: waf-content-scanning-disable + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleSchemasApiResponseCommon + description: Disable Content Scanning response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleSchemasApiResponseCommonFailure + description: Disable Content Scanning failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Disable Content Scanning + tags: + - Content Scanning + x-api-token-group: + - Zone WAF Write + - Account WAF Write + x-stackql-sdk: + service: content_scanning + resource_chain: [] + method: disable + /zones/{zone_id}/content-upload-scan/enable: + post: + description: Enable Content Scanning. + operationId: waf-content-scanning-enable + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleSchemasApiResponseCommon + description: Enable Content Scanning response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleSchemasApiResponseCommonFailure + description: Enable Content Scanning failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Enable Content Scanning + tags: + - Content Scanning + x-api-token-group: + - Zone WAF Write + - Account WAF Write + x-stackql-sdk: + service: content_scanning + resource_chain: [] + method: enable + /zones/{zone_id}/content-upload-scan/payloads: + get: + description: Get a list of existing custom scan expressions for Content Scanning. + operationId: waf-content-scanning-list-custom-scan-expressions + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleResponseCustomScanCollection + description: List existing Content Scan custom scan expressions response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + items: + type: object + $ref: '#/components/schemas/wafProductApiBundleCustomScan' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List existing Content Scan custom scan expressions failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Existing Custom Scan Expressions + tags: + - Content Scanning + x-api-token-group: + - Zone WAF Write + - Zone WAF Read + - Account WAF Write + - Account WAF Read + x-stackql-sdk: + service: content_scanning + resource_chain: + - payloads + method: create + post: + description: Add custom scan expressions for Content Scanning. + operationId: waf-content-scanning-add-custom-scan-expressions + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + properties: + payload: + $ref: '#/components/schemas/wafProductApiBundleCustomScanPayload' + required: + - payload + type: object + type: array + description: Array of custom scan expressions to add. + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleResponseCustomScanCollection + description: Add custom scan expressions for Content Scanning. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + items: + type: object + $ref: '#/components/schemas/wafProductApiBundleCustomScan' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List existing Content Scan custom scan expressions failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add Custom Scan Expressions + tags: + - Content Scanning + x-api-token-group: + - Zone WAF Write + - Account WAF Write + /zones/{zone_id}/content-upload-scan/payloads/{expression_id}: + delete: + description: Delete a Content Scan Custom Expression. + operationId: waf-content-scanning-delete-custom-scan-expressions + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: expression_id + schema: + $ref: '#/components/schemas/wafProductApiBundleCustomScanId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleResponseCustomScanCollection + description: Delete Content Scan custom scan expressions response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + items: + type: object + $ref: '#/components/schemas/wafProductApiBundleCustomScan' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Content Scan custom scan expressions failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Custom Scan Expression + tags: + - Content Scanning + x-api-token-group: + - Zone WAF Write + - Account WAF Write + /zones/{zone_id}/content-upload-scan/settings: + get: + description: Retrieve the current status of Content Scanning. + operationId: waf-content-scanning-get-status + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleSchemasResponseStatus' + description: Get Content Scanning status response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleSchemasApiResponseCommonFailure + description: Get Content Scanning status failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Content Scanning Status + tags: + - Content Scanning + x-api-token-group: + - Zone WAF Write + - Zone WAF Read + - Account WAF Write + - Account WAF Read + x-stackql-sdk: + service: content_scanning + resource_chain: [] + method: get + put: + description: Update the Content Scanning status. + operationId: waf-content-scanning-update-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + value: + description: The status value for Content Scanning. + enum: + - enabled + - disabled + type: string + required: + - value + type: object + description: Content Scanning settings to update. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleSchemasResponseStatus' + description: Update Content Scanning settings response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleSchemasApiResponseCommonFailure + description: Update Content Scanning settings failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Content Scanning Status + tags: + - Content Scanning + x-api-token-group: + - Zone WAF Write + - Account WAF Write + x-stackql-sdk: + service: content_scanning + resource_chain: [] + method: create +components: + schemas: + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + wafProductApiBundleCustomScan: + description: Defines a custom scan expression to match Content Scanning on. + properties: + id: + $ref: '#/components/schemas/wafProductApiBundleCustomScanId' + payload: + $ref: '#/components/schemas/wafProductApiBundleCustomScanPayload' + type: object + wafProductApiBundleCustomScanId: + description: defines the unique ID for this custom scan expression. + example: a350a054caa840c9becd89c3b4f0195b + $ref: '#/components/schemas/wafProductApiBundleIdentifier' + wafProductApiBundleCustomScanPayload: + description: Defines the ruleset expression to use in matching content objects. + example: lookup_json_string(http.request.body.raw, "file") + type: string + x-auditable: true + wafProductApiBundleIdentifier: + description: Defines an identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + wafProductApiBundleMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + wafProductApiBundleResponseCustomScanCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + items: + type: object + $ref: '#/components/schemas/wafProductApiBundleCustomScan' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + wafProductApiBundleSchemasApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: {} + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + wafProductApiBundleSchemasApiResponseCommonFailure: + properties: + errors: + example: + - code: 10000 + message: Authentication error + minLength: 1 + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + example: [] + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + wafProductApiBundleSchemasResponseStatus: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + $ref: '#/components/schemas/wafProductApiBundleSchemasStatus' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + wafProductApiBundleSchemasStatus: + description: Defines the status for Content Scanning. + properties: + modified: + description: >- + Defines the last modification date (ISO 8601) of the Content + Scanning status. + example: '2024-12-02T09:57:23.150259Z' + type: string + x-auditable: true + value: + description: Defines the status of Content Scanning. + example: enabled + type: string + x-auditable: true + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + content_upload_scan: + id: cloudflare.content_scanning.content_upload_scan + name: content_upload_scan + title: Content Upload Scan + methods: + disable: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + payloads: + id: cloudflare.content_scanning.payloads + name: payloads + title: Payloads + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1payloads/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + waf_content_scanning_add_custom_scan_expressions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1payloads/post' + response: + mediaType: application/json + openAPIDocKey: '200' + waf_content_scanning_delete_custom_scan_expressions: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1content-upload-scan~1payloads~1{expression_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/payloads/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/payloads/methods/waf_content_scanning_add_custom_scan_expressions + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/payloads/methods/waf_content_scanning_delete_custom_scan_expressions + replace: [] + settings: + id: cloudflare.content_scanning.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1content-upload-scan~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/create' diff --git a/providers/src/cloudflare/v00.00.00000/services/custom_certificates.yaml b/providers/src/cloudflare/v00.00.00000/services/custom_certificates.yaml new file mode 100644 index 00000000..ef57a96f --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/custom_certificates.yaml @@ -0,0 +1,1356 @@ +openapi: 3.0.3 +info: + title: custom_certificates API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/custom_certificates: + get: + description: >- + List, search, and filter all of your custom SSL certificates. The higher + priority will break ties across overlapping 'legacy_custom' + certificates, but 'legacy_custom' certificates will always supercede + 'sni_custom' certificates. + operationId: custom-ssl-for-a-zone-list-ssl-configurations + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of zones per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: match + schema: + default: all + description: Whether to match all search requirements or at least one (any). + enum: + - any + - all + type: string + - in: query + name: status + schema: + description: Status of the zone's custom SSL. + enum: + - active + - expired + - deleted + - pending + - initializing + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateResponseCollection + description: List SSL Configurations response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomCertificate + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List SSL Configurations response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List SSL Configurations + tags: + - Custom SSL for a Zone + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: custom_certificates + resource_chain: [] + method: list + post: + description: Upload a new SSL certificate for a zone. + operationId: custom-ssl-for-a-zone-create-ssl-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + bundle_method: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBundleMethod' + certificate: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificate' + custom_csr_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCsrId' + deploy: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesDeploy' + geo_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesGeoRestrictions + policy: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPolicy' + private_key: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPrivateKey' + type: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesType' + required: + - certificate + - private_key + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateResponseSingle + description: Create SSL Configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + bundle_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesBundleMethod + custom_csr_id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomCsrId + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesExpiresOn + geo_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesGeoRestrictions + hosts: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHosts' + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + keyless_server: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessCertificate + modified_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesModifiedOn + readOnly: true + policy_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPolicyRestrictions + priority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPriority + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesStatus' + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUploadedOn + zone_id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + required: + - id + - zone_id + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create SSL Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create SSL Configuration + tags: + - Custom SSL for a Zone + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: custom_certificates + resource_chain: [] + method: create + /zones/{zone_id}/custom_certificates/prioritize: + put: + description: >- + If a zone has multiple SSL certificates, you can set the order in which + they should be used during a request. The higher priority will break + ties across overlapping 'legacy_custom' certificates. + operationId: custom-ssl-for-a-zone-re-prioritize-ssl-certificates + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + certificates: + description: Array of ordered certificates. + items: + properties: + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + priority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPriority + type: object + type: array + required: + - certificates + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateResponseCollection + description: Re-prioritize SSL Certificates response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomCertificate + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Re-prioritize SSL Certificates response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Re-prioritize SSL Certificates + tags: + - Custom SSL for a Zone + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + /zones/{zone_id}/custom_certificates/{custom_certificate_id}: + delete: + description: Remove a SSL certificate from a zone. + operationId: custom-ssl-for-a-zone-delete-ssl-configuration + parameters: + - in: path + name: custom_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateResponseIdOnly + description: Delete SSL Configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/identifier' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete SSL Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete SSL Configuration + tags: + - Custom SSL for a Zone + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: custom_certificates + resource_chain: [] + method: delete + get: + description: >- + Retrieves details for a specific custom SSL certificate, including + certificate metadata, bundle method, geographic restrictions, and + associated keyless server configuration. + operationId: custom-ssl-for-a-zone-ssl-configuration-details + parameters: + - in: path + name: custom_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateResponseSingle + description: SSL Configuration Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + bundle_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesBundleMethod + custom_csr_id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomCsrId + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesExpiresOn + geo_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesGeoRestrictions + hosts: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHosts' + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + keyless_server: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessCertificate + modified_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesModifiedOn + readOnly: true + policy_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPolicyRestrictions + priority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPriority + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesStatus' + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUploadedOn + zone_id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + required: + - id + - zone_id + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: SSL Configuration Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: SSL Configuration Details + tags: + - Custom SSL for a Zone + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: custom_certificates + resource_chain: [] + method: get + patch: + description: >- + Upload a new private key and/or PEM/CRT for the SSL certificate. Note: + PATCHing a configuration for sni_custom certificates will result in a + new resource id being returned, and the previous one being deleted. + operationId: custom-ssl-for-a-zone-edit-ssl-configuration + parameters: + - in: path + name: custom_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + bundle_method: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBundleMethod' + certificate: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificate' + custom_csr_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCsrId' + deploy: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesDeploy' + geo_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesGeoRestrictions + policy: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPolicy' + private_key: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPrivateKey' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateResponseSingle + description: Edit SSL Configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + bundle_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesBundleMethod + custom_csr_id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomCsrId + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesExpiresOn + geo_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesGeoRestrictions + hosts: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHosts' + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + keyless_server: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessCertificate + modified_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesModifiedOn + readOnly: true + policy_restrictions: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPolicyRestrictions + priority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPriority + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesStatus' + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUploadedOn + zone_id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + required: + - id + - zone_id + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit SSL Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit SSL Configuration + tags: + - Custom SSL for a Zone + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: custom_certificates + resource_chain: [] + method: edit +components: + schemas: + identifier: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + enum: + - null + tlsCertificatesAndHostnamesBase: + properties: + created_on: + description: When the Keyless SSL was created. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + enabled: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesEnabled' + host: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHost' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasIdentifier' + modified_on: + description: When the Keyless SSL was last modified. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesName' + permissions: + description: >- + Available permissions for the Keyless SSL for the current user + requesting the item. + example: + - '#ssl:read' + - '#ssl:edit' + items: + type: string + x-auditable: true + readOnly: true + type: array + port: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPort' + status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasStatus' + tunnel: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessTunnel' + required: + - id + - name + - host + - port + - status + - enabled + - permissions + - created_on + - modified_on + type: object + tlsCertificatesAndHostnamesBundleMethod: + $ref: '#/components/schemas/unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1' + tlsCertificatesAndHostnamesCertificate: + description: The zone's SSL certificate or certificate and the intermediate(s). + example: | + -----BEGIN CERTIFICATE----- + MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV + BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX + aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF + MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 + ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB + CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 + CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB + KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 + 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI + dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 + izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 + 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI + GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV + BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF + MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 + 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP + Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG + SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq + 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw + YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= + -----END CERTIFICATE----- + type: string + tlsCertificatesAndHostnamesCertificateResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCertificate' + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCertificateResponseIdOnly: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCertificateResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCertificate' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCustomCertificate: + properties: + bundle_method: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBundleMethod' + custom_csr_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCsrId' + expires_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesExpiresOn' + geo_restrictions: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesGeoRestrictions' + hosts: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHosts' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + keyless_server: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessCertificate' + modified_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesModifiedOn' + readOnly: true + policy_restrictions: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPolicyRestrictions' + priority: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPriority' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesStatus' + uploaded_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUploadedOn' + zone_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: + - id + - zone_id + type: object + tlsCertificatesAndHostnamesCustomCsrId: + description: The identifier for the Custom CSR that was used. + example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752 + type: string + x-auditable: true + tlsCertificatesAndHostnamesDeploy: + default: production + description: The environment to deploy the certificate to, defaults to production + enum: + - staging + - production + example: staging + type: string + x-auditable: true + tlsCertificatesAndHostnamesEnabled: + description: Whether or not the Keyless SSL is on or off. + example: false + readOnly: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesExpiresOn: + description: When the certificate from the authority expires. + example: '2016-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesGeoRestrictions: + description: >- + Specify the region where your private key can be held locally for + optimal TLS performance. HTTPS connections to any excluded data center + will still be fully encrypted, but will incur some latency while Keyless + SSL is used to complete the handshake with the nearest allowed data + center. Options allow distribution to only to U.S. data centers, only to + E.U. data centers, or only to highest security data centers. Default + distribution is to all Cloudflare datacenters, for optimal performance. + properties: + label: + enum: + - us + - eu + - highest_security + example: us + type: string + x-auditable: true + type: object + tlsCertificatesAndHostnamesHost: + description: The keyless SSL name. + example: example.com + format: hostname + maxLength: 253 + type: string + x-auditable: true + tlsCertificatesAndHostnamesHosts: + items: + description: The valid hosts for the certificates. + example: example.com + maxLength: 253 + readOnly: true + type: string + x-auditable: true + type: array + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesIssuer: + description: The certificate authority that issued the certificate. + example: GlobalSign + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesKeylessCertificate: + type: object + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBase' + tlsCertificatesAndHostnamesKeylessPrivateIp: + description: Private IP of the Key Server Host + example: 10.0.0.1 + type: string + x-auditable: true + tlsCertificatesAndHostnamesKeylessTunnel: + description: Configuration for using Keyless SSL through a Cloudflare Tunnel + properties: + private_ip: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessPrivateIp' + vnet_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessVnetId' + required: + - private_ip + - vnet_id + type: object + tlsCertificatesAndHostnamesKeylessVnetId: + description: Cloudflare Tunnel Virtual Network ID + example: 7365377a-85a4-4390-9480-531ef7dc7a3c + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesModifiedOn: + description: When the certificate was last modified. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesName: + description: The keyless SSL name. + example: example.com Keyless SSL + maxLength: 180 + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesPolicy: + description: >- + Specify the policy that determines the region where your private key + will be held locally. HTTPS connections to any excluded data center will + still be fully encrypted, but will incur some latency while Keyless SSL + is used to complete the handshake with the nearest allowed data center. + Any combination of countries, specified by their two letter country code + (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + can be chosen, such as 'country: IN', as well as 'region: EU' which + refers to the EU region. If there are too few data centers satisfying + the policy, it will be rejected. Note: The API accepts this field as + either "policy" or "policy_restrictions" in requests. Responses return + this field as "policy_restrictions". + example: '(country: US) or (region: EU)' + type: string + x-auditable: true + tlsCertificatesAndHostnamesPolicyRestrictions: + description: >- + The policy restrictions returned by the API. This field is returned in + responses when a policy has been set. The API accepts the "policy" field + in requests but returns this field as "policy_restrictions" in + responses. Specifies the region(s) where your private key can be held + locally for optimal TLS performance. Format is a boolean expression, for + example: "(country: US) or (region: EU)" + example: '(country: US) or (region: EU)' + readOnly: true + type: string + tlsCertificatesAndHostnamesPort: + default: 24008 + description: >- + The keyless SSL port used to communicate between Cloudflare and the + client's Keyless SSL server. + example: 24008 + maxLength: 65535 + type: number + x-auditable: true + tlsCertificatesAndHostnamesPriority: + default: 0 + description: >- + The order/priority in which the certificate will be used in a request. + The higher priority will break ties across overlapping 'legacy_custom' + certificates, but 'legacy_custom' certificates will always supercede + 'sni_custom' certificates. + example: 1 + type: number + x-auditable: true + tlsCertificatesAndHostnamesPrivateKey: + description: The zone's private key. + example: | + -----BEGIN RSA PRIVATE KEY----- + MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG + dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn + abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid + tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py + FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE + ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb + HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ + axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb + +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g + +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv + KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 + 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo + /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu + iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 + N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe + VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB + vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U + lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR + 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 + mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX + dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe + PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS + fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W + qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T + lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi + -----END RSA PRIVATE KEY----- + type: string + x-sensitive: true + tlsCertificatesAndHostnamesSchemasIdentifier: + description: Keyless certificate identifier tag. + example: 4d2844d2ce78891c34d0b6c0535a291e + maxLength: 32 + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasStatus: + description: Status of the Keyless SSL. + enum: + - active + - deleted + example: active + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSignature: + description: The type of hash used for the certificate. + example: SHA256WithRSA + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesStatus: + description: Status of the zone's custom SSL. + enum: + - active + - expired + - deleted + - pending + - initializing + example: active + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesType: + default: legacy_custom + description: >- + The type 'legacy_custom' enables support for legacy clients which do not + include SNI in the TLS handshake. + enum: + - legacy_custom + - sni_custom + example: sni_custom + type: string + x-auditable: true + tlsCertificatesAndHostnamesUploadedOn: + description: When the certificate was uploaded to Cloudflare. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1: + default: ubiquitous + description: >- + A ubiquitous bundle has the highest probability of being verified + everywhere, even by clients using outdated or unusual trust stores. An + optimal bundle uses the shortest chain and newest intermediates. And the + force bundle verifies the chain, but does not otherwise modify it. + enum: + - ubiquitous + - optimal + - force + example: ubiquitous + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + custom_certificates: + id: cloudflare.custom_certificates.custom_certificates + name: custom_certificates + title: Custom Certificates + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_certificates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update_prioritize: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_certificates~1prioritize/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_certificates~1{custom_certificate_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_certificates~1{custom_certificate_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_certificates~1{custom_certificate_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_certificates/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_certificates/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_certificates/methods/create + update: + - $ref: '#/components/x-stackQL-resources/custom_certificates/methods/edit' + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_certificates/methods/delete + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/custom_hostnames.yaml b/providers/src/cloudflare/v00.00.00000/services/custom_hostnames.yaml index ec9cb50d..04d962f1 100644 --- a/providers/src/cloudflare/v00.00.00000/services/custom_hostnames.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/custom_hostnames.yaml @@ -1,727 +1,439 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Custom Hostname Fallback Origin for a Zone - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - custom_hostnames + title: custom_hostnames API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - fallback_origin_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/custom_hostnames: + get: + description: List, search, sort, and filter all of your custom hostnames. + operationId: custom-hostname-for-a-zone-list-custom-hostnames + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - origin: - description: Your origin hostname that requests to your custom hostnames will be sent to. - example: fallback.example.com - maxLength: 255 - type: string - custom_hostname_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/custom-hostname' - type: array - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - custom-hostname: - allOf: - - $ref: '#/components/schemas/customhostname' - properties: - hostname: - $ref: '#/components/schemas/hostname' - id: - $ref: '#/components/schemas/custom-hostname_components-schemas-identifier' - ssl: - $ref: '#/components/schemas/schemas-ssl' - required: - - id - - hostname - - ssl - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - customhostname: - properties: - created_at: - $ref: '#/components/schemas/created_at' - custom_metadata: - $ref: '#/components/schemas/custom_metadata' - custom_origin_server: - $ref: '#/components/schemas/custom_origin_server' - custom_origin_sni: - $ref: '#/components/schemas/custom_origin_sni' - hostname: - $ref: '#/components/schemas/hostname' - id: - $ref: '#/components/schemas/custom-hostname_components-schemas-identifier' - ownership_verification: - $ref: '#/components/schemas/ownership_verification' - ownership_verification_http: - $ref: '#/components/schemas/ownership_verification_http' - ssl: - $ref: '#/components/schemas/schemas-ssl' - status: - $ref: '#/components/schemas/custom-hostname_components-schemas-status' - verification_errors: - $ref: '#/components/schemas/verification_errors' - hostname: - description: The custom hostname that will point to your hostname via CNAME. - example: app.example.com - maxLength: 255 - readOnly: true - type: string - custom-hostname_components-schemas-identifier: - description: Custom hostname identifier tag. - example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 - maxLength: 36 - minLength: 36 - readOnly: true - type: string - schemas-ssl: - description: SSL properties for the custom hostname. - oneOf: - - properties: - bundle_method: - default: ubiquitous - description: 'A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.' - enum: - - ubiquitous - - optimal - - force - example: ubiquitous - type: string - certificate_authority: - description: The Certificate Authority that has issued this certificate. - enum: - - digicert - - google - - lets_encrypt - example: digicert - type: string - custom_certificate: - description: If a custom uploaded certificate is used. - example: '-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n' - type: string - custom_csr_id: - description: The identifier for the Custom CSR that was used. - example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752 - type: string - custom_key: - description: The key for a custom uploaded certificate. - example: | - -----BEGIN RSA PRIVATE KEY----- - MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG - dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn - abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid - tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py - FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE - ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb - HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ - axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb - +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g - +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv - KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 - 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo - /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu - iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 - N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe - VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB - vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U - lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR - 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 - mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX - dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe - PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS - fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W - qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T - lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi - -----END RSA PRIVATE KEY----- - type: string - expires_on: - description: The time the custom certificate expires on. - example: '2021-02-06T18:11:23.531995Z' - format: date-time - type: string - hosts: - description: A list of Hostnames on a custom uploaded certificate. - example: - - app.example.com - - '*.app.example.com' - items: {} - type: array - id: - description: Custom hostname SSL identifier tag. - example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 - maxLength: 36 - minLength: 36 - type: string - issuer: - description: The issuer on a custom uploaded certificate. - example: DigiCertInc - type: string - method: - description: Domain control validation (DCV) method used for this hostname. - enum: - - http - - txt - - email - example: txt - serial_number: - description: The serial number on a custom uploaded certificate. - example: '6743787633689793699141714808227354901' - type: string - settings: - $ref: '#/components/schemas/sslsettings' - signature: - description: The signature on a custom uploaded certificate. - example: SHA256WithRSA - type: string - status: - description: Status of the hostname's SSL certificates. - enum: - - initializing - - pending_validation - - deleted - - pending_issuance - - pending_deployment - - pending_deletion - - pending_expiration - - expired - - active - - initializing_timed_out - - validation_timed_out - - issuance_timed_out - - deployment_timed_out - - deletion_timed_out - - pending_cleanup - - staging_deployment - - staging_active - - deactivating - - inactive - - backup_issued - - holding_deployment - example: pending_validation - readOnly: true - type: - description: Level of validation to be used for this hostname. Domain validation (dv) must be used. - enum: - - dv - example: dv - readOnly: true - uploaded_on: - description: The time the custom certificate was uploaded. - example: '2020-02-06T18:11:23.531995Z' - format: date-time - type: string - validation_errors: - description: Domain validation errors that have been received by the certificate authority (CA). - items: - properties: - message: - description: A domain validation error. - example: SERVFAIL looking up CAA for app.example.com - type: string + - in: query + name: hostname + schema: + description: >- + Fully qualified domain name to match against. This parameter + cannot be used with the 'id' parameter. + maxLength: 255 + type: string + - in: query + name: hostname.contain + schema: + description: >- + Filters hostnames by a substring match on the hostname value. This + parameter cannot be used with the 'id' parameter. + maxLength: 255 + type: string + - in: query + name: id + schema: + description: >- + Hostname ID to match against. This ID was generated and returned + during the initial custom_hostname creation. This parameter cannot + be used with the 'hostname' parameter. + maxLength: 36 + minLength: 36 + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of hostnames per page. + maximum: 1000 + minimum: 5 + type: number + - in: query + name: order + schema: + default: ssl + description: Field to order hostnames by. + enum: + - ssl + - ssl_status + type: string + - in: query + name: direction + schema: + description: Direction to order hostnames. + enum: + - asc + - desc + type: string + - in: query + name: ssl_status + schema: + description: Filter by SSL certificate status. + enum: + - initializing + - pending_validation + - deleted + - pending_issuance + - pending_deployment + - pending_deletion + - pending_expiration + - expired + - active + - initializing_timed_out + - validation_timed_out + - issuance_timed_out + - deployment_timed_out + - deletion_timed_out + - pending_cleanup + - staging_deployment + - staging_active + - deactivating + - inactive + - backup_issued + - holding_deployment + type: string + - in: query + name: hostname_status + schema: + description: Filter by the hostname's activation status. + enum: + - active + - pending + - active_redeploying + - moved + - pending_deletion + - deleted + - pending_blocked + - pending_migration + - pending_provisioned + - test_pending + - test_active + - test_active_apex + - test_blocked + - test_failed + - provisioned + - blocked + type: string + - in: query + name: certificate_authority + schema: + description: >- + Filter by the certificate authority that issued the SSL + certificate. + enum: + - google + - lets_encrypt + - ssl_com + type: string + - in: query + name: wildcard + schema: + description: Filter by whether the custom hostname is a wildcard hostname. + type: boolean + - in: query + name: custom_origin_server + schema: + description: Filter by custom origin server name. + type: string + - in: query + name: ssl + schema: + description: Whether to filter hostnames based on if they have SSL enabled. + enum: + - 0 + - 1 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameResponseCollection + description: List Custom Hostnames response + 4XX: + content: + application/json: + schema: type: object - type: array - validation_records: - items: - $ref: '#/components/schemas/validation_record' - type: array - wildcard: - description: Indicates whether the certificate covers a wildcard. - example: false - type: boolean - type: object - type: object - created_at: - description: This is the time the hostname was created. - example: '2020-02-06T18:11:23.531995Z' - format: date-time - type: string - custom_metadata: - anyOf: - - properties: - key: - description: Unique metadata for this hostname. - example: value - type: string - type: object - description: These are per-hostname (customer) settings. - type: object - custom_origin_server: - description: 'a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.' - example: origin2.example.com - type: string - custom_origin_sni: - description: 'A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string '':request_host_header:'' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.' - example: sni.example.com - type: string - ownership_verification: - description: This is a record which can be placed to activate a hostname. - oneOf: - - properties: - name: - description: DNS Name for record. - example: _cf-custom-hostname.app.example.com - type: string - type: - description: DNS Record type. - enum: - - txt - example: txt - value: - description: Content for the record. - example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 - type: string - type: object - type: object - ownership_verification_http: - description: This presents the token to be served by the given http url to activate a hostname. - oneOf: - - properties: - http_body: - description: Token to be served. - example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 - type: string - http_url: - description: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token. - example: 'http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9' - type: string - type: object - type: object - custom-hostname_components-schemas-status: - description: Status of the hostname's activation. - enum: - - active - - pending - - active_redeploying - - moved - - pending_deletion - - deleted - - pending_blocked - - pending_migration - - pending_provisioned - - test_pending - - test_active - - test_active_apex - - test_blocked - - test_failed - - provisioned - - blocked - example: pending - verification_errors: - description: These are errors that were encountered while trying to activate a hostname. - example: - - None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found. - items: {} - type: array - sslsettings: - description: SSL specific settings. - properties: - ciphers: - description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. - example: - - ECDHE-RSA-AES128-GCM-SHA256 - - AES128-SHA - items: + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostname + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Custom Hostnames response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Custom Hostnames + tags: + - Custom Hostname for a Zone + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: custom_hostnames + resource_chain: [] + method: list + post: + description: >- + Add a new custom hostname and request that an SSL certificate be issued + for it. One of three validation methods—http, txt, email—should be used, + with 'http' recommended if the CNAME is already in place (or will be + soon). Specifying 'email' will send an email to the WHOIS contacts on + file for the base domain plus hostmaster, postmaster, webmaster, admin, + administrator. If http is used and the domain is not already pointing to + the Managed CNAME host, the PATCH method must be used once it is (to + complete validation). Enable bundling of certificates using the + custom_cert_bundle field. The bundling process requires the following + condition One certificate in the bundle must use an RSA, and the other + must use an ECDSA. + operationId: custom-hostname-for-a-zone-create-custom-hostname + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - type: array - uniqueItems: true - early_hints: - description: Whether or not Early Hints is enabled. - enum: - - 'on' - - 'off' - example: 'on' - http2: - description: Whether or not HTTP2 is enabled. - enum: - - 'on' - - 'off' - example: 'on' - min_tls_version: - description: The minimum TLS version supported. - enum: - - '1.0' - - '1.1' - - '1.2' - - '1.3' - example: '1.2' - tls_1_3: - description: Whether or not TLS 1.3 is enabled. - enum: - - 'on' - - 'off' - example: 'on' - type: object - validation_record: - description: Certificate's required validation record. - properties: - emails: - description: The set of email addresses that the certificate authority (CA) will use to complete domain validation. - example: - - administrator@example.com - - webmaster@example.com - items: {} - type: array - http_body: - description: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation. - example: ca3-574923932a82475cb8592200f1a2a23d - type: string - http_url: - description: The url that will be checked during domain validation. - example: 'http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt' - type: string - txt_name: - description: The hostname that the certificate authority (CA) will check for a TXT record during domain validation . - example: _acme-challenge.app.example.com - type: string - txt_value: - description: The TXT record that the certificate authority (CA) will check during domain validation. - example: 810b7d5f01154524b961ba0cd578acc2 - type: string - type: object - sslpost: - description: SSL properties used when creating the custom hostname. - oneOf: - - properties: - bundle_method: - default: ubiquitous - description: 'A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.' - enum: - - ubiquitous - - optimal - - force - example: ubiquitous - type: string - custom_certificate: - description: If a custom uploaded certificate is used. - example: '-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n' - type: string - custom_key: - description: The key for a custom uploaded certificate. - example: | - -----BEGIN RSA PRIVATE KEY----- - MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG - dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn - abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid - tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py - FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE - ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb - HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ - axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb - +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g - +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv - KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 - 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo - /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu - iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 - N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe - VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB - vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U - lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR - 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 - mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX - dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe - PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS - fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W - qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T - lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi - -----END RSA PRIVATE KEY----- - type: string - method: - description: Domain control validation (DCV) method used for this hostname. - enum: - - http - - txt - - email - example: http - settings: - $ref: '#/components/schemas/sslsettings' - type: - description: Level of validation to be used for this hostname. Domain validation (dv) must be used. - enum: - - dv - example: dv - readOnly: true - wildcard: - description: Indicates whether the certificate covers a wildcard. - example: false - type: boolean - type: object - type: object - custom_hostname_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: + requestBody: + content: + application/json: + schema: + properties: + custom_metadata: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomMetadata + hostname: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHostnamePost' + ssl: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSslpost' + required: + - hostname type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_fallback_origin: - id: cloudflare.custom_hostnames.zones_fallback_origin - name: zones_fallback_origin - title: Zones Fallback Origin - methods: - custom_hostname_fallback_origin_for_a_zone_delete_fallback_origin_for_custom_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1fallback_origin/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_hostname_fallback_origin_for_a_zone_get_fallback_origin_for_custom_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1fallback_origin/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _custom_hostname_fallback_origin_for_a_zone_get_fallback_origin_for_custom_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1fallback_origin/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_hostname_fallback_origin_for_a_zone_update_fallback_origin_for_custom_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1fallback_origin/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_fallback_origin/methods/custom_hostname_fallback_origin_for_a_zone_get_fallback_origin_for_custom_hostnames' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_fallback_origin/methods/custom_hostname_fallback_origin_for_a_zone_delete_fallback_origin_for_custom_hostnames' - zones: - id: cloudflare.custom_hostnames.zones - name: zones - title: Zones - methods: - custom_hostname_for_a_zone_list_custom_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _custom_hostname_for_a_zone_list_custom_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_hostname_for_a_zone_create_custom_hostname: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames/post' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_hostname_for_a_zone_delete_custom_hostname___and_any_issued_ssl_certificates_: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_hostname_for_a_zone_custom_hostname_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _custom_hostname_for_a_zone_custom_hostname_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_hostname_for_a_zone_edit_custom_hostname: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_hostnames~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones/methods/custom_hostname_for_a_zone_list_custom_hostnames' - - $ref: '#/components/x-stackQL-resources/zones/methods/custom_hostname_for_a_zone_custom_hostname_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones/methods/custom_hostname_for_a_zone_create_custom_hostname' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones/methods/custom_hostname_for_a_zone_delete_custom_hostname___and_any_issued_ssl_certificates_' -paths: - '/zones/{zone_identifier}/custom_hostnames/fallback_origin': + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameResponseSingle + description: Create Custom Hostname response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefD2a16d7ee1ad3a888dd5821c918d51fd + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Custom Hostname response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Custom Hostname + tags: + - Custom Hostname for a Zone + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: custom_hostnames + resource_chain: [] + method: create + /zones/{zone_id}/custom_hostnames/fallback_origin: delete: - operationId: custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames + description: >- + Removes the fallback origin configuration for custom hostnames on a + zone. Custom hostnames without specific origins will no longer have a + fallback. + operationId: >- + custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/fallback_origin_response' + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesFallbackOriginResponse description: Delete Fallback Origin for Custom Hostnames response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/fallback_origin_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCreatedAt + readOnly: true + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesErrors' + origin: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesOrigin' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameFallbackOriginComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUpdatedAt + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: Delete Fallback Origin for Custom Hostnames response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Fallback Origin for Custom Hostnames tags: - Custom Hostname Fallback Origin for a Zone + x-api-token-group: + - SSL and Certificates Write x-cfPermissionsRequired: enum: - '#ssl:edit' @@ -730,36 +442,88 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: custom_hostnames + resource_chain: + - fallback_origin + method: delete get: - operationId: custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames + description: >- + Retrieves the current fallback origin configuration for custom hostnames + on a zone. The fallback origin handles traffic when specific custom + hostname origins are unavailable. + operationId: >- + custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/fallback_origin_response' + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesFallbackOriginResponse description: Get Fallback Origin for Custom Hostnames response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/fallback_origin_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCreatedAt + readOnly: true + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesErrors' + origin: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesOrigin' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameFallbackOriginComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUpdatedAt + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: Get Fallback Origin for Custom Hostnames response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Get Fallback Origin for Custom Hostnames tags: - Custom Hostname Fallback Origin for a Zone + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read x-cfPermissionsRequired: enum: - '#ssl:read' @@ -768,47 +532,96 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: custom_hostnames + resource_chain: + - fallback_origin + method: get put: - operationId: custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames + description: >- + Updates the fallback origin configuration for custom hostnames on a + zone. Sets the default origin server for custom hostname traffic. + operationId: >- + custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: origin: - $ref: '#/components/schemas/origin' + $ref: '#/components/schemas/tlsCertificatesAndHostnamesOrigin' required: - origin type: object - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/fallback_origin_response' + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesFallbackOriginResponse description: Update Fallback Origin for Custom Hostnames response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/fallback_origin_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCreatedAt + readOnly: true + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesErrors' + origin: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesOrigin' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameFallbackOriginComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesUpdatedAt + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: Update Fallback Origin for Custom Hostnames response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update Fallback Origin for Custom Hostnames tags: - Custom Hostname Fallback Origin for a Zone + x-api-token-group: + - SSL and Certificates Write x-cfPermissionsRequired: enum: - '#ssl:edit' @@ -817,145 +630,253 @@ paths: enterprise: true free: true pro: true - '/zones/{zone_identifier}/custom_hostnames': - get: - description: 'List, search, sort, and filter all of your custom hostnames.' - operationId: custom-hostname-for-a-zone-list-custom-hostnames + x-stackql-sdk: + service: custom_hostnames + resource_chain: + - fallback_origin + method: update + /zones/{zone_id}/custom_hostnames/{custom_hostname_id}: + delete: + description: >- + Permanently deletes a custom hostname and revokes any SSL certificates + that were issued for it. This action cannot be undone. + operationId: >- + custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates) parameters: - in: path - name: zone_identifier + name: custom_hostname_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/custom_hostname_response_collection' - description: List Custom Hostnames response - 4xx: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + description: Delete Custom Hostname (and any issued SSL certificates) response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_hostname_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Custom Hostnames response failure + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + errors: + minLength: 1 + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: >- + Delete Custom Hostname (and any issued SSL certificates) response + failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List Custom Hostnames + summary: Delete Custom Hostname (and any issued SSL certificates) tags: - Custom Hostname for a Zone + x-api-token-group: + - SSL and Certificates Write x-cfPermissionsRequired: enum: - - '#ssl:read' + - '#ssl:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true - post: - description: 'Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with ''http'' recommended if the CNAME is already in place (or will be soon). Specifying ''email'' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation).' - operationId: custom-hostname-for-a-zone-create-custom-hostname + x-stackql-sdk: + service: custom_hostnames + resource_chain: [] + method: delete + get: + description: >- + Retrieves detailed information about a specific custom hostname, + including SSL certificate status, ownership verification, and origin + configuration. + operationId: custom-hostname-for-a-zone-custom-hostname-details parameters: - in: path - name: zone_identifier + name: custom_hostname_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - hostname: - $ref: '#/components/schemas/hostname' - ssl: - $ref: '#/components/schemas/sslpost' - required: - - hostname - - ssl - type: object - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/custom_hostname_response_single' - description: Create Custom Hostname response - 4xx: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameResponseSingle + description: Custom Hostname Details response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_hostname_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Custom Hostname response failure + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefD2a16d7ee1ad3a888dd5821c918d51fd + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Custom Hostname Details response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create Custom Hostname + summary: Custom Hostname Details tags: - Custom Hostname for a Zone + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read x-cfPermissionsRequired: enum: - - '#ssl:edit' + - '#ssl:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/custom_hostnames/{identifier}': - delete: - operationId: custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates) + x-stackql-sdk: + service: custom_hostnames + resource_chain: [] + method: get + patch: + description: >- + Modify SSL configuration for a custom hostname. When sent with SSL + config that matches existing config, used to indicate that hostname + should pass domain control validation (DCV). Can also be used to change + validation type, e.g., from 'http' to 'email'. Bundle an existing + certificate with another certificate by using the "custom_cert_bundle" + field. The bundling process supports combining certificates as long as + the following condition is met. One certificate must use the RSA + algorithm, and the other must use the ECDSA algorithm. + operationId: custom-hostname-for-a-zone-edit-custom-hostname parameters: - in: path - name: identifier - required: true + name: custom_hostname_id schema: - $ref: '#/components/schemas/custom-hostname_components-schemas-identifier' - - in: path - name: zone_identifier + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: - application/json: {} - required: true + application/json: + schema: + properties: + custom_metadata: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomMetadata + custom_origin_server: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomOriginServer + custom_origin_sni: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomOriginSni + ssl: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSslpost' + type: object responses: '200': content: application/json: schema: - properties: - id: - $ref: '#/components/schemas/custom-hostname_components-schemas-identifier' - type: object - description: Delete Custom Hostname (and any issued SSL certificates) response - 4xx: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameResponseSingle + description: Edit Custom Hostname response + 4XX: content: application/json: schema: - allOf: - - properties: - id: - $ref: '#/components/schemas/custom-hostname_components-schemas-identifier' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Custom Hostname (and any issued SSL certificates) response failure + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefD2a16d7ee1ad3a888dd5821c918d51fd + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit Custom Hostname response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Delete Custom Hostname (and any issued SSL certificates) + summary: Edit Custom Hostname tags: - Custom Hostname for a Zone + x-api-token-group: + - SSL and Certificates Write x-cfPermissionsRequired: enum: - '#ssl:edit' @@ -964,105 +885,1124 @@ paths: enterprise: true free: true pro: true - get: - operationId: custom-hostname-for-a-zone-custom-hostname-details + x-stackql-sdk: + service: custom_hostnames + resource_chain: [] + method: edit + /zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id}: + delete: + description: >- + Delete a single custom certificate from a certificate pack that contains + two bundled certificates. Deletion is subject to the following + constraints. You cannot delete a certificate if it is the only remaining + certificate in the pack. At least one certificate must remain in the + pack. + operationId: >- + custom-hostname-for-a-zone-delete_single_certificate_and_key_in_a_custom_hostname parameters: - in: path - name: identifier - required: true + name: custom_hostname_id schema: - $ref: '#/components/schemas/custom-hostname_components-schemas-identifier' + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true - in: path - name: zone_identifier + name: certificate_pack_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: certificate_id + in: path required: true + description: The certificate ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string responses: - '200': + '202': content: application/json: schema: - $ref: '#/components/schemas/custom_hostname_response_single' - description: Custom Hostname Details response - 4xx: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + description: Delete Single Certificate and Key In a Custom Hostname response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_hostname_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Custom Hostname Details response failure + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + errors: + minLength: 1 + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: >- + Delete Single Certificate and Key In a Custom Hostname response + failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Custom Hostname Details + summary: Delete Single Certificate And Key For Custom Hostname tags: - Custom Hostname for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:read' + x-api-token-group: + - SSL and Certificates Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - patch: - description: 'Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from ''http'' to ''email''.' - operationId: custom-hostname-for-a-zone-edit-custom-hostname + x-stackql-sdk: + service: custom_hostnames + resource_chain: + - certificate_pack + - certificates + method: delete + put: + description: >- + Replace a single custom certificate within a certificate pack that + contains two bundled certificates. The replacement must adhere to the + following constraints. You can only replace an RSA certificate with + another RSA certificate or an ECDSA certificate with another ECDSA + certificate. + operationId: custom-hostname-for-a-zone-edit-custom-certificate-custom-hostname parameters: - in: path - name: identifier - required: true + name: custom_hostname_id schema: - $ref: '#/components/schemas/custom-hostname_components-schemas-identifier' + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true - in: path - name: zone_identifier + name: certificate_pack_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - custom_metadata: - $ref: '#/components/schemas/custom_metadata' - custom_origin_server: - $ref: '#/components/schemas/custom_origin_server' - custom_origin_sni: - $ref: '#/components/schemas/custom_origin_sni' - ssl: - $ref: '#/components/schemas/sslpost' - type: object - required: true + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCertAndKey' responses: - '200': + '202': content: application/json: schema: - $ref: '#/components/schemas/custom_hostname_response_single' - description: Edit Custom Hostname response - 4xx: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameResponseSingle + description: Edit Custom Certificate In a Custom Hostname response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_hostname_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Custom Hostname response failure + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefD2a16d7ee1ad3a888dd5821c918d51fd + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit Custom Certificate In a Custom Hostname response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Edit Custom Hostname + summary: Replace Custom Certificate and Custom Key In Custom Hostname tags: - Custom Hostname for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' + x-api-token-group: + - SSL and Certificates Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: custom_hostnames + resource_chain: + - certificate_pack + - certificates + method: update +components: + schemas: + tlsCertificatesAndHostnamesCertificateAuthority: + description: The Certificate Authority that will issue the certificate + enum: + - digicert + - google + - lets_encrypt + - ssl_com + example: google + type: string + x-auditable: true + tlsCertificatesAndHostnamesComponentsSchemasStatus: + description: Status of the hostname's activation. + enum: + - active + - pending + - active_redeploying + - moved + - pending_deletion + - deleted + - pending_blocked + - pending_migration + - pending_provisioned + - test_pending + - test_active + - test_active_apex + - test_blocked + - test_failed + - provisioned + - blocked + example: pending + type: string + x-auditable: true + tlsCertificatesAndHostnamesCreatedAt: + description: This is the time the hostname was created. + example: '2020-02-06T18:11:23.531995Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesCustomCertAndKey: + properties: + custom_certificate: + description: If a custom uploaded certificate is used. + example: | + -----BEGIN CERTIFICATE----- + MIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx... + -----END CERTIFICATE----- + type: string + custom_key: + description: The key for a custom uploaded certificate. + example: | + -----BEGIN PRIVATE KEY----- + MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5... + -----END PRIVATE KEY----- + type: string + x-sensitive: true + required: + - custom_certificate + - custom_key + type: object + tlsCertificatesAndHostnamesCustomCertBundle: + description: Array of custom certificate and key pairs (1 or 2 pairs allowed) + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCertAndKey' + maxItems: 2 + minItems: 1 + type: array + tlsCertificatesAndHostnamesCustomHostname: + properties: + hostname: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHostname' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + ssl: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSsl' + created_at: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCreatedAt' + readOnly: true + custom_metadata: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomMetadata' + custom_origin_server: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomOriginServer' + custom_origin_sni: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomOriginSni' + ownership_verification: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesOwnershipVerification + ownership_verification_http: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesOwnershipVerificationHttp + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasStatus + verification_errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesVerificationErrors' + required: + - id + - hostname + type: object + tlsCertificatesAndHostnamesCustomHostnameFallbackOriginComponentsSchemasStatus: + description: Status of the fallback origin's activation. + enum: + - initializing + - pending_deployment + - pending_deletion + - active + - deployment_timed_out + - deletion_timed_out + example: pending_deployment + type: string + x-auditable: true + tlsCertificatesAndHostnamesCustomHostnameResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomHostname' + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCustomHostnameResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomHostname' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCustomMetadata: + description: >- + Unique key/value metadata for this hostname. These are per-hostname + (customer) settings. + type: object + tlsCertificatesAndHostnamesCustomOriginServer: + description: >- + a valid hostname that’s been added to your DNS zone as an A, AAAA, or + CNAME record. + example: origin2.example.com + type: string + x-auditable: true + tlsCertificatesAndHostnamesCustomOriginSni: + description: >- + A hostname that will be sent to your custom origin server as SNI for TLS + handshake. This can be a valid subdomain of the zone or custom origin + server name or the string ':request_host_header:' which will cause the + host header in the request to be used as SNI. Not configurable with + default/fallback origin server. + example: sni.example.com + type: string + x-auditable: true + tlsCertificatesAndHostnamesErrors: + description: >- + These are errors that were encountered while trying to activate a + fallback origin. + example: + - >- + DNS records are not setup correctly. Origin should be a proxied + A/AAAA/CNAME dns record + items: + type: string + x-auditable: true + type: array + tlsCertificatesAndHostnamesFallbackOriginResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesFallbackorigin' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesFallbackorigin: + properties: + created_at: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasCreatedAt' + readOnly: true + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesErrors' + origin: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesOrigin' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCustomHostnameFallbackOriginComponentsSchemasStatus + updated_at: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUpdatedAt' + readOnly: true + type: object + tlsCertificatesAndHostnamesHostname: + description: The custom hostname that will point to your hostname via CNAME. + example: app.example.com + maxLength: 255 + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesHostnamePost: + description: The custom hostname that will point to your hostname via CNAME. + example: app.example.com + maxLength: 255 + type: string + x-auditable: true + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesOrigin: + description: >- + Your origin hostname that requests to your custom hostnames will be sent + to. + example: fallback.example.com + maxLength: 255 + type: string + x-auditable: true + tlsCertificatesAndHostnamesOwnershipVerification: + description: This is a record which can be placed to activate a hostname. + type: object + properties: + name: + description: DNS Name for record. + example: _cf-custom-hostname.app.example.com + type: string + x-auditable: true + type: + description: DNS Record type. + enum: + - txt + example: txt + type: string + x-auditable: true + value: + description: Content for the record. + example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 + type: string + tlsCertificatesAndHostnamesOwnershipVerificationHttp: + description: >- + This presents the token to be served by the given http url to activate a + hostname. + type: object + properties: + http_body: + description: Token to be served. + example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 + type: string + http_url: + description: >- + The HTTP URL that will be checked during custom hostname + verification and where the customer should host the token. + example: >- + http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9 + type: string + tlsCertificatesAndHostnamesSchemasCreatedAt: + description: This is the time the fallback origin was created. + example: '2019-10-28T18:11:23.37411Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesSsl: + description: SSL properties for the custom hostname. + type: object + properties: + bundle_method: + $ref: >- + #/components/schemas/unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1 + certificate_authority: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificateAuthority' + custom_certificate: + description: If a custom uploaded certificate is used. + example: > + -----BEGIN CERTIFICATE----- + + MIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN + + MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O + + OeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7 + + -----END CERTIFICATE----- + type: string + custom_csr_id: + description: The identifier for the Custom CSR that was used. + example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752 + type: string + x-auditable: true + custom_key: + description: The key for a custom uploaded certificate. + example: | + -----BEGIN RSA PRIVATE KEY----- + MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG + dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn + abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid + tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py + FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE + ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb + HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ + axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb + +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g + +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv + KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 + 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo + /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu + iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 + N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe + VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB + vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U + lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR + 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 + mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX + dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe + PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS + fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W + qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T + lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi + -----END RSA PRIVATE KEY----- + type: string + x-sensitive: true + dcv_delegation_records: + description: DCV Delegation records for domain validation. + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidationRecord' + readOnly: true + type: array + expires_on: + description: The time the custom certificate expires on. + example: '2021-02-06T18:11:23.531995Z' + format: date-time + type: string + x-auditable: true + hosts: + description: A list of Hostnames on a custom uploaded certificate. + example: + - app.example.com + - '*.app.example.com' + items: + type: string + x-auditable: true + type: array + id: + description: Custom hostname SSL identifier tag. + example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 + maxLength: 36 + minLength: 36 + type: string + x-auditable: true + issuer: + description: The issuer on a custom uploaded certificate. + example: DigiCertInc + type: string + x-auditable: true + method: + $ref: >- + #/components/schemas/unnamedSchemaRef78adb375f06c6d462dd92b99e2ecf510 + serial_number: + description: The serial number on a custom uploaded certificate. + example: '6743787633689793699141714808227354901' + type: string + x-auditable: true + settings: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSslsettings' + signature: + description: The signature on a custom uploaded certificate. + example: SHA256WithRSA + type: string + x-auditable: true + status: + description: Status of the hostname's SSL certificates. + enum: + - initializing + - pending_validation + - deleted + - pending_issuance + - pending_deployment + - pending_deletion + - pending_expiration + - expired + - active + - initializing_timed_out + - validation_timed_out + - issuance_timed_out + - deployment_timed_out + - deletion_timed_out + - pending_cleanup + - staging_deployment + - staging_active + - deactivating + - inactive + - backup_issued + - holding_deployment + example: pending_validation + readOnly: true + type: string + x-auditable: true + type: + $ref: >- + #/components/schemas/unnamedSchemaRef9a9935a9a770967bb604ae41a81e42e1 + uploaded_on: + description: The time the custom certificate was uploaded. + example: '2020-02-06T18:11:23.531995Z' + format: date-time + type: string + x-auditable: true + validation_errors: + description: >- + Domain validation errors that have been received by the certificate + authority (CA). + items: + properties: + message: + description: A domain validation error. + example: SERVFAIL looking up CAA for app.example.com + type: string + x-auditable: true + type: object + type: array + validation_records: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidationRecord' + type: array + wildcard: + description: Indicates whether the certificate covers a wildcard. + example: false + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesSslpost: + description: SSL properties used when creating the custom hostname. + type: object + properties: + bundle_method: + $ref: >- + #/components/schemas/unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1 + certificate_authority: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificateAuthority' + cloudflare_branding: + description: >- + Whether or not to add Cloudflare Branding for the order. This will + add a subdomain of sni.cloudflaressl.com as the Common Name if set + to true + example: false + type: boolean + x-auditable: true + custom_cert_bundle: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomCertBundle' + custom_certificate: + description: If a custom uploaded certificate is used. + example: > + -----BEGIN CERTIFICATE----- + + MIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN + + MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O + + OeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7 + + -----END CERTIFICATE----- + type: string + x-auditable: true + custom_csr_id: + description: The identifier for the Custom CSR that was used. + example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752 + type: string + x-auditable: true + custom_key: + description: The key for a custom uploaded certificate. + example: | + -----BEGIN RSA PRIVATE KEY----- + MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG + dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn + abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid + tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py + FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE + ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb + HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ + axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb + +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g + +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv + KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 + 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo + /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu + iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 + N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe + VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB + vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U + lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR + 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 + mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX + dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe + PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS + fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W + qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T + lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi + -----END RSA PRIVATE KEY----- + type: string + x-sensitive: true + method: + $ref: >- + #/components/schemas/unnamedSchemaRef78adb375f06c6d462dd92b99e2ecf510 + settings: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSslsettings' + type: + $ref: >- + #/components/schemas/unnamedSchemaRef9a9935a9a770967bb604ae41a81e42e1 + wildcard: + description: Indicates whether the certificate covers a wildcard. + example: false + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesSslsettings: + description: SSL specific settings. + properties: + ciphers: + description: >- + An allowlist of ciphers for TLS termination. These ciphers must be + in the BoringSSL format. + example: + - ECDHE-RSA-AES128-GCM-SHA256 + - AES128-SHA + items: + type: string + x-auditable: true + type: array + uniqueItems: true + early_hints: + description: Whether or not Early Hints is enabled. + enum: + - 'on' + - 'off' + example: 'on' + type: string + x-auditable: true + http2: + description: Whether or not HTTP2 is enabled. + enum: + - 'on' + - 'off' + example: 'on' + type: string + x-auditable: true + min_tls_version: + description: The minimum TLS version supported. + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + example: '1.2' + type: string + x-auditable: true + tls_1_3: + description: Whether or not TLS 1.3 is enabled. + enum: + - 'on' + - 'off' + example: 'on' + type: string + x-auditable: true + type: object + tlsCertificatesAndHostnamesUpdatedAt: + description: This is the time the fallback origin was updated. + example: '2020-03-16T18:11:23.531995Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesValidationRecord: + description: Certificate's required validation record. + properties: + cname: + description: The CNAME record hostname for DCV delegation. + example: _acme-challenge.example.com + readOnly: true + type: string + x-auditable: true + cname_target: + description: The CNAME record target value for DCV delegation. + example: dcv.cloudflare.com + readOnly: true + type: string + x-auditable: true + emails: + description: >- + The set of email addresses that the certificate authority (CA) will + use to complete domain validation. + example: + - administrator@example.com + - webmaster@example.com + items: + type: string + x-auditable: true + type: array + http_body: + description: >- + The content that the certificate authority (CA) will expect to find + at the http_url during the domain validation. + example: ca3-574923932a82475cb8592200f1a2a23d + type: string + http_url: + description: The url that will be checked during domain validation. + example: >- + http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt + type: string + status: + description: Status of the validation record. + example: pending + readOnly: true + type: string + txt_name: + description: >- + The hostname that the certificate authority (CA) will check for a + TXT record during domain validation . + example: _acme-challenge.app.example.com + type: string + x-auditable: true + txt_value: + description: >- + The TXT record that the certificate authority (CA) will check during + domain validation. + example: 810b7d5f01154524b961ba0cd578acc2 + type: string + type: object + tlsCertificatesAndHostnamesVerificationErrors: + description: >- + These are errors that were encountered while trying to activate a + hostname. + example: + - >- + None of the A or AAAA records are owned by this account and the + pre-generated ownership verification token was not found. + items: + type: string + x-auditable: true + type: array + unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1: + default: ubiquitous + description: >- + A ubiquitous bundle has the highest probability of being verified + everywhere, even by clients using outdated or unusual trust stores. An + optimal bundle uses the shortest chain and newest intermediates. And the + force bundle verifies the chain, but does not otherwise modify it. + enum: + - ubiquitous + - optimal + - force + example: ubiquitous + type: string + x-auditable: true + unnamedSchemaRef78adb375f06c6d462dd92b99e2ecf510: + description: Domain control validation (DCV) method used for this hostname. + enum: + - http + - txt + - email + example: http + type: string + x-auditable: true + unnamedSchemaRef9a9935a9a770967bb604ae41a81e42e1: + description: >- + Level of validation to be used for this hostname. Domain validation (dv) + must be used. + enum: + - dv + example: dv + type: string + x-auditable: true + unnamedSchemaRefD2a16d7ee1ad3a888dd5821c918d51fd: + type: object + properties: + hostname: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHostname' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + ssl: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSsl' + created_at: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCreatedAt' + readOnly: true + custom_metadata: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomMetadata' + custom_origin_server: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomOriginServer' + custom_origin_sni: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCustomOriginSni' + ownership_verification: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesOwnershipVerification + ownership_verification_http: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesOwnershipVerificationHttp + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasStatus + verification_errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesVerificationErrors' + required: + - id + - hostname + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + custom_hostnames: + id: cloudflare.custom_hostnames.custom_hostnames + name: custom_hostnames + title: Custom Hostnames + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_hostnames/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_hostnames/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_hostnames~1{custom_hostname_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_hostnames~1{custom_hostname_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_hostnames~1{custom_hostname_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_hostnames/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_hostnames/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_hostnames/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/custom_hostnames/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/custom_hostnames/methods/delete' + replace: [] + fallback_origin: + id: cloudflare.custom_hostnames.fallback_origin + name: fallback_origin + title: Fallback Origin + methods: + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_hostnames~1fallback_origin/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_hostnames~1fallback_origin/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_hostnames~1fallback_origin/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fallback_origin/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/fallback_origin/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/fallback_origin/methods/update' + certificates: + id: cloudflare.custom_hostnames.certificates + name: certificates + title: Certificates + methods: + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_hostnames~1{custom_hostname_id}~1certificate_pack~1{certificate_pack_id}~1certificates~1{certificate_id}/delete + response: + mediaType: application/json + openAPIDocKey: '202' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_hostnames~1{custom_hostname_id}~1certificate_pack~1{certificate_pack_id}~1certificates~1{certificate_id}/put + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/certificates/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/custom_nameservers.yaml b/providers/src/cloudflare/v00.00.00000/services/custom_nameservers.yaml index 3c5bb072..c07a9bcd 100644 --- a/providers/src/cloudflare/v00.00.00000/services/custom_nameservers.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/custom_nameservers.yaml @@ -1,72 +1,381 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Account_Level Custom Nameservers - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - custom_nameservers + title: custom_nameservers API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/custom_ns: + get: + description: List an account's custom nameservers. + operationId: account-level-custom-nameservers-list-account-custom-nameservers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/dnsCustomNameserversAcnsResponseCollection + description: List Account Custom Nameservers response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + items: + $ref: '#/components/schemas/dnsCustomNameserversCustomNS' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Account Custom Nameservers response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Account Custom Nameservers + tags: + - Account-Level Custom Nameservers + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: custom_nameservers + resource_chain: [] + method: get + post: + operationId: account-level-custom-nameservers-add-account-custom-nameserver + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsCustomNameserversCustomNSInput' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsCustomNameserversAcnsResponseSingle' + description: Add Account Custom Nameserver response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: A single account custom nameserver. + properties: + dns_records: + description: A and AAAA records associated with the nameserver. + items: + properties: + type: + description: DNS record type. + enum: + - A + - AAAA + type: string + x-auditable: true + value: + description: DNS record contents (an IPv4 or IPv6 address). + type: string + x-auditable: true + type: object + type: array + x-stainless-collection-type: set + ns_name: + $ref: '#/components/schemas/dnsCustomNameserversNsName' + ns_set: + $ref: '#/components/schemas/dnsCustomNameserversNsSet' + status: + deprecated: true + description: Verification status of the nameserver. + enum: + - moved + - pending + - verified + type: string + x-auditable: true + zone_tag: + $ref: >- + #/components/schemas/dnsCustomNameserversSchemasIdentifier + required: + - dns_records + - ns_name + - status + - zone_tag + title: Custom NS + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Add Account Custom Nameserver response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add Account Custom Nameserver + tags: + - Account-Level Custom Nameservers + x-api-token-group: + - Account Settings Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: custom_nameservers + resource_chain: [] + method: create + /accounts/{account_id}/custom_ns/{custom_ns_id}: + delete: + operationId: account-level-custom-nameservers-delete-account-custom-nameserver + parameters: + - in: path + name: custom_ns_id + schema: + $ref: '#/components/schemas/dnsCustomNameserversNsName' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsCustomNameserversEmptyResponse' + description: Delete Account Custom Nameserver response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: >- + #/components/schemas/unnamedSchemaRef619309774d07ec6904f1e354560d6028 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Account Custom Nameserver response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Account Custom Nameserver + tags: + - Account-Level Custom Nameservers + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false components: schemas: - custom-ns_components-schemas-identifier: - description: Account identifier tag. - example: 372e67954025e0ba6aaa6d586b9e0b59 - maxLength: 32 - readOnly: true - type: string - acns_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/CustomNS' - type: array - type: object - api-response-common-failure: + dnsCustomNameserversAcnsResponseCollection: + type: object properties: errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 + $ref: '#/components/schemas/dnsCustomNameserversMessages' messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true + $ref: '#/components/schemas/dnsCustomNameserversMessages' success: - description: Whether the API call was successful + description: Whether the API call was successful. enum: - - false - example: false + - true + example: true type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dnsCustomNameserversCustomNS' + type: array required: - success - errors - messages - - result + dnsCustomNameserversAcnsResponseSingle: type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - CustomNS: + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsCustomNameserversCustomNS' + required: + - success + - errors + - messages + dnsCustomNameserversCustomNS: description: A single account custom nameserver. properties: dns_records: @@ -80,14 +389,21 @@ components: - AAAA example: A type: string + x-auditable: true value: description: DNS record contents (an IPv4 or IPv6 address). example: 1.1.1.1 type: string + x-auditable: true + type: object type: array + x-stainless-collection-type: set ns_name: - $ref: '#/components/schemas/ns_name' + $ref: '#/components/schemas/dnsCustomNameserversNsName' + ns_set: + $ref: '#/components/schemas/dnsCustomNameserversNsSet' status: + deprecated: true description: Verification status of the nameserver. enum: - moved @@ -95,549 +411,185 @@ components: - verified example: verified type: string + x-auditable: true zone_tag: - $ref: '#/components/schemas/common_components-schemas-identifier' + $ref: '#/components/schemas/dnsCustomNameserversSchemasIdentifier' required: - dns_records - ns_name - status - zone_tag title: Custom NS - messages: + type: object + dnsCustomNameserversCustomNSInput: + properties: + ns_name: + $ref: '#/components/schemas/dnsCustomNameserversNsName' + ns_set: + $ref: '#/components/schemas/dnsCustomNameserversNsSet' + required: + - ns_name + title: Custom NS Input + type: object + dnsCustomNameserversEmptyResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + result: + items: + description: Unused + type: string + x-auditable: true + maxItems: 0 + type: array + required: + - success + - errors + - messages + dnsCustomNameserversMessages: example: [] items: properties: code: minimum: 1000 type: integer + documentation_url: + type: string message: type: string + source: + properties: + pointer: + type: string + type: object required: - code - message type: object uniqueItems: true type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - ns_name: + dnsCustomNameserversNsName: description: The FQDN of the name server. example: ns1.example.com format: hostname type: string - common_components-schemas-identifier: - description: Identifier + x-auditable: true + dnsCustomNameserversNsSet: + default: 1 + description: The number of the set that this name server belongs to. + example: 1 + maximum: 5 + minimum: 1 + type: number + x-auditable: true + dnsCustomNameserversSchemasIdentifier: + description: Identifier. example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 - readOnly: true type: string - CustomNSInput: - properties: - ns_name: - $ref: '#/components/schemas/ns_name' - required: - - ns_name - title: Custom NS Input - acns_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/CustomNS' - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - availability_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - description: 'Name of zone based on which account custom nameservers can be created. For example, if example.com is returned, then ns1.example.com can be used as an account custom nameserver.' - example: example.com - format: hostname - readOnly: true - type: string - type: array - type: object - empty_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: {} - maxItems: 0 - type: array - type: object - get_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/zone_metadata' - zone_metadata: - properties: - enabled: - description: Whether zone uses account-level custom nameservers. - example: true - type: boolean - type: object - responses: {} + x-auditable: true + unnamedSchemaRef619309774d07ec6904f1e354560d6028: + items: + description: Unused + type: string + x-auditable: true + maxItems: 0 + type: array + enum: + - null securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. api_key: in: header name: X-Auth-Key type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. api_token: scheme: bearer type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - accounts_custom_ns: - id: cloudflare.custom_nameservers.accounts_custom_ns - name: accounts_custom_ns - title: Accounts Custom Ns + custom_ns: + id: cloudflare.custom_nameservers.custom_ns + name: custom_ns + title: Custom Ns methods: - account_level_custom_nameservers_list_account_custom_nameservers: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1custom_ns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_level_custom_nameservers_list_account_custom_nameservers: + list: operation: - $ref: '#/paths/~1accounts~1{identifier}~1custom_ns/get' + $ref: '#/paths/~1accounts~1{account_id}~1custom_ns/get' response: mediaType: application/json openAPIDocKey: '200' - account_level_custom_nameservers_add_account_custom_nameserver: + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1accounts~1{identifier}~1custom_ns/post' + $ref: '#/paths/~1accounts~1{account_id}~1custom_ns/post' response: mediaType: application/json openAPIDocKey: '200' account_level_custom_nameservers_delete_account_custom_nameserver: operation: - $ref: '#/paths/~1accounts~1{identifier}~1custom_ns~1{ns_name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_level_custom_nameservers_verify_account_custom_nameserver_glue_records: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1custom_ns~1verify/post' + $ref: '#/paths/~1accounts~1{account_id}~1custom_ns~1{custom_ns_id}/delete' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/accounts_custom_ns/methods/account_level_custom_nameservers_list_account_custom_nameservers' - insert: [] + - $ref: '#/components/x-stackQL-resources/custom_ns/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_ns/methods/create' update: [] delete: - - $ref: '#/components/x-stackQL-resources/accounts_custom_ns/methods/account_level_custom_nameservers_delete_account_custom_nameserver' - accounts_custom_ns_availability: - id: cloudflare.custom_nameservers.accounts_custom_ns_availability - name: accounts_custom_ns_availability - title: Accounts Custom Ns Availability - methods: - account_level_custom_nameservers_get_eligible_zones_for_account_custom_nameservers: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1custom_ns~1availability/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_level_custom_nameservers_get_eligible_zones_for_account_custom_nameservers: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1custom_ns~1availability/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_custom_ns_availability/methods/account_level_custom_nameservers_get_eligible_zones_for_account_custom_nameservers' - insert: [] - update: [] - delete: [] - zones_custom_ns: - id: cloudflare.custom_nameservers.zones_custom_ns - name: zones_custom_ns - title: Zones Custom Ns - methods: - account_level_custom_nameservers_usage_for_a_zone_get_account_custom_nameserver_related_zone_metadata: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_ns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_level_custom_nameservers_usage_for_a_zone_get_account_custom_nameserver_related_zone_metadata: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_ns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_level_custom_nameservers_usage_for_a_zone_set_account_custom_nameserver_related_zone_metadata: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_ns/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_custom_ns/methods/account_level_custom_nameservers_usage_for_a_zone_get_account_custom_nameserver_related_zone_metadata' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{identifier}/custom_ns': - get: - description: List an account's custom nameservers. - operationId: account-level-custom-nameservers-list-account-custom-nameservers - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-ns_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acns_response_collection' - description: List Account Custom Nameservers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acns_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Account Custom Nameservers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Account Custom Nameservers - tags: - - Account-Level Custom Nameservers - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - post: - operationId: account-level-custom-nameservers-add-account-custom-nameserver - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-ns_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomNSInput' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acns_response_single' - description: Add Account Custom Nameserver response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acns_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add Account Custom Nameserver response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add Account Custom Nameserver - tags: - - Account-Level Custom Nameservers - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/accounts/{identifier}/custom_ns/availability': - get: - operationId: account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-ns_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/availability_response' - description: Get Eligible Zones for Account Custom Nameservers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/availability_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Eligible Zones for Account Custom Nameservers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Eligible Zones for Account Custom Nameservers - tags: - - Account-Level Custom Nameservers - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/accounts/{identifier}/custom_ns/verify': - post: - operationId: account-level-custom-nameservers-verify-account-custom-nameserver-glue-records - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-ns_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acns_response_collection' - description: Verify Account Custom Nameserver Glue Records response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acns_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Verify Account Custom Nameserver Glue Records response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Verify Account Custom Nameserver Glue Records - tags: - - Account-Level Custom Nameservers - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/accounts/{identifier}/custom_ns/{ns_name}': - delete: - operationId: account-level-custom-nameservers-delete-account-custom-nameserver - parameters: - - in: path - name: ns_name - required: true - schema: - $ref: '#/components/schemas/ns_name' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-ns_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/empty_response' - description: Delete Account Custom Nameserver response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Account Custom Nameserver response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Account Custom Nameserver - tags: - - Account-Level Custom Nameservers - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/custom_ns': - get: - operationId: account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/get_response' - description: Get Account Custom Nameserver Related Zone Metadata response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/get_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Account Custom Nameserver Related Zone Metadata response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Account Custom Nameserver Related Zone Metadata - tags: - - Account-Level Custom Nameservers Usage for a Zone - x-cfPermissionsRequired: - enum: - - '#zone:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - put: - operationId: account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/zone_metadata' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/empty_response' - description: Set Account Custom Nameserver Related Zone Metadata response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Account Custom Nameserver Related Zone Metadata response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Account Custom Nameserver Related Zone Metadata - tags: - - Account-Level Custom Nameservers Usage for a Zone - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false + - $ref: >- + #/components/x-stackQL-resources/custom_ns/methods/account_level_custom_nameservers_delete_account_custom_nameserver + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/custom_pages.yaml b/providers/src/cloudflare/v00.00.00000/services/custom_pages.yaml new file mode 100644 index 00000000..5d386fee --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/custom_pages.yaml @@ -0,0 +1,1892 @@ +openapi: 3.0.3 +info: + title: custom_pages API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/custom_pages: + get: + description: Fetches all the custom pages. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomPageResultList' + description: List custom pages response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/customPagesCustomPage' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List custom pages response failure + security: + - api_email: [] + api_key: [] + summary: List custom pages + tags: [] + x-api-token-group: + - 'Zero Trust: PII Read' + - Account Custom Pages Write + - Account Custom Pages Read + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: [] + method: list + operationId: get_accounts_account_id_custom_pages + /zones/{zone_id}/custom_pages: + get: + description: Fetches all the custom pages. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomPageResultList' + description: List custom pages response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/customPagesCustomPage' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List custom pages response failure + security: + - api_email: [] + api_key: [] + summary: List custom pages + tags: [] + x-api-token-group: + - 'Zero Trust: PII Read' + - Account Custom Pages Write + - Account Custom Pages Read + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: [] + method: list + operationId: get_zones_zone_id_custom_pages + /accounts/{account_id}/custom_pages/assets: + get: + description: Fetches all the custom assets. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 200 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResultList' + description: List custom assets response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/customPagesCustomAsset' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List custom assets response failure + security: + - api_email: [] + api_key: [] + summary: List custom assets + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: list + operationId: get_accounts_account_id_custom_pages_assets + post: + description: Creates a new custom asset. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + name: + $ref: '#/components/schemas/customPagesAssetName' + url: + $ref: '#/components/schemas/customPagesAssetUrl' + required: + - name + - description + - url + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResult' + description: Create custom asset response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + last_updated: + $ref: '#/components/schemas/customPagesTimestamp' + name: + $ref: '#/components/schemas/customPagesAssetName' + size_bytes: + description: The size of the asset content in bytes. + readOnly: true + type: integer + url: + $ref: '#/components/schemas/customPagesAssetUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Create a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: create + operationId: post_accounts_account_id_custom_pages_assets + /zones/{zone_id}/custom_pages/assets: + get: + description: Fetches all the custom assets. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 200 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResultList' + description: List custom assets response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/customPagesCustomAsset' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List custom assets response failure + security: + - api_email: [] + api_key: [] + summary: List custom assets + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: list + operationId: get_zones_zone_id_custom_pages_assets + post: + description: Creates a new custom asset. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + name: + $ref: '#/components/schemas/customPagesAssetName' + url: + $ref: '#/components/schemas/customPagesAssetUrl' + required: + - name + - description + - url + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResult' + description: Create custom asset response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + last_updated: + $ref: '#/components/schemas/customPagesTimestamp' + name: + $ref: '#/components/schemas/customPagesAssetName' + size_bytes: + description: The size of the asset content in bytes. + readOnly: true + type: integer + url: + $ref: '#/components/schemas/customPagesAssetUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Create a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: create + operationId: post_zones_zone_id_custom_pages_assets + /accounts/{account_id}/custom_pages/assets/{asset_name}: + get: + description: Fetches the details of a custom asset. + parameters: + - in: path + name: asset_name + schema: + $ref: '#/components/schemas/customPagesAssetName' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResult' + description: Get a custom asset response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + last_updated: + $ref: '#/components/schemas/customPagesTimestamp' + name: + $ref: '#/components/schemas/customPagesAssetName' + size_bytes: + description: The size of the asset content in bytes. + readOnly: true + type: integer + url: + $ref: '#/components/schemas/customPagesAssetUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get a custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Get a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: get + operationId: get_accounts_account_id_custom_pages_assets_asset_name + put: + description: Updates the configuration of an existing custom asset. + parameters: + - in: path + name: asset_name + schema: + $ref: '#/components/schemas/customPagesAssetName' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + url: + $ref: '#/components/schemas/customPagesAssetUrl' + required: + - description + - url + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResult' + description: Update a custom asset response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + last_updated: + $ref: '#/components/schemas/customPagesTimestamp' + name: + $ref: '#/components/schemas/customPagesAssetName' + size_bytes: + description: The size of the asset content in bytes. + readOnly: true + type: integer + url: + $ref: '#/components/schemas/customPagesAssetUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update a custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Update a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: update + operationId: put_accounts_account_id_custom_pages_assets_asset_name + delete: + description: Deletes an existing custom asset. + parameters: + - in: path + name: asset_name + schema: + $ref: '#/components/schemas/customPagesAssetName' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '204': + description: Delete a custom asset response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesApiResponseCommonFailure' + description: Delete a custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Delete a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: delete + operationId: delete_accounts_account_id_custom_pages_assets_asset_name + /zones/{zone_id}/custom_pages/assets/{asset_name}: + get: + description: Fetches the details of a custom asset. + parameters: + - in: path + name: asset_name + schema: + $ref: '#/components/schemas/customPagesAssetName' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResult' + description: Get a custom asset response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + last_updated: + $ref: '#/components/schemas/customPagesTimestamp' + name: + $ref: '#/components/schemas/customPagesAssetName' + size_bytes: + description: The size of the asset content in bytes. + readOnly: true + type: integer + url: + $ref: '#/components/schemas/customPagesAssetUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get a custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Get a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: get + operationId: get_zones_zone_id_custom_pages_assets_asset_name + put: + description: Updates the configuration of an existing custom asset. + parameters: + - in: path + name: asset_name + schema: + $ref: '#/components/schemas/customPagesAssetName' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + url: + $ref: '#/components/schemas/customPagesAssetUrl' + required: + - description + - url + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomAssetResult' + description: Update a custom asset response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + last_updated: + $ref: '#/components/schemas/customPagesTimestamp' + name: + $ref: '#/components/schemas/customPagesAssetName' + size_bytes: + description: The size of the asset content in bytes. + readOnly: true + type: integer + url: + $ref: '#/components/schemas/customPagesAssetUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update a custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Update a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: update + operationId: put_zones_zone_id_custom_pages_assets_asset_name + delete: + description: Deletes an existing custom asset. + parameters: + - in: path + name: asset_name + schema: + $ref: '#/components/schemas/customPagesAssetName' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '204': + description: Delete a custom asset response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesApiResponseCommonFailure' + description: Delete a custom asset response failure + security: + - api_email: [] + api_key: [] + summary: Delete a custom asset + tags: [] + x-api-token-group: null + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: + - assets + method: delete + operationId: delete_zones_zone_id_custom_pages_assets_asset_name + /accounts/{account_id}/custom_pages/{identifier}: + get: + description: Fetches the details of a custom page. + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomPageResult' + description: Get a custom page response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + description: + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + preview_target: + type: string + x-auditable: true + required_tokens: + items: + type: string + type: array + x-auditable: true + state: + $ref: '#/components/schemas/customPagesState' + url: + $ref: '#/components/schemas/customPagesUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get a custom page response failure + security: + - api_email: [] + api_key: [] + summary: Get a custom page + tags: [] + x-api-token-group: + - 'Zero Trust: PII Read' + - Account Custom Pages Write + - Account Custom Pages Read + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: [] + method: get + operationId: get_accounts_account_id_custom_pages_identifier + put: + description: Updates the configuration of an existing custom page. + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + state: + $ref: '#/components/schemas/customPagesState' + url: + $ref: '#/components/schemas/customPagesUrl' + required: + - url + - state + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomPageResult' + description: Update a custom page response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + description: + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + preview_target: + type: string + x-auditable: true + required_tokens: + items: + type: string + type: array + x-auditable: true + state: + $ref: '#/components/schemas/customPagesState' + url: + $ref: '#/components/schemas/customPagesUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update a custom page response failure + security: + - api_email: [] + api_key: [] + summary: Update a custom page + tags: [] + x-api-token-group: + - Account Custom Pages Write + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: [] + method: update + operationId: put_accounts_account_id_custom_pages_identifier + /zones/{zone_id}/custom_pages/{identifier}: + get: + description: Fetches the details of a custom page. + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomPageResult' + description: Get a custom page response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + description: + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + preview_target: + type: string + x-auditable: true + required_tokens: + items: + type: string + type: array + x-auditable: true + state: + $ref: '#/components/schemas/customPagesState' + url: + $ref: '#/components/schemas/customPagesUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get a custom page response failure + security: + - api_email: [] + api_key: [] + summary: Get a custom page + tags: [] + x-api-token-group: + - 'Zero Trust: PII Read' + - Account Custom Pages Write + - Account Custom Pages Read + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: [] + method: get + operationId: get_zones_zone_id_custom_pages_identifier + put: + description: Updates the configuration of an existing custom page. + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + state: + $ref: '#/components/schemas/customPagesState' + url: + $ref: '#/components/schemas/customPagesUrl' + required: + - url + - state + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customPagesCustomPageResult' + description: Update a custom page response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + description: + type: string + x-auditable: true + id: + type: string + x-auditable: true + modified_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + preview_target: + type: string + x-auditable: true + required_tokens: + items: + type: string + type: array + x-auditable: true + state: + $ref: '#/components/schemas/customPagesState' + url: + $ref: '#/components/schemas/customPagesUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update a custom page response failure + security: + - api_email: [] + api_key: [] + summary: Update a custom page + tags: [] + x-api-token-group: + - Account Custom Pages Write + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: custom_pages + resource_chain: [] + method: update + operationId: put_zones_zone_id_custom_pages_identifier +components: + schemas: + customPagesApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/customPagesMessages' + messages: + example: [] + $ref: '#/components/schemas/customPagesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + customPagesAssetDescription: + description: A short description of the custom asset. + example: Custom 500 error page + type: string + customPagesAssetName: + description: >- + The unique name of the custom asset. Can only contain letters (A-Z, + a-z), numbers (0-9), and underscores (_). + example: my_custom_error_page + minLength: 1 + type: string + x-auditable: true + customPagesAssetUrl: + description: The URL where the asset content is fetched from. + example: https://example.com/error.html + format: uri + type: string + customPagesCustomAsset: + properties: + description: + $ref: '#/components/schemas/customPagesAssetDescription' + last_updated: + $ref: '#/components/schemas/customPagesTimestamp' + name: + $ref: '#/components/schemas/customPagesAssetName' + size_bytes: + description: The size of the asset content in bytes. + example: 1024 + readOnly: true + type: integer + url: + $ref: '#/components/schemas/customPagesAssetUrl' + type: object + customPagesCustomAssetResult: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/customPagesCustomAsset' + required: + - success + - errors + - messages + customPagesCustomAssetResultList: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/customPagesCustomAsset' + type: array + required: + - success + - errors + - messages + customPagesCustomPage: + properties: + created_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + description: + example: Basic Challenge + type: string + x-auditable: true + id: + example: basic_challenge + type: string + x-auditable: true + modified_on: + $ref: '#/components/schemas/customPagesTimestamp' + readOnly: true + preview_target: + example: block:basic-sec-captcha + type: string + x-auditable: true + required_tokens: + example: + - '::CAPTCHA_BOX::' + items: + type: string + type: array + x-auditable: true + state: + $ref: '#/components/schemas/customPagesState' + url: + $ref: '#/components/schemas/customPagesUrl' + type: object + customPagesCustomPageResult: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/customPagesCustomPage' + required: + - success + - errors + - messages + customPagesCustomPageResultList: + type: object + properties: + errors: + $ref: '#/components/schemas/customPagesMessages' + messages: + $ref: '#/components/schemas/customPagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/customPagesCustomPage' + type: array + required: + - success + - errors + - messages + customPagesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + customPagesState: + description: The custom page state. + enum: + - default + - customized + example: default + type: string + x-auditable: true + customPagesTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + customPagesUrl: + description: The URL associated with the custom page. + example: http://www.example.com + format: uri + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + custom_pages: + id: cloudflare.custom_pages.custom_pages + name: custom_pages + title: Custom Pages + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1custom_pages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_pages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1custom_pages~1{identifier}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1custom_pages~1{identifier}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_pages~1{identifier}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_pages~1{identifier}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_pages/methods/get_by_account + - $ref: '#/components/x-stackQL-resources/custom_pages/methods/get_by_zone' + - $ref: >- + #/components/x-stackQL-resources/custom_pages/methods/list_by_account + - $ref: '#/components/x-stackQL-resources/custom_pages/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/custom_pages/methods/update_by_account + - $ref: >- + #/components/x-stackQL-resources/custom_pages/methods/update_by_zone + assets: + id: cloudflare.custom_pages.assets + name: assets + title: Assets + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1custom_pages~1assets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1custom_pages~1assets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_pages~1assets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_pages~1assets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1custom_pages~1assets~1{asset_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1custom_pages~1assets~1{asset_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1custom_pages~1assets~1{asset_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_pages~1assets~1{asset_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_pages~1assets~1{asset_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1custom_pages~1assets~1{asset_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assets/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/assets/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/assets/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/assets/methods/list_by_zone' + insert: + - $ref: '#/components/x-stackQL-resources/assets/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/assets/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/assets/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/assets/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/assets/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/assets/methods/update_by_zone' diff --git a/providers/src/cloudflare/v00.00.00000/services/d1.yaml b/providers/src/cloudflare/v00.00.00000/services/d1.yaml new file mode 100644 index 00000000..d90bf773 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/d1.yaml @@ -0,0 +1,1718 @@ +openapi: 3.0.3 +info: + title: d1 API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/d1/database: + get: + description: Returns a list of D1 databases. + operationId: d1-list-databases + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: a database name to search for. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 1000 + description: Number of items per page. + maximum: 10000 + minimum: 10 + type: number + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: array + items: + $ref: '#/components/schemas/d1DatabaseResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service + type: number + page: + description: Current page within paginated list of results + type: number + per_page: + description: Number of results per page of results + type: number + total_count: + description: Total results available without any search parameters + type: number + type: object + required: + - success + - errors + - messages + - result + type: object + description: List D1 databases response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: List D1 databases response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List D1 Databases + tags: + - D1 + x-api-token-group: + - D1 Read + - D1 Write + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: list + post: + description: Returns the created D1 database. + operationId: d1-create-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + jurisdiction: + $ref: '#/components/schemas/d1Jurisdiction' + name: + $ref: '#/components/schemas/d1DatabaseName' + primary_location_hint: + $ref: '#/components/schemas/d1PrimaryLocationHint' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + $ref: '#/components/schemas/d1DatabaseDetailsResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Returns the created D1 database's metadata + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Database details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create D1 Database + tags: + - D1 + x-api-token-group: + - D1 Write + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: create + /accounts/{account_id}/d1/database/{database_id}: + delete: + description: Deletes the specified D1 database. + operationId: d1-delete-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + enum: + - null + nullable: true + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Delete D1 database response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Delete D1 database response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete D1 Database + tags: + - D1 + x-api-token-group: + - D1 Write + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: delete + get: + description: Returns the specified D1 database. + operationId: d1-get-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + $ref: '#/components/schemas/d1DatabaseDetailsResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Database details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Database details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get D1 Database + tags: + - D1 + x-api-token-group: + - D1 Read + - D1 Write + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: get + patch: + description: Updates partially the specified D1 database. + operationId: d1-update-partial-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/d1DatabaseUpdatePartialRequestBody' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + $ref: '#/components/schemas/d1DatabaseDetailsResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Database details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Update D1 database response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update D1 Database partially + tags: + - D1 + x-api-token-group: + - D1 Write + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: edit + put: + description: Updates the specified D1 database. + operationId: d1-update-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/d1DatabaseUpdateRequestBody' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + $ref: '#/components/schemas/d1DatabaseDetailsResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Database details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Update D1 database response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update D1 Database + tags: + - D1 + x-api-token-group: + - D1 Write + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: update + /accounts/{account_id}/d1/database/{database_id}/export: + post: + description: >- + Returns a URL where the SQL contents of your D1 can be downloaded. Note: + this process may take some time for larger DBs, during which your D1 + will be unavailable to serve queries. To avoid blocking your DB + unnecessarily, an in-progress export must be continually polled or will + automatically cancel. + operationId: d1-export-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + current_bookmark: + description: >- + To poll an in-progress export, provide the current bookmark + (returned by your first polling response) + type: string + x-auditable: true + dump_options: + properties: + no_data: + description: Export only the table definitions, not their contents + type: boolean + x-auditable: true + no_schema: + description: Export only each table's contents, not its definition + type: boolean + x-auditable: true + tables: + description: >- + Filter the export to just one or more tables. Passing an + empty array is the same as not passing anything and + means: export all tables. + items: + type: string + x-auditable: true + type: array + type: object + output_format: + description: >- + Specifies that you will poll this endpoint until the export + completes + enum: + - polling + type: string + x-auditable: true + required: + - output_format + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + properties: + at_bookmark: + description: >- + The current time-travel bookmark for your D1, used to + poll for updates. Will not change for the duration of + the export task. + type: string + x-auditable: true + error: + description: >- + Only present when status = 'error'. Contains the error + message. + type: string + x-auditable: true + messages: + description: Logs since the last time you polled + items: + type: string + x-auditable: true + type: array + result: + description: Only present when status = 'complete' + properties: + filename: + description: The generated SQL filename. + type: string + x-auditable: true + signed_url: + description: >- + The URL to download the exported SQL. Available + for one hour. + type: string + type: object + status: + enum: + - complete + - error + type: string + x-auditable: true + success: + type: boolean + x-auditable: true + type: + enum: + - export + type: string + x-auditable: true + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Polled successfully, task no longer running (errored or complete) + '202': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + properties: + at_bookmark: + description: >- + The current time-travel bookmark for your D1, used to + poll for updates. Will not change for the duration of + the export task. + type: string + x-auditable: true + messages: + description: Logs since the last time you polled + items: + type: string + x-auditable: true + type: array + status: + enum: + - active + type: string + x-auditable: true + success: + type: boolean + x-auditable: true + type: + enum: + - export + type: string + x-auditable: true + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Polled successfully, task is currently running + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Poll failed (API error) + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Export D1 Database as SQL + tags: + - D1 + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: export + /accounts/{account_id}/d1/database/{database_id}/import: + post: + description: >- + Generates a temporary URL for uploading an SQL file to, then instructing + the D1 to import it and polling it for status updates. Imports block the + D1 for their duration. + operationId: d1-import-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + title: init + properties: + action: + description: Indicates you have a new SQL file to upload. + enum: + - init + type: string + x-auditable: true + etag: + description: >- + Required when action is 'init' or 'ingest'. An md5 hash of + the file you're uploading. Used to check if it already + exists, and validate its contents before ingesting. + type: string + x-auditable: true + filename: + description: The filename you have successfully uploaded. + type: string + x-auditable: true + current_bookmark: + description: >- + This identifies the currently-running import, checking its + status. + type: string + x-auditable: true + required: + - action + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + properties: + at_bookmark: + description: >- + The current time-travel bookmark for your D1, used to + poll for updates. Will not change for the duration of + the import. Only returned if an import process is + currently running or recently finished. + type: string + x-auditable: true + error: + description: >- + Only present when status = 'error'. Contains the error + message that prevented the import from succeeding. + type: string + x-auditable: true + filename: + description: >- + Derived from the database ID and etag, to use in + avoiding repeated uploads. Only returned when for the + 'init' action. + type: string + x-auditable: true + messages: + description: Logs since the last time you polled + items: + type: string + x-auditable: true + type: array + result: + description: Only present when status = 'complete' + properties: + final_bookmark: + description: >- + The time-travel bookmark if you need restore your + D1 to directly after the import succeeded. + type: string + x-auditable: true + meta: + $ref: '#/components/schemas/d1QueryMeta' + num_queries: + description: >- + The total number of queries that were executed + during the import. + type: number + x-auditable: true + type: object + status: + enum: + - complete + - error + type: string + x-auditable: true + success: + type: boolean + x-auditable: true + type: + enum: + - import + type: string + x-auditable: true + upload_url: + description: >- + The R2 presigned URL to use for uploading. Only + returned when for the 'init' action. + type: string + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: >- + Successful action. Import is either ready to start, under way, or + finished (succeeded or failed). + '202': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + properties: + at_bookmark: + description: >- + The current bookmark for your D1, used to poll for + updates. Will not change for the duration of the + import. + type: string + x-auditable: true + messages: + description: Logs since the last time you polled + items: + type: string + x-auditable: true + type: array + status: + enum: + - active + type: string + x-auditable: true + success: + type: boolean + x-auditable: true + type: + enum: + - import + type: string + x-auditable: true + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Polled successfully, task is currently running + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Poll failed (API error) + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Import SQL into your D1 Database + tags: + - D1 + x-stackql-sdk: + service: d1 + resource_chain: + - database + method: import_ + /accounts/{account_id}/d1/database/{database_id}/query: + post: + description: Returns the query result as an object. + operationId: d1-query-database + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/d1BatchQuery' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: array + items: + $ref: '#/components/schemas/d1QueryResultResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Query response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Query response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Query D1 Database + tags: + - D1 + x-api-token-group: + - D1 Read + - D1 Write + /accounts/{account_id}/d1/database/{database_id}/raw: + post: + description: >- + Returns the query result rows as arrays rather than objects. This is a + performance-optimized version of the /query endpoint. + operationId: d1-raw-database-query + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/d1BatchQuery' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: array + items: + $ref: '#/components/schemas/d1RawResultResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Raw query response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Query response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Raw D1 Database query + tags: + - D1 + x-api-token-group: + - D1 Read + - D1 Write + /accounts/{account_id}/d1/database/{database_id}/time_travel/bookmark: + get: + description: >- + Retrieves the current bookmark, or the nearest bookmark at or before a + provided timestamp. Bookmarks can be used with the restore endpoint to + revert the database to a previous point in time. + operationId: d1-time-travel-get-bookmark + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + - description: >- + An optional ISO 8601 timestamp. If provided, returns the nearest + available bookmark at or before this timestamp. If omitted, returns + the current bookmark. + in: query + name: timestamp + schema: + $ref: '#/components/schemas/d1TimeTravelTimestamp' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + properties: + bookmark: + $ref: '#/components/schemas/d1TimeTravelBookmark' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Bookmark retrieved successfully + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Failed to retrieve bookmark + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get D1 database bookmark + tags: + - D1 + x-api-token-group: + - D1 Read + - D1 Write + x-stackql-sdk: + service: d1 + resource_chain: + - database + - time_travel + method: get_bookmark + /accounts/{account_id}/d1/database/{database_id}/time_travel/restore: + post: + description: >- + Restores a D1 database to a previous point in time either via a bookmark + or a timestamp. + operationId: d1-time-travel-restore + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: database_id + in: path + required: true + description: The D1 database ID. + schema: + type: string + - description: >- + A bookmark to restore the database to. Required if `timestamp` is + not provided. + in: query + name: bookmark + schema: + $ref: '#/components/schemas/d1TimeTravelBookmark' + - description: >- + An ISO 8601 timestamp to restore the database to. Required if + `bookmark` is not provided. + in: query + name: timestamp + schema: + $ref: '#/components/schemas/d1TimeTravelTimestamp' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/d1Messages' + messages: + $ref: '#/components/schemas/d1Messages' + result: + type: object + $ref: '#/components/schemas/d1TimeTravelRestoreResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Database restored successfully + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/d1ApiResponseCommonFailure' + description: Restore operation failed + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Restore D1 Database to a bookmark or point in time + tags: + - D1 + x-stackql-sdk: + service: d1 + resource_chain: + - database + - time_travel + method: restore +components: + schemas: + d1ApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/d1Messages' + messages: + example: [] + $ref: '#/components/schemas/d1Messages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + d1BatchQuery: + description: A single query object or a batch query object + type: object + title: single query + properties: + params: + $ref: '#/components/schemas/d1Params' + sql: + $ref: '#/components/schemas/d1Sql' + batch: + items: + $ref: '#/components/schemas/d1SingleQuery' + type: array + required: [] + d1CreatedAt: + description: Specifies the timestamp the resource was created as an ISO8601 string. + example: '2022-11-15T18:25:44.442097Z' + format: date-time + readOnly: true + type: string + x-auditable: true + d1DatabaseDetailsResponse: + description: The details of the D1 database. + properties: + created_at: + $ref: '#/components/schemas/d1CreatedAt' + readOnly: true + file_size: + $ref: '#/components/schemas/d1FileSize' + jurisdiction: + $ref: '#/components/schemas/d1JurisdictionNullable' + name: + $ref: '#/components/schemas/d1DatabaseName' + num_tables: + $ref: '#/components/schemas/d1TableCount' + read_replication: + $ref: '#/components/schemas/d1ReadReplicationDetails' + uuid: + $ref: '#/components/schemas/d1DatabaseIdentifier' + version: + $ref: '#/components/schemas/d1DatabaseVersion' + type: object + d1DatabaseIdentifier: + description: D1 database identifier (UUID). + example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + readOnly: true + type: string + x-auditable: true + d1DatabaseName: + description: D1 database name. + example: my-database + type: string + x-auditable: true + d1DatabaseResponse: + properties: + created_at: + $ref: '#/components/schemas/d1CreatedAt' + readOnly: true + jurisdiction: + $ref: '#/components/schemas/d1JurisdictionNullable' + name: + $ref: '#/components/schemas/d1DatabaseName' + uuid: + $ref: '#/components/schemas/d1DatabaseIdentifier' + version: + $ref: '#/components/schemas/d1DatabaseVersion' + type: object + d1DatabaseUpdatePartialRequestBody: + properties: + read_replication: + description: Configuration for D1 read replication. + properties: + mode: + $ref: '#/components/schemas/d1ReadReplicationMode' + required: + - mode + type: object + type: object + d1DatabaseUpdateRequestBody: + properties: + read_replication: + description: Configuration for D1 read replication. + properties: + mode: + $ref: '#/components/schemas/d1ReadReplicationMode' + required: + - mode + type: object + required: + - read_replication + type: object + d1DatabaseVersion: + example: production + type: string + x-auditable: true + d1FileSize: + description: The D1 database's size, in bytes. + example: 12 + type: number + x-auditable: true + d1Jurisdiction: + description: >- + Specify the location to restrict the D1 database to run and store data. + If this option is present, the location hint is ignored. + enum: + - eu + - fedramp + example: eu + type: string + x-auditable: true + d1JurisdictionNullable: + description: >- + Specify the location to restrict the D1 database to run and store data. + If this option is present, the location hint is ignored. + enum: + - eu + - fedramp + example: eu + nullable: true + type: string + x-auditable: true + d1Messages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + d1Params: + example: + - firstParam + - secondParam + items: + type: string + type: array + d1PrimaryLocationHint: + description: >- + Specify the region to create the D1 primary, if available. If this + option is omitted, the D1 will be created as close as possible to the + current user. + enum: + - wnam + - enam + - weur + - eeur + - apac + - oc + example: wnam + type: string + x-auditable: true + d1QueryMeta: + properties: + changed_db: + description: >- + Denotes if the database has been altered in some way, like deleting + rows. + type: boolean + x-auditable: true + changes: + description: >- + Rough indication of how many rows were modified by the query, as + provided by SQLite's `sqlite3_total_changes()`. + type: number + x-auditable: true + duration: + description: >- + The duration of the SQL query execution inside the database. Does + not include any network communication. + type: number + x-auditable: true + last_row_id: + description: >- + The row ID of the last inserted row in a table with an `INTEGER + PRIMARY KEY` as provided by SQLite. Tables created with `WITHOUT + ROWID` do not populate this. + type: number + x-auditable: true + rows_read: + description: >- + Number of rows read during the SQL query execution, including + indices (not all rows are necessarily returned). + type: number + x-auditable: true + rows_written: + description: >- + Number of rows written during the SQL query execution, including + indices. + type: number + x-auditable: true + served_by_colo: + $ref: '#/components/schemas/d1ServedByColo' + served_by_primary: + description: >- + Denotes if the query has been handled by the database primary + instance. + type: boolean + x-auditable: true + served_by_region: + $ref: '#/components/schemas/d1ServedByRegion' + size_after: + description: Size of the database after the query committed, in bytes. + type: number + x-auditable: true + timings: + description: Various durations for the query. + properties: + sql_duration_ms: + description: >- + The duration of the SQL query execution inside the database. + Does not include any network communication. + type: number + x-auditable: true + type: object + type: object + d1QueryResultResponse: + properties: + meta: + $ref: '#/components/schemas/d1QueryMeta' + results: + items: + type: object + type: array + success: + type: boolean + type: object + d1RawResultResponse: + properties: + meta: + $ref: '#/components/schemas/d1QueryMeta' + results: + properties: + columns: + items: + type: string + type: array + rows: + items: + items: + type: number + type: array + type: array + type: object + success: + type: boolean + type: object + d1ReadReplicationDetails: + description: Configuration for D1 read replication. + properties: + mode: + $ref: '#/components/schemas/d1ReadReplicationMode' + required: + - mode + type: object + d1ReadReplicationMode: + description: >- + The read replication mode for the database. Use 'auto' to create + replicas and allow D1 automatically place them around the world, or + 'disabled' to not use any database replicas (it can take a few hours for + all replicas to be deleted). + enum: + - auto + - disabled + example: auto + type: string + x-auditable: true + d1ServedByColo: + description: The three letters airport code of the colo that handled the query. + example: LHR + type: string + x-auditable: true + d1ServedByRegion: + description: Region location hint of the database instance that handled the query. + enum: + - WNAM + - ENAM + - WEUR + - EEUR + - APAC + - OC + example: EEUR + type: string + x-auditable: true + d1SingleQuery: + description: A single query with or without parameters + properties: + params: + $ref: '#/components/schemas/d1Params' + sql: + $ref: '#/components/schemas/d1Sql' + required: + - sql + title: single query + type: object + d1Sql: + description: >- + Your SQL query. Supports multiple statements, joined by semicolons, + which will be executed as a batch. + example: SELECT * FROM myTable WHERE field = ? OR field = ?; + type: string + d1TableCount: + example: 12 + type: number + x-auditable: true + d1TimeTravelBookmark: + description: >- + A bookmark representing a specific state of the database at a specific + point in time. + example: 00000001-00000002-00004e2f-0a83ea2fceebc654de0640c422be4653 + type: string + x-auditable: true + d1TimeTravelRestoreResponse: + description: Response from a time travel restore operation. + properties: + bookmark: + $ref: '#/components/schemas/d1TimeTravelBookmark' + description: >- + The new bookmark representing the state of the database after the + restore operation. + message: + description: A message describing the result of the restore operation. + example: Database restored successfully + type: string + x-auditable: true + previous_bookmark: + $ref: '#/components/schemas/d1TimeTravelBookmark' + description: >- + The bookmark representing the state of the database before the + restore operation. Can be used to undo the restore if needed. + type: object + d1TimeTravelTimestamp: + description: >- + An ISO 8601 timestamp used for time travel operations. The database will + be restored to the nearest available bookmark at or before this + timestamp. + example: '2024-01-15T12:00:00Z' + format: date-time + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + database: + id: cloudflare.d1.database + name: database + title: Database + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1d1~1database/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1d1~1database/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + export: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}~1export/post + response: + mediaType: application/json + openAPIDocKey: '200' + import: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}~1import/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_raw: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}~1raw/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/database/methods/get' + - $ref: '#/components/x-stackQL-resources/database/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/database/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/database/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/database/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/database/methods/update' + database_query: + id: cloudflare.d1.database_query + name: database_query + title: Database Query + methods: + query: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}~1query/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/database_query/methods/query' + update: [] + delete: [] + replace: [] + time_travel: + id: cloudflare.d1.time_travel + name: time_travel + title: Time Travel + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}~1time_travel~1bookmark/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + restore: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1d1~1database~1{database_id}~1time_travel~1restore/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/time_travel/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/data_loss_prevention.yaml b/providers/src/cloudflare/v00.00.00000/services/data_loss_prevention.yaml deleted file mode 100644 index c923a2a5..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/data_loss_prevention.yaml +++ /dev/null @@ -1,884 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: DLP Pattern Validation - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - data_loss_prevention - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - validate_pattern: - description: A request to validate a pattern - properties: - regex: - description: The regex pattern. - example: '^4[0-9]{6,}$' - type: string - required: - - regex - title: Pattern - type: object - schemas-validate_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - valid: - example: true - type: boolean - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - profiles_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/profiles' - type: array - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - profiles: - anyOf: - - $ref: '#/components/schemas/predefined_profile' - - $ref: '#/components/schemas/custom_profile' - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - predefined_profile: - properties: - entries: - description: The entries for this profile. - items: - $ref: '#/components/schemas/predefined_entry' - type: array - id: - $ref: '#/components/schemas/profile_id' - name: - description: The name of the profile. - example: Generic CVV Card Number - type: string - type: - description: The type of the profile. - enum: - - predefined - example: predefined - type: string - title: Predefined profile - type: object - custom_profile: - properties: - created_at: - $ref: '#/components/schemas/timestamp' - description: - description: The description of the profile. - example: A standard CVV card number - type: string - entries: - description: The entries for this profile. - items: - $ref: '#/components/schemas/custom_entry' - type: array - id: - $ref: '#/components/schemas/profile_id' - name: - description: The name of the profile. - example: Generic CVV Card Number - type: string - type: - description: The type of the profile. - enum: - - custom - example: custom - type: string - updated_at: - $ref: '#/components/schemas/timestamp' - title: Custom profile - type: object - predefined_entry: - description: A predefined entry that matches a profile - properties: - enabled: - description: Whether the entry is enabled or not. - example: true - type: boolean - id: - $ref: '#/components/schemas/entry_id' - name: - description: The name of the entry. - example: Credit card (Visa) - type: string - profile_id: - description: ID of the parent profile - title: Predefined entry - type: object - profile_id: - allOf: - - $ref: '#/components/schemas/uuid' - description: The ID for this profile - example: 384e129d-25bd-403c-8019-bc19eb7a8a5f - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - custom_entry: - description: A custom entry that matches a profile - properties: - created_at: - $ref: '#/components/schemas/timestamp' - enabled: - description: Whether the entry is enabled or not. - example: true - type: boolean - id: - $ref: '#/components/schemas/entry_id' - name: - description: The name of the entry. - example: Credit card (Visa) - type: string - pattern: - $ref: '#/components/schemas/components-schemas-pattern' - profile_id: - description: ID of the parent profile - updated_at: - $ref: '#/components/schemas/timestamp' - title: Custom entry - type: object - entry_id: - allOf: - - $ref: '#/components/schemas/uuid' - description: The ID for this entry - example: 719d1215-260f-41d0-8c32-eb320ad107f7 - uuid: - description: UUID - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true - type: string - components-schemas-pattern: - description: A pattern that matches an entry - properties: - regex: - description: The regex pattern. - example: '^4[0-9]{6,}$' - type: string - validation: - description: 'Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.' - enum: - - luhn - example: luhn - type: string - required: - - regex - title: Pattern - type: object - create_custom_profiles: - properties: - profiles: - items: - $ref: '#/components/schemas/new_custom_profile' - required: - - name - - entries - type: array - required: - - profiles - create_custom_profile_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/custom_profile' - type: array - new_custom_profile: - properties: - description: - description: The description of the profile. - example: A standard CVV card number - type: string - entries: - description: The entries for this profile. - items: - $ref: '#/components/schemas/new_custom_entry' - type: array - name: - description: The name of the profile. - example: Generic CVV Card Number - type: string - type: object - new_custom_entry: - description: A custom entry create payload - properties: - enabled: - description: Whether the entry is enabled or not. - example: true - type: boolean - name: - description: The name of the entry. - example: Credit card (Visa) - type: string - pattern: - $ref: '#/components/schemas/components-schemas-pattern' - required: - - name - - enabled - - pattern - title: Custom entry - type: object - custom_profile_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - $ref: '#/components/schemas/custom_profile' - update_custom_profile: - properties: - description: - description: The description of the profile. - example: A standard CVV card number - type: string - entries: - description: The entries for this profile. Array elements with IDs are modifying the existing entry with that ID. Elements without ID will create new entries. Any entry not in the list will be deleted. - items: - $ref: '#/components/schemas/custom_entry' - type: array - name: - description: The name of the profile. - example: Generic CVV Card Number - type: string - title: Update custom profile - type: object - predefined_profile_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - $ref: '#/components/schemas/predefined_profile' - update_predefined_profile: - properties: - entries: - description: The entries for this profile. - items: - properties: - enabled: - description: Wheter the entry is enabled or not. - example: true - type: boolean - id: - $ref: '#/components/schemas/entry_id' - type: array - title: Update predefined profile - type: object - either_profile_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - anyOf: - - $ref: '#/components/schemas/predefined_profile' - - $ref: '#/components/schemas/custom_profile' - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_dlp_patterns_validate: - id: cloudflare.data_loss_prevention.accounts_dlp_patterns_validate - name: accounts_dlp_patterns_validate - title: Accounts Dlp Patterns Validate - methods: - dlp_pattern_validation_validate_pattern: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1patterns~1validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_dlp_profiles: - id: cloudflare.data_loss_prevention.accounts_dlp_profiles - name: accounts_dlp_profiles - title: Accounts Dlp Profiles - methods: - dlp_profiles_list_all_profiles: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dlp_profiles_list_all_profiles: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles/get' - response: - mediaType: application/json - openAPIDocKey: '200' - dlp_profiles_get_dlp_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1{profile_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dlp_profiles_get_dlp_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1{profile_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_dlp_profiles/methods/dlp_profiles_list_all_profiles' - - $ref: '#/components/x-stackQL-resources/accounts_dlp_profiles/methods/dlp_profiles_get_dlp_profile' - insert: [] - update: [] - delete: [] - accounts_dlp_profiles_custom: - id: cloudflare.data_loss_prevention.accounts_dlp_profiles_custom - name: accounts_dlp_profiles_custom - title: Accounts Dlp Profiles Custom - methods: - dlp_profiles_create_custom_profiles: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1custom/post' - response: - mediaType: application/json - openAPIDocKey: '200' - dlp_profiles_delete_custom_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1custom~1{profile_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - dlp_profiles_get_custom_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1custom~1{profile_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dlp_profiles_get_custom_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1custom~1{profile_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - dlp_profiles_update_custom_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1custom~1{profile_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_dlp_profiles_custom/methods/dlp_profiles_get_custom_profile' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_dlp_profiles_custom/methods/dlp_profiles_create_custom_profiles' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_dlp_profiles_custom/methods/dlp_profiles_delete_custom_profile' - accounts_dlp_profiles_predefined: - id: cloudflare.data_loss_prevention.accounts_dlp_profiles_predefined - name: accounts_dlp_profiles_predefined - title: Accounts Dlp Profiles Predefined - methods: - dlp_profiles_get_predefined_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1predefined~1{profile_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dlp_profiles_get_predefined_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1predefined~1{profile_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - dlp_profiles_update_predefined_profile: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dlp~1profiles~1predefined~1{profile_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_dlp_profiles_predefined/methods/dlp_profiles_get_predefined_profile' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/dlp/patterns/validate': - post: - description: Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. Your regex will be rejected if it uses the Kleene Star -- be sure to bound the maximum number of characters that can be matched. - operationId: dlp-pattern-validation-validate-pattern - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/validate_pattern' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-validate_response' - description: Validate pattern response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-validate_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Validate pattern response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Validate pattern - tags: - - DLP Pattern Validation - '/accounts/{account_identifier}/dlp/profiles': - get: - description: Lists all DLP profiles in an account. - operationId: dlp-profiles-list-all-profiles - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/profiles_components-schemas-response_collection' - description: List all profiles response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/profiles_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List all profiles response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List all profiles - tags: - - DLP Profiles - '/accounts/{account_identifier}/dlp/profiles/custom': - post: - description: Creates a set of DLP custom profiles. - operationId: dlp-profiles-create-custom-profiles - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_custom_profiles' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/create_custom_profile_response' - description: Create custom profiles response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/create_custom_profile_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create custom profiles response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create custom profiles - tags: - - DLP Profiles - '/accounts/{account_identifier}/dlp/profiles/custom/{profile_id}': - delete: - description: Deletes a DLP custom profile. - operationId: dlp-profiles-delete-custom-profile - parameters: - - in: path - name: profile_id - required: true - schema: - $ref: '#/components/schemas/profile_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Delete custom profile response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete custom profile response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete custom profile - tags: - - DLP Profiles - get: - description: Fetches a custom DLP profile. - operationId: dlp-profiles-get-custom-profile - parameters: - - in: path - name: profile_id - required: true - schema: - $ref: '#/components/schemas/profile_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/custom_profile_response' - description: Get custom profile response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/custom_profile_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get custom profile response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get custom profile - tags: - - DLP Profiles - put: - description: Updates a DLP custom profile. - operationId: dlp-profiles-update-custom-profile - parameters: - - in: path - name: profile_id - required: true - schema: - $ref: '#/components/schemas/profile_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/update_custom_profile' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/custom_profile' - description: Update custom profile response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/custom_profile' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update custom profile response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update custom profile - tags: - - DLP Profiles - '/accounts/{account_identifier}/dlp/profiles/predefined/{profile_id}': - get: - description: Fetches a predefined DLP profile. - operationId: dlp-profiles-get-predefined-profile - parameters: - - in: path - name: profile_id - required: true - schema: - $ref: '#/components/schemas/profile_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/predefined_profile_response' - description: Get predefined profile response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/predefined_profile_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get predefined profile response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get predefined profile - tags: - - DLP Profiles - put: - description: Updates a DLP predefined profile. Only supports enabling/disabling entries. - operationId: dlp-profiles-update-predefined-profile - parameters: - - in: path - name: profile_id - required: true - schema: - $ref: '#/components/schemas/profile_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/update_predefined_profile' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/predefined_profile' - description: Update predefined profile response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/predefined_profile' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update predefined profile response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update predefined profile - tags: - - DLP Profiles - '/accounts/{account_identifier}/dlp/profiles/{profile_id}': - get: - description: Fetches a DLP profile by ID. Supports both predefined and custom profiles - operationId: dlp-profiles-get-dlp-profile - parameters: - - in: path - name: profile_id - required: true - schema: - $ref: '#/components/schemas/profile_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/either_profile_response' - description: Get DLP Profile response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/either_profile_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get DLP Profile response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get DLP Profile - tags: - - DLP Profiles diff --git a/providers/src/cloudflare/v00.00.00000/services/dcv_delegation.yaml b/providers/src/cloudflare/v00.00.00000/services/dcv_delegation.yaml new file mode 100644 index 00000000..dd906005 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/dcv_delegation.yaml @@ -0,0 +1,215 @@ +openapi: 3.0.3 +info: + title: dcv_delegation API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/dcv_delegation/uuid: + get: + description: >- + Retrieve the account and zone specific unique identifier used as part of + the CNAME target for DCV Delegation. + operationId: dcv-delegation-uuid-get + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesDcvDelegationResponse + description: Retrieve the DCV Delegation unique identifier response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + uuid: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUuid' + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Retrieve the DCV Delegation unique identifier response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve the DCV Delegation unique identifier. + tags: + - DCV Delegation + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dcv_delegation + resource_chain: [] + method: get +components: + schemas: + tlsCertificatesAndHostnamesDcvDelegationResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUuidObject' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesUuid: + description: The DCV Delegation unique identifier. + example: abc123def456ghi7 + type: string + x-auditable: true + tlsCertificatesAndHostnamesUuidObject: + properties: + uuid: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUuid' + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + uuid: + id: cloudflare.dcv_delegation.uuid + name: uuid + title: Uuid + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dcv_delegation~1uuid/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/uuid/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/ddos_protection.yaml b/providers/src/cloudflare/v00.00.00000/services/ddos_protection.yaml new file mode 100644 index 00000000..9bcc4383 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/ddos_protection.yaml @@ -0,0 +1,3388 @@ +openapi: 3.0.3 +info: + title: ddos_protection API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist: + delete: + description: Delete all allowlist prefixes for an account. + operationId: deleteAllowlistPrefixesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete all allowlist prefixes response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete all allowlist prefixes failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all allowlist prefixes. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - allowlist + method: bulk_delete + get: + description: List all allowlist prefixes for an account. + operationId: listAllowlistPrefixesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The page number for pagination. Defaults to 1. + explode: false + in: query + name: page + schema: + format: int64 + type: integer + x-auditable: true + - description: >- + The number of items per page. Must be between 10 and 1000. Defaults + to 25. + explode: false + in: query + name: per_page + schema: + format: int64 + type: integer + x-auditable: true + - description: The field to order by. Defaults to 'prefix'. + explode: false + in: query + name: order + schema: + type: string + - description: The direction of ordering (ASC or DESC). Defaults to 'ASC'. + explode: false + in: query + name: direction + schema: + type: string + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosInfraPrefixListResponse' + description: List all allowlist prefixes response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: List all allowlist prefixes failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all allowlist prefixes. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - allowlist + method: list + post: + description: Create an allowlist prefix for an account. + operationId: createAllowlistedPrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosNewInfraPrefix' + description: The new allowlist prefix to create. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosInfraPrefixResponse' + description: Create allowlist prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create allowlist prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create allowlist prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - allowlist + method: create + /accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}: + delete: + description: Delete the allowlist prefix for an account given a UUID. + operationId: deleteAllowlistPrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete allowlist prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete allowlist prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete allowlist prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - allowlist + - items + method: delete + get: + description: Get an allowlist prefix specified by the given UUID. + operationId: getAllowlistPrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosInfraPrefixResponse' + description: Get allowlist prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get allowlist prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get allowlist prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - allowlist + - items + method: get + patch: + description: Update an allowlist prefix specified by the given UUID. + operationId: updateAllowlistPrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosInfraPrefixUpdate' + description: The updates to apply to the allowlist prefix. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosInfraPrefixResponse' + description: Update allowlist prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update allowlist prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update allowlist prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - allowlist + - items + method: edit + /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes: + delete: + description: Delete all prefixes for an account. + operationId: deletePrefixesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete all prefixes response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete all prefixes failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all prefixes. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - prefixes + method: bulk_delete + get: + description: List all prefixes for an account. + operationId: listPrefixesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The page number for pagination. Defaults to 1. + explode: false + in: query + name: page + schema: + format: int64 + type: integer + x-auditable: true + - description: >- + The number of items per page. Must be between 10 and 1000. Defaults + to 25. + explode: false + in: query + name: per_page + schema: + format: int64 + type: integer + x-auditable: true + - description: The field to order by. Defaults to 'prefix'. + explode: false + in: query + name: order + schema: + type: string + x-auditable: true + - description: The direction of ordering (ASC or DESC). Defaults to 'ASC'. + explode: false + in: query + name: direction + schema: + type: string + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosPrefixListResponse' + description: List all prefixes response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: List all allowlist prefixes failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all prefixes. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - prefixes + method: list + post: + description: Create a prefix for an account. + operationId: createPrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosNewPrefix' + description: The new prefix to create. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosPrefixResponse' + description: Create prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - prefixes + method: create + /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/bulk: + post: + description: Create multiple prefixes for an account. + operationId: bulkCreatePrefixes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/dosNewPrefix' + type: array + description: The list of new prefixes to create. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosPrefixListResponse' + description: Create multiple prefixes response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create multiple prefixes failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create multiple prefixes. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + /accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}: + delete: + description: Delete the prefix for an account given a UUID. + operationId: deletePrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - prefixes + - items + method: delete + get: + description: Get a prefix specified by the given UUID. + operationId: getPrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosPrefixResponse' + description: Get prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - prefixes + - items + method: get + patch: + description: Update a prefix specified by the given UUID. + operationId: updatePrefix + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: prefix_id + in: path + required: true + description: The IP prefix ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosPrefixUpdate' + description: The updates to apply to the prefix. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosPrefixResponse' + description: Update prefix response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update prefix failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update prefix. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - prefixes + - items + method: edit + /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters: + delete: + description: Delete all SYN Protection filters for an account. + operationId: deleteSynProtectionFiltersForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete all SYN Protection filters response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete all SYN Protection filters failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all SYN Protection filters. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - filters + method: bulk_delete + get: + description: List all SYN Protection filters for an account. + operationId: listSynProtectionFiltersForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + The mode of the filters to get. Optional. Valid values: 'enabled', + 'disabled', 'monitoring'. + explode: false + in: query + name: mode + schema: + type: string + x-auditable: true + - description: The page number for pagination. Defaults to 1. + explode: false + in: query + name: page + schema: + format: int64 + type: integer + x-auditable: true + - description: >- + The number of items per page. Must be between 10 and 1000. Defaults + to 25. + explode: false + in: query + name: per_page + schema: + format: int64 + type: integer + x-auditable: true + - description: The field to order by. Defaults to 'prefix'. + explode: false + in: query + name: order + schema: + type: string + x-auditable: true + - description: The direction of ordering (ASC or DESC). Defaults to 'ASC'. + explode: false + in: query + name: direction + schema: + type: string + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterListResponse' + description: List all SYN Protection filters response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: List all SYN Protection filters failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all SYN Protection filters. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - filters + method: list + post: + description: Create a SYN Protection filter for an account. + operationId: createSynProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosNewExpressionFilter' + description: The new filter to create. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterResponse' + description: Create SYN Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create SYN Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a SYN Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - filters + method: create + /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}: + delete: + description: Delete a SYN Protection filter specified by the given UUID. + operationId: deleteSynProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The UUID of the filter to delete. + in: path + name: filter_id + schema: + $ref: '#/components/schemas/dosUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete SYN Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete SYN Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete SYN Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - filters + - items + method: delete + get: + description: Get a SYN Protection filter specified by the given UUID. + operationId: getSynProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The UUID of the filter to retrieve. + in: path + name: filter_id + schema: + $ref: '#/components/schemas/dosUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterResponse' + description: Get SYN Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get SYN Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get SYN Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - filters + - items + method: get + patch: + description: Update a SYN Protection filter specified by the given UUID. + operationId: updateSynProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The UUID of the filter to update. + in: path + name: filter_id + schema: + $ref: '#/components/schemas/dosUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterUpdate' + description: The updates to apply to the filter. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterResponse' + description: Update SYN Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update SYN Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update SYN Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - filters + - items + method: edit + /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules: + delete: + description: Delete all SYN Protection rules for an account. + operationId: deleteSynProtectionRulesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete all SYN Protection rules response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete all SYN Protection rules failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all SYN Protection rules. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - rules + method: bulk_delete + get: + description: List all SYN Protection rules for an account. + operationId: listSynProtectionRulesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The page number for pagination. Defaults to 1. + explode: false + in: query + name: page + schema: + format: int64 + type: integer + x-auditable: true + - description: >- + The number of items per page. Must be between 10 and 1000. Defaults + to 25. + explode: false + in: query + name: per_page + schema: + format: int64 + type: integer + x-auditable: true + - description: The field to order by. Defaults to 'prefix'. + explode: false + in: query + name: order + schema: + type: string + x-auditable: true + - description: The direction of ordering (ASC or DESC). Defaults to 'ASC'. + explode: false + in: query + name: direction + schema: + type: string + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosSynProtectionRuleListResponse' + description: List all SYN Protection rules response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: List all SYN Protection rules failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all SYN Protection rules. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - rules + method: list + post: + description: Create a SYN Protection rule for an account. + operationId: createSynProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosNewSynProtectionRule' + description: The new SYN Protection rule to add. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosSynProtectionRuleResponse' + description: Create SYN Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create SYN Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create SYN Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - rules + method: create + /accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id}: + delete: + description: Delete a SYN Protection rule specified by the given UUID. + operationId: deleteSynProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete SYN Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete SYN Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete SYN Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - rules + - items + method: delete + get: + description: Get a SYN Protection rule specified by the given UUID. + operationId: getSynProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosSynProtectionRuleResponse' + description: Get SYN Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get SYN Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get SYN Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - rules + - items + method: get + patch: + description: Update a SYN Protection rule specified by the given UUID. + operationId: updateSynProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosSynProtectionRuleUpdate' + description: The fields to update on the SYN Protection rule. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosSynProtectionRuleResponse' + description: Update SYN Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update SYN Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update SYN Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - syn_protection + - rules + - items + method: edit + /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters: + delete: + description: Delete all TCP Flow Protection filters for an account. + operationId: deleteTcpFlowProtectionFiltersForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete all TCP Flow Protection filters response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete all TCP Flow Protection filters failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all TCP Flow Protection filters. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - filters + method: bulk_delete + get: + description: List all TCP Flow Protection filters for an account. + operationId: listTcpFlowProtectionFiltersForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + The mode of the filters to get. Optional. Valid values: 'enabled', + 'disabled', 'monitoring'. + explode: false + in: query + name: mode + schema: + type: string + x-auditable: true + - description: The page number for pagination. Defaults to 1. + explode: false + in: query + name: page + schema: + format: int64 + type: integer + x-auditable: true + - description: >- + The number of items per page. Must be between 10 and 1000. Defaults + to 25. + explode: false + in: query + name: per_page + schema: + format: int64 + type: integer + x-auditable: true + - description: The field to order by. Defaults to 'prefix'. + explode: false + in: query + name: order + schema: + type: string + x-auditable: true + - description: The direction of ordering (ASC or DESC). Defaults to 'ASC'. + explode: false + in: query + name: direction + schema: + type: string + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterListResponse' + description: List all TCP Flow Protection filters response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: List all TCP Flow Protection filters failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all TCP Flow Protection filters. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - filters + method: list + post: + description: Create a TCP Flow Protection filter for an account. + operationId: createTcpFlowProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosNewExpressionFilter' + description: The new filter to create. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterResponse' + description: Create TCP Flow Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create TCP Flow Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a TCP Flow Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - filters + method: create + /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}: + delete: + description: Delete a TCP Flow Protection filter specified by the given UUID. + operationId: deleteTcpFlowProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The UUID of the filter to delete. + in: path + name: filter_id + schema: + $ref: '#/components/schemas/dosUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete TCP Flow Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete TCP Flow Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete TCP Flow Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - filters + - items + method: delete + get: + description: Get a TCP Flow Protection filter specified by the given UUID. + operationId: getTcpFlowProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The UUID of the filter to retrieve. + in: path + name: filter_id + schema: + $ref: '#/components/schemas/dosUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterResponse' + description: Get TCP Flow Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get TCP Flow Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get TCP Flow Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - filters + - items + method: get + patch: + description: Update a TCP Flow Protection filter specified by the given UUID. + operationId: updateTcpFlowProtectionFilter + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The UUID of the filter to update. + in: path + name: filter_id + schema: + $ref: '#/components/schemas/dosUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterUpdate' + description: The updates to apply to the filter. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosExpressionFilterResponse' + description: Update TCP Flow Protection filter response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update TCP Flow Protection filter failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update TCP Flow Protection filter. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - filters + - items + method: edit + /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules: + delete: + description: Delete all TCP Flow Protection rules for an account. + operationId: deleteTcpFlowProtectionRulesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete all TCP Flow Protection rules response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete all TCP Flow Protection rules failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all TCP Flow Protection rules. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - rules + method: bulk_delete + get: + description: List all TCP Flow Protection rules for an account. + operationId: listTcpFlowProtectionRulesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The page number for pagination. Defaults to 1. + explode: false + in: query + name: page + schema: + format: int64 + type: integer + x-auditable: true + - description: >- + The number of items per page. Must be between 10 and 1000. Defaults + to 25. + explode: false + in: query + name: per_page + schema: + format: int64 + type: integer + x-auditable: true + - description: The field to order by. Defaults to 'prefix'. + explode: false + in: query + name: order + schema: + type: string + x-auditable: true + - description: The direction of ordering (ASC or DESC). Defaults to 'ASC'. + explode: false + in: query + name: direction + schema: + type: string + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosTcpFlowProtectionRuleListResponse' + description: List all TCP Flow Protection rules response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: List all TCP Flow Protection rules failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all TCP Flow Protection rules. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - rules + method: list + post: + description: Create a TCP Flow Protection rule for an account. + operationId: createTcpFlowProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosNewTcpFlowProtectionRule' + description: The new TCP Flow Protection rule. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosTcpFlowProtectionRuleResponse' + description: Create TCP Flow Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create TCP Flow Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create TCP Flow Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - rules + method: create + /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id}: + delete: + description: Delete a TCP Flow Protection rule specified by the given UUID. + operationId: deleteTcpFlowProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete TCP Flow Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete TCP Flow Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete TCP Flow Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - rules + - items + method: delete + get: + description: Get a TCP Flow Protection rule specified by the given UUID. + operationId: getTcpFlowProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosTcpFlowProtectionRuleResponse' + description: Get TCP Flow Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get TCP Flow Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get TCP Flow Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - rules + - items + method: get + patch: + description: Update a TCP Flow Protection rule specified by the given UUID. + operationId: updateTcpFlowProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosTcpFlowProtectionRuleUpdate' + description: The updates to apply to the TCP Flow Protection rule. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosTcpFlowProtectionRuleResponse' + description: Update TCP Flow Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update TCP Flow Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update TCP Flow Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - tcp_flow_protection + - rules + - items + method: edit + /accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status: + get: + description: Get the protection status of the account. + operationId: getProtectionStatus + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosProtectionStatusResponse' + description: Get protection status response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get protection status failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get protection status. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - status + method: get + patch: + description: Update the protection status of the account. + operationId: updateProtectionStatus + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosUpdateProtectionStatus' + description: The update to apply to the protection status. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosProtectionStatusResponse' + description: Update protection status response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update protection status failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update protection status. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + x-stackql-sdk: + service: ddos_protection + resource_chain: + - advanced_tcp_protection + - status + method: edit +components: + schemas: + dosApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + dosApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/dosMessages' + messages: + example: [] + $ref: '#/components/schemas/dosMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + dosExpressionFilter: + properties: + created_on: + description: The creation timestamp of the expression filter. + format: date-time + type: string + x-auditable: true + readOnly: true + expression: + description: The filter expression. + example: >- + ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 + 443 10000..65535 } + type: string + x-auditable: true + id: + description: The unique ID of the expression filter. + type: string + x-auditable: true + mode: + description: >- + The filter's mode. Must be one of 'enabled', 'disabled', + 'monitoring'. + type: string + x-auditable: true + modified_on: + description: The last modification timestamp of the expression filter. + format: date-time + type: string + x-auditable: true + readOnly: true + required: + - id + - expression + - mode + - created_on + - modified_on + type: object + dosExpressionFilterListResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dosExpressionFilter' + type: array + required: + - success + - errors + - messages + dosExpressionFilterResponse: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dosExpressionFilter' + required: + - success + - errors + - messages + type: object + dosExpressionFilterUpdate: + properties: + expression: + description: The new filter expression. Optional. + example: >- + ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 + 443 10000..65535 } + type: string + x-auditable: true + mode: + description: >- + The new mode for the filter. Optional. Must be one of 'enabled', + 'disabled', 'monitoring'. + type: string + x-auditable: true + type: object + dosInfraPrefix: + properties: + comment: + description: An optional comment describing the allowlist prefix. + type: string + x-auditable: true + created_on: + description: The creation timestamp of the allowlist prefix. + format: date-time + type: string + x-auditable: true + readOnly: true + enabled: + description: >- + Whether to enable the allowlist prefix into effect. Defaults to + false. + type: boolean + x-auditable: true + id: + description: The unique ID of the allowlist prefix. + type: string + x-auditable: true + modified_on: + description: The last modification timestamp of the allowlist prefix. + format: date-time + type: string + x-auditable: true + readOnly: true + prefix: + description: The allowlist prefix in CIDR format. + type: string + x-auditable: true + required: + - id + - prefix + - comment + - enabled + - created_on + - modified_on + type: object + dosInfraPrefixListResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dosInfraPrefix' + type: array + required: + - success + - errors + - messages + dosInfraPrefixResponse: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dosInfraPrefix' + required: + - success + - errors + - messages + type: object + dosInfraPrefixUpdate: + properties: + comment: + description: A comment describing the allowlist prefix. Optional. + type: string + x-auditable: true + enabled: + description: Whether to enable the allowlist prefix into effect. Optional. + type: boolean + x-auditable: true + type: object + dosMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dosNewExpressionFilter: + properties: + expression: + description: The filter expression. + example: >- + ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 + 443 10000..65535 } + type: string + x-auditable: true + mode: + description: >- + The filter's mode. Must be one of 'enabled', 'disabled', + 'monitoring'. + type: string + x-auditable: true + required: + - expression + - mode + type: object + dosNewInfraPrefix: + properties: + comment: + description: An comment describing the allowlist prefix. + type: string + x-auditable: true + enabled: + description: Whether to enable the allowlist prefix into effect. + type: boolean + x-auditable: true + prefix: + description: The allowlist prefix to add in CIDR format. + type: string + x-auditable: true + required: + - prefix + - comment + - enabled + type: object + dosNewPrefix: + properties: + comment: + description: A comment describing the prefix. + type: string + x-auditable: true + excluded: + description: Whether to exclude the prefix from protection. + type: boolean + x-auditable: true + prefix: + description: The prefix to add in CIDR format. + example: 192.0.2.0/24 + type: string + x-auditable: true + required: + - prefix + - comment + - excluded + type: object + dosNewSynProtectionRule: + properties: + burst_sensitivity: + description: The burst sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + mitigation_type: + description: >- + The type of mitigation. Must be one of 'challenge' or 'retransmit'. + Optional. Defaults to 'challenge'. + type: string + x-auditable: true + mode: + description: >- + The mode for SYN Protection. Must be one of 'enabled', 'disabled', + 'monitoring'. + type: string + x-auditable: true + name: + description: >- + The name of the SYN Protection rule. Value is relative to the + 'scope' setting. For 'global' scope, name should be 'global'. For + either the 'region' or 'datacenter' scope, name should be the actual + name of the region or datacenter, e.g., 'wnam' or 'lax'. + type: string + x-auditable: true + rate_sensitivity: + description: The rate sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + scope: + description: >- + The scope for the SYN Protection rule. Must be one of 'global', + 'region', or 'datacenter'. + type: string + x-auditable: true + required: + - scope + - name + - mode + - rate_sensitivity + - burst_sensitivity + type: object + dosNewTcpFlowProtectionRule: + properties: + burst_sensitivity: + description: The burst sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + mode: + description: >- + The mode for the TCP Flow Protection. Must be one of 'enabled', + 'disabled', 'monitoring'. + type: string + x-auditable: true + name: + description: >- + The name of the TCP Flow Protection rule. Value is relative to the + 'scope' setting. For 'global' scope, name should be 'global'. For + either the 'region' or 'datacenter' scope, name should be the actual + name of the region or datacenter, e.g., 'wnam' or 'lax'. + type: string + x-auditable: true + rate_sensitivity: + description: The rate sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + scope: + description: The scope for the TCP Flow Protection rule. + type: string + x-auditable: true + required: + - scope + - name + - mode + - rate_sensitivity + - burst_sensitivity + type: object + dosPrefix: + properties: + comment: + description: A comment describing the prefix. + type: string + x-auditable: true + created_on: + description: The creation timestamp of the prefix. + format: date-time + type: string + x-auditable: true + readOnly: true + excluded: + description: Whether to exclude the prefix from protection. + type: boolean + x-auditable: true + id: + description: The unique ID of the prefix. + type: string + x-auditable: true + modified_on: + description: The last modification timestamp of the prefix. + format: date-time + type: string + x-auditable: true + readOnly: true + prefix: + description: The prefix in CIDR format. + example: 192.0.2.0/24 + type: string + x-auditable: true + required: + - id + - prefix + - comment + - excluded + - created_on + - modified_on + type: object + dosPrefixListResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dosPrefix' + type: array + required: + - success + - errors + - messages + dosPrefixResponse: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dosPrefix' + required: + - success + - errors + - messages + type: object + dosPrefixUpdate: + properties: + comment: + description: A new comment for the prefix. Optional. + type: string + x-auditable: true + excluded: + description: Whether to exclude the prefix from protection. Optional. + type: boolean + x-auditable: true + type: object + dosProtectionStatus: + properties: + enabled: + type: boolean + x-auditable: true + required: + - enabled + type: object + dosProtectionStatusResponse: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dosProtectionStatus' + required: + - success + - errors + - messages + type: object + dosSynProtectionRule: + properties: + burst_sensitivity: + description: The burst sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + created_on: + description: The creation timestamp of the SYN Protection rule. + format: date-time + type: string + x-auditable: true + readOnly: true + id: + description: The unique ID of the SYN Protection rule. + type: string + x-auditable: true + mitigation_type: + description: >- + The type of mitigation for SYN Protection. Must be one of + 'challenge' or 'retransmit'. + type: string + x-auditable: true + mode: + description: >- + The mode for SYN Protection. Must be one of 'enabled', 'disabled', + 'monitoring'. + type: string + x-auditable: true + modified_on: + description: The last modification timestamp of the SYN Protection rule. + format: date-time + type: string + x-auditable: true + readOnly: true + name: + description: >- + The name of the SYN Protection rule. Value is relative to the + 'scope' setting. For 'global' scope, name should be 'global'. For + either the 'region' or 'datacenter' scope, name should be the actual + name of the region or datacenter, e.g., 'wnam' or 'lax'. + type: string + x-auditable: true + rate_sensitivity: + description: The rate sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + scope: + description: >- + The scope for the SYN Protection rule. Must be one of 'global', + 'region', or 'datacenter'. + type: string + x-auditable: true + required: + - id + - scope + - name + - mode + - mitigation_type + - rate_sensitivity + - burst_sensitivity + - created_on + - modified_on + type: object + dosSynProtectionRuleListResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dosSynProtectionRule' + type: array + required: + - success + - errors + - messages + dosSynProtectionRuleResponse: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dosSynProtectionRule' + required: + - success + - errors + - messages + type: object + dosSynProtectionRuleUpdate: + properties: + burst_sensitivity: + description: >- + The new burst sensitivity. Optional. Must be one of 'low', 'medium', + 'high'. + type: string + x-auditable: true + mitigation_type: + description: >- + The new mitigation type. Optional. Must be one of 'challenge' or + 'retransmit'. + type: string + x-auditable: true + mode: + description: >- + The new mode for SYN Protection. Optional. Must be one of 'enabled', + 'disabled', 'monitoring'. + type: string + x-auditable: true + rate_sensitivity: + description: >- + The new rate sensitivity. Optional. Must be one of 'low', 'medium', + 'high'. + type: string + x-auditable: true + type: object + dosTcpFlowProtectionRule: + properties: + burst_sensitivity: + description: The burst sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + created_on: + description: The creation timestamp of the TCP Flow Protection rule. + format: date-time + type: string + x-auditable: true + readOnly: true + id: + description: The unique ID of the TCP Flow Protection rule. + type: string + x-auditable: true + mode: + description: >- + The mode for TCP Flow Protection. Must be one of 'enabled', + 'disabled', 'monitoring'. + type: string + x-auditable: true + modified_on: + description: The last modification timestamp of the TCP Flow Protection rule. + format: date-time + type: string + x-auditable: true + readOnly: true + name: + description: >- + The name of the TCP Flow Protection rule. Value is relative to the + 'scope' setting. For 'global' scope, name should be 'global'. For + either the 'region' or 'datacenter' scope, name should be the actual + name of the region or datacenter, e.g., 'wnam' or 'lax'. + type: string + x-auditable: true + rate_sensitivity: + description: The rate sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + scope: + description: >- + The scope for the TCP Flow Protection rule. Must be one of 'global', + 'region', or 'datacenter'. + type: string + x-auditable: true + required: + - id + - scope + - name + - mode + - rate_sensitivity + - burst_sensitivity + - created_on + - modified_on + type: object + dosTcpFlowProtectionRuleListResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dosTcpFlowProtectionRule' + type: array + required: + - success + - errors + - messages + dosTcpFlowProtectionRuleResponse: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dosTcpFlowProtectionRule' + required: + - success + - errors + - messages + type: object + dosTcpFlowProtectionRuleUpdate: + properties: + burst_sensitivity: + description: >- + The new burst sensitivity. Optional. Must be one of 'low', 'medium', + 'high'. + type: string + x-auditable: true + mode: + description: >- + The new mode for TCP Flow Protection. Optional. Must be one of + 'enabled', 'disabled', 'monitoring'. + type: string + x-auditable: true + rate_sensitivity: + description: >- + The new rate sensitivity. Optional. Must be one of 'low', 'medium', + 'high'. + type: string + x-auditable: true + type: object + dosUpdateProtectionStatus: + properties: + enabled: + description: Enables or disables protection. + type: boolean + x-auditable: true + required: + - enabled + type: object + dosUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + allowlist: + id: cloudflare.ddos_protection.allowlist + name: allowlist + title: Allowlist + methods: + bulk_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1allowlist/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1allowlist/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1allowlist/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/allowlist/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/allowlist/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/allowlist/methods/bulk_delete' + replace: [] + configs_allowlist: + id: cloudflare.ddos_protection.configs_allowlist + name: configs_allowlist + title: Configs Allowlist + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1allowlist~1{prefix_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1allowlist~1{prefix_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1allowlist~1{prefix_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configs_allowlist/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/configs_allowlist/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/configs_allowlist/methods/delete' + replace: [] + prefixes: + id: cloudflare.ddos_protection.prefixes + name: prefixes + title: Prefixes + methods: + bulk_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1prefixes/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1prefixes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1prefixes/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1prefixes~1bulk/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/prefixes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/prefixes/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/prefixes/methods/bulk_delete' + replace: [] + configs_prefixes: + id: cloudflare.ddos_protection.configs_prefixes + name: configs_prefixes + title: Configs Prefixes + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1prefixes~1{prefix_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1prefixes~1{prefix_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1prefixes~1{prefix_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configs_prefixes/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/configs_prefixes/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/configs_prefixes/methods/delete' + replace: [] + syn_protection_filters: + id: cloudflare.ddos_protection.syn_protection_filters + name: syn_protection_filters + title: Syn Protection Filters + methods: + bulk_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1filters/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1filters/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1filters/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1filters~1{filter_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1filters~1{filter_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1filters~1{filter_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/syn_protection_filters/methods/get + - $ref: >- + #/components/x-stackQL-resources/syn_protection_filters/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/syn_protection_filters/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/syn_protection_filters/methods/edit + delete: + - $ref: >- + #/components/x-stackQL-resources/syn_protection_filters/methods/delete + - $ref: >- + #/components/x-stackQL-resources/syn_protection_filters/methods/bulk_delete + replace: [] + syn_protection_rules: + id: cloudflare.ddos_protection.syn_protection_rules + name: syn_protection_rules + title: Syn Protection Rules + methods: + bulk_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1rules/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1rules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1rules/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1rules~1{rule_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1syn_protection~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/syn_protection_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/syn_protection_rules/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/syn_protection_rules/methods/create + update: + - $ref: '#/components/x-stackQL-resources/syn_protection_rules/methods/edit' + delete: + - $ref: >- + #/components/x-stackQL-resources/syn_protection_rules/methods/delete + - $ref: >- + #/components/x-stackQL-resources/syn_protection_rules/methods/bulk_delete + replace: [] + tcp_flow_protection_filters: + id: cloudflare.ddos_protection.tcp_flow_protection_filters + name: tcp_flow_protection_filters + title: Tcp Flow Protection Filters + methods: + bulk_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1filters/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1filters/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1filters/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1filters~1{filter_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1filters~1{filter_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1filters~1{filter_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_filters/methods/get + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_filters/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_filters/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_filters/methods/edit + delete: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_filters/methods/delete + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_filters/methods/bulk_delete + replace: [] + tcp_flow_protection_rules: + id: cloudflare.ddos_protection.tcp_flow_protection_rules + name: tcp_flow_protection_rules + title: Tcp Flow Protection Rules + methods: + bulk_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1rules/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1rules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1rules/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1rules~1{rule_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_flow_protection~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_rules/methods/get + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_rules/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_rules/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_rules/methods/edit + delete: + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_rules/methods/delete + - $ref: >- + #/components/x-stackQL-resources/tcp_flow_protection_rules/methods/bulk_delete + replace: [] + status: + id: cloudflare.ddos_protection.status + name: status + title: Status + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_protection_status/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1magic~1advanced_tcp_protection~1configs~1tcp_protection_status/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/status/methods/edit' + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/devices.yaml b/providers/src/cloudflare/v00.00.00000/services/devices.yaml deleted file mode 100644 index e526142b..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/devices.yaml +++ /dev/null @@ -1,2708 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Device Posture Integrations - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - devices - version: 4.0.0 -components: - schemas: - device-posture-integrations_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - device-posture-integrations_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/device-posture-integrations' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - device-posture-integrations: - properties: - config: - $ref: '#/components/schemas/config_response' - id: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid' - interval: - $ref: '#/components/schemas/schemas-interval' - name: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-name' - type: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-type' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - config_response: - description: The configuration object containing third party integration information. - example: - api_url: 'https://as123.awmdm.com/API' - auth_url: 'https://na.uemauth.vmwservices.com/connect/token' - client_id: example client id - oneOf: - - $ref: '#/components/schemas/workspace_one_config_response' - type: object - device-posture-integrations_components-schemas-uuid: - description: API uuid tag. - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - type: string - schemas-interval: - description: The interval between each posture check with the third party API. Use "m" for minutes (e.g. "5m") and "h" for hours (e.g. "12h"). - example: 10m - type: string - device-posture-integrations_components-schemas-name: - description: The name of the Device Posture Integration. - example: My Workspace One Integration - type: string - device-posture-integrations_components-schemas-type: - description: The type of Device Posture Integration. - enum: - - workspace_one - - crowdstrike_s2s - - uptycs - - intune - example: workspace_one - type: string - workspace_one_config_response: - description: The Workspace One Config Response. - properties: - api_url: - description: The Workspace One API URL provided in the Workspace One Admin Dashboard. - example: 'https://as123.awmdm.com/API' - type: string - auth_url: - description: The Workspace One Authorization URL depending on your region. - example: 'https://na.uemauth.vmwservices.com/connect/token' - type: string - client_id: - description: The Workspace One client ID provided in the Workspace One Admin Dashboard. - example: example client id - type: string - required: - - api_url - - auth_url - - client_id - type: object - config_request: - description: The configuration object containing third party integration information. - example: - api_url: 'https://as123.awmdm.com/API' - auth_url: 'https://na.uemauth.vmwservices.com/connect/token' - client_id: example client id - client_secret: example client secret - oneOf: - - $ref: '#/components/schemas/workspace_one_config_request' - - $ref: '#/components/schemas/crowdstrike_config_request' - - $ref: '#/components/schemas/uptycs_config_request' - - $ref: '#/components/schemas/intune_config_request' - type: object - device-posture-integrations_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/device-posture-integrations' - workspace_one_config_request: - properties: - api_url: - description: The Workspace One API URL provided in the Workspace One Admin Dashboard. - example: 'https://as123.awmdm.com/API' - type: string - auth_url: - description: The Workspace One Authorization URL depending on your region. - example: 'https://na.uemauth.vmwservices.com/connect/token' - type: string - client_id: - description: The Workspace One client ID provided in the Workspace One Admin Dashboard. - example: example client id - type: string - client_secret: - description: The Workspace One client secret provided in the Workspace One Admin Dashboard. - example: example client secret - type: string - required: - - api_url - - auth_url - - client_id - - client_secret - type: object - crowdstrike_config_request: - properties: - api_url: - description: The Crowdstrike API URL. - example: 'https://api.us-2.crowdstrike.com' - type: string - client_id: - description: The Crowdstrike client ID. - example: example client id - type: string - client_secret: - description: The Crowdstrike client secret. - example: example client secret - type: string - customer_id: - description: The Crowdstrike customer ID. - example: example customer id - type: string - required: - - api_url - - customer_id - - client_id - - client_secret - type: object - uptycs_config_request: - properties: - client_key: - description: The Uptycs client secret. - example: example client key - type: string - client_secret: - description: The Uptycs client secret. - example: example client secret - type: string - customer_id: - description: The Uptycs customer ID. - example: example customer id - type: string - required: - - client_key - - customer_id - - client_secret - type: object - intune_config_request: - properties: - client_id: - description: The Intune client ID. - example: example client id - type: string - client_secret: - description: The Intune client secret. - example: example client secret - type: string - customer_id: - description: The Intune customer ID. - example: example customer id - type: string - required: - - customer_id - - client_id - - client_secret - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - device-posture-integrations_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - nullable: true - device-posture-rules_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - device-posture-rules_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/device-posture-rules' - type: array - device-posture-rules: - properties: - description: - $ref: '#/components/schemas/device-posture-rules_components-schemas-description' - expiration: - $ref: '#/components/schemas/schemas-expiration' - id: - $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid' - input: - $ref: '#/components/schemas/schemas-input' - match: - $ref: '#/components/schemas/schemas-match' - name: - $ref: '#/components/schemas/device-posture-rules_components-schemas-name' - schedule: - $ref: '#/components/schemas/schedule' - type: - $ref: '#/components/schemas/device-posture-rules_components-schemas-type' - type: object - device-posture-rules_components-schemas-description: - description: The description of the Device Posture Rule. - example: The rule for admin serial numbers - type: string - schemas-expiration: - description: Expire posture results after the specified amount of time. - example: 1h - type: string - device-posture-rules_components-schemas-uuid: - description: API uuid tag. - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - type: string - schemas-input: - description: The value to be checked against. - properties: - id: - $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid' - type: object - schemas-match: - description: The conditions that the client must match to run the rule. - items: - $ref: '#/components/schemas/match_item' - type: array - device-posture-rules_components-schemas-name: - description: The name of the Device Posture Rule. - example: Admin Serial Numbers - type: string - schedule: - description: Tells the client when to run the device posture check. - example: 1h - type: string - device-posture-rules_components-schemas-type: - description: The type of Device Posture Rule. - enum: - - file - - application - - serial_number - - tanium - - gateway - - warp - example: file - type: string - match_item: - properties: - platform: - $ref: '#/components/schemas/platform' - type: object - platform: - enum: - - windows - - mac - - linux - - android - - ios - example: windows - type: string - device-posture-rules_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/device-posture-rules' - device-posture-rules_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid' - type: object - devices_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - devices_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/devices' - type: array - devices: - properties: - created: - $ref: '#/components/schemas/devices_components-schemas-created' - deleted: - $ref: '#/components/schemas/schemas-deleted' - device_type: - $ref: '#/components/schemas/platform' - id: - $ref: '#/components/schemas/devices_components-schemas-uuid' - ip: - $ref: '#/components/schemas/devices_components-schemas-ip' - key: - $ref: '#/components/schemas/schemas-key' - last_seen: - $ref: '#/components/schemas/last_seen' - mac_address: - $ref: '#/components/schemas/mac_address' - manufacturer: - $ref: '#/components/schemas/manufacturer' - model: - $ref: '#/components/schemas/model' - name: - $ref: '#/components/schemas/devices_components-schemas-name' - os_distro_name: - $ref: '#/components/schemas/os_distro_name' - os_distro_revision: - $ref: '#/components/schemas/os_distro_revision' - os_version: - $ref: '#/components/schemas/os_version' - revoked_at: - $ref: '#/components/schemas/revoked_at' - serial_number: - $ref: '#/components/schemas/schemas-serial_number' - updated: - $ref: '#/components/schemas/updated' - user: - $ref: '#/components/schemas/user' - version: - $ref: '#/components/schemas/devices_components-schemas-version' - type: object - devices_components-schemas-created: - description: When the device was created. - example: '2017-06-14T00:00:00Z' - format: date-time - type: string - schemas-deleted: - description: True if the device was deleted. - example: true - type: boolean - devices_components-schemas-uuid: - description: Device ID. - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - type: string - devices_components-schemas-ip: - description: IPv4 or IPv6 address. - example: 1.1.1.1 - type: string - schemas-key: - description: The device's public key. - example: yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc= - type: string - last_seen: - description: When the device last connected to Cloudflare services. - example: '2017-06-14T00:00:00Z' - format: date-time - type: string - mac_address: - description: The device mac address. - example: 00-00-5E-00-53-00 - type: string - manufacturer: - description: The device manufacturer name. - example: My phone corp - type: string - model: - description: The device model name. - example: MyPhone(pro-X) - type: string - devices_components-schemas-name: - description: The device name. - example: My mobile device - type: string - os_distro_name: - description: The Linux distro name. - example: ubuntu - type: string - os_distro_revision: - description: The Linux distro revision. - example: 1.0.0 - type: string - os_version: - description: The operating system version. - example: 10.0.0 - type: string - revoked_at: - description: When the device was revoked. - example: '2017-06-14T00:00:00Z' - format: date-time - type: string - schemas-serial_number: - description: The device serial number. - example: EXAMPLEHMD6R - type: string - updated: - description: When the device was updated. - example: '2017-06-14T00:00:00Z' - format: date-time - type: string - user: - properties: - email: - $ref: '#/components/schemas/email' - id: - $ref: '#/components/schemas/uuid' - name: - description: The enrolled device user's name. - example: John Appleseed - type: string - type: object - devices_components-schemas-version: - description: The WARP client version. - example: 1.0.0 - type: string - email: - description: The contact email address of the user. - example: user@example.com - maxLength: 90 - type: string - uuid: - description: UUID - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true - type: string - device_settings_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/device_settings_policy' - type: array - device_settings_policy: - properties: - allow_mode_switch: - $ref: '#/components/schemas/allow_mode_switch' - allow_updates: - $ref: '#/components/schemas/allow_updates' - allowed_to_leave: - $ref: '#/components/schemas/allowed_to_leave' - auto_connect: - $ref: '#/components/schemas/auto_connect' - captive_portal: - $ref: '#/components/schemas/captive_portal' - default: - $ref: '#/components/schemas/schemas-default' - disable_auto_fallback: - $ref: '#/components/schemas/disable_auto_fallback' - enabled: - description: Whether the policy will be applied to matching devices. - example: true - type: boolean - exclude: - $ref: '#/components/schemas/components-schemas-exclude' - fallback_domains: - $ref: '#/components/schemas/fallback_domains' - gateway_unique_id: - $ref: '#/components/schemas/gateway_unique_id' - include: - $ref: '#/components/schemas/schemas-include' - match: - $ref: '#/components/schemas/components-schemas-match' - name: - description: The name of the device settings policy. - example: Allow Developers - maxLength: 100 - type: string - policy_id: - $ref: '#/components/schemas/uuid' - precedence: - $ref: '#/components/schemas/components-schemas-precedence' - service_mode_v2: - $ref: '#/components/schemas/service_mode_v2' - support_url: - $ref: '#/components/schemas/support_url' - switch_locked: - $ref: '#/components/schemas/switch_locked' - type: object - allow_mode_switch: - description: Whether to allow the user to switch WARP between modes. - example: true - type: boolean - allow_updates: - description: Whether to receive update notifications when a new version of the client is available. - example: true - type: boolean - allowed_to_leave: - description: Whether to allow devices to leave the organization. - example: true - type: boolean - auto_connect: - description: The amount of time in minutes to reconnect after having been disabled. - example: 0 - type: number - captive_portal: - description: Turn on the captive portal after the specified amount of time. - example: 180 - type: number - schemas-default: - description: Whether the policy is the default policy for an account. - example: false - type: boolean - disable_auto_fallback: - description: 'If the dns_server field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers, unless this policy option is set.' - example: true - type: boolean - components-schemas-exclude: - items: - $ref: '#/components/schemas/split_tunnel' - type: array - fallback_domains: - items: - $ref: '#/components/schemas/fallback_domain' - type: array - gateway_unique_id: - example: 699d98642c564d2e855e9661899b7252 - type: string - schemas-include: - items: - $ref: '#/components/schemas/split_tunnel_include' - type: array - components-schemas-match: - description: The wirefilter expression to match devices. - example: user.identity == "test@cloudflare.com" - maxLength: 500 - type: string - components-schemas-precedence: - description: The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field. - example: 100 - type: number - service_mode_v2: - properties: - mode: - description: The mode to run the WARP client under. - example: proxy - type: string - port: - description: The port number when used with proxy mode. - example: 3000 - type: number - type: object - support_url: - description: The URL to launch when the Send Feedback button is clicked. - example: 'https://1.1.1.1/help' - type: string - switch_locked: - description: Whether to allow the user to turn off the WARP switch and disconnect the client. - example: true - type: boolean - split_tunnel: - properties: - address: - description: 'The address in CIDR format to exclude from the tunnel. If address is present, host must not be present.' - example: 192.0.2.0/24 - type: string - description: - description: 'A description of the split tunnel item, displayed in the client UI.' - example: Exclude testing domains from the tunnel - maxLength: 100 - type: string - host: - description: 'The domain name to exclude from the tunnel. If host is present, address must not be present.' - example: '*.example.com' - type: string - required: - - address - - description - type: object - fallback_domain: - properties: - description: - description: 'A description of the fallback domain, displayed in the client UI.' - example: Domain bypass for local development - maxLength: 100 - type: string - dns_server: - description: A list of IP addresses to handle domain resolution. - items: {} - type: array - suffix: - description: The domain suffix to match when resolving locally. - example: example.com - type: string - required: - - suffix - type: object - split_tunnel_include: - properties: - address: - description: 'The address in CIDR format to include in the tunnel. If address is present, host must not be present.' - example: 192.0.2.0/24 - type: string - description: - description: 'A description of the split tunnel item, displayed in the client UI.' - example: Include testing domains from the tunnel - maxLength: 100 - type: string - host: - description: 'The domain name to include in the tunnel. If host is present, address must not be present.' - example: '*.example.com' - type: string - required: - - address - - description - type: object - default_device_settings_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/default_device_settings_policy' - default_device_settings_policy: - properties: - allow_mode_switch: - $ref: '#/components/schemas/allow_mode_switch' - allow_updates: - $ref: '#/components/schemas/allow_updates' - allowed_to_leave: - $ref: '#/components/schemas/allowed_to_leave' - auto_connect: - $ref: '#/components/schemas/auto_connect' - captive_portal: - $ref: '#/components/schemas/captive_portal' - default: - description: Whether the policy will be applied to matching devices. - example: true - type: boolean - disable_auto_fallback: - $ref: '#/components/schemas/disable_auto_fallback' - enabled: - description: Whether the policy will be applied to matching devices. - example: true - type: boolean - exclude: - $ref: '#/components/schemas/components-schemas-exclude' - fallback_domains: - $ref: '#/components/schemas/fallback_domains' - gateway_unique_id: - $ref: '#/components/schemas/gateway_unique_id' - include: - $ref: '#/components/schemas/schemas-include' - service_mode_v2: - $ref: '#/components/schemas/service_mode_v2' - support_url: - $ref: '#/components/schemas/support_url' - switch_locked: - $ref: '#/components/schemas/switch_locked' - type: object - device_settings_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/device_settings_policy' - split_tunnel_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/split_tunnel' - type: array - fallback_domain_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/fallback_domain' - type: array - split_tunnel_include_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/split_tunnel_include' - type: array - revoke_devices_request: - description: A list of device ids to revoke. - items: - $ref: '#/components/schemas/uuid' - maxLength: 200 - type: array - unrevoke_devices_request: - description: A list of device ids to unrevoke. - items: - $ref: '#/components/schemas/uuid' - maxLength: 200 - type: array - device_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - override_codes_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - properties: - disable_for_time: - $ref: '#/components/schemas/disable_for_time' - type: object - disable_for_time: - properties: - '1': - description: Override code that is valid for 1 hour. - example: '9106681' - '3': - description: Override code that is valid for 3 hours. - example: '5356247' - '6': - description: Override code that is valid for 6 hours. - example: '9478972' - '12': - description: Override code that is valid for 12 hour2. - example: '3424359' - '24': - description: Override code that is valid for 24 hour.2. - example: '2887634' - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_posture_integration: - id: cloudflare.devices.accounts_posture_integration - name: accounts_posture_integration - title: Accounts Posture Integration - methods: - device_posture_integrations_list_device_posture_integrations: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1integration/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _device_posture_integrations_list_device_posture_integrations: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1integration/get' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_integrations_create_device_posture_integration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1integration/post' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_integrations_delete_device_posture_integration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1integration~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_integrations_device_posture_integration_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1integration~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _device_posture_integrations_device_posture_integration_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1integration~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_integrations_update_device_posture_integration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1integration~1{uuid}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_posture_integration/methods/device_posture_integrations_list_device_posture_integrations' - - $ref: '#/components/x-stackQL-resources/accounts_posture_integration/methods/device_posture_integrations_device_posture_integration_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_posture_integration/methods/device_posture_integrations_create_device_posture_integration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_posture_integration/methods/device_posture_integrations_delete_device_posture_integration' - accounts_posture: - id: cloudflare.devices.accounts_posture - name: accounts_posture - title: Accounts Posture - methods: - device_posture_rules_list_device_posture_rules: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _device_posture_rules_list_device_posture_rules: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture/get' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_rules_create_device_posture_rule: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture/post' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_rules_delete_device_posture_rule: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_rules_device_posture_rules_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _device_posture_rules_device_posture_rules_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - device_posture_rules_update_device_posture_rule: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1posture~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_posture/methods/device_posture_rules_list_device_posture_rules' - - $ref: '#/components/x-stackQL-resources/accounts_posture/methods/device_posture_rules_device_posture_rules_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_posture/methods/device_posture_rules_create_device_posture_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_posture/methods/device_posture_rules_delete_device_posture_rule' - accounts: - id: cloudflare.devices.accounts - name: accounts - title: Accounts - methods: - list_devices: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_devices: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices/get' - response: - mediaType: application/json - openAPIDocKey: '200' - device_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _device_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - revoke_devices: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1revoke/post' - response: - mediaType: application/json - openAPIDocKey: '200' - unrevoke_devices: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1unrevoke/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts/methods/list_devices' - - $ref: '#/components/x-stackQL-resources/accounts/methods/device_details' - insert: [] - update: [] - delete: [] - accounts_policies: - id: cloudflare.devices.accounts_policies - name: accounts_policies - title: Accounts Policies - methods: - list_device_settings_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_device_settings_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_policies/methods/list_device_settings_policies' - insert: [] - update: [] - delete: [] - accounts_policy: - id: cloudflare.devices.accounts_policy - name: accounts_policy - title: Accounts Policy - methods: - get_default_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_default_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_default_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - create_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get_device_settings_policy_by_id: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_device_settings_policy_by_id: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_policy/methods/get_default_device_settings_policy' - - $ref: '#/components/x-stackQL-resources/accounts_policy/methods/get_device_settings_policy_by_id' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_policy/methods/create_device_settings_policy' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_policy/methods/delete_device_settings_policy' - accounts_policy_exclude: - id: cloudflare.devices.accounts_policy_exclude - name: accounts_policy_exclude - title: Accounts Policy Exclude - methods: - get_split_tunnel_exclude_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1exclude/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_split_tunnel_exclude_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1exclude/get' - response: - mediaType: application/json - openAPIDocKey: '200' - set_split_tunnel_exclude_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1exclude/put' - response: - mediaType: application/json - openAPIDocKey: '200' - get_split_tunnel_exclude_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1exclude/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_split_tunnel_exclude_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1exclude/get' - response: - mediaType: application/json - openAPIDocKey: '200' - set_split_tunnel_exclude_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1exclude/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_policy_exclude/methods/get_split_tunnel_exclude_list' - - $ref: '#/components/x-stackQL-resources/accounts_policy_exclude/methods/get_split_tunnel_exclude_list_for_a_device_settings_policy' - insert: [] - update: [] - delete: [] - accounts_policy_fallback_domains: - id: cloudflare.devices.accounts_policy_fallback_domains - name: accounts_policy_fallback_domains - title: Accounts Policy Fallback Domains - methods: - get_local_domain_fallback_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1fallback_domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_local_domain_fallback_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1fallback_domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - set_local_domain_fallback_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1fallback_domains/put' - response: - mediaType: application/json - openAPIDocKey: '200' - get_local_domain_fallback_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1fallback_domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_local_domain_fallback_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1fallback_domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - set_local_domain_fallback_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1fallback_domains/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_policy_fallback_domains/methods/get_local_domain_fallback_list' - - $ref: '#/components/x-stackQL-resources/accounts_policy_fallback_domains/methods/get_local_domain_fallback_list_for_a_device_settings_policy' - insert: [] - update: [] - delete: [] - accounts_policy_include: - id: cloudflare.devices.accounts_policy_include - name: accounts_policy_include - title: Accounts Policy Include - methods: - get_split_tunnel_include_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1include/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_split_tunnel_include_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1include/get' - response: - mediaType: application/json - openAPIDocKey: '200' - set_split_tunnel_include_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1include/put' - response: - mediaType: application/json - openAPIDocKey: '200' - get_split_tunnel_include_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1include/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_split_tunnel_include_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1include/get' - response: - mediaType: application/json - openAPIDocKey: '200' - set_split_tunnel_include_list_for_a_device_settings_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1policy~1{uuid}~1include/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_policy_include/methods/get_split_tunnel_include_list' - - $ref: '#/components/x-stackQL-resources/accounts_policy_include/methods/get_split_tunnel_include_list_for_a_device_settings_policy' - insert: [] - update: [] - delete: [] - accounts_override_codes: - id: cloudflare.devices.accounts_override_codes - name: accounts_override_codes - title: Accounts Override Codes - methods: - list_admin_override_code_for_device: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1{uuid}~1override_codes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_admin_override_code_for_device: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1{uuid}~1override_codes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_override_codes/methods/list_admin_override_code_for_device' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{identifier}/devices/posture/integration': - get: - description: List Device Posture Integrations for an account. - operationId: device-posture-integrations-list-device-posture-integrations - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-response_collection' - description: List Device Posture Integrations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-integrations_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Device Posture Integrations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Device Posture Integrations - tags: - - Device Posture Integrations - post: - description: Create a new Device Posture Integration. - operationId: device-posture-integrations-create-device-posture-integration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - $ref: '#/components/schemas/config_request' - interval: - $ref: '#/components/schemas/schemas-interval' - name: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-name' - type: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-type' - required: - - name - - type - - interval - - config - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response' - description: Create Device Posture Integration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Device Posture Integration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Device Posture Integration - tags: - - Device Posture Integrations - '/accounts/{identifier}/devices/posture/integration/{uuid}': - delete: - description: Delete a Device Posture Integration. - operationId: device-posture-integrations-delete-device-posture-integration - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-id_response' - description: Delete Device Posture Integration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-integrations_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Device Posture Integration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Device Posture Integration - tags: - - Device Posture Integrations - get: - description: Fetch a single Device Posture Integration. - operationId: device-posture-integrations-device-posture-integration-details - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response' - description: Device Posture Integration Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Device Posture Integration Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Device Posture Integration Details - tags: - - Device Posture Integrations - patch: - description: Update a Device Posture Integration. - operationId: device-posture-integrations-update-device-posture-integration - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - $ref: '#/components/schemas/config_request' - interval: - $ref: '#/components/schemas/schemas-interval' - name: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-name' - type: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-type' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response' - description: Update Device Posture Integration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Device Posture Integration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Device Posture Integration - tags: - - Device Posture Integrations - '/accounts/{identifier}/devices/posture': - get: - description: List Device Posture Rules for an account. - operationId: device-posture-rules-list-device-posture-rules - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-response_collection' - description: List Device Posture Rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-rules_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Device Posture Rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Device Posture Rules - tags: - - Device Posture Rules - post: - description: Create a new Device Posture Rule. - operationId: device-posture-rules-create-device-posture-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/device-posture-rules_components-schemas-description' - expiration: - $ref: '#/components/schemas/schemas-expiration' - input: - $ref: '#/components/schemas/schemas-input' - match: - $ref: '#/components/schemas/schemas-match' - name: - $ref: '#/components/schemas/device-posture-rules_components-schemas-name' - schedule: - $ref: '#/components/schemas/schedule' - type: - $ref: '#/components/schemas/device-posture-rules_components-schemas-type' - required: - - name - - type - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response' - description: Create Device Posture Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Device Posture Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Device Posture Rule - tags: - - Device Posture Rules - '/accounts/{identifier}/devices/posture/{uuid}': - delete: - description: Delete a Device Posture Rule. - operationId: device-posture-rules-delete-device-posture-rule - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-id_response' - description: Delete Device Posture Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-rules_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Device Posture Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Device Posture Rule - tags: - - Device Posture Rules - get: - description: Fetch a single Device Posture Rule. - operationId: device-posture-rules-device-posture-rules-details - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response' - description: Device Posture Rules Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Device Posture Rules Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Device Posture Rules Details - tags: - - Device Posture Rules - put: - description: Update a Device Posture Rule. - operationId: device-posture-rules-update-device-posture-rule - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/device-posture-rules_components-schemas-description' - expiration: - $ref: '#/components/schemas/schemas-expiration' - input: - $ref: '#/components/schemas/schemas-input' - match: - $ref: '#/components/schemas/schemas-match' - name: - $ref: '#/components/schemas/device-posture-rules_components-schemas-name' - schedule: - $ref: '#/components/schemas/schedule' - type: - $ref: '#/components/schemas/device-posture-rules_components-schemas-type' - required: - - name - - type - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response' - description: Update Device Posture Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Device Posture Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Device Posture Rule - tags: - - Device Posture Rules - '/accounts/{identifier}/devices': - get: - description: List Enrolled Devices. - operationId: devices-list-devices - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/devices_response' - description: List Devices response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/devices_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Devices response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Devices - tags: - - Devices - '/accounts/{identifier}/devices/policies': - get: - description: Lists the device settings policies for an account. - operationId: devices-list-device-settings-policies - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device_settings_response_collection' - description: List Device Settings Policies response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device_settings_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Device Settings Policies response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Device Settings Policies - tags: - - Devices - '/accounts/{identifier}/devices/policy': - get: - description: Get the default device settings policy for an account. - operationId: devices-get-default-device-settings-policy - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/default_device_settings_response' - description: Get Default Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/default_device_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Default Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Default Device Settings Policy - tags: - - Devices - patch: - description: Update the default device settings policy for an account. - operationId: devices-update-default-device-settings-policy - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - allow_mode_switch: - $ref: '#/components/schemas/allow_mode_switch' - allow_updates: - $ref: '#/components/schemas/allow_updates' - allowed_to_leave: - $ref: '#/components/schemas/allowed_to_leave' - auto_connect: - $ref: '#/components/schemas/auto_connect' - captive_portal: - $ref: '#/components/schemas/captive_portal' - disable_auto_fallback: - $ref: '#/components/schemas/disable_auto_fallback' - service_mode_v2: - $ref: '#/components/schemas/service_mode_v2' - support_url: - $ref: '#/components/schemas/support_url' - switch_locked: - $ref: '#/components/schemas/switch_locked' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/default_device_settings_response' - description: Update Default Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/default_device_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Default Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Default Device Settings Policy - tags: - - Devices - post: - description: Create a device settings policy to be applied to certain devices matching the criteria. - operationId: devices-create-device-settings-policy - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - allow_mode_switch: - $ref: '#/components/schemas/allow_mode_switch' - allow_updates: - $ref: '#/components/schemas/allow_updates' - allowed_to_leave: - $ref: '#/components/schemas/allowed_to_leave' - auto_connect: - $ref: '#/components/schemas/auto_connect' - captive_portal: - $ref: '#/components/schemas/captive_portal' - disable_auto_fallback: - $ref: '#/components/schemas/disable_auto_fallback' - enabled: - description: Whether the policy will be applied to matching devices. - example: true - type: boolean - match: - $ref: '#/components/schemas/components-schemas-match' - name: - description: The name of the device settings policy. - example: Allow Developers - maxLength: 100 - type: string - precedence: - $ref: '#/components/schemas/components-schemas-precedence' - service_mode_v2: - $ref: '#/components/schemas/service_mode_v2' - support_url: - $ref: '#/components/schemas/support_url' - switch_locked: - $ref: '#/components/schemas/switch_locked' - required: - - name - - precedence - - match - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device_settings_response' - description: Create Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Device Settings Policy - tags: - - Devices - '/accounts/{identifier}/devices/policy/exclude': - get: - description: Get the list of routes excluded from the WARP client's tunnel. - operationId: devices-get-split-tunnel-exclude-list - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_response_collection' - description: Get Split Tunnel Exclude List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Split Tunnel Exclude List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Split Tunnel Exclude List - tags: - - Devices - put: - description: Set the list of routes excluded from the WARP client's tunnel. - operationId: devices-set-split-tunnel-exclude-list - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - items: - $ref: '#/components/schemas/split_tunnel' - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_response_collection' - description: Set Split Tunnel Exclude List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Split Tunnel Exclude List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Split Tunnel Exclude List - tags: - - Devices - '/accounts/{identifier}/devices/policy/fallback_domains': - get: - description: Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server. - operationId: devices-get-local-domain-fallback-list - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/fallback_domain_response_collection' - description: Get Local Domain Fallback List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/fallback_domain_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Local Domain Fallback List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Local Domain Fallback List - tags: - - Devices - put: - description: Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server. - operationId: devices-set-local-domain-fallback-list - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - items: - $ref: '#/components/schemas/fallback_domain' - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/fallback_domain_response_collection' - description: Set Local Domain Fallback List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/fallback_domain_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Local Domain Fallback List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Local Domain Fallback List - tags: - - Devices - '/accounts/{identifier}/devices/policy/include': - get: - description: Get the list of routes included in the WARP client's tunnel. - operationId: devices-get-split-tunnel-include-list - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_include_response_collection' - description: Get Split Tunnel Include List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_include_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Split Tunnel Include List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Split Tunnel Include List - tags: - - Devices - put: - description: Set the list of routes included in the WARP client's tunnel. - operationId: devices-set-split-tunnel-include-list - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - items: - $ref: '#/components/schemas/split_tunnel_include' - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_include_response_collection' - description: Set Split Tunnel Include List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_include_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Split Tunnel Include List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Split Tunnel Include List - tags: - - Devices - '/accounts/{identifier}/devices/policy/{uuid}': - delete: - description: Delete a device settings policy. Returns the remaining policies for the account. - operationId: devices-delete-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device_settings_response_collection' - description: Delete Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device_settings_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Device Settings Policy - tags: - - Devices - get: - description: Get the device settings policy by ID. - operationId: devices-get-device-settings-policy-by-id - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device_settings_response' - description: Get Device Settings Policy by ID response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Device Settings Policy by ID response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Device Settings Policy by ID - tags: - - Devices - patch: - description: Update a device settings policy. - operationId: devices-update-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - allow_mode_switch: - $ref: '#/components/schemas/allow_mode_switch' - allow_updates: - $ref: '#/components/schemas/allow_updates' - allowed_to_leave: - $ref: '#/components/schemas/allowed_to_leave' - auto_connect: - $ref: '#/components/schemas/auto_connect' - captive_portal: - $ref: '#/components/schemas/captive_portal' - disable_auto_fallback: - $ref: '#/components/schemas/disable_auto_fallback' - enabled: - description: Whether the policy will be applied to matching devices. - example: true - type: boolean - match: - $ref: '#/components/schemas/components-schemas-match' - name: - description: The name of the device settings policy. - example: Allow Developers - maxLength: 100 - type: string - precedence: - $ref: '#/components/schemas/components-schemas-precedence' - service_mode_v2: - $ref: '#/components/schemas/service_mode_v2' - support_url: - $ref: '#/components/schemas/support_url' - switch_locked: - $ref: '#/components/schemas/switch_locked' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device_settings_response' - description: Update Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Device Settings Policy - tags: - - Devices - '/accounts/{identifier}/devices/policy/{uuid}/exclude': - get: - description: Get the list of routes excluded from the WARP client's tunnel for one specific device settings policy. - operationId: devices-get-split-tunnel-exclude-list-for-a-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_response_collection' - description: Get Split Tunnel Exclude List for a Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Split Tunnel Exclude List for a Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Split Tunnel Exclude List for a Device Settings Policy - tags: - - Devices - put: - description: Set the list of routes excluded from the WARP client's tunnel for one specific device settings policy. - operationId: devices-set-split-tunnel-exclude-list-for-a-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - items: - $ref: '#/components/schemas/split_tunnel' - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_response_collection' - description: Set Split Tunnel Exclude List for a Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Split Tunnel Exclude List for a Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Split Tunnel Exclude List for a Device Settings Policy - tags: - - Devices - '/accounts/{identifier}/devices/policy/{uuid}/fallback_domains': - get: - description: Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server. - operationId: devices-get-local-domain-fallback-list-for-a-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/fallback_domain_response_collection' - description: Get Local Domain Fallback List for a Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/fallback_domain_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Local Domain Fallback List for a Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Local Domain Fallback List for a Device Settings Policy - tags: - - Devices - put: - description: Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server. - operationId: devices-set-local-domain-fallback-list-for-a-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - items: - $ref: '#/components/schemas/fallback_domain' - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/fallback_domain_response_collection' - description: Set Local Domain Fallback List for a Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/fallback_domain_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Local Domain Fallback List for a Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Local Domain Fallback List for a Device Settings Policy - tags: - - Devices - '/accounts/{identifier}/devices/policy/{uuid}/include': - get: - description: Get the list of routes included in the WARP client's tunnel for one specific device settings policy. - operationId: devices-get-split-tunnel-include-list-for-a-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_include_response_collection' - description: Get Split Tunnel Include List for a Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_include_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Split Tunnel Include List for a Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Split Tunnel Include List for a Device Settings Policy - tags: - - Devices - put: - description: Set the list of routes included in the WARP client's tunnel for one specific device settings policy. - operationId: devices-set-split-tunnel-include-list-for-a-device-settings-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - items: - $ref: '#/components/schemas/split_tunnel_include' - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/split_tunnel_include_response_collection' - description: Set Split Tunnel Include List for a Device Settings Policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/split_tunnel_include_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Split Tunnel Include List for a Device Settings Policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Split Tunnel Include List for a Device Settings Policy - tags: - - Devices - '/accounts/{identifier}/devices/revoke': - post: - description: Revoke a list of devices. - operationId: devices-revoke-devices - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/revoke_devices_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Revoke Devices response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Revoke Devices response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Revoke Devices - tags: - - Devices - '/accounts/{identifier}/devices/unrevoke': - post: - description: Unrevoke a list of devices. - operationId: devices-unrevoke-devices - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/unrevoke_devices_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Unrevoke Devices response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Unrevoke Devices response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Unrevoke Devices - tags: - - Devices - '/accounts/{identifier}/devices/{uuid}': - get: - description: Fetch a single Device. - operationId: devices-device-details - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/device_response' - description: Device Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/device_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Device Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Device Details - tags: - - Devices - '/accounts/{identifier}/devices/{uuid}/override_codes': - get: - description: Fetch one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration. - operationId: devices-list-admin-override-code-for-device - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/devices_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/override_codes_response' - description: List Admin Override code for device response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/override_codes_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Admin Override code for device response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Admin Override code for device - tags: - - Devices diff --git a/providers/src/cloudflare/v00.00.00000/services/diagnostics.yaml b/providers/src/cloudflare/v00.00.00000/services/diagnostics.yaml new file mode 100644 index 00000000..bcce7f4f --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/diagnostics.yaml @@ -0,0 +1,878 @@ +openapi: 3.0.3 +info: + title: diagnostics API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/diagnostics/endpoint-healthchecks: + get: + description: List Endpoint Health Checks. + operationId: diagnostics-endpoint-healthcheck-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/magicTransitEndpointHealthCheckResponseSingle + description: Endpoint Health Checks for account. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitApiResponseCommonFailure' + description: Endpoint Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Endpoint Health Checks + tags: + - Endpoint Health Checks + x-api-token-group: + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: diagnostics + resource_chain: + - endpoint_healthchecks + method: list + post: + description: Create Endpoint Health Check. + operationId: diagnostics-endpoint-healthcheck-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitEndpointHealthCheck' + responses: + '201': + content: + application/json: + schema: + $ref: >- + #/components/schemas/magicTransitEndpointHealthCheckResponseSingle + description: Endpoint Health Check response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitApiResponseCommonFailure' + description: Endpoint Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Endpoint Health Check + tags: + - Endpoint Health Checks + x-api-token-group: + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: diagnostics + resource_chain: + - endpoint_healthchecks + method: create + /accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}: + delete: + description: Delete Endpoint Health Check. + operationId: diagnostics-endpoint-healthcheck-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitApiResponseCommon' + description: Endpoint Health Checks response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitApiResponseCommonFailure' + description: Endpoint Health Check failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Endpoint Health Check + tags: + - Endpoint Health Checks + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: diagnostics + resource_chain: + - endpoint_healthchecks + method: delete + get: + description: Get a single Endpoint Health Check. + operationId: diagnostics-endpoint-healthcheck-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/magicTransitEndpointHealthCheckResponseSingle + description: Endpoint Health Checks response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/magicTransitMessages' + messages: + $ref: '#/components/schemas/magicTransitMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/magicTransitTargetResult' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Endpoint Health Check failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Endpoint Health Check + tags: + - Endpoint Health Checks + x-api-token-group: + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: diagnostics + resource_chain: + - endpoint_healthchecks + method: get + put: + description: Update a Endpoint Health Check. + operationId: diagnostics-endpoint-healthcheck-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitEndpointHealthCheck' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/magicTransitEndpointHealthCheckResponseSingle + description: Endpoint Health Checks response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitApiResponseCommonFailure' + description: Endpoint Health Check failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Endpoint Health Check + tags: + - Endpoint Health Checks + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: diagnostics + resource_chain: + - endpoint_healthchecks + method: update + /accounts/{account_id}/diagnostics/traceroute: + post: + description: Run traceroutes from Cloudflare colos. + operationId: diagnostics-traceroute + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + colos: + $ref: '#/components/schemas/magicTransitColos' + options: + $ref: '#/components/schemas/magicTransitOptions' + targets: + $ref: '#/components/schemas/magicTransitTargets' + required: + - targets + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicTransitTracerouteResponseCollection' + description: Traceroute response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/magicTransitMessages' + messages: + $ref: '#/components/schemas/magicTransitMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/magicTransitTargetResult' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Traceroute response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Traceroute + tags: + - Diagnostics + x-api-token-group: + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false +components: + schemas: + magicTransitApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/magicTransitMessages' + messages: + $ref: '#/components/schemas/magicTransitMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + magicTransitApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/magicTransitMessages' + messages: + example: [] + $ref: '#/components/schemas/magicTransitMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicTransitAsn: + description: AS number associated with the node object. + type: string + magicTransitCheckType: + default: icmp + description: type of check to perform + enum: + - icmp + example: icmp + type: string + magicTransitColo: + properties: + city: + $ref: '#/components/schemas/magicTransitColoCity' + name: + $ref: '#/components/schemas/magicTransitColoName' + type: object + magicTransitColoCity: + description: Source colo city. + example: Denver, CO, US + type: string + magicTransitColoName: + description: Source colo name. + example: den01 + type: string + magicTransitColoResult: + properties: + colo: + $ref: '#/components/schemas/magicTransitColo' + error: + $ref: '#/components/schemas/magicTransitError' + hops: + items: + $ref: '#/components/schemas/magicTransitHopResult' + type: array + target_summary: + $ref: '#/components/schemas/magicTransitTargetSummary' + traceroute_time_ms: + $ref: '#/components/schemas/magicTransitTracerouteTimeMs' + type: object + magicTransitColos: + description: >- + If no source colo names specified, all colos will be used. China colos + are unavailable for traceroutes. + example: + - den + - sin + items: + description: Source colo name. + type: string + type: array + magicTransitEndpointHealthCheck: + properties: + check_type: + $ref: '#/components/schemas/magicTransitCheckType' + endpoint: + description: the IP address of the host to perform checks against + example: 203.0.113.1 + type: string + name: + description: Optional name associated with this check + example: My Endpoint + type: string + required: + - check_type + - endpoint + type: object + magicTransitEndpointHealthCheckResponse: + required: + - check_type + - endpoint + type: object + properties: + check_type: + $ref: '#/components/schemas/magicTransitCheckType' + endpoint: + description: the IP address of the host to perform checks against + example: 203.0.113.1 + type: string + name: + description: Optional name associated with this check + example: My Endpoint + type: string + id: + $ref: '#/components/schemas/magicTransitUuid' + magicTransitEndpointHealthCheckResponseSingle: + properties: + errors: + $ref: '#/components/schemas/magicTransitMessages' + messages: + $ref: '#/components/schemas/magicTransitMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/magicTransitEndpointHealthCheckResponse' + required: + - success + - errors + - messages + type: object + magicTransitError: + description: Errors resulting from collecting traceroute from colo to target. + enum: + - '' + - 'Could not gather traceroute data: Code 1' + - 'Could not gather traceroute data: Code 2' + - 'Could not gather traceroute data: Code 3' + - 'Could not gather traceroute data: Code 4' + example: '' + type: string + magicTransitHopResult: + properties: + nodes: + description: An array of node objects. + items: + $ref: '#/components/schemas/magicTransitNodeResult' + type: array + packets_lost: + $ref: '#/components/schemas/magicTransitPacketsLost' + packets_sent: + $ref: '#/components/schemas/magicTransitPacketsSent' + packets_ttl: + $ref: '#/components/schemas/magicTransitPacketsTtl' + type: object + magicTransitIp: + description: IP address of the node. + type: string + magicTransitLabels: + description: >- + Field appears if there is an additional annotation printed when the + probe returns. Field also appears when running a GRE+ICMP traceroute to + denote which traceroute a node comes from. + items: + type: string + type: array + magicTransitMaxRttMs: + description: Maximum RTT in ms. + type: number + magicTransitMaxTtl: + default: 15 + description: Max TTL. + maximum: 64 + minimum: 0 + type: integer + magicTransitMeanRttMs: + description: Mean RTT in ms. + type: number + magicTransitMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + magicTransitMinRttMs: + description: Minimum RTT in ms. + type: number + magicTransitName: + description: Host name of the address, this may be the same as the IP address. + type: string + magicTransitNodeResult: + example: + asn: AS13335 + ip: 1.1.1.1 + max_latency_ms: 0.034 + mean_latency_ms: 0.021 + min_latency_ms: 0.014 + name: one.one.one.one + packet_count: 3 + std_dev_latency_ms: 0.011269427669584647 + properties: + asn: + $ref: '#/components/schemas/magicTransitAsn' + ip: + $ref: '#/components/schemas/magicTransitIp' + labels: + $ref: '#/components/schemas/magicTransitLabels' + max_rtt_ms: + $ref: '#/components/schemas/magicTransitMaxRttMs' + mean_rtt_ms: + $ref: '#/components/schemas/magicTransitMeanRttMs' + min_rtt_ms: + $ref: '#/components/schemas/magicTransitMinRttMs' + name: + $ref: '#/components/schemas/magicTransitName' + packet_count: + $ref: '#/components/schemas/magicTransitPacketCount' + std_dev_rtt_ms: + $ref: '#/components/schemas/magicTransitStdDevRttMs' + type: object + magicTransitOptions: + example: + max_ttl: 15 + packet_type: icmp + properties: + max_ttl: + $ref: '#/components/schemas/magicTransitMaxTtl' + packet_type: + $ref: '#/components/schemas/magicTransitPacketType' + packets_per_ttl: + $ref: '#/components/schemas/magicTransitPacketsPerTtl' + port: + $ref: '#/components/schemas/magicTransitPort' + wait_time: + $ref: '#/components/schemas/magicTransitWaitTime' + type: object + magicTransitPacketCount: + description: Number of packets with a response from this node. + type: integer + magicTransitPacketType: + default: icmp + description: Type of packet sent. + enum: + - icmp + - tcp + - udp + - gre + - gre+icmp + example: icmp + type: string + magicTransitPacketsLost: + description: Number of packets where no response was received. + type: integer + magicTransitPacketsPerTtl: + default: 3 + description: Number of packets sent at each TTL. + maximum: 10 + minimum: 0 + type: integer + magicTransitPacketsSent: + description: Number of packets sent with specified TTL. + type: integer + magicTransitPacketsTtl: + description: The time to live (TTL). + type: integer + magicTransitPort: + default: 0 + description: >- + For UDP and TCP, specifies the destination port. For ICMP, specifies the + initial ICMP sequence value. Default value 0 will choose the best value + to use for each protocol. + maximum: 65535 + minimum: 0 + type: integer + magicTransitStdDevRttMs: + description: Standard deviation of the RTTs in ms. + type: number + magicTransitTarget: + description: The target hostname, IPv6, or IPv6 address. + example: 1.1.1.1 + type: string + magicTransitTargetResult: + properties: + colos: + items: + $ref: '#/components/schemas/magicTransitColoResult' + type: array + target: + $ref: '#/components/schemas/magicTransitTarget' + type: object + magicTransitTargetSummary: + description: Aggregated statistics from all hops about the target. + example: + asn: '' + ip: 1.1.1.1 + max_latency_ms: 0.034 + mean_latency_ms: 0.021 + min_latency_ms: 0.014 + name: 1.1.1.1 + packet_count: 3 + std_dev_latency_ms: 0.011269427669584647 + type: object + magicTransitTargets: + example: + - 203.0.113.1 + - cloudflare.com + items: + description: Hosts as a hostname or IPv4/IPv6 address represented by strings. + example: 203.0.113.1 + type: string + maxLength: 10 + type: array + magicTransitTracerouteResponseCollection: + properties: + errors: + $ref: '#/components/schemas/magicTransitMessages' + messages: + $ref: '#/components/schemas/magicTransitMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/magicTransitTargetResult' + type: array + required: + - success + - errors + - messages + type: object + magicTransitTracerouteTimeMs: + description: Total time of traceroute in ms. + type: integer + magicTransitUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + magicTransitWaitTime: + default: 1 + description: Set the time (in seconds) to wait for a response to a probe. + maximum: 5 + minimum: 1 + type: integer + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + endpoint_healthchecks: + id: cloudflare.diagnostics.endpoint_healthchecks + name: endpoint_healthchecks + title: Endpoint Healthchecks + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1diagnostics~1endpoint-healthchecks/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1diagnostics~1endpoint-healthchecks/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1diagnostics~1endpoint-healthchecks~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1diagnostics~1endpoint-healthchecks~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1diagnostics~1endpoint-healthchecks~1{id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/endpoint_healthchecks/methods/get' + - $ref: >- + #/components/x-stackQL-resources/endpoint_healthchecks/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/endpoint_healthchecks/methods/create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/endpoint_healthchecks/methods/delete + replace: + - $ref: >- + #/components/x-stackQL-resources/endpoint_healthchecks/methods/update + diagnostics: + id: cloudflare.diagnostics.diagnostics + name: diagnostics + title: Diagnostics + methods: + create_traceroute: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1diagnostics~1traceroute/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/dns.yaml b/providers/src/cloudflare/v00.00.00000/services/dns.yaml index fb64cbdb..6ea5a066 100644 --- a/providers/src/cloudflare/v00.00.00000/services/dns.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/dns.yaml @@ -1,5021 +1,8850 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: DNS Analytics - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - dns - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - result: - properties: - data: - items: - properties: - dimensions: - description: Array of dimension values for this row. - example: - - name: NODATA - items: - $ref: '#/components/schemas/dimension_value' - type: array - metrics: - items: {} - type: array - required: - - dimensions - - metrics - type: object - nullable: true - type: array - data_lag: - description: 'Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.' - example: 60 - minimum: 0 - type: number - max: - description: Maximum results for each metric. - min: - description: Minimum results for each metric. - rows: - description: Total number of rows in the result. - example: 100 - minimum: 0 - type: number - totals: - description: Total results for metrics across all data. - required: - - rows - - data - - totals - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - dimension_value: - anyOf: - - description: 'Dimension value, may contain dimension identifier for drill down.' - properties: - id: - description: Dimension value identifier that can be used for drill down. - type: string - name: - description: Dimension value. - example: NODATA - type: string - required: - - name - type: object - - description: Dimension value. - example: NODATA - type: string - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - dns_firewall_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/dns-firewall' - type: array - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - dns-firewall: - properties: - attack_mitigation: - $ref: '#/components/schemas/attack_mitigation' - deprecate_any_requests: - $ref: '#/components/schemas/deprecate_any_requests' - dns_firewall_ips: - $ref: '#/components/schemas/dns_firewall_ips' - ecs_fallback: - $ref: '#/components/schemas/ecs_fallback' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - maximum_cache_ttl: - $ref: '#/components/schemas/maximum_cache_ttl' - minimum_cache_ttl: - $ref: '#/components/schemas/minimum_cache_ttl' - modified_on: - $ref: '#/components/schemas/schemas-modified_on' - name: - $ref: '#/components/schemas/dns-firewall_components-schemas-name' - negative_cache_ttl: - $ref: '#/components/schemas/negative_cache_ttl' - origin_ips: - $ref: '#/components/schemas/origin_ips' - ratelimit: - $ref: '#/components/schemas/ratelimit' - required: - - id - - name - - origin_ips - - dns_firewall_ips - - minimum_cache_ttl - - maximum_cache_ttl - - deprecate_any_requests - - ecs_fallback - - modified_on - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - attack_mitigation: - description: Attack mitigation settings. - nullable: true - properties: - enabled: - description: 'When enabled, random-prefix attacks are automatically mitigated and the origin DNS servers protected.' - example: true - type: boolean - only_when_origin_unhealthy: - default: true - description: Only mitigate attacks when origin servers seem unhealthy. - example: false - type: boolean - type: object - deprecate_any_requests: - description: Deprecate the response to ANY requests. - example: true - type: boolean - dns_firewall_ips: - example: - - 203.0.113.1 - - 203.0.113.254 - - '2001:DB8:AB::CF' - - '2001:DB8:CD::CF' - items: - anyOf: - - description: Origin DNS Server IPv4 Address. - example: 203.0.113.1 - format: ipv4 - type: string - - description: Origin DNS Server IPv6 Address. - example: '2001:DB8:ab::CF' - format: ipv6 - type: string - type: array - ecs_fallback: - description: Forward client IP (resolver) subnet if no EDNS Client Subnet is sent. - example: false - type: boolean - maximum_cache_ttl: - default: 900 - description: Maximum DNS Cache TTL. - example: 900 - maximum: 36000 - minimum: 30 - type: number - minimum_cache_ttl: - default: 60 - description: Minimum DNS Cache TTL. - example: 60 - maximum: 36000 - minimum: 30 - type: number - schemas-modified_on: - description: Last modification of DNS Firewall cluster. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - dns-firewall_components-schemas-name: - description: DNS Firewall Cluster Name. - example: My Awesome DNS Firewall cluster - maxLength: 160 - type: string - negative_cache_ttl: - description: Negative DNS Cache TTL. - example: 900 - maximum: 36000 - minimum: 30 - nullable: true - type: number - origin_ips: - example: - - 192.0.2.1 - - 198.51.100.1 - - '2001:DB8:100::CF' - items: - anyOf: - - description: Origin DNS Server IPv4 Address. - example: 192.0.2.1 - format: ipv4 - type: string - - description: Origin DNS Server IPv6 Address. - example: '2001:DB8:100::CF' - format: ipv6 - type: string - type: array - ratelimit: - description: Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster). - example: 600 - maximum: 1000000000 - minimum: 100 - nullable: true - type: number - dns_firewall_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/dns-firewall' - schemas-dns-firewall: - allOf: - - $ref: '#/components/schemas/dns-firewall' - virtual_dns_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/virtual-dns' - type: array - virtual-dns: - properties: - deprecate_any_requests: - $ref: '#/components/schemas/deprecate_any_requests' - ecs_fallback: - $ref: '#/components/schemas/ecs_fallback' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - maximum_cache_ttl: - $ref: '#/components/schemas/maximum_cache_ttl' - minimum_cache_ttl: - $ref: '#/components/schemas/minimum_cache_ttl' - modified_on: - $ref: '#/components/schemas/schemas-modified_on' - name: - $ref: '#/components/schemas/virtual-dns_components-schemas-name' - negative_cache_ttl: - $ref: '#/components/schemas/schemas-negative_cache_ttl' - origin_ips: - $ref: '#/components/schemas/origin_ips' - ratelimit: - $ref: '#/components/schemas/schemas-ratelimit' - virtual_dns_ips: - $ref: '#/components/schemas/virtual_dns_ips' - required: - - id - - name - - origin_ips - - virtual_dns_ips - - minimum_cache_ttl - - maximum_cache_ttl - - deprecate_any_requests - - ecs_fallback - - modified_on - type: object - virtual-dns_components-schemas-name: - description: DNS Firewall Cluster Name. - example: My Awesome DNS Firewall cluster - maxLength: 160 - type: string - schemas-negative_cache_ttl: - default: 900 - description: Negative DNS Cache TTL. - example: 900 - maximum: 36000 - minimum: 30 - nullable: true - type: number - schemas-ratelimit: - description: |- - Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster). - Notes: A ratelimit of 0 turns off the ratelimit. Otherwise the minimum is 100. - example: 600 - maximum: 100000000 - type: number - virtual_dns_ips: - example: - - 203.0.113.1 - - 203.0.113.254 - - '2001:DB8:AB::CF' - - '2001:DB8:CD::CF' - items: - anyOf: - - description: Origin DNS Server IPv4 Address. - example: 203.0.113.1 - format: ipv4 - type: string - - description: Origin DNS Server IPv6 Address. - example: '2001:DB8:ab::CF' - format: ipv6 - type: string - type: array - virtual_dns_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/virtual-dns' - schemas-virtual-dns: - allOf: - - $ref: '#/components/schemas/virtual-dns' - dns_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/dns-record' - type: array - type: object - dns-record: - oneOf: - - $ref: '#/components/schemas/ARecord' - - $ref: '#/components/schemas/AAAARecord' - - $ref: '#/components/schemas/CNAMERecord' - - $ref: '#/components/schemas/HTTPSRecord' - - $ref: '#/components/schemas/NSRecord' - - $ref: '#/components/schemas/MXRecord' - - $ref: '#/components/schemas/TXTRecord' - - $ref: '#/components/schemas/LOCRecord' - - $ref: '#/components/schemas/SRVRecord' - - $ref: '#/components/schemas/CERTRecord' - - $ref: '#/components/schemas/DNSKEYRecord' - - $ref: '#/components/schemas/DSRecord' - - $ref: '#/components/schemas/NAPTRRecord' - - $ref: '#/components/schemas/SMIMEARecord' - - $ref: '#/components/schemas/SSHFPRecord' - - $ref: '#/components/schemas/SVCBRecord' - - $ref: '#/components/schemas/TLSARecord' - - $ref: '#/components/schemas/URIRecord' - required: - - id - - type - - name - - content - - proxiable - - proxied - - ttl - - locked - - zone_name - - created_on - - modified_on - type: object - ARecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: A valid IPv4 address. - example: 198.51.100.4 - format: ipv4 - type: string - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - A - example: A - required: - - type - - name - - content - title: A Record - AAAARecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: A valid IPv6 address. - example: '2400:cb00:2049:1::173.245.59.16' - format: ipv6 - type: string - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - AAAA - example: AAAA - required: - - type - - name - - content - title: AAAA Record - CNAMERecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: A valid hostname. - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - CNAME - example: CNAME - required: - - type - - name - - content - title: CNAME Record - HTTPSRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted HTTPS content. See 'data' to set HTTPS properties. - readOnly: true - type: string - data: - description: Components of a HTTPS record. - properties: - priority: - description: priority. - example: 1 - maximum: 65535 - minimum: 0 - type: number - target: - description: target. - example: . - type: string - value: - description: value. - example: 'alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1"' - type: string - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - HTTPS - example: HTTPS - required: - - type - - name - - data - title: HTTPS Record - NSRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: A valid name server host name. - example: ns1.example.com - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - NS - example: NS - required: - - type - - name - - content - title: NS Record - MXRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: A valid mail server hostname. - example: mx.example.com - format: hostname - type: string - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - priority: - $ref: '#/components/schemas/priority' - type: - description: Record type. - enum: - - MX - example: MX - required: - - type - - name - - content - - priority - title: MX Record - TXTRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Text content for the record. - example: example text content - type: string - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - TXT - example: TXT - required: - - type - - name - - content - title: TXT Record - LOCRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted LOC content. See 'data' to set LOC properties. - example: IN LOC 37 46 46 N 122 23 35 W 0m 100m 0m 0m - readOnly: true - type: string - data: - description: Components of a LOC record. - properties: - altitude: - description: Altitude of location in meters. - example: 0 - maximum: 42849672.95 - minimum: -100000 - type: number - lat_degrees: - description: Degrees of latitude. - example: 37 - maximum: 90 - minimum: 0 - type: number - lat_direction: - description: Latitude direction. - enum: - - 'N' - - S - example: 'N' - lat_minutes: - default: 0 - description: Minutes of latitude. - example: 46 - maximum: 59 - minimum: 0 - type: number - lat_seconds: - default: 0 - description: Seconds of latitude. - example: 46 - maximum: 59.999 - minimum: 0 - type: number - long_degrees: - description: Degrees of longitude. - example: 122 - maximum: 180 - minimum: 0 - type: number - long_direction: - description: Longitude direction. - enum: - - E - - W - example: W - long_minutes: - default: 0 - description: Minutes of longitude. - example: 23 - maximum: 59 - minimum: 0 - type: number - long_seconds: - default: 0 - description: Seconds of longitude. - example: 35 - maximum: 59.999 - minimum: 0 - type: number - precision_horz: - default: 0 - description: Horizontal precision of location. - example: 0 - maximum: 90000000 - minimum: 0 - type: number - precision_vert: - default: 0 - description: Vertical precision of location. - example: 0 - maximum: 90000000 - minimum: 0 - type: number - size: - default: 0 - description: Size of location in meters. - example: 100 - maximum: 90000000 - minimum: 0 - type: number - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - LOC - example: LOC - required: - - type - - name - - data - title: LOC Record - SRVRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: 'Priority, weight, port, and SRV target. See ''data'' for setting the individual component values.' - example: 10 IN SRV 5 8806 example.com. - readOnly: true - type: string - data: - description: Components of a SRV record. - properties: - name: - description: A valid hostname. - example: example.com - format: hostname - type: string - port: - description: The port of the service. - example: 8806 - maximum: 65535 - minimum: 0 - type: number - priority: - $ref: '#/components/schemas/priority' - proto: - description: A valid protocol. - example: _tcp - type: string - service: - description: 'A service type, prefixed with an underscore.' - example: _sip - type: string - target: - description: A valid hostname. - example: example.com - format: hostname - type: string - weight: - description: The record weight. - example: 5 - maximum: 65535 - minimum: 0 - type: number - type: object - name: - description: 'Service, protocol, and SRV name content. See ''data'' for setting the individual component values.' - example: _sip._tcp.example.com - maxLength: 255 - readOnly: true - type: string - type: - description: Record type. - enum: - - SRV - example: SRV - required: - - type - - data - title: SRV Record - CERTRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted CERT content. See 'data' to set CERT properties. - readOnly: true - type: string - data: - description: Components of a CERT record. - properties: - algorithm: - description: Algorithm. - example: 8 - maximum: 255 - minimum: 0 - type: number - certificate: - description: Certificate. - type: string - key_tag: - description: Key Tag. - example: 1 - maximum: 65535 - minimum: 0 - type: number - type: - description: Type. - example: 9 - maximum: 65535 - minimum: 0 - type: number - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - CERT - example: CERT - required: - - type - - name - - data - title: CERT Record - DNSKEYRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted DNSKEY content. See 'data' to set DNSKEY properties. - readOnly: true - type: string - data: - description: Components of a DNSKEY record. - properties: - algorithm: - description: Algorithm. - example: 5 - maximum: 255 - minimum: 0 - type: number - flags: - description: Flags. - example: 1 - maximum: 65535 - minimum: 0 - type: number - protocol: - description: Protocol. - example: 3 - maximum: 255 - minimum: 0 - type: number - public_key: - description: Public Key. - type: string - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - DNSKEY - example: DNSKEY - required: - - type - - name - - data - title: DNSKEY Record - DSRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted DS content. See 'data' to set DS properties. - readOnly: true - type: string - data: - description: Components of a DS record. - properties: - algorithm: - description: Algorithm. - example: 3 - maximum: 255 - minimum: 0 - type: number - digest: - description: Digest. - type: string - digest_type: - description: Digest Type. - example: 1 - maximum: 255 - minimum: 0 - type: number - key_tag: - description: Key Tag. - example: 1 - maximum: 65535 - minimum: 0 - type: number - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - DS - example: DS - required: - - type - - name - - data - title: DS Record - NAPTRRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted NAPTR content. See 'data' to set NAPTR properties. - readOnly: true - type: string - data: - description: Components of a NAPTR record. - properties: - flags: - description: Flags. - type: string - order: - description: Order. - example: 100 - maximum: 65535 - minimum: 0 - type: number - preference: - description: Preference. - example: 10 - maximum: 65535 - minimum: 0 - type: number - regex: - description: Regex. - type: string - replacement: - description: Replacement. - type: string - service: - description: Service. - type: string - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - NAPTR - example: NAPTR - required: - - type - - name - - data - title: NAPTR Record - SMIMEARecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted SMIMEA content. See 'data' to set SMIMEA properties. - readOnly: true - type: string - data: - description: Components of a SMIMEA record. - properties: - certificate: - description: Certificate. - type: string - matching_type: - description: Matching Type. - example: 0 - maximum: 255 - minimum: 0 - type: number - selector: - description: Selector. - example: 0 - maximum: 255 - minimum: 0 - type: number - usage: - description: Usage. - example: 3 - maximum: 255 - minimum: 0 - type: number - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - SMIMEA - example: SMIMEA - required: - - type - - name - - data - title: SMIMEA Record - SSHFPRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted SSHFP content. See 'data' to set SSHFP properties. - readOnly: true - type: string - data: - description: Components of a SSHFP record. - properties: - algorithm: - description: algorithm. - example: 2 - maximum: 255 - minimum: 0 - type: number - fingerprint: - description: fingerprint. - type: string - type: - description: type. - example: 1 - maximum: 255 - minimum: 0 - type: number - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - SSHFP - example: SSHFP - required: - - type - - name - - data - title: SSHFP Record - SVCBRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted SVCB content. See 'data' to set SVCB properties. - readOnly: true - type: string - data: - description: Components of a SVCB record. - properties: - priority: - description: priority. - example: 1 - maximum: 65535 - minimum: 0 - type: number - target: - description: target. - example: . - type: string - value: - description: value. - example: 'alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1"' - type: string - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - SVCB - example: SVCB - required: - - type - - name - - data - title: SVCB Record - TLSARecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted TLSA content. See 'data' to set TLSA properties. - readOnly: true - type: string - data: - description: Components of a TLSA record. - properties: - certificate: - description: certificate. - type: string - matching_type: - description: Matching Type. - example: 1 - maximum: 255 - minimum: 0 - type: number - selector: - description: Selector. - example: 0 - maximum: 255 - minimum: 0 - type: number - usage: - description: Usage. - example: 0 - maximum: 255 - minimum: 0 - type: number - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - type: - description: Record type. - enum: - - TLSA - example: TLSA - required: - - type - - name - - data - title: TLSA Record - URIRecord: - allOf: - - $ref: '#/components/schemas/dns-record_components-schemas-base' - - properties: - content: - description: Formatted URI content. See 'data' to set URI properties. - readOnly: true - type: string - data: - description: Components of a URI record. - properties: - content: - description: The record content. - example: 'http://example.com/example.html' - type: string - weight: - description: The record weight. - example: 20 - maximum: 65535 - minimum: 0 - type: number - type: object - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - priority: - $ref: '#/components/schemas/priority' - type: - description: Record type. - enum: - - URI - example: URI - required: - - type - - name - - data - - priority - title: URI Record - dns-record_components-schemas-base: - properties: - content: - $ref: '#/components/schemas/content' - created_on: - description: When the record was created. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - data: - description: Metadata about the record. - example: {} - type: object - id: - $ref: '#/components/schemas/dns-record_components-schemas-identifier' - locked: - description: Whether this record can be modified/deleted (true means it's managed by Cloudflare). - example: false - readOnly: true - type: boolean - meta: - description: Extra Cloudflare-specific information about the record. - properties: - auto_added: - description: Will exist if Cloudflare automatically added this DNS record during initial setup. - example: true - type: boolean - source: - description: Where the record originated from. - example: primary - type: string - type: object - modified_on: - description: When the record was last modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - proxiable: - description: Whether the record can be proxied by Cloudflare or not. - example: true - readOnly: true - type: boolean - proxied: - $ref: '#/components/schemas/proxied' - ttl: - $ref: '#/components/schemas/ttl' - type: - $ref: '#/components/schemas/dns-record_components-schemas-type' - zone_id: - $ref: '#/components/schemas/common_components-schemas-identifier' - zone_name: - description: The domain of the record. - example: example.com - format: hostname - readOnly: true - type: string - dns-record_components-schemas-name: - description: DNS record name (or @ for the zone apex). - example: example.com - maxLength: 255 - type: string - priority: - description: 'Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.' - example: 10 - maximum: 65535 - minimum: 0 - type: number - content: - description: DNS record content. - example: 127.0.0.1 - type: string - dns-record_components-schemas-identifier: - description: DNS record identifier tag. - example: 372e67954025e0ba6aaa6d586b9e0b59 - maxLength: 32 - readOnly: true - type: string - proxied: - description: Whether the record is receiving the performance and security benefits of Cloudflare. - example: false - type: boolean - ttl: - anyOf: - - example: 3600 - maximum: 86400 - minimum: 60 - type: number - - enum: - - 1 - type: number - description: 'Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ''automatic''.' - example: 3600 - type: number - dns-record_components-schemas-type: - description: DNS record type. - enum: - - A - - AAAA - - CNAME - - HTTPS - - TXT - - SRV - - LOC - - MX - - NS - - CERT - - DNSKEY - - DS - - NAPTR - - SMIMEA - - SSHFP - - SVCB - - TLSA - - URI - example: A - readOnly: true - type: string - dns_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - dns_response_import_scan: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - recs_added: - description: Number of DNS records added. - example: 5 - type: number - total_records_parsed: - description: Total number of DNS records parsed. - example: 5 - type: number - type: object - timing: - properties: - end_time: - description: When the file parsing ended. - example: '2014-03-01T12:20:01Z' - format: date-time - type: string - process_time: - description: Processing time of the file in seconds. - example: 1 - type: number - start_time: - description: When the file parsing started. - example: '2014-03-01T12:20:00Z' - format: date-time - type: string - type: object - type: object - delete_dnssec_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - example: '' - type: string - dnssec_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - schemas-account_identifier: - example: 01a7362d577a6c3019a474fd6f485823 - acl_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/acl' - type: array - acl: - properties: - id: - $ref: '#/components/schemas/acl_components-schemas-identifier' - ip_range: - $ref: '#/components/schemas/ip_range' - name: - $ref: '#/components/schemas/acl_components-schemas-name' - required: - - id - - name - - ip_range - type: object - acl_components-schemas-identifier: - example: 23ff594956f20c2a721606e94745a8aa - ip_range: - description: Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively. - example: 192.0.2.53/28 - type: string - acl_components-schemas-name: - description: The name of the acl. - example: my-acl-1 - type: string - acl_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/acl' - acl_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/acl_components-schemas-identifier' - type: object - peer_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/peer' - type: array - peer: - properties: - id: - $ref: '#/components/schemas/peer_components-schemas-identifier' - ip: - $ref: '#/components/schemas/ip' - ixfr_enable: - $ref: '#/components/schemas/ixfr_enable' - name: - $ref: '#/components/schemas/peer_components-schemas-name' - port: - $ref: '#/components/schemas/port' - tsig_id: - $ref: '#/components/schemas/tsig_id' - required: - - id - - name - type: object - peer_components-schemas-identifier: - example: 23ff594956f20c2a721606e94745a8aa - ip: - description: 'IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.' - example: 192.0.2.53 - type: string - ixfr_enable: - description: 'Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.' - example: false - type: boolean - peer_components-schemas-name: - description: The name of the peer. - example: my-peer-1 - type: string - port: - description: 'DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.' - example: 53 - type: number - tsig_id: - description: TSIG authentication will be used for zone transfer if configured. - example: 69cd1e104af3e6ed3cb344f263fd0d5a - type: string - peer_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/peer' - peer_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/peer_components-schemas-identifier' - type: object - dns-secondary-primary-zone_components-schemas-identifier: - example: 269d8f4853475ca241c4e730be286b20 - schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - type: object - single_response_outgoing: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - checked_time: - $ref: '#/components/schemas/time' - created_time: - $ref: '#/components/schemas/time' - id: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - last_transferred_time: - $ref: '#/components/schemas/time' - name: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-name' - peers: - $ref: '#/components/schemas/peers' - soa_serial: - $ref: '#/components/schemas/soa_serial' - type: object - time: - description: The time for a specific event. - example: '2019-10-24T17:09:42.883908+01:00' - type: string - dns-secondary-primary-zone_components-schemas-name: - description: Zone name. - example: www.example.com. - type: string - peers: - description: A list of peer tags. - example: - - 23ff594956f20c2a721606e94745a8aa - - 00920f38ce07c2e2f4df50b1f61d4194 - items: {} - type: array - soa_serial: - description: The serial number of the SOA for the given zone. - example: 2019102400 - type: number - single_request_outgoing: - properties: - id: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - name: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-name' - peers: - $ref: '#/components/schemas/peers' - required: - - id - - name - - peers - disable_transfer_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/disable_transfer_result' - disable_transfer_result: - description: The zone transfer status of a primary zone - example: Disabled - type: string - enable_transfer_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/enable_transfer_result' - enable_transfer_result: - description: The zone transfer status of a primary zone - example: Enabled - type: string - schemas-force_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/schemas-force_result' - schemas-force_result: - description: 'When force_notify query parameter is set to true, the response is a simple string' - example: OK - type: string - dns-secondary-secondary-zone_components-schemas-identifier: - example: 269d8f4853475ca241c4e730be286b20 - force_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/force_result' - force_result: - description: 'When force_axfr query parameter is set to true, the response is a simple string' - example: OK - type: string - id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - type: object - single_response_incoming: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - auto_refresh_seconds: - $ref: '#/components/schemas/auto_refresh_seconds' - checked_time: - $ref: '#/components/schemas/time' - created_time: - $ref: '#/components/schemas/time' - id: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - modified_time: - $ref: '#/components/schemas/time' - name: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-name' - peers: - $ref: '#/components/schemas/peers' - soa_serial: - $ref: '#/components/schemas/soa_serial' - type: object - auto_refresh_seconds: - description: |- - How often should a secondary zone auto refresh regardless of DNS NOTIFY. - Not applicable for primary zones. - example: 86400 - type: number - dns-secondary-secondary-zone_components-schemas-name: - description: Zone name. - example: www.example.com. - type: string - dns-secondary-secondary-zone: - properties: - auto_refresh_seconds: - $ref: '#/components/schemas/auto_refresh_seconds' - id: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - name: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-name' - peers: - $ref: '#/components/schemas/peers' - required: - - id - - name - - peers - - auto_refresh_seconds - type: object - tsig_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/tsig' - type: array - tsig: - properties: - algo: - $ref: '#/components/schemas/algo' - id: - $ref: '#/components/schemas/tsig_components-schemas-identifier' - name: - $ref: '#/components/schemas/tsig_components-schemas-name' - secret: - $ref: '#/components/schemas/secret' - required: - - id - - name - - secret - - algo - type: object - algo: - description: TSIG algorithm. - example: hmac-sha512. - type: string - tsig_components-schemas-identifier: - example: 69cd1e104af3e6ed3cb344f263fd0d5a - tsig_components-schemas-name: - description: TSIG key name. - example: tsig.customer.cf. - type: string - secret: - description: TSIG secret. - example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c - type: string - components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/tsig' - components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/tsig_components-schemas-identifier' - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_dns_analytics_report: - id: cloudflare.dns.zones_dns_analytics_report - name: zones_dns_analytics_report - title: Zones Dns Analytics Report - methods: - analytics_table: - operation: - $ref: '#/paths/~1zones~1{identifier}~1dns_analytics~1report/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _analytics_table: - operation: - $ref: '#/paths/~1zones~1{identifier}~1dns_analytics~1report/get' - response: - mediaType: application/json - openAPIDocKey: '200' - analytics_by_time: - operation: - $ref: '#/paths/~1zones~1{identifier}~1dns_analytics~1report~1bytime/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _analytics_by_time: - operation: - $ref: '#/paths/~1zones~1{identifier}~1dns_analytics~1report~1bytime/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_dns_firewall: - id: cloudflare.dns.accounts_dns_firewall - name: accounts_dns_firewall - title: Accounts Dns Firewall - methods: - firewall_list_dns_firewall_clusters: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall_list_dns_firewall_clusters: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall/get' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall_create_dns_firewall_cluster: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall/post' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall_delete_dns_firewall_cluster: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall_dns_firewall_cluster_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall_dns_firewall_cluster_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall_update_dns_firewall_cluster: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_dns_firewall/methods/firewall_list_dns_firewall_clusters' - - $ref: '#/components/x-stackQL-resources/accounts_dns_firewall/methods/firewall_dns_firewall_cluster_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_dns_firewall/methods/firewall_create_dns_firewall_cluster' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_dns_firewall/methods/firewall_delete_dns_firewall_cluster' - accounts_virtual_dns: - id: cloudflare.dns.accounts_virtual_dns - name: accounts_virtual_dns - title: Accounts Virtual Dns - methods: - firewall___legacy__list_dns_firewall_clusters: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall___legacy__list_dns_firewall_clusters: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall___legacy__create_dns_firewall_cluster: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns/post' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall___legacy__delete_dns_firewall_cluster: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall___legacy__dns_firewall_cluster_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall___legacy__dns_firewall_cluster_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall___legacy__update_dns_firewall_cluster: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_virtual_dns/methods/firewall___legacy__list_dns_firewall_clusters' - - $ref: '#/components/x-stackQL-resources/accounts_virtual_dns/methods/firewall___legacy__dns_firewall_cluster_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_virtual_dns/methods/firewall___legacy__create_dns_firewall_cluster' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_virtual_dns/methods/firewall___legacy__delete_dns_firewall_cluster' - accounts_dns_firewall_dns_analytics_report: - id: cloudflare.dns.accounts_dns_firewall_dns_analytics_report - name: accounts_dns_firewall_dns_analytics_report - title: Accounts Dns Firewall Dns Analytics Report - methods: - firewall_analytics_table: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}~1dns_analytics~1report/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall_analytics_table: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}~1dns_analytics~1report/get' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall_analytics_by_time: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}~1dns_analytics~1report~1bytime/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall_analytics_by_time: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1dns_firewall~1{identifier}~1dns_analytics~1report~1bytime/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_virtual_dns_dns_analytics_report: - id: cloudflare.dns.accounts_virtual_dns_dns_analytics_report - name: accounts_virtual_dns_dns_analytics_report - title: Accounts Virtual Dns Dns Analytics Report - methods: - firewall_analytics___legacy__table: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}~1dns_analytics~1report/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall_analytics___legacy__table: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}~1dns_analytics~1report/get' - response: - mediaType: application/json - openAPIDocKey: '200' - firewall_analytics___legacy__by_time: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}~1dns_analytics~1report~1bytime/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _firewall_analytics___legacy__by_time: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1virtual_dns~1{identifier}~1dns_analytics~1report~1bytime/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_dns_records: - id: cloudflare.dns.zones_dns_records - name: zones_dns_records - title: Zones Dns Records - methods: - records_for_a_zone_list_dns_records: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _records_for_a_zone_list_dns_records: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records/get' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_create_dns_record: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records/post' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_delete_dns_record: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_dns_record_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _records_for_a_zone_dns_record_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_patch_dns_record: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_update_dns_record: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_export_dns_records: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1export/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _records_for_a_zone_export_dns_records: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1export/get' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_import_dns_records: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1import/post' - response: - mediaType: application/json - openAPIDocKey: '200' - records_for_a_zone_scan_dns_records: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dns_records~1scan/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_dns_records/methods/records_for_a_zone_list_dns_records' - - $ref: '#/components/x-stackQL-resources/zones_dns_records/methods/records_for_a_zone_dns_record_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_dns_records/methods/records_for_a_zone_create_dns_record' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_dns_records/methods/records_for_a_zone_delete_dns_record' - zones_dnssec: - id: cloudflare.dns.zones_dnssec - name: zones_dnssec - title: Zones Dnssec - methods: - dnssec_delete_dnssec_records: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dnssec/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - dnssec_dnssec_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dnssec/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _dnssec_dnssec_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dnssec/get' - response: - mediaType: application/json - openAPIDocKey: '200' - dnssec_edit_dnssec_status: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1dnssec/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_dnssec/methods/dnssec_dnssec_details' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_dnssec/methods/dnssec_delete_dnssec_records' - accounts_secondary_dns_acls: - id: cloudflare.dns.accounts_secondary_dns_acls - name: accounts_secondary_dns_acls - title: Accounts Secondary Dns Acls - methods: - secondary_dns___acl__list_ac_ls: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1acls/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___acl__list_ac_ls: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1acls/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___acl__create_acl: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1acls/post' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___acl__delete_acl: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1acls~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___acl__acl_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1acls~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___acl__acl_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1acls~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___acl__update_acl: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1acls~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_acls/methods/secondary_dns___acl__list_ac_ls' - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_acls/methods/secondary_dns___acl__acl_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_acls/methods/secondary_dns___acl__create_acl' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_acls/methods/secondary_dns___acl__delete_acl' - accounts_secondary_dns_peers: - id: cloudflare.dns.accounts_secondary_dns_peers - name: accounts_secondary_dns_peers - title: Accounts Secondary Dns Peers - methods: - secondary_dns___peer__list_peers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1peers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___peer__list_peers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1peers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___peer__create_peer: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1peers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___peer__delete_peer: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1peers~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___peer__peer_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1peers~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___peer__peer_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1peers~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___peer__update_peer: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1peers~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_peers/methods/secondary_dns___peer__list_peers' - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_peers/methods/secondary_dns___peer__peer_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_peers/methods/secondary_dns___peer__create_peer' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_peers/methods/secondary_dns___peer__delete_peer' - zones_secondary_dns_outgoing: - id: cloudflare.dns.zones_secondary_dns_outgoing - name: zones_secondary_dns_outgoing - title: Zones Secondary Dns Outgoing - methods: - secondary_dns___primary_zone__delete_primary_zone_configuration: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___primary_zone__primary_zone_configuration_details: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___primary_zone__primary_zone_configuration_details: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___primary_zone__create_primary_zone_configuration: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing/post' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___primary_zone__update_primary_zone_configuration: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing/put' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___primary_zone__disable_outgoing_zone_transfers: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing~1disable/post' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___primary_zone__enable_outgoing_zone_transfers: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing~1enable/post' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___primary_zone__force_dns_notify: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing~1force_notify/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_secondary_dns_outgoing/methods/secondary_dns___primary_zone__primary_zone_configuration_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_secondary_dns_outgoing/methods/secondary_dns___primary_zone__create_primary_zone_configuration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_secondary_dns_outgoing/methods/secondary_dns___primary_zone__delete_primary_zone_configuration' - zones_secondary_dns_outgoing_status: - id: cloudflare.dns.zones_secondary_dns_outgoing_status - name: zones_secondary_dns_outgoing_status - title: Zones Secondary Dns Outgoing Status - methods: - secondary_dns___primary_zone__get_outgoing_zone_transfer_status: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing~1status/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _secondary_dns___primary_zone__get_outgoing_zone_transfer_status: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1outgoing~1status/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_secondary_dns_outgoing_status/methods/secondary_dns___primary_zone__get_outgoing_zone_transfer_status' - insert: [] - update: [] - delete: [] - zones_secondary_dns_force_axfr: - id: cloudflare.dns.zones_secondary_dns_force_axfr - name: zones_secondary_dns_force_axfr - title: Zones Secondary Dns Force Axfr - methods: - secondary_dns___secondary_zone__force_axfr: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1force_axfr/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_secondary_dns_incoming: - id: cloudflare.dns.zones_secondary_dns_incoming - name: zones_secondary_dns_incoming - title: Zones Secondary Dns Incoming - methods: - secondary_dns___secondary_zone__delete_secondary_zone_configuration: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1incoming/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___secondary_zone__secondary_zone_configuration_details: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1incoming/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___secondary_zone__secondary_zone_configuration_details: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1incoming/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___secondary_zone__create_secondary_zone_configuration: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1incoming/post' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___secondary_zone__update_secondary_zone_configuration: - operation: - $ref: '#/paths/~1zones~1{identifier}~1secondary_dns~1incoming/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_secondary_dns_incoming/methods/secondary_dns___secondary_zone__secondary_zone_configuration_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_secondary_dns_incoming/methods/secondary_dns___secondary_zone__create_secondary_zone_configuration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_secondary_dns_incoming/methods/secondary_dns___secondary_zone__delete_secondary_zone_configuration' - accounts_secondary_dns_tsigs: - id: cloudflare.dns.accounts_secondary_dns_tsigs - name: accounts_secondary_dns_tsigs - title: Accounts Secondary Dns Tsigs - methods: - secondary_dns___tsig__list_tsi_gs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1tsigs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___tsig__list_tsi_gs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1tsigs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___tsig__create_tsig: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1tsigs/post' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___tsig__delete_tsig: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1tsigs~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___tsig__tsig_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1tsigs~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _secondary_dns___tsig__tsig_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1tsigs~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - secondary_dns___tsig__update_tsig: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1secondary_dns~1tsigs~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_tsigs/methods/secondary_dns___tsig__list_tsi_gs' - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_tsigs/methods/secondary_dns___tsig__tsig_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_tsigs/methods/secondary_dns___tsig__create_tsig' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_secondary_dns_tsigs/methods/secondary_dns___tsig__delete_tsig' -paths: - '/zones/{identifier}/dns_analytics/report': - get: - description: Retrieves a list of summarised aggregate metrics over a given time period. - operationId: dns-analytics-table - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - description: Table response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Table response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Table - tags: - - DNS Analytics - x-cfPermissionsRequired: - enum: - - '#analytics:read' - '/zones/{identifier}/dns_analytics/report/bytime': - get: - description: Retrieves a list of aggregate metrics grouped by time interval. - operationId: dns-analytics-by-time - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - description: By Time response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: By Time response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: By Time - tags: - - DNS Analytics - x-cfPermissionsRequired: - enum: - - '#analytics:read' - '/accounts/{account_identifier}/dns_firewall': - get: - description: List configured DNS Firewall clusters for an account. - operationId: dns-firewall-list-dns-firewall-clusters - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_firewall_response_collection' - description: List DNS Firewall Clusters response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_firewall_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List DNS Firewall Clusters response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List DNS Firewall Clusters - tags: - - DNS Firewall - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create a configured DNS Firewall Cluster. - operationId: dns-firewall-create-dns-firewall-cluster - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - deprecate_any_requests: - $ref: '#/components/schemas/deprecate_any_requests' - ecs_fallback: - $ref: '#/components/schemas/ecs_fallback' - maximum_cache_ttl: - $ref: '#/components/schemas/maximum_cache_ttl' - minimum_cache_ttl: - $ref: '#/components/schemas/minimum_cache_ttl' - name: - $ref: '#/components/schemas/dns-firewall_components-schemas-name' - negative_cache_ttl: - $ref: '#/components/schemas/negative_cache_ttl' - origin_ips: - $ref: '#/components/schemas/origin_ips' - ratelimit: - $ref: '#/components/schemas/ratelimit' - required: - - name - - origin_ips - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_firewall_single_response' - description: Create DNS Firewall Cluster response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_firewall_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create DNS Firewall Cluster response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create DNS Firewall Cluster - tags: - - DNS Firewall - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/dns_firewall/{identifier}': - delete: - description: Delete a configured DNS Firewall Cluster. - operationId: dns-firewall-delete-dns-firewall-cluster - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - description: Delete DNS Firewall Cluster response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete DNS Firewall Cluster response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete DNS Firewall Cluster - tags: - - DNS Firewall - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Show a single configured DNS Firewall cluster for an account. - operationId: dns-firewall-dns-firewall-cluster-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_firewall_single_response' - description: DNS Firewall Cluster Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_firewall_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: DNS Firewall Cluster Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: DNS Firewall Cluster Details - tags: - - DNS Firewall - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: Modify a DNS Firewall Cluster configuration. - operationId: dns-firewall-update-dns-firewall-cluster - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-dns-firewall' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_firewall_single_response' - description: Update DNS Firewall Cluster response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_firewall_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update DNS Firewall Cluster response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update DNS Firewall Cluster - tags: - - DNS Firewall - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/virtual_dns': - get: - description: List configured DNS Firewall clusters for an account. - operationId: dns-firewall-(-legacy)-list-dns-firewall-clusters - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/virtual_dns_response_collection' - description: List DNS Firewall Clusters response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/virtual_dns_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List DNS Firewall Clusters response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List DNS Firewall Clusters - tags: - - DNS Firewall (Legacy) - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create a configured DNS Firewall Cluster. - operationId: dns-firewall-(-legacy)-create-dns-firewall-cluster - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - deprecate_any_requests: - $ref: '#/components/schemas/deprecate_any_requests' - ecs_fallback: - $ref: '#/components/schemas/ecs_fallback' - maximum_cache_ttl: - $ref: '#/components/schemas/maximum_cache_ttl' - minimum_cache_ttl: - $ref: '#/components/schemas/minimum_cache_ttl' - name: - $ref: '#/components/schemas/virtual-dns_components-schemas-name' - negative_cache_ttl: - $ref: '#/components/schemas/schemas-negative_cache_ttl' - origin_ips: - $ref: '#/components/schemas/origin_ips' - ratelimit: - $ref: '#/components/schemas/schemas-ratelimit' - required: - - name - - origin_ips - - virtual_dns_ips - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/virtual_dns_single_response' - description: Create DNS Firewall Cluster response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/virtual_dns_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create DNS Firewall Cluster response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create DNS Firewall Cluster - tags: - - DNS Firewall (Legacy) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/virtual_dns/{identifier}': - delete: - description: Delete a configured DNS Firewall Cluster. - operationId: dns-firewall-(-legacy)-delete-dns-firewall-cluster - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - description: Delete DNS Firewall Cluster response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete DNS Firewall Cluster response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete DNS Firewall Cluster - tags: - - DNS Firewall (Legacy) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Show a single configured DNS Firewall cluster for an account. - operationId: dns-firewall-(-legacy)-dns-firewall-cluster-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/virtual_dns_single_response' - description: DNS Firewall Cluster Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/virtual_dns_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: DNS Firewall Cluster Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: DNS Firewall Cluster Details - tags: - - DNS Firewall (Legacy) - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Modify a DNS Firewall Cluster configuration. - operationId: dns-firewall-(-legacy)-update-dns-firewall-cluster - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-virtual-dns' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/virtual_dns_single_response' - description: Update DNS Firewall Cluster response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/virtual_dns_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update DNS Firewall Cluster response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update DNS Firewall Cluster - tags: - - DNS Firewall (Legacy) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report': - get: - description: Retrieves a list of summarised aggregate metrics over a given time period. - operationId: dns-firewall-analytics-table - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - description: Table response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Table response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Table - tags: - - DNS Firewall Analytics - x-cfPermissionsRequired: - enum: - - '#analytics:read' - '/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report/bytime': - get: - description: Retrieves a list of aggregate metrics grouped by time interval. - operationId: dns-firewall-analytics-by-time - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - description: By Time response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: By Time response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: By Time - tags: - - DNS Firewall Analytics - x-cfPermissionsRequired: - enum: - - '#analytics:read' - '/accounts/{account_identifier}/virtual_dns/{identifier}/dns_analytics/report': - get: - description: Retrieves a list of summarised aggregate metrics over a given time period. - operationId: dns-firewall-analytics-(-legacy)-table - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - description: Table response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Table response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Table - tags: - - DNS Firewall Analytics (Legacy) - x-cfPermissionsRequired: - enum: - - '#analytics:read' - '/accounts/{account_identifier}/virtual_dns/{identifier}/dns_analytics/report/bytime': - get: - description: Retrieves a list of aggregate metrics grouped by time interval. - operationId: dns-firewall-analytics-(-legacy)-by-time - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - description: By Time response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: By Time response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: By Time - tags: - - DNS Firewall Analytics (Legacy) - x-cfPermissionsRequired: - enum: - - '#analytics:read' - '/zones/{zone_identifier}/dns_records': - get: - description: 'List, search, sort, and filter a zones'' DNS records.' - operationId: dns-records-for-a-zone-list-dns-records - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_response_collection' - description: List DNS Records response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List DNS Records response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List DNS Records - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Create a new DNS record for a zone. See the record object definitions for required attributes for each record type. - operationId: dns-records-for-a-zone-create-dns-record - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - content: - $ref: '#/components/schemas/content' - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - priority: - $ref: '#/components/schemas/priority' - proxied: - $ref: '#/components/schemas/proxied' - ttl: - $ref: '#/components/schemas/ttl' - type: - $ref: '#/components/schemas/dns-record_components-schemas-type' - required: - - type - - name - - content - - ttl - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_response_single' - description: Create DNS Record response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create DNS Record response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create DNS Record - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/dns_records/export': - get: - description: 'You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint.' - operationId: dns-records-for-a-zone-export-dns-records - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: {} - description: Export DNS Records response - 4xx: - content: - application/json: - schema: - allOf: - - {} - - $ref: '#/components/schemas/api-response-common-failure' - description: Export DNS Records response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Export DNS Records - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/dns_records/import': - post: - description: 'You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.' - operationId: dns-records-for-a-zone-import-dns-records - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - multipart/form-data: - schema: - properties: - file: - description: BIND config to upload. - example: '@bind_config.txt' - type: string - proxied: - description: Whether or not proxiable records should receive the performance and security benefits of Cloudflare. - example: false - type: boolean - required: - - file - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_response_import_scan' - description: Import DNS Records response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_response_import_scan' - - $ref: '#/components/schemas/api-response-common-failure' - description: Import DNS Records response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Import DNS Records - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/dns_records/scan': - post: - description: Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet. - operationId: dns-records-for-a-zone-scan-dns-records - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_response_import_scan' - description: Scan DNS Records response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_response_import_scan' - - $ref: '#/components/schemas/api-response-common-failure' - description: Scan DNS Records response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Scan DNS Records - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/dns_records/{identifier}': - delete: - operationId: dns-records-for-a-zone-delete-dns-record - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-record_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - id: - $ref: '#/components/schemas/dns-record_components-schemas-identifier' - type: object - type: object - description: Delete DNS Record response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - id: - $ref: '#/components/schemas/dns-record_components-schemas-identifier' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete DNS Record response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete DNS Record - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - operationId: dns-records-for-a-zone-dns-record-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-record_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_response_single' - description: DNS Record Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: DNS Record Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: DNS Record Details - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - operationId: dns-records-for-a-zone-patch-dns-record - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-record_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - content: - $ref: '#/components/schemas/content' - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - proxied: - $ref: '#/components/schemas/proxied' - ttl: - $ref: '#/components/schemas/ttl' - type: - $ref: '#/components/schemas/dns-record_components-schemas-type' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_response_single' - description: Patch DNS Record response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch DNS Record response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Patch DNS Record - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - operationId: dns-records-for-a-zone-update-dns-record - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-record_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - content: - $ref: '#/components/schemas/content' - name: - $ref: '#/components/schemas/dns-record_components-schemas-name' - proxied: - $ref: '#/components/schemas/proxied' - ttl: - $ref: '#/components/schemas/ttl' - type: - $ref: '#/components/schemas/dns-record_components-schemas-type' - required: - - type - - name - - content - - ttl - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dns_response_single' - description: Update DNS Record response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update DNS Record response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update DNS Record - tags: - - DNS Records for a Zone - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/dnssec': - delete: - description: Delete DNSSEC. - operationId: dnssec-delete-dnssec-records - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/delete_dnssec_response_single' - description: Delete DNSSEC records response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/delete_dnssec_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete DNSSEC records response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete DNSSEC records - tags: - - DNSSEC - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Details about DNSSEC status and configuration. - operationId: dnssec-dnssec-details - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dnssec_response_single' - description: DNSSEC Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dnssec_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: DNSSEC Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: DNSSEC Details - tags: - - DNSSEC - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Enable or disable DNSSEC. - operationId: dnssec-edit-dnssec-status - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - status: - description: 'Status of DNSSEC, based on user-desired state and presence of necessary records.' - enum: - - active - - disabled - example: active - required: - - status - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dnssec_response_single' - description: Edit DNSSEC Status response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dnssec_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit DNSSEC Status response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit DNSSEC Status - tags: - - DNSSEC - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/secondary_dns/acls': - get: - description: List ACLs. - operationId: secondary-dns-(-acl)-list-ac-ls - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acl_components-schemas-response_collection' - description: List ACLs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acl_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List ACLs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List ACLs - tags: - - Secondary DNS (ACL) - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create ACL. - operationId: secondary-dns-(-acl)-create-acl - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - ip_range - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acl_components-schemas-single_response' - description: Create ACL response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acl_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create ACL response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create ACL - tags: - - Secondary DNS (ACL) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/secondary_dns/acls/{identifier}': - delete: - description: Delete ACL. - operationId: secondary-dns-(-acl)-delete-acl - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/acl_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acl_components-schemas-id_response' - description: Delete ACL response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acl_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete ACL response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete ACL - tags: - - Secondary DNS (ACL) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Get ACL. - operationId: secondary-dns-(-acl)-acl-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/acl_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acl_components-schemas-single_response' - description: ACL Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acl_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: ACL Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: ACL Details - tags: - - Secondary DNS (ACL) - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Modify ACL. - operationId: secondary-dns-(-acl)-update-acl - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/acl_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/acl' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/acl_components-schemas-single_response' - description: Update ACL response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/acl_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update ACL response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update ACL - tags: - - Secondary DNS (ACL) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/secondary_dns/peers': - get: - description: List Peers. - operationId: secondary-dns-(-peer)-list-peers - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/peer_components-schemas-response_collection' - description: List Peers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/peer_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Peers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Peers - tags: - - Secondary DNS (Peer) - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create Peer. - operationId: secondary-dns-(-peer)-create-peer - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: - schema: - required: - - name - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/peer_components-schemas-single_response' - description: Create Peer response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/peer_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Peer response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Peer - tags: - - Secondary DNS (Peer) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/secondary_dns/peers/{identifier}': - delete: - description: Delete Peer. - operationId: secondary-dns-(-peer)-delete-peer - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/peer_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/peer_components-schemas-id_response' - description: Delete Peer response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/peer_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Peer response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Peer - tags: - - Secondary DNS (Peer) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Get Peer. - operationId: secondary-dns-(-peer)-peer-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/peer_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/peer_components-schemas-single_response' - description: Peer Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/peer_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Peer Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Peer Details - tags: - - Secondary DNS (Peer) - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Modify Peer. - operationId: secondary-dns-(-peer)-update-peer - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/peer_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/peer' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/peer_components-schemas-single_response' - description: Update Peer response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/peer_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Peer response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Peer - tags: - - Secondary DNS (Peer) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{identifier}/secondary_dns/outgoing': - delete: - description: Delete primary zone configuration for outgoing zone transfers. - operationId: secondary-dns-(-primary-zone)-delete-primary-zone-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-id_response' - description: Delete Primary Zone Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Primary Zone Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Primary Zone Configuration - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Get primary zone configuration for outgoing zone transfers. - operationId: secondary-dns-(-primary-zone)-primary-zone-configuration-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response_outgoing' - description: Primary Zone Configuration Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response_outgoing' - - $ref: '#/components/schemas/api-response-common-failure' - description: Primary Zone Configuration Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Primary Zone Configuration Details - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create primary zone configuration for outgoing zone transfers. - operationId: secondary-dns-(-primary-zone)-create-primary-zone-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/single_request_outgoing' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response_outgoing' - description: Create Primary Zone Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response_outgoing' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Primary Zone Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Primary Zone Configuration - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Update primary zone configuration for outgoing zone transfers. - operationId: secondary-dns-(-primary-zone)-update-primary-zone-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/single_request_outgoing' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response_outgoing' - description: Update Primary Zone Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response_outgoing' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Primary Zone Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Primary Zone Configuration - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{identifier}/secondary_dns/outgoing/disable': - post: - description: Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone. - operationId: secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/disable_transfer_response' - description: Disable Outgoing Zone Transfers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/disable_transfer_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Disable Outgoing Zone Transfers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Disable Outgoing Zone Transfers - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{identifier}/secondary_dns/outgoing/enable': - post: - description: Enable outgoing zone transfers for primary zone. - operationId: secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/enable_transfer_response' - description: Enable Outgoing Zone Transfers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/enable_transfer_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Enable Outgoing Zone Transfers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Enable Outgoing Zone Transfers - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{identifier}/secondary_dns/outgoing/force_notify': - post: - description: Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone. - operationId: secondary-dns-(-primary-zone)-force-dns-notify - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-force_response' - description: Force DNS NOTIFY response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-force_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Force DNS NOTIFY response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Force DNS NOTIFY - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{identifier}/secondary_dns/outgoing/status': - get: - description: Get primary zone transfer status. - operationId: secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/enable_transfer_response' - description: Get Outgoing Zone Transfer Status response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/enable_transfer_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Outgoing Zone Transfer Status response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Outgoing Zone Transfer Status - tags: - - Secondary DNS (Primary Zone) - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{identifier}/secondary_dns/force_axfr': - post: - description: Sends AXFR zone transfer request to primary nameserver(s). - operationId: secondary-dns-(-secondary-zone)-force-axfr - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/force_response' - description: Force AXFR response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/force_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Force AXFR response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Force AXFR - tags: - - Secondary DNS (Secondary Zone) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{identifier}/secondary_dns/incoming': - delete: - description: Delete secondary zone configuration for incoming zone transfers. - operationId: secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/id_response' - description: Delete Secondary Zone Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Secondary Zone Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Secondary Zone Configuration - tags: - - Secondary DNS (Secondary Zone) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Get secondary zone configuration for incoming zone transfers. - operationId: secondary-dns-(-secondary-zone)-secondary-zone-configuration-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response_incoming' - description: Secondary Zone Configuration Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response_incoming' - - $ref: '#/components/schemas/api-response-common-failure' - description: Secondary Zone Configuration Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Secondary Zone Configuration Details - tags: - - Secondary DNS (Secondary Zone) - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create secondary zone configuration for incoming zone transfers. - operationId: secondary-dns-(-secondary-zone)-create-secondary-zone-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/dns-secondary-secondary-zone' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response_incoming' - description: Create Secondary Zone Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response_incoming' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Secondary Zone Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Secondary Zone Configuration - tags: - - Secondary DNS (Secondary Zone) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Update secondary zone configuration for incoming zone transfers. - operationId: secondary-dns-(-secondary-zone)-update-secondary-zone-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/dns-secondary-secondary-zone' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response_incoming' - description: Update Secondary Zone Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response_incoming' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Secondary Zone Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Secondary Zone Configuration - tags: - - Secondary DNS (Secondary Zone) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/secondary_dns/tsigs': - get: - description: List TSIGs. - operationId: secondary-dns-(-tsig)-list-tsi-gs - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tsig_components-schemas-response_collection' - description: List TSIGs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tsig_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List TSIGs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List TSIGs - tags: - - Secondary DNS (TSIG) - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create TSIG. - operationId: secondary-dns-(-tsig)-create-tsig - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - algo - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-single_response' - description: Create TSIG response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create TSIG response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create TSIG - tags: - - Secondary DNS (TSIG) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/secondary_dns/tsigs/{identifier}': - delete: - description: Delete TSIG. - operationId: secondary-dns-(-tsig)-delete-tsig - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/tsig_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-id_response' - description: Delete TSIG response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete TSIG response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete TSIG - tags: - - Secondary DNS (TSIG) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Get TSIG. - operationId: secondary-dns-(-tsig)-tsig-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/tsig_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-single_response' - description: TSIG Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: TSIG Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: TSIG Details - tags: - - Secondary DNS (TSIG) - x-cfPermissionsRequired: - enum: - - '#dns_records:read' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Modify TSIG. - operationId: secondary-dns-(-tsig)-update-tsig - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/tsig_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/tsig' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-single_response' - description: Update TSIG response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update TSIG response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update TSIG - tags: - - Secondary DNS (TSIG) - x-cfPermissionsRequired: - enum: - - '#dns_records:edit' - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false +openapi: 3.0.3 +info: + title: dns API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/dns_settings: + get: + description: Show DNS settings for an account + operationId: dns-settings-for-an-account-list-dns-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsResponseSingle' + description: Show DNS Settings response + 4XX: + content: + application/json: + schema: + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + enforce_dns_only: + $ref: '#/components/schemas/dnsSettingsEnforceDnsOnly' + zone_defaults: + $ref: '#/components/schemas/dnsSettingsDnsSettingsAccountResponse' + required: + - zone_defaults + type: object + enum: + - null + description: Show DNS Settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Show DNS Settings + tags: + - DNS Settings for an Account + x-api-token-group: + - Account DNS Settings Write + - Account DNS Settings Read + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - settings + - account + method: get + patch: + description: Update DNS settings for an account + operationId: dns-settings-for-an-account-update-dns-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsAccountSettingsPatch' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsResponseSingle' + description: Show DNS Settings response + 4XX: + content: + application/json: + schema: + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + enforce_dns_only: + $ref: '#/components/schemas/dnsSettingsEnforceDnsOnly' + zone_defaults: + $ref: '#/components/schemas/dnsSettingsDnsSettingsAccountResponse' + required: + - zone_defaults + type: object + enum: + - null + description: Show DNS Settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update DNS Settings + tags: + - DNS Settings for an Account + x-api-token-group: + - Account DNS Settings Write + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - settings + - account + method: edit + /accounts/{account_id}/dns_settings/views: + get: + description: List DNS Internal Views for an Account + operationId: dns-views-for-an-account-list-internal-dns-views + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: Exact value of the DNS view name. This is a convenience alias for `name.exact`. + type: string + - in: query + name: name.exact + schema: + description: Exact value of the DNS view name. + type: string + - in: query + name: name.contains + schema: + description: Substring of the DNS view name. + type: string + - in: query + name: name.startswith + schema: + description: Prefix of the DNS view name. + type: string + - in: query + name: name.endswith + schema: + description: Suffix of the DNS view name. + type: string + - in: query + name: zone_id + schema: + description: A zone ID that exists in the zones list for the view. + type: string + - in: query + name: zone_name + schema: + description: A zone name that exists in the zones list for the view. + type: string + - in: query + name: match + schema: + $ref: '#/components/schemas/dnsSettingsMatch' + - in: query + name: page + schema: + $ref: '#/components/schemas/dnsSettingsPage' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/dnsSettingsPerPage' + - in: query + name: order + schema: + $ref: '#/components/schemas/dnsSettingsOrder' + - in: query + name: direction + schema: + $ref: '#/components/schemas/dnsSettingsDirection' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsViewResponseCollection' + description: List Internal DNS Views response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/dnsSettingsDnsViewResponse' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Internal DNS Views response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Internal DNS Views + tags: + - DNS Internal Views for an Account + x-api-token-group: + - DNS View Write + - DNS View Read + x-cfPermissionsRequired: + enum: + - '#dns.view:list' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - settings + - account + - views + method: list + post: + description: Create Internal DNS View for an account + operationId: dns-views-for-an-account-create-internal-dns-views + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsViewPost' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsViewResponseSingle' + description: Create Internal DNS View response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - id + - name + - zones + - created_time + - modified_time + - id + type: object + properties: + created_time: + $ref: '#/components/schemas/dnsSettingsCreatedTime' + modified_time: + $ref: '#/components/schemas/dnsSettingsModifiedTime' + name: + $ref: '#/components/schemas/dnsSettingsName' + zones: + $ref: '#/components/schemas/dnsSettingsZones' + id: + $ref: '#/components/schemas/dnsSettingsIdentifier' + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Internal DNS View response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Internal DNS View + tags: + - DNS Internal Views for an Account + x-api-token-group: + - DNS View Write + x-cfPermissionsRequired: + enum: + - '#dns.view:create' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - settings + - account + - views + method: create + /accounts/{account_id}/dns_settings/views/{view_id}: + delete: + description: Delete an existing Internal DNS View + operationId: dns-views-for-an-account-delete-internal-dns-view + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: view_id + schema: + $ref: '#/components/schemas/dnsSettingsIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: '#/components/schemas/dnsSettingsIdentifier' + type: object + type: object + description: Delete Internal DNS View response + 4XX: + content: + application/json: + schema: + type: object + properties: + result: + properties: + id: + $ref: '#/components/schemas/dnsSettingsIdentifier' + type: object + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + description: Update Internal DNS View response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Internal DNS View + tags: + - DNS Internal Views for an Account + x-api-token-group: + - DNS View Write + x-cfPermissionsRequired: + enum: + - '#dns.view:delete' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - settings + - account + - views + method: delete + get: + description: Get DNS Internal View + operationId: dns-views-for-an-account-get-internal-dns-view + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: view_id + schema: + $ref: '#/components/schemas/dnsSettingsIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsViewResponseSingle' + description: Get DNS Internal View response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - id + - name + - zones + - created_time + - modified_time + - id + type: object + properties: + created_time: + $ref: '#/components/schemas/dnsSettingsCreatedTime' + modified_time: + $ref: '#/components/schemas/dnsSettingsModifiedTime' + name: + $ref: '#/components/schemas/dnsSettingsName' + zones: + $ref: '#/components/schemas/dnsSettingsZones' + id: + $ref: '#/components/schemas/dnsSettingsIdentifier' + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Internal DNS Views response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: DNS Internal View Details + tags: + - DNS Internal Views for an Account + x-api-token-group: + - DNS View Write + - DNS View Read + x-cfPermissionsRequired: + enum: + - '#dns.view:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - settings + - account + - views + method: get + patch: + description: Update an existing Internal DNS View + operationId: dns-views-for-an-account-update-internal-dns-view + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: view_id + schema: + $ref: '#/components/schemas/dnsSettingsIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsViewPatch' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsViewResponseSingle' + description: Update Internal DNS View response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - id + - name + - zones + - created_time + - modified_time + - id + type: object + properties: + created_time: + $ref: '#/components/schemas/dnsSettingsCreatedTime' + modified_time: + $ref: '#/components/schemas/dnsSettingsModifiedTime' + name: + $ref: '#/components/schemas/dnsSettingsName' + zones: + $ref: '#/components/schemas/dnsSettingsZones' + id: + $ref: '#/components/schemas/dnsSettingsIdentifier' + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Internal DNS View response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Internal DNS View + tags: + - DNS Internal Views for an Account + x-api-token-group: + - DNS View Write + x-cfPermissionsRequired: + enum: + - '#dns.view:update' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - settings + - account + - views + method: edit + /accounts/{account_id}/secondary_dns/acls: + get: + description: List ACLs. + operationId: secondary-dns-(-acl)-list-ac-ls + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasResponseCollection' + description: List ACLs response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/secondaryDnsAcl' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List ACLs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List ACLs + tags: + - Secondary DNS (ACL) + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - acls + method: list + post: + description: Create ACL. + operationId: secondary-dns-(-acl)-create-acl + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ip_range: + $ref: '#/components/schemas/secondaryDnsIpRange' + name: + $ref: '#/components/schemas/secondaryDnsAclComponentsSchemasName' + required: + - name + - ip_range + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasSingleResponse' + description: Create ACL response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip_range: + $ref: '#/components/schemas/secondaryDnsIpRange' + name: + $ref: '#/components/schemas/secondaryDnsAclComponentsSchemasName' + required: + - id + - name + - ip_range + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create ACL response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create ACL + tags: + - Secondary DNS (ACL) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - acls + method: create + /accounts/{account_id}/secondary_dns/acls/{acl_id}: + delete: + description: Delete ACL. + operationId: secondary-dns-(-acl)-delete-acl + parameters: + - in: path + name: acl_id + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdResponse' + description: Delete ACL response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete ACL response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete ACL + tags: + - Secondary DNS (ACL) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - acls + method: delete + get: + description: Get ACL. + operationId: secondary-dns-(-acl)-acl-details + parameters: + - in: path + name: acl_id + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasSingleResponse' + description: ACL Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip_range: + $ref: '#/components/schemas/secondaryDnsIpRange' + name: + $ref: '#/components/schemas/secondaryDnsAclComponentsSchemasName' + required: + - id + - name + - ip_range + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: ACL Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: ACL Details + tags: + - Secondary DNS (ACL) + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - acls + method: get + put: + description: Modify ACL. + operationId: secondary-dns-(-acl)-update-acl + parameters: + - in: path + name: acl_id + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsAcl' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasSingleResponse' + description: Update ACL response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip_range: + $ref: '#/components/schemas/secondaryDnsIpRange' + name: + $ref: '#/components/schemas/secondaryDnsAclComponentsSchemasName' + required: + - id + - name + - ip_range + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update ACL response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update ACL + tags: + - Secondary DNS (ACL) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - acls + method: update + /accounts/{account_id}/secondary_dns/peers: + get: + description: List Peers. + operationId: secondary-dns-(-peer)-list-peers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSchemasResponseCollection' + description: List Peers response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/secondaryDnsPeer' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Peers response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Peers + tags: + - Secondary DNS (Peer) + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - peers + method: list + post: + description: Create Peer. + operationId: secondary-dns-(-peer)-create-peer + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasName' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSchemasSingleResponse' + description: Create Peer response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip: + $ref: '#/components/schemas/secondaryDnsIp' + ixfr_enable: + $ref: '#/components/schemas/secondaryDnsIxfrEnable' + name: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasName' + port: + $ref: '#/components/schemas/secondaryDnsPort' + tsig_id: + $ref: '#/components/schemas/secondaryDnsTsigId' + required: + - id + - name + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Peer response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Peer + tags: + - Secondary DNS (Peer) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - peers + method: create + /accounts/{account_id}/secondary_dns/peers/{peer_id}: + delete: + description: Delete Peer. + operationId: secondary-dns-(-peer)-delete-peer + parameters: + - in: path + name: peer_id + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdResponse' + description: Delete Peer response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Peer response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Peer + tags: + - Secondary DNS (Peer) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - peers + method: delete + get: + description: Get Peer. + operationId: secondary-dns-(-peer)-peer-details + parameters: + - in: path + name: peer_id + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSchemasSingleResponse' + description: Peer Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip: + $ref: '#/components/schemas/secondaryDnsIp' + ixfr_enable: + $ref: '#/components/schemas/secondaryDnsIxfrEnable' + name: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasName' + port: + $ref: '#/components/schemas/secondaryDnsPort' + tsig_id: + $ref: '#/components/schemas/secondaryDnsTsigId' + required: + - id + - name + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Peer Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Peer Details + tags: + - Secondary DNS (Peer) + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - peers + method: get + put: + description: Modify Peer. + operationId: secondary-dns-(-peer)-update-peer + parameters: + - in: path + name: peer_id + schema: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsPeer' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSchemasSingleResponse' + description: Update Peer response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip: + $ref: '#/components/schemas/secondaryDnsIp' + ixfr_enable: + $ref: '#/components/schemas/secondaryDnsIxfrEnable' + name: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasName' + port: + $ref: '#/components/schemas/secondaryDnsPort' + tsig_id: + $ref: '#/components/schemas/secondaryDnsTsigId' + required: + - id + - name + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Peer response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Peer + tags: + - Secondary DNS (Peer) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - peers + method: update + /accounts/{account_id}/secondary_dns/tsigs: + get: + description: List TSIGs. + operationId: secondary-dns-(-tsig)-list-tsi-gs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsResponseCollection' + description: List TSIGs response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/secondaryDnsTsig' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List TSIGs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List TSIGs + tags: + - Secondary DNS (TSIG) + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - tsigs + method: list + post: + description: Create TSIG. + operationId: secondary-dns-(-tsig)-create-tsig + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsTsig' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponse' + description: Create TSIG response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + algo: + $ref: '#/components/schemas/secondaryDnsAlgo' + id: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + name: + $ref: '#/components/schemas/secondaryDnsSchemasName' + secret: + $ref: '#/components/schemas/secondaryDnsSecret' + required: + - id + - name + - secret + - algo + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create TSIG response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create TSIG + tags: + - Secondary DNS (TSIG) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - tsigs + method: create + /accounts/{account_id}/secondary_dns/tsigs/{tsig_id}: + delete: + description: Delete TSIG. + operationId: secondary-dns-(-tsig)-delete-tsig + parameters: + - in: path + name: tsig_id + schema: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSchemasIdResponse' + description: Delete TSIG response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete TSIG response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete TSIG + tags: + - Secondary DNS (TSIG) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - tsigs + method: delete + get: + description: Get TSIG. + operationId: secondary-dns-(-tsig)-tsig-details + parameters: + - in: path + name: tsig_id + schema: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponse' + description: TSIG Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + algo: + $ref: '#/components/schemas/secondaryDnsAlgo' + id: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + name: + $ref: '#/components/schemas/secondaryDnsSchemasName' + secret: + $ref: '#/components/schemas/secondaryDnsSecret' + required: + - id + - name + - secret + - algo + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: TSIG Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: TSIG Details + tags: + - Secondary DNS (TSIG) + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - tsigs + method: get + put: + description: Modify TSIG. + operationId: secondary-dns-(-tsig)-update-tsig + parameters: + - in: path + name: tsig_id + schema: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsTsig' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponse' + description: Update TSIG response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + algo: + $ref: '#/components/schemas/secondaryDnsAlgo' + id: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + name: + $ref: '#/components/schemas/secondaryDnsSchemasName' + secret: + $ref: '#/components/schemas/secondaryDnsSecret' + required: + - id + - name + - secret + - algo + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update TSIG response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update TSIG + tags: + - Secondary DNS (TSIG) + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - tsigs + method: update + /zones/{zone_id}/dns_analytics/report: + get: + description: Retrieves a list of summarised aggregate metrics over a given time period. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters. + operationId: dns-analytics-table + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: metrics + schema: + $ref: '#/components/schemas/dnsAnalyticsMetrics' + - in: query + name: dimensions + schema: + $ref: '#/components/schemas/dnsAnalyticsDimensions' + - in: query + name: since + schema: + $ref: '#/components/schemas/dnsAnalyticsSince' + - in: query + name: until + schema: + $ref: '#/components/schemas/dnsAnalyticsUntil' + - in: query + name: limit + schema: + $ref: '#/components/schemas/dnsAnalyticsLimit' + - in: query + name: sort + schema: + $ref: '#/components/schemas/dnsAnalyticsSort' + - in: query + name: filters + schema: + $ref: '#/components/schemas/dnsAnalyticsFilters' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dnsAnalyticsReport' + required: + - success + - errors + - messages + description: Table response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + description: Table response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Table + tags: + - DNS Analytics + x-api-token-group: + - Analytics Read + x-cfPermissionsRequired: + enum: + - '#analytics:read' + x-stackql-sdk: + service: dns + resource_chain: + - analytics + - reports + method: get + /zones/{zone_id}/dns_analytics/report/bytime: + get: + description: Retrieves a list of aggregate metrics grouped by time interval. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters. + operationId: dns-analytics-by-time + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: metrics + schema: + $ref: '#/components/schemas/dnsAnalyticsMetrics' + - in: query + name: dimensions + schema: + $ref: '#/components/schemas/dnsAnalyticsDimensions' + - in: query + name: since + schema: + $ref: '#/components/schemas/dnsAnalyticsSince' + - in: query + name: until + schema: + $ref: '#/components/schemas/dnsAnalyticsUntil' + - in: query + name: limit + schema: + $ref: '#/components/schemas/dnsAnalyticsLimit' + - in: query + name: sort + schema: + $ref: '#/components/schemas/dnsAnalyticsSort' + - in: query + name: filters + schema: + $ref: '#/components/schemas/dnsAnalyticsFilters' + - in: query + name: time_delta + schema: + $ref: '#/components/schemas/dnsAnalyticsTimeDelta' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dnsAnalyticsReportBytime' + required: + - success + - errors + - messages + description: By Time response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + description: By Time response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: By Time + tags: + - DNS Analytics + x-api-token-group: + - Analytics Read + x-cfPermissionsRequired: + enum: + - '#analytics:read' + x-stackql-sdk: + service: dns + resource_chain: + - analytics + - reports + - bytimes + method: get + /zones/{zone_id}/dns_records: + get: + description: List, search, sort, and filter a zones' DNS records. + operationId: dns-records-for-a-zone-list-dns-records + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: name + schema: + description: Exact value of the DNS record name. This is a convenience alias for `name.exact`. + type: string + - in: query + name: name.exact + schema: + description: Exact value of the DNS record name. Name filters are case-insensitive. + type: string + - in: query + name: name.contains + schema: + description: Substring of the DNS record name. Name filters are case-insensitive. + type: string + - in: query + name: name.startswith + schema: + description: Prefix of the DNS record name. Name filters are case-insensitive. + type: string + - in: query + name: name.endswith + schema: + description: Suffix of the DNS record name. Name filters are case-insensitive. + type: string + - in: query + name: type + schema: + $ref: '#/components/schemas/dnsRecordsType' + - in: query + name: content + schema: + description: Exact value of the DNS record content. This is a convenience alias for `content.exact`. + type: string + - in: query + name: content.exact + schema: + description: Exact value of the DNS record content. Content filters are case-insensitive. + type: string + - in: query + name: content.contains + schema: + description: Substring of the DNS record content. Content filters are case-insensitive. + type: string + - in: query + name: content.startswith + schema: + description: Prefix of the DNS record content. Content filters are case-insensitive. + type: string + - in: query + name: content.endswith + schema: + description: Suffix of the DNS record content. Content filters are case-insensitive. + type: string + - in: query + name: proxied + schema: + $ref: '#/components/schemas/dnsRecordsProxied' + - in: query + name: match + schema: + $ref: '#/components/schemas/dnsRecordsMatch' + - in: query + name: comment + schema: + description: Exact value of the DNS record comment. This is a convenience alias for `comment.exact`. + type: string + - in: query + name: comment.present + schema: + description: If this parameter is present, only records *with* a comment are returned. + type: string + - in: query + name: comment.absent + schema: + description: If this parameter is present, only records *without* a comment are returned. + type: string + - in: query + name: comment.exact + schema: + description: Exact value of the DNS record comment. Comment filters are case-insensitive. + type: string + - in: query + name: comment.contains + schema: + description: Substring of the DNS record comment. Comment filters are case-insensitive. + type: string + - in: query + name: comment.startswith + schema: + description: Prefix of the DNS record comment. Comment filters are case-insensitive. + type: string + - in: query + name: comment.endswith + schema: + description: Suffix of the DNS record comment. Comment filters are case-insensitive. + type: string + - in: query + name: tag + schema: + description: 'Condition on the DNS record tag. Parameter values can be of the form `:` to search for an exact `name:value` pair, or just `` to search for records with a specific tag name regardless of its value. This is a convenience shorthand for the more powerful `tag.` parameters. Examples: - `tag=important` is equivalent to `tag.present=important` - `tag=team:DNS` is equivalent to `tag.exact=team:DNS`' + type: string + - in: query + name: tag.present + schema: + description: Name of a tag which must be present on the DNS record. Tag filters are case-insensitive. + type: string + - in: query + name: tag.absent + schema: + description: Name of a tag which must *not* be present on the DNS record. Tag filters are case-insensitive. + type: string + - in: query + name: tag.exact + schema: + description: A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value is ``. Tag filters are case-insensitive. + type: string + - in: query + name: tag.contains + schema: + description: A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value contains ``. Tag filters are case-insensitive. + type: string + - in: query + name: tag.startswith + schema: + description: A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value starts with ``. Tag filters are case-insensitive. + type: string + - in: query + name: tag.endswith + schema: + description: A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value ends with ``. Tag filters are case-insensitive. + type: string + - in: query + name: search + schema: + $ref: '#/components/schemas/dnsRecordsSearch' + - in: query + name: tag_match + schema: + $ref: '#/components/schemas/dnsRecordsTagMatch' + - in: query + name: page + schema: + $ref: '#/components/schemas/dnsRecordsPage' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/dnsRecordsPerPage' + - in: query + name: order + schema: + $ref: '#/components/schemas/dnsRecordsOrder' + - in: query + name: direction + schema: + $ref: '#/components/schemas/dnsRecordsDirection' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseCollection' + description: List DNS Records response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List DNS Records response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List DNS Records + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Read + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: list + post: + description: 'Create a new DNS record for a zone. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.' + operationId: dns-records-for-a-zone-create-dns-record + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsRecordPost' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseSingle' + description: Create DNS Record response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - name + - ttl + - type + type: object + properties: + comment_modified_on: + description: When the record comment was last modified. Omitted if there is no comment. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + created_on: + description: When the record was created. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + meta: + description: Extra Cloudflare-specific information about the record. + readOnly: true + type: object + x-stainless-terraform-configurability: computed + modified_on: + description: When the record was last modified. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + proxiable: + description: Whether the record can be proxied by Cloudflare or not. + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + tags_modified_on: + description: When the record tags were last modified. Omitted if there are no tags. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + enum: + - null + title: A Record + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create DNS Record response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create DNS Record + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: create + /zones/{zone_id}/dns_records/batch: + post: + description: 'Send a Batch of DNS Record API calls to be executed together. Notes: - Although Cloudflare will execute the batched operations in a single database transaction, Cloudflare''s distributed KV store must treat each record change as a single key-value pair. This means that the propagation of changes is not atomic. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/batch-record-changes/ "Batch DNS records") for more information. - The operations you specify within the /batch request body are always executed in the following order: - Deletes - Patches - Puts - Posts' + operationId: dns-records-for-a-zone-batch-dns-records + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsRequestBatchObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseBatch' + description: Batch DNS Records response + 4XX: + content: + application/json: + schema: + type: object + $ref: '#/components/schemas/dnsRecordsApiResponseCommonFailure' + description: Batch DNS Records response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Batch DNS Records + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:batch' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: batch + /zones/{zone_id}/dns_records/export: + get: + description: You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information. + operationId: dns-records-for-a-zone-export-dns-records + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + text/plain: + schema: + type: object + properties: + contents: + type: string + description: Export DNS Records response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsApiResponseCommonFailure' + description: Export DNS Records response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Export DNS Records + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Read + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: export + /zones/{zone_id}/dns_records/import: + post: + description: You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information. + operationId: dns-records-for-a-zone-import-dns-records + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + description: BIND config to import. **Tip:** When using cURL, a file can be uploaded using `--form 'file=@bind_config.txt'`. + type: string + proxied: + default: 'false' + description: Whether or not proxiable records should receive the performance and security benefits of Cloudflare. The value should be either `true` or `false`. + type: string + required: + - file + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseImportScan' + description: Import DNS Records response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + recs_added: + description: Number of DNS records added. + type: number + total_records_parsed: + description: Total number of DNS records parsed. + type: number + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Import DNS Records response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Import DNS Records + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: import_ + /zones/{zone_id}/dns_records/scan: + post: + deprecated: true + description: Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet. + operationId: dns-records-for-a-zone-scan-dns-records + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseImportScan' + description: Scan DNS Records response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + recs_added: + description: Number of DNS records added. + type: number + total_records_parsed: + description: Total number of DNS records parsed. + type: number + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Scan DNS Records response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Scan DNS Records + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: 'This endpoint is deprecated in favor of a new asynchronous version. Please use the [/scan/trigger](https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/scan/trigger) and [/scan/review](https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/scan/review) endpoints instead. + + ' + x-stackql-sdk: + service: dns + resource_chain: + - records + method: scan + /zones/{zone_id}/dns_records/scan/review: + get: + description: Retrieves the list of DNS records discovered up to this point by the asynchronous scan. These records are temporary until explicitly accepted or rejected via `POST /scan/review`. Additional records may be discovered by the scan later. + operationId: dns-records-for-a-zone-review-dns-scan + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseCollection' + description: List of discovered DNS records + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsApiResponseCommonFailure' + description: Scan review failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Scanned DNS Records + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Read + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: scan_list + post: + description: Accept or reject DNS records found by the DNS records scan. Accepted records will be permanently added to the zone, while rejected records will be permanently deleted. + operationId: dns-records-for-a-zone-apply-dns-scan-results + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsRequestReviewScanObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseReviewScan' + description: Records reviewed successfully + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsApiResponseCommonFailure' + description: Review failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Review Scanned DNS Records + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: scan_review + /zones/{zone_id}/dns_records/scan/trigger: + post: + description: Initiates an asynchronous scan for common DNS records on your domain. Note that this **does not** automatically add records to your zone. The scan runs in the background, and results can be reviewed later using the `/scan/review` endpoints. Useful if you haven't updated your nameservers yet. + operationId: dns-records-for-a-zone-trigger-dns-scan + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseTriggerScan' + description: Trigger DNS Records Scan Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Trigger DNS Records Scan response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Trigger DNS Record Scan + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: scan_trigger + /zones/{zone_id}/dns_records/{dns_record_id}: + delete: + operationId: dns-records-for-a-zone-delete-dns-record + parameters: + - in: path + name: dns_record_id + schema: + $ref: '#/components/schemas/dnsRecordsIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + type: object + type: object + description: Delete DNS Record response + 4XX: + content: + application/json: + schema: + type: object + properties: + result: + properties: + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + type: object + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + description: Delete DNS Record response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete DNS Record + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: delete + get: + operationId: dns-records-for-a-zone-dns-record-details + parameters: + - in: path + name: dns_record_id + schema: + $ref: '#/components/schemas/dnsRecordsIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseSingle' + description: DNS Record Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - name + - ttl + - type + type: object + properties: + comment_modified_on: + description: When the record comment was last modified. Omitted if there is no comment. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + created_on: + description: When the record was created. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + meta: + description: Extra Cloudflare-specific information about the record. + readOnly: true + type: object + x-stainless-terraform-configurability: computed + modified_on: + description: When the record was last modified. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + proxiable: + description: Whether the record can be proxied by Cloudflare or not. + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + tags_modified_on: + description: When the record tags were last modified. Omitted if there are no tags. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + enum: + - null + title: A Record + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: DNS Record Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: DNS Record Details + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Read + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: get + patch: + description: 'Update an existing DNS record. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.' + operationId: dns-records-for-a-zone-patch-dns-record + parameters: + - in: path + name: dns_record_id + schema: + $ref: '#/components/schemas/dnsRecordsIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsRecordPatch' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseSingle' + description: Patch DNS Record response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - name + - ttl + - type + type: object + properties: + comment_modified_on: + description: When the record comment was last modified. Omitted if there is no comment. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + created_on: + description: When the record was created. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + meta: + description: Extra Cloudflare-specific information about the record. + readOnly: true + type: object + x-stainless-terraform-configurability: computed + modified_on: + description: When the record was last modified. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + proxiable: + description: Whether the record can be proxied by Cloudflare or not. + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + tags_modified_on: + description: When the record tags were last modified. Omitted if there are no tags. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + enum: + - null + title: A Record + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Patch DNS Record response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update DNS Record + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: edit + put: + description: 'Overwrite an existing DNS record. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record.' + operationId: dns-records-for-a-zone-update-dns-record + parameters: + - in: path + name: dns_record_id + schema: + $ref: '#/components/schemas/dnsRecordsIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsRecordPost' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseSingle' + description: Update DNS Record response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - name + - ttl + - type + type: object + properties: + comment_modified_on: + description: When the record comment was last modified. Omitted if there is no comment. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + created_on: + description: When the record was created. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + meta: + description: Extra Cloudflare-specific information about the record. + readOnly: true + type: object + x-stainless-terraform-configurability: computed + modified_on: + description: When the record was last modified. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + proxiable: + description: Whether the record can be proxied by Cloudflare or not. + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + tags_modified_on: + description: When the record tags were last modified. Omitted if there are no tags. + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + enum: + - null + title: A Record + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update DNS Record response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Overwrite DNS Record + tags: + - DNS Records for a Zone + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - records + method: update + /zones/{zone_id}/dns_settings: + get: + description: Show DNS settings for a zone + operationId: dns-settings-for-a-zone-list-dns-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsSchemasDnsResponseSingle' + description: Show DNS Settings response + 4XX: + content: + application/json: + schema: + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + flatten_all_cnames: + $ref: '#/components/schemas/dnsSettingsFlattenAllCnames' + foundation_dns: + $ref: '#/components/schemas/dnsSettingsFoundationDns' + internal_dns: + description: Settings for this internal zone. + properties: + reference_zone_id: + description: The ID of the zone to fallback to. + type: string + type: object + multi_provider: + $ref: '#/components/schemas/dnsSettingsMultiProvider' + ns_ttl: + $ref: '#/components/schemas/dnsSettingsNsTtl' + secondary_overrides: + $ref: '#/components/schemas/dnsSettingsSecondaryOverrides' + soa: + description: Components of the zone's SOA record. + properties: + expire: + description: Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone. + maximum: 2419200 + minimum: 86400 + type: number + x-auditable: true + min_ttl: + description: The time to live (TTL) for negative caching of records within the zone. + maximum: 86400 + minimum: 60 + type: number + x-auditable: true + mname: + description: The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used. + nullable: true + type: string + x-auditable: true + refresh: + description: Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated. + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + retry: + description: Time in seconds after which secondary servers should retry queries after the primary server was unresponsive. + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + rname: + description: The email address of the zone administrator, with the first label representing the local part of the email address. + type: string + x-auditable: true + ttl: + description: The time to live (TTL) of the SOA record itself. + maximum: 86400 + minimum: 300 + type: number + x-auditable: true + type: object + zone_mode: + $ref: '#/components/schemas/dnsSettingsZoneMode' + nameservers: + description: Settings determining the nameservers through which the zone should be available. + properties: + ns_set: + description: Configured nameserver set to be used for this zone + maximum: 5 + minimum: 1 + type: integer + x-auditable: true + type: + description: Nameserver type + enum: + - cloudflare.standard + - custom.account + - custom.tenant + - custom.zone + type: string + x-auditable: true + required: + - type + type: object + required: + - flatten_all_cnames + - foundation_dns + - multi_provider + - secondary_overrides + - soa + - ns_ttl + - zone_mode + - internal_dns + - nameservers + enum: + - null + description: Show DNS Settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Show DNS Settings + tags: + - DNS Settings for a Zone + x-api-token-group: + - Zone DNS Settings Write + - Zone DNS Settings Read + - DNS Read + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - settings + - zone + method: get + patch: + description: Update DNS settings for a zone + operationId: dns-settings-for-a-zone-update-dns-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsDnsSettingsZonePatch' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsSettingsSchemasDnsResponseSingle' + description: Show DNS Settings response + 4XX: + content: + application/json: + schema: + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + flatten_all_cnames: + $ref: '#/components/schemas/dnsSettingsFlattenAllCnames' + foundation_dns: + $ref: '#/components/schemas/dnsSettingsFoundationDns' + internal_dns: + description: Settings for this internal zone. + properties: + reference_zone_id: + description: The ID of the zone to fallback to. + type: string + type: object + multi_provider: + $ref: '#/components/schemas/dnsSettingsMultiProvider' + ns_ttl: + $ref: '#/components/schemas/dnsSettingsNsTtl' + secondary_overrides: + $ref: '#/components/schemas/dnsSettingsSecondaryOverrides' + soa: + description: Components of the zone's SOA record. + properties: + expire: + description: Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone. + maximum: 2419200 + minimum: 86400 + type: number + x-auditable: true + min_ttl: + description: The time to live (TTL) for negative caching of records within the zone. + maximum: 86400 + minimum: 60 + type: number + x-auditable: true + mname: + description: The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used. + nullable: true + type: string + x-auditable: true + refresh: + description: Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated. + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + retry: + description: Time in seconds after which secondary servers should retry queries after the primary server was unresponsive. + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + rname: + description: The email address of the zone administrator, with the first label representing the local part of the email address. + type: string + x-auditable: true + ttl: + description: The time to live (TTL) of the SOA record itself. + maximum: 86400 + minimum: 300 + type: number + x-auditable: true + type: object + zone_mode: + $ref: '#/components/schemas/dnsSettingsZoneMode' + nameservers: + description: Settings determining the nameservers through which the zone should be available. + properties: + ns_set: + description: Configured nameserver set to be used for this zone + maximum: 5 + minimum: 1 + type: integer + x-auditable: true + type: + description: Nameserver type + enum: + - cloudflare.standard + - custom.account + - custom.tenant + - custom.zone + type: string + x-auditable: true + required: + - type + type: object + required: + - flatten_all_cnames + - foundation_dns + - multi_provider + - secondary_overrides + - soa + - ns_ttl + - zone_mode + - internal_dns + - nameservers + enum: + - null + description: Show DNS Settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update DNS Settings + tags: + - DNS Settings for a Zone + x-api-token-group: + - Zone DNS Settings Write + - DNS Write + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - settings + - zone + method: edit + /zones/{zone_id}/dnssec: + delete: + description: Delete DNSSEC. + operationId: dnssec-delete-dnssec-records + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnssecDeleteDnssecResponseSingle' + description: Delete DNSSEC records response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnssecMessages' + messages: + $ref: '#/components/schemas/dnssecMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete DNSSEC records response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete DNSSEC records + tags: + - DNSSEC + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#zone_settings:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - dnssec + method: delete + get: + description: Details about DNSSEC status and configuration. + operationId: dnssec-dnssec-details + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnssecDnssecResponseSingle' + description: DNSSEC Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnssecMessages' + messages: + $ref: '#/components/schemas/dnssecMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + algorithm: + $ref: '#/components/schemas/dnssecAlgorithm' + digest: + $ref: '#/components/schemas/dnssecDigest' + digest_algorithm: + $ref: '#/components/schemas/dnssecDigestAlgorithm' + digest_type: + $ref: '#/components/schemas/dnssecDigestType' + dnssec_multi_signer: + $ref: '#/components/schemas/dnssecDnssecMultiSigner' + dnssec_presigned: + $ref: '#/components/schemas/dnssecDnssecPresigned' + dnssec_use_nsec3: + $ref: '#/components/schemas/dnssecDnssecUseNsec3' + ds: + $ref: '#/components/schemas/dnssecDs' + flags: + $ref: '#/components/schemas/dnssecFlags' + key_tag: + $ref: '#/components/schemas/dnssecKeyTag' + key_type: + $ref: '#/components/schemas/dnssecKeyType' + modified_on: + $ref: '#/components/schemas/dnssecModifiedOn' + readOnly: true + public_key: + $ref: '#/components/schemas/dnssecPublicKey' + status: + $ref: '#/components/schemas/dnssecStatus' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: DNSSEC Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: DNSSEC Details + tags: + - DNSSEC + x-api-token-group: + - DNS Read + - DNS Write + x-cfPermissionsRequired: + enum: + - '#zone_settings:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - dnssec + method: get + patch: + description: Enable or disable DNSSEC. + operationId: dnssec-edit-dnssec-status + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + dnssec_multi_signer: + $ref: '#/components/schemas/dnssecDnssecMultiSigner' + dnssec_presigned: + $ref: '#/components/schemas/dnssecDnssecPresigned' + dnssec_use_nsec3: + $ref: '#/components/schemas/dnssecDnssecUseNsec3' + status: + description: Status of DNSSEC, based on user-desired state and presence of necessary records. + enum: + - active + - disabled + type: string + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnssecDnssecResponseSingle' + description: Edit DNSSEC Status response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnssecMessages' + messages: + $ref: '#/components/schemas/dnssecMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + algorithm: + $ref: '#/components/schemas/dnssecAlgorithm' + digest: + $ref: '#/components/schemas/dnssecDigest' + digest_algorithm: + $ref: '#/components/schemas/dnssecDigestAlgorithm' + digest_type: + $ref: '#/components/schemas/dnssecDigestType' + dnssec_multi_signer: + $ref: '#/components/schemas/dnssecDnssecMultiSigner' + dnssec_presigned: + $ref: '#/components/schemas/dnssecDnssecPresigned' + dnssec_use_nsec3: + $ref: '#/components/schemas/dnssecDnssecUseNsec3' + ds: + $ref: '#/components/schemas/dnssecDs' + flags: + $ref: '#/components/schemas/dnssecFlags' + key_tag: + $ref: '#/components/schemas/dnssecKeyTag' + key_type: + $ref: '#/components/schemas/dnssecKeyType' + modified_on: + $ref: '#/components/schemas/dnssecModifiedOn' + readOnly: true + public_key: + $ref: '#/components/schemas/dnssecPublicKey' + status: + $ref: '#/components/schemas/dnssecStatus' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit DNSSEC Status response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit DNSSEC Status + tags: + - DNSSEC + x-api-token-group: + - DNS Write + x-cfPermissionsRequired: + enum: + - '#zone_settings:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: dns + resource_chain: + - dnssec + method: edit + /zones/{zone_id}/dnssec/zsk: + get: + description: List the Zone Signing Keys (ZSKs) that DNSSEC uses for the zone. + operationId: dnssec-list-dnssec-zsks + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnssecDnssecZskResponseCollection' + description: List DNSSEC ZSKs response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnssecMessages' + messages: + $ref: '#/components/schemas/dnssecMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/dnssecDnssecZsk' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List DNSSEC ZSKs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List DNSSEC ZSKs + tags: + - DNSSEC + x-api-token-group: + - DNS Read + - DNS Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}/secondary_dns/force_axfr: + post: + description: Sends AXFR zone transfer request to primary nameserver(s). + operationId: secondary-dns-(-secondary-zone)-force-axfr + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsForceResponse' + description: Force AXFR response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: When force_axfr query parameter is set to true, the response is a simple string. + type: string + x-auditable: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Force AXFR response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Force AXFR + tags: + - Secondary DNS (Secondary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - force_axfr + method: create + /zones/{zone_id}/secondary_dns/incoming: + delete: + description: Delete secondary zone configuration for incoming zone transfers. + operationId: secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsIdResponse' + description: Delete Secondary Zone Configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Secondary Zone Configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Secondary Zone Configuration + tags: + - Secondary DNS (Secondary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - incoming + method: delete + get: + description: Get secondary zone configuration for incoming zone transfers. + operationId: secondary-dns-(-secondary-zone)-secondary-zone-configuration-details + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponseIncoming' + description: Secondary Zone Configuration Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef150c555e27f53dbb40cdce4d6644ff0a' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Secondary Zone Configuration Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Secondary Zone Configuration Details + tags: + - Secondary DNS (Secondary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - DNS Read + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - incoming + method: get + post: + description: Create secondary zone configuration for incoming zone transfers. + operationId: secondary-dns-(-secondary-zone)-create-secondary-zone-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsDnsSecondarySecondaryZone' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponseIncoming' + description: Create Secondary Zone Configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef150c555e27f53dbb40cdce4d6644ff0a' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Secondary Zone Configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Secondary Zone Configuration + tags: + - Secondary DNS (Secondary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - incoming + method: create + put: + description: Update secondary zone configuration for incoming zone transfers. + operationId: secondary-dns-(-secondary-zone)-update-secondary-zone-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsDnsSecondarySecondaryZone' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponseIncoming' + description: Update Secondary Zone Configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef150c555e27f53dbb40cdce4d6644ff0a' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Secondary Zone Configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Secondary Zone Configuration + tags: + - Secondary DNS (Secondary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - incoming + method: update + /zones/{zone_id}/secondary_dns/outgoing: + delete: + description: Delete primary zone configuration for outgoing zone transfers. + operationId: secondary-dns-(-primary-zone)-delete-primary-zone-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsIdResponse' + description: Delete Primary Zone Configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Primary Zone Configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Primary Zone Configuration + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + method: delete + get: + description: Get primary zone configuration for outgoing zone transfers. + operationId: secondary-dns-(-primary-zone)-primary-zone-configuration-details + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponseOutgoing' + description: Primary Zone Configuration Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef0e152c3e4c55b8a0ca6531578a42c564' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Primary Zone Configuration Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Primary Zone Configuration Details + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - DNS Read + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + method: get + post: + description: Create primary zone configuration for outgoing zone transfers. + operationId: secondary-dns-(-primary-zone)-create-primary-zone-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleRequestOutgoing' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponseOutgoing' + description: Create Primary Zone Configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef0e152c3e4c55b8a0ca6531578a42c564' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Primary Zone Configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Primary Zone Configuration + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + method: create + put: + description: Update primary zone configuration for outgoing zone transfers. + operationId: secondary-dns-(-primary-zone)-update-primary-zone-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleRequestOutgoing' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSingleResponseOutgoing' + description: Update Primary Zone Configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef0e152c3e4c55b8a0ca6531578a42c564' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Primary Zone Configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Primary Zone Configuration + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + method: update + /zones/{zone_id}/secondary_dns/outgoing/disable: + post: + description: Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone. + operationId: secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsDisableTransferResponse' + description: Disable Outgoing Zone Transfers response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/outgoingStatus' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Disable Outgoing Zone Transfers response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Disable Outgoing Zone Transfers + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + method: disable + /zones/{zone_id}/secondary_dns/outgoing/enable: + post: + description: Enable outgoing zone transfers for primary zone. + operationId: secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsEnableTransferResponse' + description: Enable Outgoing Zone Transfers response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/outgoingStatus' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Enable Outgoing Zone Transfers response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Enable Outgoing Zone Transfers + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + method: enable + /zones/{zone_id}/secondary_dns/outgoing/force_notify: + post: + description: Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone. + operationId: secondary-dns-(-primary-zone)-force-dns-notify + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsSchemasForceResponse' + description: Force DNS NOTIFY response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: When force_notify query parameter is set to true, the response is a simple string. + type: string + x-auditable: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Force DNS NOTIFY response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Force DNS NOTIFY + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + method: force_notify + /zones/{zone_id}/secondary_dns/outgoing/status: + get: + description: Get primary zone transfer status. + operationId: secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secondaryDnsEnableTransferResponse' + description: Get Outgoing Zone Transfer Status response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/outgoingStatus' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Outgoing Zone Transfer Status response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Outgoing Zone Transfer Status + tags: + - Secondary DNS (Primary Zone) + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - DNS Read + - Zone Write + - DNS Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns + resource_chain: + - zone_transfers + - outgoing + - status + method: get + /accounts/{account_id}/dns_records/usage: + get: + description: Get the current DNS record usage and quota for an account or zone. May include internal DNS usage and quota. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseAccountUsage' + description: Get DNS Record Usage response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + internal_record_quota: + description: Maximum number of DNS records allowed across all internal zones in the account. Only present if internal DNS is enabled. + minimum: 0 + type: integer + internal_record_usage: + description: Current number of DNS records across all internal zones in the account. Only present if internal DNS is enabled. + minimum: 0 + type: integer + record_quota: + description: Maximum number of DNS records allowed across all public zones in the account. Null if using zone-level quota. + minimum: 0 + nullable: true + type: integer + record_usage: + description: Current number of DNS records across all public zones in the account. + minimum: 0 + type: integer + required: + - record_usage + - record_quota + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get DNS Record Usage response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS Record Usage for account or zone + tags: [] + x-api-token-group: + - Account DNS Settings Write + - Account DNS Settings Read + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + operationId: get_accounts_account_id_dns_records_usage + /zones/{zone_id}/dns_records/usage: + get: + description: Get the current DNS record usage and quota for an account or zone. May include internal DNS usage and quota. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsRecordsDnsResponseAccountUsage' + description: Get DNS Record Usage response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + internal_record_quota: + description: Maximum number of DNS records allowed across all internal zones in the account. Only present if internal DNS is enabled. + minimum: 0 + type: integer + internal_record_usage: + description: Current number of DNS records across all internal zones in the account. Only present if internal DNS is enabled. + minimum: 0 + type: integer + record_quota: + description: Maximum number of DNS records allowed across all public zones in the account. Null if using zone-level quota. + minimum: 0 + nullable: true + type: integer + record_usage: + description: Current number of DNS records across all public zones in the account. + minimum: 0 + type: integer + required: + - record_usage + - record_quota + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get DNS Record Usage response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS Record Usage for account or zone + tags: [] + x-api-token-group: + - Account DNS Settings Write + - Account DNS Settings Read + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + operationId: get_zones_zone_id_dns_records_usage +components: + schemas: + dnsAnalyticsDimensions: + description: A comma-separated list of dimensions to group results by. + example: queryType + type: string + dnsAnalyticsFilters: + description: Segmentation filter in 'attribute operator value' format. + example: responseCode==NOERROR,queryType==A + type: string + dnsAnalyticsLimit: + default: 100000 + description: Limit number of returned metrics. + example: 100 + type: integer + dnsAnalyticsMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dnsAnalyticsMetrics: + description: A comma-separated list of metrics to query. + example: queryCount,uncachedCount + type: string + dnsAnalyticsQuery: + properties: + dimensions: + description: Array of dimension names. + example: + - responseCode + - queryName + items: + description: Dimension name. + example: responseCode + type: string + type: array + filters: + $ref: '#/components/schemas/dnsAnalyticsFilters' + limit: + $ref: '#/components/schemas/dnsAnalyticsLimit' + metrics: + description: Array of metric names. + example: + - queryCount + - responseTimeAvg + items: + description: Metric name. + example: queries + type: string + type: array + since: + $ref: '#/components/schemas/dnsAnalyticsSince' + sort: + description: Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending). + example: + - +responseCode + - -queryName + items: + description: Dimension name (may be prefixed by - (descending) or + (ascending). + example: +responseCode + type: string + type: array + until: + $ref: '#/components/schemas/dnsAnalyticsUntil' + required: + - dimensions + - metrics + - since + - until + - limit + type: object + dnsAnalyticsReport: + type: object + properties: + data: + description: Array with one row per combination of dimension values. + items: + $ref: '#/components/schemas/dnsAnalyticsReport_data_item' + type: array + data_lag: + description: Number of seconds between current time and last processed event, in another words how many seconds of data could be missing. + example: 60 + minimum: 0 + type: number + max: + description: Maximum results for each metric (object mapping metric names to values). Currently always an empty object. + type: object + min: + description: Minimum results for each metric (object mapping metric names to values). Currently always an empty object. + type: object + query: + $ref: '#/components/schemas/dnsAnalyticsQuery' + rows: + description: Total number of rows in the result. + example: 100 + minimum: 0 + type: number + totals: + description: Total results for metrics across all data (object mapping metric names to values). + type: object + required: + - rows + - totals + - min + - max + - data_lag + - query + - data + - data + dnsAnalyticsReportBytime: + type: object + properties: + data: + description: Array with one row per combination of dimension values. + items: + $ref: '#/components/schemas/dnsAnalyticsReportBytime_data_item' + type: array + data_lag: + description: Number of seconds between current time and last processed event, in another words how many seconds of data could be missing. + example: 60 + minimum: 0 + type: number + max: + description: Maximum results for each metric (object mapping metric names to values). Currently always an empty object. + type: object + min: + description: Minimum results for each metric (object mapping metric names to values). Currently always an empty object. + type: object + query: + properties: + dimensions: + description: Array of dimension names. + example: + - responseCode + - queryName + items: + description: Dimension name. + example: responseCode + type: string + type: array + filters: + $ref: '#/components/schemas/dnsAnalyticsFilters' + limit: + $ref: '#/components/schemas/dnsAnalyticsLimit' + metrics: + description: Array of metric names. + example: + - queryCount + - responseTimeAvg + items: + description: Metric name. + example: queries + type: string + type: array + since: + $ref: '#/components/schemas/dnsAnalyticsSince' + sort: + description: Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending). + example: + - +responseCode + - -queryName + items: + description: Dimension name (may be prefixed by - (descending) or + (ascending). + example: +responseCode + type: string + type: array + until: + $ref: '#/components/schemas/dnsAnalyticsUntil' + time_delta: + $ref: '#/components/schemas/dnsAnalyticsTimeDelta' + required: + - dimensions + - metrics + - since + - until + - limit + - time_delta + type: object + rows: + description: Total number of rows in the result. + example: 100 + minimum: 0 + type: number + totals: + description: Total results for metrics across all data (object mapping metric names to values). + type: object + time_intervals: + description: 'Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time.' + items: + description: Array with exactly two items, representing the start and end time (respectively) of this time interval. + items: + description: Time value. + example: '2023-11-11T12:00:00Z' + format: date-time + type: string + type: array + type: array + required: + - rows + - totals + - min + - max + - data_lag + - query + - data + - time_intervals + - query + - data + dnsAnalyticsReportBytime_data_item: + properties: + dimensions: + description: Array of dimension values, representing the combination of dimension values corresponding to this row. + items: + description: Dimension value. + example: NODATA + type: string + type: array + metrics: + description: Array with one item per requested metric. Each item is an array of values, broken down by time interval. + items: + description: Nominal metric values, broken down by time interval. + items: + description: Nominal metric value. + type: number + type: array + type: array + required: + - dimensions + - metrics + type: object + dnsAnalyticsReport_data_item: + properties: + dimensions: + description: Array of dimension values, representing the combination of dimension values corresponding to this row. + items: + description: Dimension value. + example: NODATA + type: string + type: array + metrics: + description: Array with one item per requested metric. Each item is a single value. + items: + description: Nominal metric value. + type: number + type: array + required: + - dimensions + - metrics + type: object + dnsAnalyticsSince: + description: Start date and time of requesting data period in ISO 8601 format. + example: '2023-11-11T12:00:00Z' + format: date-time + type: string + dnsAnalyticsSort: + description: A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending). + example: +responseCode,-queryName + type: string + dnsAnalyticsTimeDelta: + description: Unit of time to group data by. + enum: + - all + - auto + - year + - quarter + - month + - week + - day + - hour + - dekaminute + - minute + example: hour + type: string + dnsAnalyticsUntil: + description: End date and time of requesting data period in ISO 8601 format. + example: '2023-11-11T13:00:00Z' + format: date-time + type: string + dnsRecordsApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + dnsRecordsApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + example: [] + $ref: '#/components/schemas/dnsRecordsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + dnsRecordsApiResponseSingle: + type: object + $ref: '#/components/schemas/dnsRecordsApiResponseCommon' + dnsRecordsComment: + description: Comments or notes about the DNS record. This field has no effect on DNS responses. + example: Domain verification record + type: string + x-auditable: true + dnsRecordsDirection: + default: asc + description: Direction to order DNS records in. + enum: + - asc + - desc + type: string + dnsRecordsDnsRecordBatchDelete: + required: + - id + type: object + properties: + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + dnsRecordsDnsRecordBatchPatch: + properties: + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + example: 198.51.100.4 + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + example: true + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + example: A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + example: 1 + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + example: issue + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + required: + - id + - name + - ttl + - type + type: object + title: A Record + dnsRecordsDnsRecordBatchPost: + type: object + $ref: '#/components/schemas/dnsRecordsDnsRecordPost' + dnsRecordsDnsRecordBatchPut: + properties: + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + example: 198.51.100.4 + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + example: true + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + example: A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + example: 1 + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + example: issue + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + required: + - id + - name + - ttl + - type + type: object + title: A Record + dnsRecordsDnsRecordPatch: + type: object + title: A Record + properties: + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + example: 198.51.100.4 + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + example: true + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + example: A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + example: 1 + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + example: issue + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + required: + - name + - ttl + - type + dnsRecordsDnsRecordPost: + type: object + title: A Record + properties: + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + example: 198.51.100.4 + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + example: true + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + example: A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + example: 1 + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + example: issue + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + required: + - name + - ttl + - type + dnsRecordsDnsRecordResponse: + required: + - name + - ttl + - type + type: object + properties: + comment_modified_on: + description: When the record comment was last modified. Omitted if there is no comment. + example: '2024-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + created_on: + description: When the record was created. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + meta: + description: Extra Cloudflare-specific information about the record. + readOnly: true + type: object + x-stainless-terraform-configurability: computed + modified_on: + description: When the record was last modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + proxiable: + description: Whether the record can be proxied by Cloudflare or not. + example: true + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + tags_modified_on: + description: When the record tags were last modified. Omitted if there are no tags. + example: '2025-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + comment: + $ref: '#/components/schemas/dnsRecordsComment' + name: + $ref: '#/components/schemas/dnsRecordsName' + proxied: + $ref: '#/components/schemas/dnsRecordsProxied' + settings: + $ref: '#/components/schemas/dnsRecordsSettings' + tags: + $ref: '#/components/schemas/dnsRecordsTags' + ttl: + $ref: '#/components/schemas/dnsRecordsTtl' + content: + description: A valid IPv4 address. + example: 198.51.100.4 + format: ipv4 + type: string + x-auditable: true + private_routing: + default: false + description: Enables private network routing to the origin. + example: true + type: boolean + x-auditable: true + type: + description: Record type. + enum: + - A + example: A + type: string + x-auditable: true + priority: + $ref: '#/components/schemas/dnsRecordsPriority' + data: + description: Components of a CAA record. + properties: + flags: + description: Flags for the CAA record. + example: 1 + maximum: 255 + minimum: 0 + type: number + x-auditable: true + tag: + description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' + example: issue + type: string + x-auditable: true + value: + description: Value of the record. This field's semantics depend on the chosen tag. + type: string + x-auditable: true + type: object + title: A Record + dnsRecordsDnsRecordScanBatchAccept: + type: object + $ref: '#/components/schemas/dnsRecordsDnsRecordPatch' + dnsRecordsDnsRecordScanBatchReject: + required: + - id + type: object + properties: + id: + $ref: '#/components/schemas/dnsRecordsIdentifier' + dnsRecordsDnsRequestBatchObject: + properties: + deletes: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordBatchDelete' + type: array + patches: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordBatchPatch' + type: array + posts: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordBatchPost' + type: array + puts: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordBatchPut' + type: array + type: object + dnsRecordsDnsRequestReviewScanObject: + properties: + accepts: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordScanBatchAccept' + type: array + rejects: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordScanBatchReject' + type: array + type: object + dnsRecordsDnsResponseAccountUsage: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + internal_record_quota: + description: Maximum number of DNS records allowed across all internal zones in the account. Only present if internal DNS is enabled. + example: 1000000 + minimum: 0 + type: integer + internal_record_usage: + description: Current number of DNS records across all internal zones in the account. Only present if internal DNS is enabled. + example: 5000 + minimum: 0 + type: integer + record_quota: + description: Maximum number of DNS records allowed across all public zones in the account. Null if using zone-level quota. + example: 1000000 + minimum: 0 + nullable: true + type: integer + record_usage: + description: Current number of DNS records across all public zones in the account. + example: 5000 + minimum: 0 + type: integer + required: + - record_usage + - record_quota + type: object + required: + - success + - errors + - messages + dnsRecordsDnsResponseBatch: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsRecordsDnsResponseBatchObject' + required: + - success + - errors + - messages + dnsRecordsDnsResponseBatchObject: + properties: + deletes: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + type: array + patches: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + type: array + posts: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + type: array + puts: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + type: array + type: object + dnsRecordsDnsResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + type: array + required: + - success + - errors + - messages + dnsRecordsDnsResponseImportScan: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + recs_added: + description: Number of DNS records added. + example: 5 + type: number + total_records_parsed: + description: Total number of DNS records parsed. + example: 5 + type: number + type: object + required: + - success + - errors + - messages + dnsRecordsDnsResponseReviewScan: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsRecordsDnsResponseReviewScanObject' + required: + - success + - errors + - messages + dnsRecordsDnsResponseReviewScanObject: + properties: + accepts: + items: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + type: array + rejects: + items: + $ref: '#/components/schemas/dnsRecordsIdentifier' + type: array + type: object + dnsRecordsDnsResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsRecordsMessages' + messages: + $ref: '#/components/schemas/dnsRecordsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsRecordsDnsRecordResponse' + required: + - success + - errors + - messages + dnsRecordsDnsResponseTriggerScan: + type: object + $ref: '#/components/schemas/dnsRecordsApiResponseSingle' + dnsRecordsIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + dnsRecordsMatch: + default: all + description: Whether to match all search requirements or at least one (any). If set to `all`, acts like a logical AND between filters. If set to `any`, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the `tag-match` parameter instead. + enum: + - any + - all + example: any + type: string + dnsRecordsMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dnsRecordsName: + description: Complete DNS record name, including the zone name, in Punycode. + example: example.com + maxLength: 255 + minLength: 1 + type: string + x-auditable: true + dnsRecordsOrder: + default: type + description: Field to order DNS records by. + enum: + - type + - name + - content + - ttl + - proxied + type: string + dnsRecordsPage: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + dnsRecordsPerPage: + default: 100 + description: Number of DNS records per page. + example: 5 + maximum: 5000000 + minimum: 1 + type: number + dnsRecordsPriority: + description: Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map. + example: 10 + maximum: 65535 + minimum: 0 + type: number + x-auditable: true + dnsRecordsProxied: + default: false + description: Whether the record is receiving the performance and security benefits of Cloudflare. + example: true + type: boolean + x-auditable: true + dnsRecordsSearch: + description: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the `match` setting. For automated searches, please use the other available parameters. + example: www.cloudflare.com + type: string + dnsRecordsSettings: + description: Settings for the DNS record. + properties: + ipv4_only: + default: false + description: When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6. + example: true + type: boolean + x-auditable: true + ipv6_only: + default: false + description: When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6. + example: true + type: boolean + x-auditable: true + type: object + dnsRecordsTagMatch: + default: all + description: Whether to match all tag search requirements or at least one (any). If set to `all`, acts like a logical AND between tag filters. If set to `any`, acts like a logical OR instead. Note that the regular `match` parameter is still used to combine the resulting condition with other filters that aren't related to tags. + enum: + - any + - all + example: any + type: string + dnsRecordsTags: + default: [] + description: Custom tags for the DNS record. This field has no effect on DNS responses. + items: + description: Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens) + example: owner:dns-team + type: string + x-auditable: true + type: array + x-stainless-collection-type: set + dnsRecordsTtl: + default: 1 + description: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones. + example: 3600 + type: number + x-auditable: true + enum: + - 1 + dnsRecordsType: + description: Record type. + enum: + - A + - AAAA + - CAA + - CERT + - CNAME + - DNSKEY + - DS + - HTTPS + - LOC + - MX + - NAPTR + - NS + - OPENPGPKEY + - PTR + - SMIMEA + - SRV + - SSHFP + - SVCB + - TLSA + - TXT + - URI + example: A + type: string + x-auditable: true + dnsSettingsAccountSettings: + properties: + enforce_dns_only: + $ref: '#/components/schemas/dnsSettingsEnforceDnsOnly' + zone_defaults: + $ref: '#/components/schemas/dnsSettingsDnsSettingsAccountResponse' + required: + - zone_defaults + type: object + dnsSettingsAccountSettingsPatch: + properties: + enforce_dns_only: + $ref: '#/components/schemas/dnsSettingsEnforceDnsOnly' + zone_defaults: + $ref: '#/components/schemas/dnsSettingsDnsSettingsAccountPatch' + type: object + dnsSettingsCreatedTime: + description: When the view was created. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + dnsSettingsDirection: + default: asc + description: Direction to order DNS views in. + enum: + - asc + - desc + type: string + dnsSettingsDnsResponseSingle: + required: + - success + - errors + - messages + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsSettingsAccountSettings' + dnsSettingsDnsSettingsAccountPatch: + type: object + properties: + flatten_all_cnames: + $ref: '#/components/schemas/dnsSettingsFlattenAllCnames' + foundation_dns: + $ref: '#/components/schemas/dnsSettingsFoundationDns' + internal_dns: + $ref: '#/components/schemas/dnsSettingsInternalDnsBase' + multi_provider: + $ref: '#/components/schemas/dnsSettingsMultiProvider' + ns_ttl: + $ref: '#/components/schemas/dnsSettingsNsTtl' + secondary_overrides: + $ref: '#/components/schemas/dnsSettingsSecondaryOverrides' + soa: + $ref: '#/components/schemas/dnsSettingsSoaBase' + zone_mode: + $ref: '#/components/schemas/dnsSettingsZoneMode' + nameservers: + description: Settings determining the nameservers through which the zone should be available. + properties: + type: + description: Nameserver type + enum: + - cloudflare.standard + - cloudflare.standard.random + - custom.account + - custom.tenant + example: cloudflare.standard + type: string + x-auditable: true + type: object + dnsSettingsDnsSettingsAccountResponse: + type: object + properties: + flatten_all_cnames: + $ref: '#/components/schemas/dnsSettingsFlattenAllCnames' + foundation_dns: + $ref: '#/components/schemas/dnsSettingsFoundationDns' + internal_dns: + description: Settings for this internal zone. + properties: + reference_zone_id: + description: The ID of the zone to fallback to. + type: string + type: object + multi_provider: + $ref: '#/components/schemas/dnsSettingsMultiProvider' + ns_ttl: + $ref: '#/components/schemas/dnsSettingsNsTtl' + secondary_overrides: + $ref: '#/components/schemas/dnsSettingsSecondaryOverrides' + soa: + description: Components of the zone's SOA record. + properties: + expire: + description: Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone. + example: 604800 + maximum: 2419200 + minimum: 86400 + type: number + x-auditable: true + min_ttl: + description: The time to live (TTL) for negative caching of records within the zone. + example: 1800 + maximum: 86400 + minimum: 60 + type: number + x-auditable: true + mname: + description: The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used. + example: kristina.ns.cloudflare.com + nullable: true + type: string + x-auditable: true + refresh: + description: Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated. + example: 10000 + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + retry: + description: Time in seconds after which secondary servers should retry queries after the primary server was unresponsive. + example: 2400 + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + rname: + description: The email address of the zone administrator, with the first label representing the local part of the email address. + example: admin.example.com + type: string + x-auditable: true + ttl: + description: The time to live (TTL) of the SOA record itself. + example: 3600 + maximum: 86400 + minimum: 300 + type: number + x-auditable: true + type: object + zone_mode: + $ref: '#/components/schemas/dnsSettingsZoneMode' + nameservers: + description: Settings determining the nameservers through which the zone should be available. + properties: + type: + description: Nameserver type + enum: + - cloudflare.standard + - cloudflare.standard.random + - custom.account + - custom.tenant + example: cloudflare.standard + type: string + x-auditable: true + required: + - type + type: object + required: + - flatten_all_cnames + - foundation_dns + - multi_provider + - secondary_overrides + - soa + - ns_ttl + - zone_mode + - internal_dns + - nameservers + dnsSettingsDnsSettingsZonePatch: + type: object + properties: + flatten_all_cnames: + $ref: '#/components/schemas/dnsSettingsFlattenAllCnames' + foundation_dns: + $ref: '#/components/schemas/dnsSettingsFoundationDns' + internal_dns: + $ref: '#/components/schemas/dnsSettingsInternalDnsBase' + multi_provider: + $ref: '#/components/schemas/dnsSettingsMultiProvider' + ns_ttl: + $ref: '#/components/schemas/dnsSettingsNsTtl' + secondary_overrides: + $ref: '#/components/schemas/dnsSettingsSecondaryOverrides' + soa: + $ref: '#/components/schemas/dnsSettingsSoaBase' + zone_mode: + $ref: '#/components/schemas/dnsSettingsZoneMode' + nameservers: + description: Settings determining the nameservers through which the zone should be available. + properties: + ns_set: + description: Configured nameserver set to be used for this zone + example: 1 + maximum: 5 + minimum: 1 + type: integer + x-auditable: true + type: + description: Nameserver type + enum: + - cloudflare.standard + - custom.account + - custom.tenant + - custom.zone + example: cloudflare.standard + type: string + x-auditable: true + type: object + dnsSettingsDnsSettingsZoneResponse: + type: object + properties: + flatten_all_cnames: + $ref: '#/components/schemas/dnsSettingsFlattenAllCnames' + foundation_dns: + $ref: '#/components/schemas/dnsSettingsFoundationDns' + internal_dns: + description: Settings for this internal zone. + properties: + reference_zone_id: + description: The ID of the zone to fallback to. + type: string + type: object + multi_provider: + $ref: '#/components/schemas/dnsSettingsMultiProvider' + ns_ttl: + $ref: '#/components/schemas/dnsSettingsNsTtl' + secondary_overrides: + $ref: '#/components/schemas/dnsSettingsSecondaryOverrides' + soa: + description: Components of the zone's SOA record. + properties: + expire: + description: Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone. + example: 604800 + maximum: 2419200 + minimum: 86400 + type: number + x-auditable: true + min_ttl: + description: The time to live (TTL) for negative caching of records within the zone. + example: 1800 + maximum: 86400 + minimum: 60 + type: number + x-auditable: true + mname: + description: The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used. + example: kristina.ns.cloudflare.com + nullable: true + type: string + x-auditable: true + refresh: + description: Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated. + example: 10000 + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + retry: + description: Time in seconds after which secondary servers should retry queries after the primary server was unresponsive. + example: 2400 + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + rname: + description: The email address of the zone administrator, with the first label representing the local part of the email address. + example: admin.example.com + type: string + x-auditable: true + ttl: + description: The time to live (TTL) of the SOA record itself. + example: 3600 + maximum: 86400 + minimum: 300 + type: number + x-auditable: true + type: object + zone_mode: + $ref: '#/components/schemas/dnsSettingsZoneMode' + nameservers: + description: Settings determining the nameservers through which the zone should be available. + properties: + ns_set: + description: Configured nameserver set to be used for this zone + example: 1 + maximum: 5 + minimum: 1 + type: integer + x-auditable: true + type: + description: Nameserver type + enum: + - cloudflare.standard + - custom.account + - custom.tenant + - custom.zone + example: cloudflare.standard + type: string + x-auditable: true + required: + - type + type: object + required: + - flatten_all_cnames + - foundation_dns + - multi_provider + - secondary_overrides + - soa + - ns_ttl + - zone_mode + - internal_dns + - nameservers + dnsSettingsDnsView: + properties: + created_time: + $ref: '#/components/schemas/dnsSettingsCreatedTime' + modified_time: + $ref: '#/components/schemas/dnsSettingsModifiedTime' + name: + $ref: '#/components/schemas/dnsSettingsName' + zones: + $ref: '#/components/schemas/dnsSettingsZones' + type: object + dnsSettingsDnsViewPatch: + type: object + $ref: '#/components/schemas/dnsSettingsDnsView' + dnsSettingsDnsViewPost: + type: object + $ref: '#/components/schemas/dnsSettingsDnsView' + dnsSettingsDnsViewResponse: + required: + - id + - name + - zones + - created_time + - modified_time + - id + type: object + properties: + created_time: + $ref: '#/components/schemas/dnsSettingsCreatedTime' + modified_time: + $ref: '#/components/schemas/dnsSettingsModifiedTime' + name: + $ref: '#/components/schemas/dnsSettingsName' + zones: + $ref: '#/components/schemas/dnsSettingsZones' + id: + $ref: '#/components/schemas/dnsSettingsIdentifier' + dnsSettingsDnsViewResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dnsSettingsDnsViewResponse' + type: array + required: + - success + - errors + - messages + dnsSettingsDnsViewResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsSettingsDnsViewResponse' + required: + - success + - errors + - messages + dnsSettingsEnforceDnsOnly: + description: When enabled, forces all proxied DNS records in the account to behave as DNS-only at the edge, regardless of each record's individual proxy setting. Note that this account-level override does not modify the records themselves; it only affects how they are served at the edge. See more on [Enforce DNS-only](https://developers.cloudflare.com/dns/proxy-status/enforce-dns-only). + example: false + type: boolean + x-auditable: true + dnsSettingsFlattenAllCnames: + description: Whether to flatten all CNAME records in the zone. Note that, due to DNS limitations, a CNAME record at the zone apex will always be flattened. + example: false + type: boolean + x-auditable: true + dnsSettingsFoundationDns: + description: Whether to enable Foundation DNS Advanced Nameservers on the zone. + example: false + type: boolean + x-auditable: true + dnsSettingsIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + dnsSettingsInternalDnsBase: + description: Settings for this internal zone. + properties: + reference_zone_id: + description: The ID of the zone to fallback to. + type: string + type: object + dnsSettingsMatch: + default: all + description: Whether to match all search requirements or at least one (any). If set to `all`, acts like a logical AND between filters. If set to `any`, acts like a logical OR instead. + enum: + - any + - all + example: any + type: string + dnsSettingsMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dnsSettingsModifiedTime: + description: When the view was last modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + dnsSettingsMultiProvider: + description: Whether to enable multi-provider DNS, which causes Cloudflare to activate the zone even when non-Cloudflare NS records exist, and to respect NS records at the zone apex during outbound zone transfers. + example: false + type: boolean + x-auditable: true + dnsSettingsName: + description: The name of the view. + example: my view + maxLength: 255 + minLength: 1 + type: string + x-auditable: true + dnsSettingsNsTtl: + description: The time to live (TTL) of the zone's nameserver (NS) records. + example: 86400 + maximum: 86400 + minimum: 30 + type: number + x-auditable: true + dnsSettingsOrder: + description: Field to order DNS views by. + enum: + - name + - created_on + - modified_on + type: string + dnsSettingsPage: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + dnsSettingsPerPage: + default: 100 + description: Number of DNS views per page. + example: 5 + maximum: 5000000 + minimum: 1 + type: number + dnsSettingsSchemasDnsResponseSingle: + required: + - success + - errors + - messages + type: object + properties: + errors: + $ref: '#/components/schemas/dnsSettingsMessages' + messages: + $ref: '#/components/schemas/dnsSettingsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsSettingsDnsSettingsZoneResponse' + dnsSettingsSecondaryOverrides: + description: Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex. + example: false + type: boolean + x-auditable: true + dnsSettingsSoaBase: + description: Components of the zone's SOA record. + properties: + expire: + description: Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone. + example: 604800 + maximum: 2419200 + minimum: 86400 + type: number + x-auditable: true + min_ttl: + description: The time to live (TTL) for negative caching of records within the zone. + example: 1800 + maximum: 86400 + minimum: 60 + type: number + x-auditable: true + mname: + description: The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used. + example: kristina.ns.cloudflare.com + nullable: true + type: string + x-auditable: true + refresh: + description: Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated. + example: 10000 + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + retry: + description: Time in seconds after which secondary servers should retry queries after the primary server was unresponsive. + example: 2400 + maximum: 86400 + minimum: 600 + type: number + x-auditable: true + rname: + description: The email address of the zone administrator, with the first label representing the local part of the email address. + example: admin.example.com + type: string + x-auditable: true + ttl: + description: The time to live (TTL) of the SOA record itself. + example: 3600 + maximum: 86400 + minimum: 300 + type: number + x-auditable: true + type: object + dnsSettingsZoneMode: + description: Whether the zone mode is a regular or CDN/DNS only zone. + enum: + - standard + - cdn_only + - dns_only + example: dns_only + type: string + x-auditable: true + dnsSettingsZones: + description: The list of zones linked to this view. + items: + description: The zone ID. + example: 372e67954025e0ba6aaa6d586b9e0b59 + maxLength: 32 + minLength: 32 + type: string + x-auditable: true + type: array + x-stainless-collection-type: set + dnssecAlgorithm: + description: Algorithm key code. + example: '13' + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecDeleteDnssecResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/dnssecMessages' + messages: + $ref: '#/components/schemas/dnssecMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + example: '' + type: string + required: + - success + - errors + - messages + dnssecDigest: + description: Digest hash. + example: 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45 + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecDigestAlgorithm: + description: Type of digest algorithm. + example: SHA256 + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecDigestType: + description: Coded type for digest algorithm. + example: '2' + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecDnskeyRecord: + properties: + Algorithm: + example: 13 + nullable: true + readOnly: true + type: integer + Flags: + example: 256 + nullable: true + readOnly: true + type: integer + Hdr: + $ref: '#/components/schemas/dnssecDnskeyRecordHeader' + Protocol: + example: 3 + nullable: true + readOnly: true + type: integer + PublicKey: + example: oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA== + nullable: true + readOnly: true + type: string + type: object + dnssecDnskeyRecordHeader: + properties: + Class: + example: 1 + nullable: true + readOnly: true + type: integer + Name: + example: example.com. + nullable: true + readOnly: true + type: string + Rdlength: + example: 0 + nullable: true + readOnly: true + type: integer + Rrtype: + example: 48 + nullable: true + readOnly: true + type: integer + Ttl: + example: 3600 + nullable: true + readOnly: true + type: integer + type: object + dnssecDnskeySigningKey: + properties: + kek: + description: Key encryption key name used to encrypt the private key. + example: edge_kek_default + nullable: true + readOnly: true + type: string + privkey: + description: Encrypted private key material for the signing key. + example: U3ZlbidzIHZlcnkgc2VjcmV0IGtleQ== + format: byte + nullable: true + readOnly: true + type: string + pubkey: + description: Public key content associated with the signing key. + example: 256 3 13 oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA== + nullable: true + readOnly: true + type: string + type: object + dnssecDnssec: + properties: + algorithm: + $ref: '#/components/schemas/dnssecAlgorithm' + digest: + $ref: '#/components/schemas/dnssecDigest' + digest_algorithm: + $ref: '#/components/schemas/dnssecDigestAlgorithm' + digest_type: + $ref: '#/components/schemas/dnssecDigestType' + dnssec_multi_signer: + $ref: '#/components/schemas/dnssecDnssecMultiSigner' + dnssec_presigned: + $ref: '#/components/schemas/dnssecDnssecPresigned' + dnssec_use_nsec3: + $ref: '#/components/schemas/dnssecDnssecUseNsec3' + ds: + $ref: '#/components/schemas/dnssecDs' + flags: + $ref: '#/components/schemas/dnssecFlags' + key_tag: + $ref: '#/components/schemas/dnssecKeyTag' + key_type: + $ref: '#/components/schemas/dnssecKeyType' + modified_on: + $ref: '#/components/schemas/dnssecModifiedOn' + readOnly: true + public_key: + $ref: '#/components/schemas/dnssecPublicKey' + status: + $ref: '#/components/schemas/dnssecStatus' + type: object + dnssecDnssecKeyState: + description: Lifecycle state tag attached to the DNSSEC key. + enum: + - active + - publish + - external + - retired + - revoked + - removed + example: active + type: string + x-auditable: true + dnssecDnssecMultiSigner: + description: If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers to serve a DNSSEC-signed zone at the same time. This is required for DNSKEY records (except those automatically generated by Cloudflare) to be added to the zone. See [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/) for details. + example: false + type: boolean + x-auditable: true + dnssecDnssecPresigned: + description: If true, allows Cloudflare to transfer in a DNSSEC-signed zone including signatures from an external provider, without requiring Cloudflare to sign any records on the fly. Note that this feature has some limitations. See [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec) for details. + example: true + type: boolean + x-auditable: true + dnssecDnssecResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/dnssecMessages' + messages: + $ref: '#/components/schemas/dnssecMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnssecDnssec' + required: + - success + - errors + - messages + dnssecDnssecUseNsec3: + description: If true, enables the use of NSEC3 together with DNSSEC on the zone. Combined with setting dnssec_presigned to true, this enables the use of NSEC3 records when transferring in from an external provider. If dnssec_presigned is instead set to false (default), NSEC3 records will be generated and signed at request time. See [DNSSEC with NSEC3](https://developers.cloudflare.com/dns/dnssec/enable-nsec3/) for details. + example: false + type: boolean + x-auditable: true + dnssecDnssecZsk: + properties: + DNSKEY: + $ref: '#/components/schemas/dnssecDnskeyRecord' + Location: + $ref: '#/components/schemas/dnssecKeyStorageLocation' + Name: + description: Internal key name for the ZSK. + example: zsk_default + readOnly: true + type: string + SigningKey: + $ref: '#/components/schemas/dnssecDnskeySigningKey' + Tag: + $ref: '#/components/schemas/dnssecDnssecKeyState' + type: object + dnssecDnssecZskResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/dnssecMessages' + messages: + $ref: '#/components/schemas/dnssecMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/dnssecDnssecZsk' + type: array + required: + - success + - errors + - messages + dnssecDs: + description: Full DS record. + example: example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45 + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecFlags: + description: Flag for DNSSEC record. + example: 257 + nullable: true + readOnly: true + type: number + x-auditable: true + dnssecKeyStorageLocation: + description: Storage backend where the DNSSEC key material is stored. + enum: + - database + - vault + example: database + type: string + x-auditable: true + dnssecKeyTag: + description: Code for key tag. + example: 42 + nullable: true + readOnly: true + type: number + x-auditable: true + dnssecKeyType: + description: Algorithm key type. + example: ECDSAP256SHA256 + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dnssecModifiedOn: + description: When DNSSEC was last modified. + example: '2014-01-01T05:20:00Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecPublicKey: + description: Public key for DS record. + example: oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA== + nullable: true + readOnly: true + type: string + x-auditable: true + dnssecStatus: + description: Status of DNSSEC, based on user-desired state and presence of necessary records. + enum: + - active + - pending + - disabled + - pending-disabled + - error + example: active + x-auditable: true + type: string + outgoingStatus: + description: The zone transfer status of a primary zone. + type: string + x-auditable: true + enum: + - null + secondaryDnsAcl: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip_range: + $ref: '#/components/schemas/secondaryDnsIpRange' + name: + $ref: '#/components/schemas/secondaryDnsAclComponentsSchemasName' + required: + - id + - name + - ip_range + type: object + secondaryDnsAclComponentsSchemasName: + description: The name of the acl. + example: my-acl-1 + type: string + x-auditable: true + secondaryDnsAlgo: + description: TSIG algorithm. + example: hmac-sha512. + type: string + x-auditable: true + secondaryDnsAutoRefreshSeconds: + default: 86400 + description: How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not applicable for primary zones. + example: 86400 + minimum: 300 + type: number + x-auditable: true + secondaryDnsComponentsSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + type: object + required: + - success + - errors + - messages + secondaryDnsComponentsSchemasIdentifier: + example: 23ff594956f20c2a721606e94745a8aa + readOnly: true + type: string + x-auditable: true + secondaryDnsComponentsSchemasName: + description: The name of the peer. + example: my-peer-1 + type: string + x-auditable: true + secondaryDnsComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/secondaryDnsAcl' + type: array + required: + - success + - errors + - messages + secondaryDnsComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/secondaryDnsAcl' + required: + - success + - errors + - messages + secondaryDnsDisableTransferResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/secondaryDnsDisableTransferResult' + required: + - success + - errors + - messages + secondaryDnsDisableTransferResult: + description: The zone transfer status of a primary zone. + example: Disabled + type: string + x-auditable: true + secondaryDnsDnsSecondarySecondaryZone: + properties: + auto_refresh_seconds: + $ref: '#/components/schemas/secondaryDnsAutoRefreshSeconds' + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + name: + $ref: '#/components/schemas/secondaryDnsName' + peers: + $ref: '#/components/schemas/secondaryDnsPeers' + required: + - id + - name + - peers + - auto_refresh_seconds + type: object + secondaryDnsEnableTransferResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/secondaryDnsEnableTransferResult' + required: + - success + - errors + - messages + secondaryDnsEnableTransferResult: + description: The zone transfer status of a primary zone. + example: Enabled + type: string + x-auditable: true + secondaryDnsForceResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/secondaryDnsForceResult' + required: + - success + - errors + - messages + secondaryDnsForceResult: + description: When force_axfr query parameter is set to true, the response is a simple string. + example: OK + type: string + x-auditable: true + secondaryDnsIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + type: object + required: + - success + - errors + - messages + secondaryDnsIdentifier: + example: 269d8f4853475ca241c4e730be286b20 + readOnly: true + type: string + x-auditable: true + secondaryDnsIp: + description: IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to. + example: 192.0.2.53 + type: string + x-auditable: true + secondaryDnsIpRange: + description: Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively. + example: 192.0.2.53/28 + type: string + x-auditable: true + secondaryDnsIxfrEnable: + description: Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones. + example: false + type: boolean + x-auditable: true + secondaryDnsMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + secondaryDnsName: + description: Zone name. + example: www.example.com. + type: string + x-auditable: true + secondaryDnsPeer: + properties: + id: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasIdentifier' + ip: + $ref: '#/components/schemas/secondaryDnsIp' + ixfr_enable: + $ref: '#/components/schemas/secondaryDnsIxfrEnable' + name: + $ref: '#/components/schemas/secondaryDnsComponentsSchemasName' + port: + $ref: '#/components/schemas/secondaryDnsPort' + tsig_id: + $ref: '#/components/schemas/secondaryDnsTsigId' + required: + - id + - name + type: object + secondaryDnsPeers: + description: A list of peer tags. + example: + - 23ff594956f20c2a721606e94745a8aa + - 00920f38ce07c2e2f4df50b1f61d4194 + items: + $ref: '#/components/schemas/secondaryDnsIdentifier' + type: array + x-stainless-collection-type: set + secondaryDnsPort: + description: DNS port of primary or secondary nameserver, depending on what zone this peer is linked to. + example: 53 + type: number + x-auditable: true + secondaryDnsResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/secondaryDnsTsig' + type: array + required: + - success + - errors + - messages + secondaryDnsSchemasForceResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/secondaryDnsSchemasForceResult' + required: + - success + - errors + - messages + secondaryDnsSchemasForceResult: + description: When force_notify query parameter is set to true, the response is a simple string. + example: OK + type: string + x-auditable: true + secondaryDnsSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + type: object + required: + - success + - errors + - messages + secondaryDnsSchemasIdentifier: + example: 69cd1e104af3e6ed3cb344f263fd0d5a + readOnly: true + type: string + x-auditable: true + secondaryDnsSchemasName: + description: TSIG key name. + example: tsig.customer.cf. + type: string + x-auditable: true + secondaryDnsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/secondaryDnsPeer' + type: array + required: + - success + - errors + - messages + secondaryDnsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/secondaryDnsPeer' + required: + - success + - errors + - messages + secondaryDnsSecret: + description: TSIG secret. + example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c + type: string + x-sensitive: true + secondaryDnsSingleRequestOutgoing: + properties: + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + name: + $ref: '#/components/schemas/secondaryDnsName' + peers: + $ref: '#/components/schemas/secondaryDnsPeers' + required: + - id + - name + - peers + type: object + secondaryDnsSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/secondaryDnsTsig' + required: + - success + - errors + - messages + secondaryDnsSingleResponseIncoming: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + auto_refresh_seconds: + $ref: '#/components/schemas/secondaryDnsAutoRefreshSeconds' + checked_time: + $ref: '#/components/schemas/secondaryDnsTime' + created_time: + $ref: '#/components/schemas/secondaryDnsTime' + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + modified_time: + $ref: '#/components/schemas/secondaryDnsTime' + name: + $ref: '#/components/schemas/secondaryDnsName' + peers: + $ref: '#/components/schemas/secondaryDnsPeers' + soa_serial: + $ref: '#/components/schemas/secondaryDnsSoaSerial' + type: object + required: + - success + - errors + - messages + secondaryDnsSingleResponseOutgoing: + type: object + properties: + errors: + $ref: '#/components/schemas/secondaryDnsMessages' + messages: + $ref: '#/components/schemas/secondaryDnsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + checked_time: + $ref: '#/components/schemas/secondaryDnsTime' + created_time: + $ref: '#/components/schemas/secondaryDnsTime' + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + last_transferred_time: + $ref: '#/components/schemas/secondaryDnsTime' + name: + $ref: '#/components/schemas/secondaryDnsName' + peers: + $ref: '#/components/schemas/secondaryDnsPeers' + soa_serial: + $ref: '#/components/schemas/secondaryDnsSoaSerial' + type: object + required: + - success + - errors + - messages + secondaryDnsSoaSerial: + description: The serial number of the SOA for the given zone. + example: 2019102400 + type: number + x-auditable: true + secondaryDnsTime: + description: The time for a specific event. + example: '2019-10-24T17:09:42.883908+01:00' + type: string + x-auditable: true + secondaryDnsTsig: + properties: + algo: + $ref: '#/components/schemas/secondaryDnsAlgo' + id: + $ref: '#/components/schemas/secondaryDnsSchemasIdentifier' + name: + $ref: '#/components/schemas/secondaryDnsSchemasName' + secret: + $ref: '#/components/schemas/secondaryDnsSecret' + required: + - id + - name + - secret + - algo + type: object + secondaryDnsTsigId: + description: TSIG authentication will be used for zone transfer if configured. + example: 69cd1e104af3e6ed3cb344f263fd0d5a + type: string + x-auditable: true + unnamedSchemaRef0e152c3e4c55b8a0ca6531578a42c564: + properties: + checked_time: + $ref: '#/components/schemas/secondaryDnsTime' + created_time: + $ref: '#/components/schemas/secondaryDnsTime' + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + last_transferred_time: + $ref: '#/components/schemas/secondaryDnsTime' + name: + $ref: '#/components/schemas/secondaryDnsName' + peers: + $ref: '#/components/schemas/secondaryDnsPeers' + soa_serial: + $ref: '#/components/schemas/secondaryDnsSoaSerial' + type: object + enum: + - null + unnamedSchemaRef150c555e27f53dbb40cdce4d6644ff0a: + properties: + auto_refresh_seconds: + $ref: '#/components/schemas/secondaryDnsAutoRefreshSeconds' + checked_time: + $ref: '#/components/schemas/secondaryDnsTime' + created_time: + $ref: '#/components/schemas/secondaryDnsTime' + id: + $ref: '#/components/schemas/secondaryDnsIdentifier' + modified_time: + $ref: '#/components/schemas/secondaryDnsTime' + name: + $ref: '#/components/schemas/secondaryDnsName' + peers: + $ref: '#/components/schemas/secondaryDnsPeers' + soa_serial: + $ref: '#/components/schemas/secondaryDnsSoaSerial' + type: object + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + account: + id: cloudflare.dns.account + name: account + title: Account + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/account/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/account/methods/edit' + delete: [] + replace: [] + views: + id: cloudflare.dns.views + name: views + title: Views + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_settings~1views/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_settings~1views/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_settings~1views~1{view_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_settings~1views~1{view_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_settings~1views~1{view_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/views/methods/get' + - $ref: '#/components/x-stackQL-resources/views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/views/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/views/methods/delete' + replace: [] + acls: + id: cloudflare.dns.acls + name: acls + title: Acls + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1acls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1acls/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1acls~1{acl_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1acls~1{acl_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1acls~1{acl_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acls/methods/get' + - $ref: '#/components/x-stackQL-resources/acls/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/acls/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/acls/methods/update' + peers: + id: cloudflare.dns.peers + name: peers + title: Peers + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1peers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1peers/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1peers~1{peer_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1peers~1{peer_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1peers~1{peer_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/peers/methods/get' + - $ref: '#/components/x-stackQL-resources/peers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/peers/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/peers/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/peers/methods/update' + tsigs: + id: cloudflare.dns.tsigs + name: tsigs + title: Tsigs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1tsigs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1tsigs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1tsigs~1{tsig_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1tsigs~1{tsig_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secondary_dns~1tsigs~1{tsig_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tsigs/methods/get' + - $ref: '#/components/x-stackQL-resources/tsigs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tsigs/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tsigs/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/tsigs/methods/update' + reports: + id: cloudflare.dns.reports + name: reports + title: Reports + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_analytics~1report/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.data + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reports/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bytimes: + id: cloudflare.dns.bytimes + name: bytimes + title: Bytimes + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_analytics~1report~1bytime/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.data + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bytimes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + zones_dns_records: + id: cloudflare.dns.zones_dns_records + name: zones_dns_records + title: Zones Dns Records + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zones_dns_records/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/zones_dns_records/methods/create' + update: [] + delete: [] + replace: [] + dns_records: + id: cloudflare.dns.dns_records + name: dns_records + title: Dns Records + methods: + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1batch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1export/get' + response: + mediaType: text/plain + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + import: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1import/post' + response: + mediaType: application/json + openAPIDocKey: '200' + scan: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1scan/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_records/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + scan_review: + id: cloudflare.dns.scan_review + name: scan_review + title: Scan Review + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1scan~1review/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + scan_review: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1scan~1review/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scan_review/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scan_review/methods/scan_review' + update: [] + delete: [] + replace: [] + records: + id: cloudflare.dns.records + name: records + title: Records + methods: + scan_trigger: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1scan~1trigger/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1{dns_record_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1{dns_record_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1{dns_record_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1{dns_record_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/records/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/records/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/records/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/records/methods/update' + zone: + id: cloudflare.dns.zone + name: zone + title: Zone + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zone/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/zone/methods/edit' + delete: [] + replace: [] + dnssec: + id: cloudflare.dns.dnssec + name: dnssec + title: Dnssec + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dnssec/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dnssec/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dnssec/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dnssec/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/dnssec/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/dnssec/methods/delete' + replace: [] + zsk: + id: cloudflare.dns.zsk + name: zsk + title: Zsk + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dnssec~1zsk/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zsk/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + secondary_dns: + id: cloudflare.dns.secondary_dns + name: secondary_dns + title: Secondary Dns + methods: + force_axfr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1force_axfr/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_outgoing: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + incoming: + id: cloudflare.dns.incoming + name: incoming + title: Incoming + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1incoming/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1incoming/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1incoming/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1incoming/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/incoming/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/incoming/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/incoming/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/incoming/methods/update' + outgoing: + id: cloudflare.dns.outgoing + name: outgoing + title: Outgoing + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing/put' + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing~1disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing~1enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + force_notify: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing~1force_notify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/outgoing/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/outgoing/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/outgoing/methods/update' + status: + id: cloudflare.dns.status + name: status + title: Status + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1secondary_dns~1outgoing~1status/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + usage: + id: cloudflare.dns.usage + name: usage + title: Usage + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_records~1usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1dns_records~1usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/usage/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/usage/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/dns_firewall.yaml b/providers/src/cloudflare/v00.00.00000/services/dns_firewall.yaml new file mode 100644 index 00000000..16cf81a0 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/dns_firewall.yaml @@ -0,0 +1,1813 @@ +openapi: 3.0.3 +info: + title: dns_firewall API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/dns_firewall: + get: + description: List DNS Firewall clusters for an account + operationId: dns-firewall-list-dns-firewall-clusters + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of clusters per page + maximum: 100 + minimum: 1 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsFirewallDnsFirewallResponseCollection' + description: List DNS Firewall Clusters response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/dnsFirewallDnsFirewallClusterResponse + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List DNS Firewall Clusters response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List DNS Firewall Clusters + tags: + - DNS Firewall + x-api-token-group: + - DNS Firewall Write + - DNS Firewall Read + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns_firewall + resource_chain: [] + method: list + post: + description: Create a DNS Firewall cluster + operationId: dns-firewall-create-dns-firewall-cluster + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsFirewallDnsFirewallClusterPost' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsFirewallDnsFirewallSingleResponse' + description: Create DNS Firewall Cluster response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - name + - upstream_ips + - minimum_cache_ttl + - maximum_cache_ttl + - negative_cache_ttl + - deprecate_any_requests + - ecs_fallback + - ratelimit + - retries + - id + - dns_firewall_ips + - modified_on + type: object + properties: + attack_mitigation: + $ref: '#/components/schemas/dnsFirewallAttackMitigation' + deprecate_any_requests: + $ref: '#/components/schemas/dnsFirewallDeprecateAnyRequests' + ecs_fallback: + $ref: '#/components/schemas/dnsFirewallEcsFallback' + maximum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMaximumCacheTtl' + minimum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMinimumCacheTtl' + name: + $ref: '#/components/schemas/dnsFirewallName' + negative_cache_ttl: + $ref: '#/components/schemas/dnsFirewallNegativeCacheTtl' + ratelimit: + $ref: '#/components/schemas/dnsFirewallRatelimit' + retries: + $ref: '#/components/schemas/dnsFirewallRetries' + upstream_ips: + $ref: '#/components/schemas/dnsFirewallUpstreamIps' + dns_firewall_ips: + $ref: '#/components/schemas/dnsFirewallDnsFirewallIps' + id: + $ref: '#/components/schemas/dnsFirewallIdentifier' + modified_on: + $ref: '#/components/schemas/dnsFirewallModifiedOn' + readOnly: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create DNS Firewall Cluster response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create DNS Firewall Cluster + tags: + - DNS Firewall + x-api-token-group: + - DNS Firewall Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns_firewall + resource_chain: [] + method: create + /accounts/{account_id}/dns_firewall/{dns_firewall_id}: + delete: + description: Delete a DNS Firewall cluster + operationId: dns-firewall-delete-dns-firewall-cluster + parameters: + - in: path + name: dns_firewall_id + schema: + $ref: '#/components/schemas/dnsFirewallIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/dnsFirewallIdentifier' + type: object + required: + - success + - errors + - messages + description: Delete DNS Firewall Cluster response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/dnsFirewallIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete DNS Firewall Cluster response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete DNS Firewall Cluster + tags: + - DNS Firewall + x-api-token-group: + - DNS Firewall Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns_firewall + resource_chain: [] + method: delete + get: + description: Show a single DNS Firewall cluster for an account + operationId: dns-firewall-dns-firewall-cluster-details + parameters: + - in: path + name: dns_firewall_id + schema: + $ref: '#/components/schemas/dnsFirewallIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsFirewallDnsFirewallSingleResponse' + description: DNS Firewall Cluster Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - name + - upstream_ips + - minimum_cache_ttl + - maximum_cache_ttl + - negative_cache_ttl + - deprecate_any_requests + - ecs_fallback + - ratelimit + - retries + - id + - dns_firewall_ips + - modified_on + type: object + properties: + attack_mitigation: + $ref: '#/components/schemas/dnsFirewallAttackMitigation' + deprecate_any_requests: + $ref: '#/components/schemas/dnsFirewallDeprecateAnyRequests' + ecs_fallback: + $ref: '#/components/schemas/dnsFirewallEcsFallback' + maximum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMaximumCacheTtl' + minimum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMinimumCacheTtl' + name: + $ref: '#/components/schemas/dnsFirewallName' + negative_cache_ttl: + $ref: '#/components/schemas/dnsFirewallNegativeCacheTtl' + ratelimit: + $ref: '#/components/schemas/dnsFirewallRatelimit' + retries: + $ref: '#/components/schemas/dnsFirewallRetries' + upstream_ips: + $ref: '#/components/schemas/dnsFirewallUpstreamIps' + dns_firewall_ips: + $ref: '#/components/schemas/dnsFirewallDnsFirewallIps' + id: + $ref: '#/components/schemas/dnsFirewallIdentifier' + modified_on: + $ref: '#/components/schemas/dnsFirewallModifiedOn' + readOnly: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: DNS Firewall Cluster Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: DNS Firewall Cluster Details + tags: + - DNS Firewall + x-api-token-group: + - DNS Firewall Write + - DNS Firewall Read + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns_firewall + resource_chain: [] + method: get + patch: + description: Modify the configuration of a DNS Firewall cluster + operationId: dns-firewall-update-dns-firewall-cluster + parameters: + - in: path + name: dns_firewall_id + schema: + $ref: '#/components/schemas/dnsFirewallIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsFirewallDnsFirewallClusterPatch' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dnsFirewallDnsFirewallSingleResponse' + description: Update DNS Firewall Cluster response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - name + - upstream_ips + - minimum_cache_ttl + - maximum_cache_ttl + - negative_cache_ttl + - deprecate_any_requests + - ecs_fallback + - ratelimit + - retries + - id + - dns_firewall_ips + - modified_on + type: object + properties: + attack_mitigation: + $ref: '#/components/schemas/dnsFirewallAttackMitigation' + deprecate_any_requests: + $ref: '#/components/schemas/dnsFirewallDeprecateAnyRequests' + ecs_fallback: + $ref: '#/components/schemas/dnsFirewallEcsFallback' + maximum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMaximumCacheTtl' + minimum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMinimumCacheTtl' + name: + $ref: '#/components/schemas/dnsFirewallName' + negative_cache_ttl: + $ref: '#/components/schemas/dnsFirewallNegativeCacheTtl' + ratelimit: + $ref: '#/components/schemas/dnsFirewallRatelimit' + retries: + $ref: '#/components/schemas/dnsFirewallRetries' + upstream_ips: + $ref: '#/components/schemas/dnsFirewallUpstreamIps' + dns_firewall_ips: + $ref: '#/components/schemas/dnsFirewallDnsFirewallIps' + id: + $ref: '#/components/schemas/dnsFirewallIdentifier' + modified_on: + $ref: '#/components/schemas/dnsFirewallModifiedOn' + readOnly: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update DNS Firewall Cluster response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update DNS Firewall Cluster + tags: + - DNS Firewall + x-api-token-group: + - DNS Firewall Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns_firewall + resource_chain: [] + method: edit + /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report: + get: + description: >- + Retrieves a list of summarised aggregate metrics over a given time + period. See [Analytics API + properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) + for detailed information about the available query parameters. + operationId: dns-firewall-analytics-table + parameters: + - in: path + name: dns_firewall_id + schema: + $ref: '#/components/schemas/dnsAnalyticsIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: metrics + schema: + $ref: '#/components/schemas/dnsAnalyticsMetrics' + - in: query + name: dimensions + schema: + $ref: '#/components/schemas/dnsAnalyticsDimensions' + - in: query + name: since + schema: + $ref: '#/components/schemas/dnsAnalyticsSince' + - in: query + name: until + schema: + $ref: '#/components/schemas/dnsAnalyticsUntil' + - in: query + name: limit + schema: + $ref: '#/components/schemas/dnsAnalyticsLimit' + - in: query + name: sort + schema: + $ref: '#/components/schemas/dnsAnalyticsSort' + - in: query + name: filters + schema: + $ref: '#/components/schemas/dnsAnalyticsFilters' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dnsAnalyticsReport' + required: + - success + - errors + - messages + description: Table response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + description: Table response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Table + tags: + - DNS Firewall Analytics + x-api-token-group: + - DNS Firewall Write + - DNS Firewall Read + x-stackql-sdk: + service: dns_firewall + resource_chain: + - analytics + - reports + method: get + /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime: + get: + description: >- + Retrieves a list of aggregate metrics grouped by time interval. See + [Analytics API + properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) + for detailed information about the available query parameters. + operationId: dns-firewall-analytics-by-time + parameters: + - in: path + name: dns_firewall_id + schema: + $ref: '#/components/schemas/dnsAnalyticsIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: metrics + schema: + $ref: '#/components/schemas/dnsAnalyticsMetrics' + - in: query + name: dimensions + schema: + $ref: '#/components/schemas/dnsAnalyticsDimensions' + - in: query + name: since + schema: + $ref: '#/components/schemas/dnsAnalyticsSince' + - in: query + name: until + schema: + $ref: '#/components/schemas/dnsAnalyticsUntil' + - in: query + name: limit + schema: + $ref: '#/components/schemas/dnsAnalyticsLimit' + - in: query + name: sort + schema: + $ref: '#/components/schemas/dnsAnalyticsSort' + - in: query + name: filters + schema: + $ref: '#/components/schemas/dnsAnalyticsFilters' + - in: query + name: time_delta + schema: + $ref: '#/components/schemas/dnsAnalyticsTimeDelta' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dnsAnalyticsReportBytime' + required: + - success + - errors + - messages + description: By Time response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/dnsAnalyticsMessages' + messages: + $ref: '#/components/schemas/dnsAnalyticsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + description: By Time response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: By Time + tags: + - DNS Firewall Analytics + x-api-token-group: + - DNS Firewall Write + - DNS Firewall Read + x-stackql-sdk: + service: dns_firewall + resource_chain: + - analytics + - reports + - bytimes + method: get + /accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns: + get: + description: Show reverse DNS configuration (PTR records) for a DNS Firewall cluster + operationId: dns-firewall-show-dns-firewall-cluster-reverse-dns + parameters: + - in: path + name: dns_firewall_id + schema: + $ref: '#/components/schemas/dnsFirewallIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/dnsFirewallDnsFirewallReverseDnsResponse_2 + description: Show DNS Firewall Cluster Reverse DNS response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - ptr + type: object + properties: + ptr: + description: Map of cluster IP addresses to PTR record contents + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Show DNS Firewall Cluster Reverse DNS response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Show DNS Firewall Cluster Reverse DNS + tags: + - DNS Firewall + x-api-token-group: + - DNS Firewall Write + - DNS Firewall Read + x-cfPermissionsRequired: + enum: + - '#dns_records:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns_firewall + resource_chain: + - reverse_dns + method: get + patch: + description: >- + Update reverse DNS configuration (PTR records) for a DNS Firewall + cluster + operationId: dns-firewall-update-dns-firewall-cluster-reverse-dns + parameters: + - in: path + name: dns_firewall_id + schema: + $ref: '#/components/schemas/dnsFirewallIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dnsFirewallDnsFirewallReverseDnsPatch' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/dnsFirewallDnsFirewallReverseDnsResponse_2 + description: Update DNS Firewall Cluster Reverse DNS response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + required: + - ptr + type: object + properties: + ptr: + description: Map of cluster IP addresses to PTR record contents + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update DNS Firewall Cluster Reverse DNS response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update DNS Firewall Cluster Reverse DNS + tags: + - DNS Firewall + x-api-token-group: + - DNS Firewall Write + x-cfPermissionsRequired: + enum: + - '#dns_records:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: dns_firewall + resource_chain: + - reverse_dns + method: edit +components: + schemas: + dnsAnalyticsDimensions: + description: A comma-separated list of dimensions to group results by. + example: queryType + type: string + dnsAnalyticsFilters: + description: Segmentation filter in 'attribute operator value' format. + example: responseCode==NOERROR,queryType==A + type: string + dnsAnalyticsIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + dnsAnalyticsLimit: + default: 100000 + description: Limit number of returned metrics. + example: 100 + type: integer + dnsAnalyticsMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dnsAnalyticsMetrics: + description: A comma-separated list of metrics to query. + example: queryCount,uncachedCount + type: string + dnsAnalyticsQuery: + properties: + dimensions: + description: Array of dimension names. + example: + - responseCode + - queryName + items: + description: Dimension name. + example: responseCode + type: string + type: array + filters: + $ref: '#/components/schemas/dnsAnalyticsFilters' + limit: + $ref: '#/components/schemas/dnsAnalyticsLimit' + metrics: + description: Array of metric names. + example: + - queryCount + - responseTimeAvg + items: + description: Metric name. + example: queries + type: string + type: array + since: + $ref: '#/components/schemas/dnsAnalyticsSince' + sort: + description: >- + Array of dimensions to sort by, where each dimension may be prefixed + by - (descending) or + (ascending). + example: + - +responseCode + - '-queryName' + items: + description: >- + Dimension name (may be prefixed by - (descending) or + + (ascending). + example: +responseCode + type: string + type: array + until: + $ref: '#/components/schemas/dnsAnalyticsUntil' + required: + - dimensions + - metrics + - since + - until + - limit + type: object + dnsAnalyticsReport: + type: object + properties: + data: + description: Array with one row per combination of dimension values. + items: + $ref: '#/components/schemas/dnsAnalyticsReport_data_item' + type: array + data_lag: + description: >- + Number of seconds between current time and last processed event, in + another words how many seconds of data could be missing. + example: 60 + minimum: 0 + type: number + max: + description: >- + Maximum results for each metric (object mapping metric names to + values). Currently always an empty object. + type: object + min: + description: >- + Minimum results for each metric (object mapping metric names to + values). Currently always an empty object. + type: object + query: + $ref: '#/components/schemas/dnsAnalyticsQuery' + rows: + description: Total number of rows in the result. + example: 100 + minimum: 0 + type: number + totals: + description: >- + Total results for metrics across all data (object mapping metric + names to values). + type: object + required: + - rows + - totals + - min + - max + - data_lag + - query + - data + - data + dnsAnalyticsReportBytime: + type: object + properties: + data: + description: Array with one row per combination of dimension values. + items: + $ref: '#/components/schemas/dnsAnalyticsReportBytime_data_item' + type: array + data_lag: + description: >- + Number of seconds between current time and last processed event, in + another words how many seconds of data could be missing. + example: 60 + minimum: 0 + type: number + max: + description: >- + Maximum results for each metric (object mapping metric names to + values). Currently always an empty object. + type: object + min: + description: >- + Minimum results for each metric (object mapping metric names to + values). Currently always an empty object. + type: object + query: + properties: + dimensions: + description: Array of dimension names. + example: + - responseCode + - queryName + items: + description: Dimension name. + example: responseCode + type: string + type: array + filters: + $ref: '#/components/schemas/dnsAnalyticsFilters' + limit: + $ref: '#/components/schemas/dnsAnalyticsLimit' + metrics: + description: Array of metric names. + example: + - queryCount + - responseTimeAvg + items: + description: Metric name. + example: queries + type: string + type: array + since: + $ref: '#/components/schemas/dnsAnalyticsSince' + sort: + description: >- + Array of dimensions to sort by, where each dimension may be + prefixed by - (descending) or + (ascending). + example: + - +responseCode + - '-queryName' + items: + description: >- + Dimension name (may be prefixed by - (descending) or + + (ascending). + example: +responseCode + type: string + type: array + until: + $ref: '#/components/schemas/dnsAnalyticsUntil' + time_delta: + $ref: '#/components/schemas/dnsAnalyticsTimeDelta' + required: + - dimensions + - metrics + - since + - until + - limit + - time_delta + type: object + rows: + description: Total number of rows in the result. + example: 100 + minimum: 0 + type: number + totals: + description: >- + Total results for metrics across all data (object mapping metric + names to values). + type: object + time_intervals: + description: >- + Array of time intervals in the response data. Each interval is + represented as an array containing two values: the start time, and + the end time. + items: + description: >- + Array with exactly two items, representing the start and end time + (respectively) of this time interval. + items: + description: Time value. + example: '2023-11-11T12:00:00Z' + format: date-time + type: string + type: array + type: array + required: + - rows + - totals + - min + - max + - data_lag + - query + - data + - time_intervals + - query + - data + dnsAnalyticsReportBytime_data_item: + properties: + dimensions: + description: >- + Array of dimension values, representing the combination of dimension + values corresponding to this row. + items: + description: Dimension value. + example: NODATA + type: string + type: array + metrics: + description: >- + Array with one item per requested metric. Each item is an array of + values, broken down by time interval. + items: + description: Nominal metric values, broken down by time interval. + items: + description: Nominal metric value. + type: number + type: array + type: array + required: + - dimensions + - metrics + type: object + dnsAnalyticsReport_data_item: + properties: + dimensions: + description: >- + Array of dimension values, representing the combination of dimension + values corresponding to this row. + items: + description: Dimension value. + example: NODATA + type: string + type: array + metrics: + description: >- + Array with one item per requested metric. Each item is a single + value. + items: + description: Nominal metric value. + type: number + type: array + required: + - dimensions + - metrics + type: object + dnsAnalyticsSince: + description: Start date and time of requesting data period in ISO 8601 format. + example: '2023-11-11T12:00:00Z' + format: date-time + type: string + dnsAnalyticsSort: + description: >- + A comma-separated list of dimensions to sort by, where each dimension + may be prefixed by - (descending) or + (ascending). + example: +responseCode,-queryName + type: string + dnsAnalyticsTimeDelta: + description: Unit of time to group data by. + enum: + - all + - auto + - year + - quarter + - month + - week + - day + - hour + - dekaminute + - minute + example: hour + type: string + dnsAnalyticsUntil: + description: End date and time of requesting data period in ISO 8601 format. + example: '2023-11-11T13:00:00Z' + format: date-time + type: string + dnsFirewallAttackMitigation: + description: Attack mitigation settings + nullable: true + properties: + enabled: + description: >- + When enabled, automatically mitigate random-prefix attacks to + protect upstream DNS servers + example: true + type: boolean + x-auditable: true + only_when_upstream_unhealthy: + default: true + description: Only mitigate attacks when upstream servers seem unhealthy + example: false + type: boolean + x-auditable: true + type: object + dnsFirewallDeprecateAnyRequests: + description: Whether to refuse to answer queries for the ANY type + example: true + type: boolean + x-auditable: true + dnsFirewallDnsFirewallCluster: + properties: + attack_mitigation: + $ref: '#/components/schemas/dnsFirewallAttackMitigation' + deprecate_any_requests: + $ref: '#/components/schemas/dnsFirewallDeprecateAnyRequests' + ecs_fallback: + $ref: '#/components/schemas/dnsFirewallEcsFallback' + maximum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMaximumCacheTtl' + minimum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMinimumCacheTtl' + name: + $ref: '#/components/schemas/dnsFirewallName' + negative_cache_ttl: + $ref: '#/components/schemas/dnsFirewallNegativeCacheTtl' + ratelimit: + $ref: '#/components/schemas/dnsFirewallRatelimit' + retries: + $ref: '#/components/schemas/dnsFirewallRetries' + upstream_ips: + $ref: '#/components/schemas/dnsFirewallUpstreamIps' + type: object + dnsFirewallDnsFirewallClusterPatch: + type: object + $ref: '#/components/schemas/dnsFirewallDnsFirewallCluster' + dnsFirewallDnsFirewallClusterPost: + type: object + $ref: '#/components/schemas/dnsFirewallDnsFirewallCluster' + dnsFirewallDnsFirewallClusterResponse: + required: + - name + - upstream_ips + - minimum_cache_ttl + - maximum_cache_ttl + - negative_cache_ttl + - deprecate_any_requests + - ecs_fallback + - ratelimit + - retries + - id + - dns_firewall_ips + - modified_on + type: object + properties: + attack_mitigation: + $ref: '#/components/schemas/dnsFirewallAttackMitigation' + deprecate_any_requests: + $ref: '#/components/schemas/dnsFirewallDeprecateAnyRequests' + ecs_fallback: + $ref: '#/components/schemas/dnsFirewallEcsFallback' + maximum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMaximumCacheTtl' + minimum_cache_ttl: + $ref: '#/components/schemas/dnsFirewallMinimumCacheTtl' + name: + $ref: '#/components/schemas/dnsFirewallName' + negative_cache_ttl: + $ref: '#/components/schemas/dnsFirewallNegativeCacheTtl' + ratelimit: + $ref: '#/components/schemas/dnsFirewallRatelimit' + retries: + $ref: '#/components/schemas/dnsFirewallRetries' + upstream_ips: + $ref: '#/components/schemas/dnsFirewallUpstreamIps' + dns_firewall_ips: + $ref: '#/components/schemas/dnsFirewallDnsFirewallIps' + id: + $ref: '#/components/schemas/dnsFirewallIdentifier' + modified_on: + $ref: '#/components/schemas/dnsFirewallModifiedOn' + readOnly: true + dnsFirewallDnsFirewallIps: + example: + - 203.0.113.1 + - 203.0.113.254 + - 2001:DB8:AB::CF + - 2001:DB8:CD::CF + items: + type: string + format: ipv4 + description: Cloudflare-assigned DNS IPv4 address + example: 203.0.113.1 + type: array + x-stainless-collection-type: set + dnsFirewallDnsFirewallResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dnsFirewallDnsFirewallClusterResponse' + type: array + required: + - success + - errors + - messages + dnsFirewallDnsFirewallReverseDns: + properties: + ptr: + description: Map of cluster IP addresses to PTR record contents + type: object + type: object + dnsFirewallDnsFirewallReverseDnsPatch: + type: object + $ref: '#/components/schemas/dnsFirewallDnsFirewallReverseDns' + dnsFirewallDnsFirewallReverseDnsResponse: + type: object + $ref: '#/components/schemas/dnsFirewallDnsFirewallReverseDns' + dnsFirewallDnsFirewallReverseDnsResponse_2: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsFirewallDnsFirewallReverseDnsResponse' + required: + - success + - errors + - messages + dnsFirewallDnsFirewallSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsFirewallMessages' + messages: + $ref: '#/components/schemas/dnsFirewallMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dnsFirewallDnsFirewallClusterResponse' + required: + - success + - errors + - messages + dnsFirewallEcsFallback: + description: >- + Whether to forward client IP (resolver) subnet if no EDNS Client Subnet + is sent + example: false + type: boolean + x-auditable: true + dnsFirewallIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + dnsFirewallMaximumCacheTtl: + default: 900 + description: >- + By default, Cloudflare attempts to cache responses for as long as + indicated by the TTL received from upstream nameservers. This setting + sets an upper bound on this duration. For caching purposes, higher TTLs + will be decreased to the maximum value defined by this setting. This + setting does not affect the TTL value in the DNS response Cloudflare + returns to clients. Cloudflare will always forward the TTL value + received from upstream nameservers. + example: 900 + maximum: 36000 + minimum: 30 + type: number + x-auditable: true + dnsFirewallMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dnsFirewallMinimumCacheTtl: + default: 60 + description: >- + By default, Cloudflare attempts to cache responses for as long as + indicated by the TTL received from upstream nameservers. This setting + sets a lower bound on this duration. For caching purposes, lower TTLs + will be increased to the minimum value defined by this setting. This + setting does not affect the TTL value in the DNS response Cloudflare + returns to clients. Cloudflare will always forward the TTL value + received from upstream nameservers. Note that, even with this setting, + there is no guarantee that a response will be cached for at least the + specified duration. Cached responses may be removed earlier for capacity + or other operational reasons. + example: 60 + maximum: 36000 + minimum: 30 + type: number + x-auditable: true + dnsFirewallModifiedOn: + description: Last modification of DNS Firewall cluster + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + dnsFirewallName: + description: DNS Firewall cluster name + example: My Awesome DNS Firewall cluster + maxLength: 160 + minLength: 1 + type: string + x-auditable: true + dnsFirewallNegativeCacheTtl: + description: >- + This setting controls how long DNS Firewall should cache negative + responses (e.g., NXDOMAIN) from the upstream servers. This setting does + not affect the TTL value in the DNS response Cloudflare returns to + clients. Cloudflare will always forward the TTL value received from + upstream nameservers. + example: 900 + maximum: 36000 + minimum: 30 + nullable: true + type: number + x-auditable: true + dnsFirewallRatelimit: + description: >- + Ratelimit in queries per second per datacenter (applies to DNS queries + sent to the upstream nameservers configured on the cluster) + example: 600 + maximum: 1000000000 + minimum: 100 + nullable: true + type: number + x-auditable: true + dnsFirewallRetries: + default: 2 + description: >- + Number of retries for fetching DNS responses from upstream nameservers + (not counting the initial attempt) + example: 2 + maximum: 2 + minimum: 0 + type: number + x-auditable: true + dnsFirewallUpstreamIps: + example: + - 192.0.2.1 + - 198.51.100.1 + - 2001:DB8:100::CF + items: + type: string + format: ipv4 + description: Upstream DNS Server IPv4 address + example: 192.0.2.1 + minLength: 1 + type: array + x-stainless-collection-type: set + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + dns_firewall: + id: cloudflare.dns_firewall.dns_firewall + name: dns_firewall + title: Dns Firewall + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_firewall/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dns_firewall/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1dns_firewall~1{dns_firewall_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1dns_firewall~1{dns_firewall_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1dns_firewall~1{dns_firewall_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_firewall/methods/get' + - $ref: '#/components/x-stackQL-resources/dns_firewall/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dns_firewall/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dns_firewall/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/dns_firewall/methods/delete' + replace: [] + reports: + id: cloudflare.dns_firewall.reports + name: reports + title: Reports + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1dns_firewall~1{dns_firewall_id}~1dns_analytics~1report/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.data + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reports/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bytimes: + id: cloudflare.dns_firewall.bytimes + name: bytimes + title: Bytimes + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1dns_firewall~1{dns_firewall_id}~1dns_analytics~1report~1bytime/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.data + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bytimes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + reverse_dns: + id: cloudflare.dns_firewall.reverse_dns + name: reverse_dns + title: Reverse Dns + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1dns_firewall~1{dns_firewall_id}~1reverse_dns/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1dns_firewall~1{dns_firewall_id}~1reverse_dns/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reverse_dns/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/reverse_dns/methods/edit' + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/domains.yaml b/providers/src/cloudflare/v00.00.00000/services/domains.yaml deleted file mode 100644 index 1bb83ab8..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/domains.yaml +++ /dev/null @@ -1,562 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Registrar Domains - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - domains - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - domain_names: - description: List of domain names. - example: - - cloudflare.com - - cloudflare.net - items: - type: string - type: array - domain_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/domains' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - domains: - allOf: - - $ref: '#/components/schemas/domain_properties' - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - domain_properties: - properties: - available: - $ref: '#/components/schemas/schemas-available' - can_register: - $ref: '#/components/schemas/can_register' - created_at: - $ref: '#/components/schemas/components-schemas-created_at' - current_registrar: - $ref: '#/components/schemas/current_registrar' - expires_at: - $ref: '#/components/schemas/expires_at' - id: - $ref: '#/components/schemas/schemas-domain_identifier' - locked: - $ref: '#/components/schemas/locked' - registrant_contact: - $ref: '#/components/schemas/registrant_contact' - registry_statuses: - $ref: '#/components/schemas/registry_statuses' - supported_tld: - $ref: '#/components/schemas/supported_tld' - transfer_in: - $ref: '#/components/schemas/transfer_in' - updated_at: - $ref: '#/components/schemas/components-schemas-updated_at' - type: object - schemas-available: - description: Shows if a domain is available for transferring into Cloudflare Registrar. - example: false - type: boolean - can_register: - description: Indicates if the domain can be registered as a new domain. - example: false - type: boolean - components-schemas-created_at: - description: Shows time of creation. - example: '2018-08-28T17:26:26Z' - format: date-time - type: string - current_registrar: - description: Shows name of current registrar. - example: Cloudflare - type: string - expires_at: - description: Shows when domain name registration expires. - example: '2019-08-28T23:59:59Z' - format: date-time - type: string - schemas-domain_identifier: - description: Domain identifier. - example: ea95132c15732412d22c1476fa83f27a - maxLength: 32 - readOnly: true - type: string - locked: - description: Shows whether a registrar lock is in place for a domain. - example: false - type: boolean - registrant_contact: - allOf: - - $ref: '#/components/schemas/contacts' - description: Shows contact information for domain registrant. - registry_statuses: - description: 'A comma-separated list of registry status codes. A full list of status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).' - example: 'ok,serverTransferProhibited' - type: string - supported_tld: - description: 'Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of supported TLDs.' - example: true - type: boolean - transfer_in: - description: Statuses for domain transfers into Cloudflare Registrar. - properties: - accept_foa: - description: Form of authorization has been accepted by the registrant. - example: needed - approve_transfer: - description: Shows transfer status with the registry. - example: unknown - can_cancel_transfer: - description: Indicates if cancellation is still possible. - example: true - type: boolean - disable_privacy: - description: Privacy guards are disabled at the foreign registrar. - enter_auth_code: - description: Auth code has been entered and verified. - example: needed - unlock_domain: - description: Domain is unlocked at the foreign registrar. - components-schemas-updated_at: - description: Last updated. - example: '2018-08-28T17:26:26Z' - format: date-time - type: string - contacts: - allOf: - - $ref: '#/components/schemas/contact_properties' - contact_properties: - properties: - address: - $ref: '#/components/schemas/components-schemas-address' - address2: - $ref: '#/components/schemas/address2' - city: - $ref: '#/components/schemas/city' - country: - $ref: '#/components/schemas/country' - email: - $ref: '#/components/schemas/email' - fax: - $ref: '#/components/schemas/fax' - first_name: - $ref: '#/components/schemas/first_name' - id: - $ref: '#/components/schemas/contact_identifier' - last_name: - $ref: '#/components/schemas/last_name' - organization: - $ref: '#/components/schemas/schemas-organization' - phone: - $ref: '#/components/schemas/telephone' - state: - $ref: '#/components/schemas/contacts_components-schemas-state' - zip: - $ref: '#/components/schemas/zipcode' - required: - - first_name - - last_name - - address - - city - - state - - zip - - country - - phone - - organization - type: object - components-schemas-address: - description: Address. - example: 123 Sesame St. - type: string - address2: - description: 'Optional address line for unit, floor, suite, etc.' - example: Suite 430 - type: string - city: - description: City. - example: Austin - type: string - country: - description: The country in which the user lives. - example: US - maxLength: 30 - nullable: true - type: string - email: - description: The contact email address of the user. - example: user@example.com - maxLength: 90 - type: string - fax: - description: Contact fax number. - example: 123-867-5309 - type: string - first_name: - description: User's first name - example: John - maxLength: 60 - nullable: true - type: string - contact_identifier: - description: Contact Identifier. - example: ea95132c15732412d22c1476fa83f27a - maxLength: 32 - readOnly: true - type: string - last_name: - description: User's last name - example: Appleseed - maxLength: 60 - nullable: true - type: string - schemas-organization: - description: Name of organization. - example: 'Cloudflare, Inc.' - type: string - telephone: - description: User's telephone number - example: +1 123-123-1234 - maxLength: 20 - nullable: true - type: string - contacts_components-schemas-state: - description: State. - example: TX - type: string - zipcode: - description: The zipcode or postal code where the user lives. - example: '12345' - maxLength: 20 - nullable: true - type: string - schemas-domain_name: - description: Domain name. - example: cloudflare.com - type: string - domain_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - domain_update_properties: - properties: - auto_renew: - $ref: '#/components/schemas/auto_renew' - locked: - $ref: '#/components/schemas/locked' - name_servers: - $ref: '#/components/schemas/name_servers' - privacy: - $ref: '#/components/schemas/privacy' - type: object - auto_renew: - description: Auto-renew controls whether subscription is automatically renewed upon domain expiration. - example: true - type: boolean - name_servers: - description: List of name servers. - example: - - preston.ns.cloudflare.com - - oli.ns.cloudflare.com - items: - type: string - type: array - privacy: - description: Privacy option controls redacting WHOIS information. - example: true - type: boolean - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_registrar: - id: cloudflare.domains.accounts_registrar - name: accounts_registrar - title: Accounts Registrar - methods: - registrar_domains_list_domains: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1registrar~1domains/post' - response: - mediaType: application/json - openAPIDocKey: '200' - registrar_domains_get_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1registrar~1domains~1{domain_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _registrar_domains_get_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1registrar~1domains~1{domain_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - registrar_domains_update_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1registrar~1domains~1{domain_name}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_registrar/methods/registrar_domains_get_domain' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/registrar/domains': - post: - description: List domains handled by Registrar. - operationId: registrar-domains-list-domains - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - id: - $ref: '#/components/schemas/domain_names' - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain_response_collection' - description: List domains response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List domains response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List domains - tags: - - Registrar Domains - '/accounts/{account_identifier}/registrar/domains/{domain_name}': - get: - description: Show individual domain. - operationId: registrar-domains-get-domain - parameters: - - in: path - name: domain_name - required: true - schema: - $ref: '#/components/schemas/schemas-domain_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain_response_single' - description: Get domain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get domain - tags: - - Registrar Domains - put: - description: Update individual domain. - operationId: registrar-domains-update-domain - parameters: - - in: path - name: domain_name - required: true - schema: - $ref: '#/components/schemas/schemas-domain_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain_update_properties' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain_response_single' - description: Update domain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update domain - tags: - - Registrar Domains diff --git a/providers/src/cloudflare/v00.00.00000/services/durable_objects.yaml b/providers/src/cloudflare/v00.00.00000/services/durable_objects.yaml new file mode 100644 index 00000000..b95eb202 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/durable_objects.yaml @@ -0,0 +1,451 @@ +openapi: 3.0.3 +info: + title: durable_objects API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/workers/durable_objects/namespaces: + get: + description: Returns the Durable Object namespaces owned by an account. + operationId: durable-objects-namespace-list-namespaces + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Current page. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Items per-page. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/workersNamespace' + type: array + required: + - success + - errors + - messages + description: List Namespaces response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/workersNamespace' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Namespaces response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Namespaces + tags: + - Durable Objects Namespace + x-api-token-group: + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: durable_objects + resource_chain: + - namespaces + method: list + /accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects: + get: + description: Returns the Durable Objects in a given namespace. + operationId: durable-objects-namespace-list-objects + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - in: query + name: limit + schema: + default: 1000 + description: >- + The number of objects to return. The cursor attribute may be used + to iterate over the next batch of objects if there are more than + the limit. + maximum: 10000 + minimum: 10 + type: number + - in: query + name: cursor + schema: + description: >- + Opaque token indicating the position from which to continue when + requesting the next set of records. A valid value for the cursor + can be obtained from the cursors object in the result_info + structure. + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total results returned based on your list parameters. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + cursor: + $ref: '#/components/schemas/workersCursor' + type: object + result: + items: + $ref: '#/components/schemas/workersObject' + type: array + required: + - success + - errors + - messages + description: List Objects response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total results returned based on your list parameters. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + cursor: + $ref: '#/components/schemas/workersCursor' + type: object + result: + items: + $ref: '#/components/schemas/workersObject' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Objects response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Objects + tags: + - Durable Objects Namespace + x-api-token-group: + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: durable_objects + resource_chain: + - namespaces + - objects + method: list +components: + schemas: + workersCursor: + description: >- + Opaque token indicating the position from which to continue when + requesting the next set of records. A valid value for the cursor can be + obtained from the cursors object in the result_info structure. + example: >- + AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc + type: string + workersMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + workersNamespace: + properties: + class: + type: string + id: + readOnly: true + type: string + name: + type: string + script: + type: string + use_sqlite: + type: boolean + type: object + workersObject: + properties: + hasStoredData: + description: Whether the Durable Object has stored data. + example: true + readOnly: true + type: boolean + id: + description: ID of the Durable Object. + example: fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8 + readOnly: true + type: string + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + namespaces: + id: cloudflare.durable_objects.namespaces + name: namespaces + title: Namespaces + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workers~1durable_objects~1namespaces/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + objects: + id: cloudflare.durable_objects.objects + name: objects + title: Objects + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workers~1durable_objects~1namespaces~1{id}~1objects/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/objects/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/email_routing.yaml b/providers/src/cloudflare/v00.00.00000/services/email_routing.yaml index 6ce13844..c38936bb 100644 --- a/providers/src/cloudflare/v00.00.00000/services/email_routing.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/email_routing.yaml @@ -1,785 +1,148 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Email Routing destination addresses - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - email_routing + title: email_routing API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - destination_addresses_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/addresses' - type: array - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 20 - total_count: - example: 1 - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - addresses: - allOf: - - $ref: '#/components/schemas/destination_address_properties' - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/email/routing/addresses: + get: + description: Lists existing destination addresses. + operationId: email-routing-destination-addresses-list-destination-addresses + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - destination_address_properties: - properties: - created: - $ref: '#/components/schemas/created' - email: - $ref: '#/components/schemas/email' - modified: - $ref: '#/components/schemas/modified' - tag: - $ref: '#/components/schemas/destination_address_identifier' - verified: - $ref: '#/components/schemas/verified' - type: object - created: - description: The date and time the destination address has been created. - example: '2014-01-02T02:20:00Z' - format: date-time - readOnly: true - type: string - email: - description: The contact email address of the user. - example: user@example.com - maxLength: 90 - type: string - modified: - description: The date and time the destination address was last modified. - example: '2014-01-02T02:20:00Z' - format: date-time - readOnly: true - type: string - destination_address_identifier: - description: Destination address identifier. - example: ea95132c15732412d22c1476fa83f27a - maxLength: 32 - readOnly: true - type: string - verified: - description: The date and time the destination address has been verified. Null means not verified yet. - example: '2014-01-02T02:20:00Z' - format: date-time - readOnly: true - type: string - create_destination_address_properties: - properties: - email: - $ref: '#/components/schemas/email' - required: - - email - type: object - destination_address_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - rules_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/rules' - type: array - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 20 - total_count: - example: 1 - type: object - rules: - allOf: - - $ref: '#/components/schemas/rule_properties' - rule_properties: - properties: - actions: - $ref: '#/components/schemas/actions' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled' - matchers: - $ref: '#/components/schemas/matchers' - name: - $ref: '#/components/schemas/rules_components-schemas-name' - priority: - $ref: '#/components/schemas/components-schemas-priority' - tag: - $ref: '#/components/schemas/rule_identifier' - type: object - actions: - description: List actions patterns. - items: - $ref: '#/components/schemas/schemas-action' - type: array - rules_components-schemas-enabled: - default: true - description: Routing rule status. - enum: - - true - - false - example: true - type: boolean - matchers: - description: Matching patterns to forward to your actions. - items: - $ref: '#/components/schemas/matcher' - type: array - rules_components-schemas-name: - description: Routing rule name. - example: Send to user@example.net rule. - maxLength: 256 - type: string - components-schemas-priority: - default: 0 - description: Priority of the routing rule. - minimum: 0 - type: number - rule_identifier: - description: Routing rule identifier. - example: a7e6fb77503c41d8a7f3113c6918f10c - maxLength: 32 - readOnly: true - type: string - schemas-action: - description: Actions pattern. - properties: - type: - description: Type of supported action. - enum: - - forward - - worker - example: forward - type: string - value: - items: - description: Value for action. - example: destinationaddress@example.net - maxLength: 90 + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of results per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: direction + schema: + default: asc + description: Sorts results in an ascending or descending order. + enum: + - asc + - desc type: string - type: array - required: - - type - - value - type: object - matcher: - description: Matching pattern to forward your actions. - properties: - field: - description: Field for type matcher. - enum: - - to - example: to - type: string - type: - description: Type of matcher. - enum: - - literal - example: literal - type: string - value: - description: Value for matcher. - example: test@example.com - maxLength: 90 - type: string - required: - - type - - field - - value - type: object - create_rule_properties: - properties: - actions: - $ref: '#/components/schemas/actions' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled' - matchers: - $ref: '#/components/schemas/matchers' - name: - $ref: '#/components/schemas/rules_components-schemas-name' - priority: - $ref: '#/components/schemas/components-schemas-priority' - required: - - actions - - matchers - type: object - rule_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - catch_all_rule_response_single: - properties: - actions: - $ref: '#/components/schemas/catchall-actions' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled' - matchers: - $ref: '#/components/schemas/catchall-matchers' - name: - $ref: '#/components/schemas/rules_components-schemas-name' - tag: - $ref: '#/components/schemas/rule_identifier' - type: object - catchall-actions: - description: List actions for the catch-all routing rule. - items: - $ref: '#/components/schemas/catchall-action' - type: array - catchall-matchers: - description: List of matchers for the catch-all routing rule. - items: - $ref: '#/components/schemas/catchall-matcher' - type: array - catchall-action: - description: Action for the catch-all routing rule. - properties: - type: - description: Type of action for catch-all rule. - enum: - - drop - - forward - - worker - example: forward - type: string - value: - items: - description: Input value for action. - example: destinationaddress@example.net - maxLength: 90 + - in: query + name: verified + schema: + default: true + description: Filter by verified destination addresses. + enum: + - true + - false + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/emailDestinationAddressesResponseCollection + description: List destination addresses response + security: + - api_email: [] + api_key: [] + summary: List destination addresses + tags: + - Email Routing destination addresses + x-api-token-group: + - Email Routing Addresses Write + - Email Routing Addresses Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.routing.address.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_routing + resource_chain: + - addresses + method: list + post: + description: >- + Create a destination address to forward your emails to. Destination + addresses need to be verified before they can be used. + operationId: email-routing-destination-addresses-create-a-destination-address + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - type: array - required: - - type - type: object - catchall-matcher: - description: Matcher for catch-all routing rule. - properties: - type: - description: Type of matcher. Default is 'all'. - enum: - - all - example: all - type: string - required: - - type - type: object - update_catch_all_rule_properties: - properties: - actions: - $ref: '#/components/schemas/catchall-actions' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled' - matchers: - $ref: '#/components/schemas/catchall-matchers' - name: - $ref: '#/components/schemas/rules_components-schemas-name' - required: - - actions - - matchers - type: object - update_rule_properties: - properties: - actions: - $ref: '#/components/schemas/actions' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled' - matchers: - $ref: '#/components/schemas/matchers' - name: - $ref: '#/components/schemas/rules_components-schemas-name' - priority: - $ref: '#/components/schemas/components-schemas-priority' - required: - - actions - - matchers - type: object - email-settings_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - dns-settings_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-dns-record' - type: array - schemas-dns-record: - description: List of records needed to enable an Email Routing zone. - properties: - content: - description: DNS record content. - example: 127.0.0.1 - type: string - name: - description: DNS record name (or @ for the zone apex). - example: example.com - maxLength: 255 - type: string - priority: - description: 'Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.' - example: 10 - maximum: 65535 - minimum: 0 - type: number - ttl: - anyOf: - - example: 3600 - maximum: 86400 - minimum: 60 - type: number - - enum: - - 1 - type: number - description: 'Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ''automatic''.' - example: 3600 - type: number - type: - description: DNS record type. - enum: - - A - - AAAA - - CNAME - - HTTPS - - TXT - - SRV - - LOC - - MX - - NS - - CERT - - DNSKEY - - DS - - NAPTR - - SMIMEA - - SSHFP - - SVCB - - TLSA - - URI - example: A - readOnly: true - type: string - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_email_routing_addresses: - id: cloudflare.email_routing.accounts_email_routing_addresses - name: accounts_email_routing_addresses - title: Accounts Email Routing Addresses - methods: - destination_addresses_list_destination_addresses: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1email~1routing~1addresses/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _destination_addresses_list_destination_addresses: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1email~1routing~1addresses/get' - response: - mediaType: application/json - openAPIDocKey: '200' - destination_addresses_create_a_destination_address: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1email~1routing~1addresses/post' - response: - mediaType: application/json - openAPIDocKey: '200' - destination_addresses_delete_destination_address: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1email~1routing~1addresses~1{destination_address_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - destination_addresses_get_a_destination_address: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1email~1routing~1addresses~1{destination_address_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _destination_addresses_get_a_destination_address: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1email~1routing~1addresses~1{destination_address_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_email_routing_addresses/methods/destination_addresses_list_destination_addresses' - - $ref: '#/components/x-stackQL-resources/accounts_email_routing_addresses/methods/destination_addresses_get_a_destination_address' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_email_routing_addresses/methods/destination_addresses_create_a_destination_address' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_email_routing_addresses/methods/destination_addresses_delete_destination_address' - zones_email_routing_rules: - id: cloudflare.email_routing.zones_email_routing_rules - name: zones_email_routing_rules - title: Zones Email Routing Rules - methods: - routing_rules_list_routing_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _routing_rules_list_routing_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - routing_rules_create_routing_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - routing_rules_delete_routing_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules~1{rule_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - routing_rules_get_routing_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules~1{rule_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _routing_rules_get_routing_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules~1{rule_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - routing_rules_update_routing_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules~1{rule_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_email_routing_rules/methods/routing_rules_list_routing_rules' - - $ref: '#/components/x-stackQL-resources/zones_email_routing_rules/methods/routing_rules_get_routing_rule' - insert: - - $ref: '#/components/x-stackQL-resources/zones_email_routing_rules/methods/routing_rules_create_routing_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_email_routing_rules/methods/routing_rules_delete_routing_rule' - zones_email_routing_rules_catch_all: - id: cloudflare.email_routing.zones_email_routing_rules_catch_all - name: zones_email_routing_rules_catch_all - title: Zones Email Routing Rules Catch All - methods: - routing_rules_get_catch_all_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules~1catch_all/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _routing_rules_get_catch_all_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules~1catch_all/get' - response: - mediaType: application/json - openAPIDocKey: '200' - routing_rules_update_catch_all_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1rules~1catch_all/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_email_routing_rules_catch_all/methods/routing_rules_get_catch_all_rule' - insert: [] - update: [] - delete: [] - zones_email_routing: - id: cloudflare.email_routing.zones_email_routing - name: zones_email_routing - title: Zones Email Routing - methods: - settings_get_email_routing_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _settings_get_email_routing_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - settings_disable_email_routing: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1disable/post' - response: - mediaType: application/json - openAPIDocKey: '200' - settings_email_routing_dns_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1dns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _settings_email_routing_dns_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1dns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - settings_enable_email_routing: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1email~1routing~1enable/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_email_routing/methods/settings_get_email_routing_settings' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/email/routing/addresses': - get: - description: Lists existing destination addresses. - operationId: email-routing-destination-addresses-list-destination-addresses - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/destination_addresses_response_collection' - description: List destination addresses response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/destination_addresses_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List destination addresses response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List destination addresses - tags: - - Email Routing destination addresses - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.email.routing.address.list - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used. - operationId: email-routing-destination-addresses-create-a-destination-address - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_destination_address_properties' - required: true + $ref: '#/components/schemas/emailCreateDestinationAddressProperties' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/destination_address_response_single' + $ref: '#/components/schemas/emailDestinationAddressResponseSingle' description: Create a destination address response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/destination_address_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a destination address response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Create a destination address tags: - Email Routing destination addresses + x-api-token-group: + - Email Routing Addresses Write x-cfPermissionsRequired: enum: - com.cloudflare.api.account.email.routing.address.create @@ -788,47 +151,42 @@ paths: enterprise: true free: true pro: true - '/accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}': + x-stackql-sdk: + service: email_routing + resource_chain: + - addresses + method: create + /accounts/{account_id}/email/routing/addresses/{destination_address_identifier}: delete: description: Deletes a specific destination address. operationId: email-routing-destination-addresses-delete-destination-address parameters: - in: path name: destination_address_identifier - required: true schema: - $ref: '#/components/schemas/destination_address_identifier' - - in: path - name: account_identifier + $ref: '#/components/schemas/emailDestinationAddressIdentifier' required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/destination_address_response_single' + $ref: '#/components/schemas/emailDestinationAddressResponseSingle' description: Delete destination address response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/destination_address_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete destination address response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Delete destination address tags: - Email Routing destination addresses + x-api-token-group: + - Email Routing Addresses Write x-cfPermissionsRequired: enum: - com.cloudflare.api.account.email.routing.address.delete @@ -837,42 +195,42 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: email_routing + resource_chain: + - addresses + method: delete get: description: Gets information for a specific destination email already created. operationId: email-routing-destination-addresses-get-a-destination-address parameters: - in: path name: destination_address_identifier - required: true schema: - $ref: '#/components/schemas/destination_address_identifier' - - in: path - name: account_identifier + $ref: '#/components/schemas/emailDestinationAddressIdentifier' required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/destination_address_response_single' + $ref: '#/components/schemas/emailDestinationAddressResponseSingle' description: Get a destination address response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/destination_address_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a destination address response failure security: - api_email: [] api_key: [] - - api_token: [] summary: Get a destination address tags: - Email Routing destination addresses + x-api-token-group: + - Email Routing Addresses Write + - Email Routing Addresses Read x-cfPermissionsRequired: enum: - com.cloudflare.api.account.email.routing.address.read @@ -881,484 +239,1952 @@ paths: enterprise: true free: true pro: true - '/zones/{zone_identifier}/email/routing/rules': + x-stackql-sdk: + service: email_routing + resource_chain: + - addresses + method: get + /zones/{zone_id}/email/routing: get: - description: Lists existing routing rules. - operationId: email-routing-routing-rules-list-routing-rules + description: Get information about the settings for your Email Routing zone. + operationId: email-routing-settings-get-email-routing-settings parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rules_response_collection' - description: List routing rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rules_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List routing rules response failure + $ref: '#/components/schemas/emailEmailSettingsResponseSingle' + description: Get Email Routing settings response security: - api_email: [] api_key: [] - - api_token: [] - summary: List routing rules + summary: Get Email Routing settings tags: - - Email Routing routing rules + - Email Routing settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.rule.list + - com.cloudflare.api.account.zone.email.routing.config.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: email_routing + resource_chain: [] + method: get + /zones/{zone_id}/email/routing/disable: post: - description: Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address). - operationId: email-routing-routing-rules-create-routing-rule + deprecated: true + description: >- + Disable your Email Routing zone. Also removes additional MX records + previously required for Email Routing to work. + operationId: email-routing-settings-disable-email-routing parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: - application/json: - schema: - $ref: '#/components/schemas/create_rule_properties' - required: true + application/json: {} responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rule_response_single' - description: Create routing rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create routing rule response failure + $ref: '#/components/schemas/emailEmailSettingsResponseSingle' + description: Disable Email Routing response security: - api_email: [] api_key: [] - - api_token: [] - summary: Create routing rule + summary: Disable Email Routing tags: - - Email Routing routing rules + - Email Routing settings + x-api-token-group: + - Zone Settings Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.rule.create + - com.cloudflare.api.account.zone.email.routing.config.update x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/email/routing/rules/catch_all': - get: - description: Get information on the default catch-all routing rule. - operationId: email-routing-routing-rules-get-catch-all-rule + x-stackql-sdk: + service: email_routing + resource_chain: [] + method: disable + /zones/{zone_id}/email/routing/dns: + delete: + description: >- + Disable your Email Routing zone. Also removes additional MX records + previously required for Email Routing to work. + operationId: email-routing-settings-disable-email-routing-dns parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/catch_all_rule_response_single' - description: Get catch-all rule response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/emailDnsRecord' + type: array + required: + - errors + - success + - messages + description: Disable Email Routing response + security: + - api_email: [] + api_key: [] + summary: Disable Email Routing + tags: + - Email Routing settings + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + get: + description: Show the DNS records needed to configure your Email Routing zone. + operationId: email-routing-settings-email-routing-dns-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: subdomain + schema: + $ref: '#/components/schemas/emailEmailSettingName' + responses: + '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/catch_all_rule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get catch-all rule response failure + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + properties: + errors: + $ref: >- + #/components/schemas/emailEmailRoutingGetResponseDnsErrors + record: + items: + $ref: '#/components/schemas/emailDnsRecord' + type: array + type: object + required: + - errors + - messages + - success + description: Email Routing - DNS settings response security: - api_email: [] api_key: [] - - api_token: [] - summary: Get catch-all rule + summary: Email Routing - DNS settings tags: - - Email Routing routing rules + - Email Routing settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.rule.read + - com.cloudflare.api.account.zone.email.routing.config.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - put: - description: 'Enable or disable catch-all routing rule, or change action to forward to specific destination address.' - operationId: email-routing-routing-rules-update-catch-all-rule + x-stackql-sdk: + service: email_routing + resource_chain: + - dns + method: delete + patch: + description: Unlock MX Records previously locked by Email Routing. + operationId: email-routing-settings-unlock-email-routing-dns parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/update_catch_all_rule_properties' - required: true + $ref: '#/components/schemas/emailEmailSettingDnsRequestBody' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/catch_all_rule_response_single' - description: Update catch-all rule response - 4xx: + $ref: '#/components/schemas/emailEmailSettingsResponseSingle' + description: Unlock Email Routing MX records + security: + - api_email: [] + api_key: [] + summary: Unlock Email Routing + tags: + - Email Routing settings + x-api-token-group: + - Zone Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.zone.email.routing.config.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_routing + resource_chain: + - dns + method: edit + post: + description: >- + Enable you Email Routing zone. Add and lock the necessary MX and SPF + records. + operationId: email-routing-settings-enable-email-routing-dns + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailEmailSettingDnsRequestBody' + responses: + '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/catch_all_rule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update catch-all rule response failure + $ref: '#/components/schemas/emailEmailSettingsResponseSingle' + description: Enable Email Routing response security: - api_email: [] api_key: [] - - api_token: [] - summary: Update catch-all rule + summary: Enable Email Routing tags: - - Email Routing routing rules + - Email Routing settings + x-api-token-group: + - Zone Settings Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.rule.update + - com.cloudflare.api.account.zone.email.routing.config.update x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/email/routing/rules/{rule_identifier}': - delete: - description: Delete a specific routing rule. - operationId: email-routing-routing-rules-delete-routing-rule + x-stackql-sdk: + service: email_routing + resource_chain: + - dns + method: create + /zones/{zone_id}/email/routing/enable: + post: + deprecated: true + description: >- + Enable you Email Routing zone. Add and lock the necessary MX and SPF + records. + operationId: email-routing-settings-enable-email-routing parameters: - - in: path - name: rule_identifier - required: true - schema: - $ref: '#/components/schemas/rule_identifier' - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: {} - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rule_response_single' - description: Delete routing rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete routing rule response failure + $ref: '#/components/schemas/emailEmailSettingsResponseSingle' + description: Enable Email Routing response security: - api_email: [] api_key: [] - - api_token: [] - summary: Delete routing rule + summary: Enable Email Routing tags: - - Email Routing routing rules + - Email Routing settings + x-api-token-group: + - Zone Settings Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.rule.delete + - com.cloudflare.api.account.zone.email.routing.config.update x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: email_routing + resource_chain: [] + method: enable + /zones/{zone_id}/email/routing/rules: get: - description: Get information for a specific routing rule already created. - operationId: email-routing-routing-rules-get-routing-rule + description: Lists existing routing rules. + operationId: email-routing-routing-rules-list-routing-rules parameters: - - in: path - name: rule_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/rule_identifier' - - in: path - name: zone_identifier - required: true + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + default: 20 + description: Maximum number of results per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: enabled + schema: + description: Filter by enabled routing rules. + enum: + - true + - false + type: boolean responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rule_response_single' - description: Get routing rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get routing rule response failure + $ref: '#/components/schemas/emailRulesResponseCollection' + description: List routing rules response security: - api_email: [] api_key: [] - - api_token: [] - summary: Get routing rule + summary: List routing rules tags: - Email Routing routing rules + x-api-token-group: + - Email Routing Rules Write + - Email Routing Rules Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.rule.read + - com.cloudflare.api.account.zone.email.routing.rule.list x-cfPlanAvailability: business: true enterprise: true free: true pro: true - put: - description: 'Update actions and matches, or enable/disable specific routing rules.' - operationId: email-routing-routing-rules-update-routing-rule + x-stackql-sdk: + service: email_routing + resource_chain: + - rules + method: list + post: + description: >- + Rules consist of a set of criteria for matching emails (such as an email + being sent to a specific custom email address) plus a set of actions to + take on the email (like forwarding it to a specific destination + address). Forward actions require all destination addresses to be + verified. + operationId: email-routing-routing-rules-create-routing-rule parameters: - - in: path - name: rule_identifier - required: true - schema: - $ref: '#/components/schemas/rule_identifier' - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/update_rule_properties' - required: true + $ref: '#/components/schemas/emailCreateRuleProperties' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rule_response_single' - description: Update routing rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update routing rule response failure + $ref: '#/components/schemas/emailRuleResponseSingle' + description: Create routing rule response + '400': + description: >- + Error 2054: Destination address is not verified. All forward action + destination addresses must be verified before they can be used in + rules. security: - api_email: [] api_key: [] - - api_token: [] - summary: Update routing rule + summary: Create routing rule tags: - Email Routing routing rules + x-api-token-group: + - Email Routing Rules Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.rule.update + - com.cloudflare.api.account.zone.email.routing.rule.create x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/email/routing': + x-stackql-sdk: + service: email_routing + resource_chain: + - rules + method: create + /zones/{zone_id}/email/routing/rules/catch_all: get: - description: Get information about the settings for your Email Routing zone. - operationId: email-routing-settings-get-email-routing-settings + description: Get information on the default catch-all routing rule. + operationId: email-routing-routing-rules-get-catch-all-rule parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/email-settings_response_single' - description: Get Email Routing settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/email-settings_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Email Routing settings response failure + $ref: '#/components/schemas/emailCatchAllRuleResponseSingle' + description: Get catch-all rule response security: - api_email: [] api_key: [] - - api_token: [] - summary: Get Email Routing settings + summary: Get catch-all rule tags: - - Email Routing settings + - Email Routing routing rules + x-api-token-group: + - Email Routing Rules Write + - Email Routing Rules Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.config.read + - com.cloudflare.api.account.zone.email.routing.rule.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/email/routing/disable': - post: - description: Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work. - operationId: email-routing-settings-disable-email-routing + x-stackql-sdk: + service: email_routing + resource_chain: + - rules + - catch_alls + method: get + put: + description: >- + Enable or disable catch-all routing rule, or change action to forward to + specific destination address. Forward actions require all destination + addresses to be verified. + operationId: email-routing-routing-rules-update-catch-all-rule parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: - application/json: {} - required: true + application/json: + schema: + $ref: '#/components/schemas/emailUpdateCatchAllRuleProperties' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/email-settings_response_single' - description: Disable Email Routing response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/email-settings_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Disable Email Routing response failure + $ref: '#/components/schemas/emailCatchAllRuleResponseSingle' + description: Update catch-all rule response + '400': + description: >- + Error 2054: Destination address is not verified. All forward action + destination addresses must be verified before they can be used in + rules. security: - api_email: [] api_key: [] - - api_token: [] - summary: Disable Email Routing + summary: Update catch-all rule tags: - - Email Routing settings + - Email Routing routing rules + x-api-token-group: + - Email Routing Rules Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.config.update + - com.cloudflare.api.account.zone.email.routing.rule.update x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/email/routing/dns': - get: - description: Show the DNS records needed to configure your Email Routing zone. - operationId: email-routing-settings-email-routing-dns-settings + x-stackql-sdk: + service: email_routing + resource_chain: + - rules + - catch_alls + method: update + /zones/{zone_id}/email/routing/rules/{rule_identifier}: + delete: + description: Delete a specific routing rule. + operationId: email-routing-routing-rules-delete-routing-rule parameters: - in: path - name: zone_identifier + name: rule_identifier + schema: + $ref: '#/components/schemas/emailRuleIdentifier' required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/dns-settings_response_collection' - description: Email Routing - DNS settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dns-settings_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Email Routing - DNS settings response failure + $ref: '#/components/schemas/emailRuleResponseSingle' + description: Delete routing rule response security: - api_email: [] api_key: [] - - api_token: [] - summary: Email Routing - DNS settings + summary: Delete routing rule tags: - - Email Routing settings + - Email Routing routing rules + x-api-token-group: + - Email Routing Rules Write x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.config.read + - com.cloudflare.api.account.zone.email.routing.rule.delete x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/email/routing/enable': - post: - description: Enable you Email Routing zone. Add and lock the necessary MX and SPF records. - operationId: email-routing-settings-enable-email-routing + x-stackql-sdk: + service: email_routing + resource_chain: + - rules + method: delete + get: + description: Get information for a specific routing rule already created. + operationId: email-routing-routing-rules-get-routing-rule parameters: - in: path - name: zone_identifier + name: rule_identifier + schema: + $ref: '#/components/schemas/emailRuleIdentifier' required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/email-settings_response_single' - description: Enable Email Routing response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/email-settings_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Enable Email Routing response failure + $ref: '#/components/schemas/emailRuleResponseSingle' + description: Get routing rule response security: - api_email: [] api_key: [] - - api_token: [] - summary: Enable Email Routing + summary: Get routing rule tags: - - Email Routing settings + - Email Routing routing rules + x-api-token-group: + - Email Routing Rules Write + - Email Routing Rules Read x-cfPermissionsRequired: enum: - - com.cloudflare.api.account.zone.email.routing.config.update + - com.cloudflare.api.account.zone.email.routing.rule.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: email_routing + resource_chain: + - rules + method: get + put: + description: >- + Update actions and matches, or enable/disable specific routing rules. + Forward actions require all destination addresses to be verified. + operationId: email-routing-routing-rules-update-routing-rule + parameters: + - in: path + name: rule_identifier + schema: + $ref: '#/components/schemas/emailRuleIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailUpdateRuleProperties' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailRuleResponseSingle' + description: Update routing rule response + '400': + description: >- + Error 2054: Destination address is not verified. All forward action + destination addresses must be verified before they can be used in + rules. + security: + - api_email: [] + api_key: [] + summary: Update routing rule + tags: + - Email Routing routing rules + x-api-token-group: + - Email Routing Rules Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.zone.email.routing.rule.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_routing + resource_chain: + - rules + method: update + /zones/{zone_id}/email/routing/suppression: + get: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 0 + type: integer + - in: query + name: per_page + schema: + default: 100 + maximum: 1000 + minimum: 0 + type: integer + - in: query + name: order + schema: + default: created_at + enum: + - email + - expires_at + - created_at + type: string + - in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + page: + type: integer + per_page: + type: integer + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + type: array + total: + type: integer + required: + - page + - per_page + - total + - result + type: object + description: Returns suppressed emails. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: List account or zone email suppressions + tags: [] + operationId: get_zones_zone_id_email_routing_suppression + post: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + required: + - email + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + format: uuid + type: string + required: + - id + type: object + required: + - result + type: object + description: Returns suppression. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: Create account or zone email suppression + tags: [] + operationId: post_zones_zone_id_email_routing_suppression + /zones/{zone_id}/email/routing/suppression/{suppression_id}: + get: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + required: + - result + type: object + description: Returns suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Get account or zone email suppression + tags: [] + operationId: get_zones_zone_id_email_routing_suppression_suppression_id + delete: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + success: + type: boolean + required: + - success + type: object + description: Deletes suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Delete account or zone email suppression + tags: [] + operationId: delete_zones_zone_id_email_routing_suppression_suppression_id +components: + schemas: + emailAddresses: + type: object + $ref: '#/components/schemas/emailDestinationAddressProperties' + emailCatchAllRule: + properties: + actions: + $ref: '#/components/schemas/emailRuleCatchallActions' + enabled: + $ref: '#/components/schemas/emailRuleEnabled' + id: + $ref: '#/components/schemas/emailRuleIdentifier' + matchers: + $ref: '#/components/schemas/emailRuleCatchallMatchers' + name: + $ref: '#/components/schemas/emailRuleName' + tag: + $ref: '#/components/schemas/emailRuleTag' + type: object + emailCatchAllRuleResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/emailCatchAllRule' + required: + - success + - errors + - messages + emailCreateDestinationAddressProperties: + properties: + email: + $ref: '#/components/schemas/emailEmail' + required: + - email + type: object + emailCreateRuleProperties: + properties: + actions: + $ref: '#/components/schemas/emailRuleActions' + enabled: + $ref: '#/components/schemas/emailRuleEnabled' + matchers: + $ref: '#/components/schemas/emailRuleMatchers' + name: + $ref: '#/components/schemas/emailRuleName' + priority: + $ref: '#/components/schemas/emailRulePriority' + required: + - actions + - matchers + type: object + emailCreated: + description: The date and time the destination address has been created. + example: '2014-01-02T02:20:00Z' + format: date-time + readOnly: true + type: string + emailDestinationAddressIdentifier: + description: Destination address identifier. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + readOnly: true + type: string + x-auditable: true + emailDestinationAddressProperties: + properties: + created: + $ref: '#/components/schemas/emailCreated' + email: + $ref: '#/components/schemas/emailEmail' + id: + $ref: '#/components/schemas/emailDestinationAddressIdentifier' + modified: + $ref: '#/components/schemas/emailModified' + tag: + $ref: '#/components/schemas/emailDestinationAddressTag' + verified: + $ref: '#/components/schemas/emailVerified' + type: object + emailDestinationAddressResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/emailAddresses' + required: + - success + - errors + - messages + emailDestinationAddressTag: + deprecated: true + description: >- + Destination address tag. (Deprecated, replaced by destination address + identifier) + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + readOnly: true + type: string + emailDestinationAddressesResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 1 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/emailAddresses' + type: array + required: + - success + - errors + - messages + emailDnsRecord: + description: List of records needed to enable an Email Routing zone. + properties: + content: + description: DNS record content. + example: route1.mx.cloudflare.net + type: string + name: + description: DNS record name (or @ for the zone apex). + example: example.com + maxLength: 255 + type: string + x-auditable: true + priority: + description: >- + Required for MX, SRV and URI records. Unused by other record types. + Records with lower priorities are preferred. + example: 12 + maximum: 65535 + minimum: 0 + type: number + x-auditable: true + ttl: + description: >- + Time to live, in seconds, of the DNS record. Must be between 60 and + 86400, or 1 for 'automatic'. + example: 1 + type: number + x-auditable: true + enum: + - 1 + type: + description: DNS record type. + enum: + - A + - AAAA + - CNAME + - HTTPS + - TXT + - SRV + - LOC + - MX + - NS + - CERT + - DNSKEY + - DS + - NAPTR + - SMIMEA + - SSHFP + - SVCB + - TLSA + - URI + example: NS + readOnly: true + type: string + x-auditable: true + type: object + emailEmail: + description: The contact email address of the user. + example: user@example.com + maxLength: 90 + type: string + x-auditable: true + emailEmailRoutingGetResponseDnsError: + properties: + code: + type: string + missing: + $ref: '#/components/schemas/emailDnsRecord' + type: object + emailEmailRoutingGetResponseDnsErrors: + items: + $ref: '#/components/schemas/emailEmailRoutingGetResponseDnsError' + type: array + emailEmailSettingCreated: + description: The date and time the settings have been created. + example: '2014-01-02T02:20:00Z' + format: date-time + readOnly: true + type: string + emailEmailSettingDnsRequestBody: + nullable: true + properties: + name: + $ref: '#/components/schemas/emailEmailSettingName' + type: object + emailEmailSettingEnabled: + description: State of the zone settings for Email Routing. + enum: + - true + - false + example: true + readOnly: true + type: boolean + x-auditable: true + emailEmailSettingIdentifier: + description: Email Routing settings identifier. + example: 75610dab9e69410a82cf7e400a09ecec + maxLength: 32 + readOnly: true + type: string + x-auditable: true + emailEmailSettingModified: + description: The date and time the settings have been modified. + example: '2014-01-02T02:20:00Z' + format: date-time + readOnly: true + type: string + emailEmailSettingName: + description: Domain of your zone. + example: example.net + type: string + x-auditable: true + emailEmailSettingSkipWizard: + description: Flag to check if the user skipped the configuration wizard. + enum: + - true + - false + example: true + readOnly: true + type: boolean + emailEmailSettingStatus: + description: Show the state of your account, and the type or configuration error. + enum: + - ready + - unconfigured + - misconfigured + - misconfigured/locked + - unlocked + example: ready + readOnly: true + type: string + emailEmailSettingTag: + deprecated: true + description: >- + Email Routing settings tag. (Deprecated, replaced by Email Routing + settings identifier) + example: 75610dab9e69410a82cf7e400a09ecec + maxLength: 32 + readOnly: true + type: string + emailEmailSettingsProperties: + properties: + created: + $ref: '#/components/schemas/emailEmailSettingCreated' + enabled: + $ref: '#/components/schemas/emailEmailSettingEnabled' + id: + $ref: '#/components/schemas/emailEmailSettingIdentifier' + modified: + $ref: '#/components/schemas/emailEmailSettingModified' + name: + $ref: '#/components/schemas/emailEmailSettingName' + skip_wizard: + $ref: '#/components/schemas/emailEmailSettingSkipWizard' + status: + $ref: '#/components/schemas/emailEmailSettingStatus' + tag: + $ref: '#/components/schemas/emailEmailSettingTag' + required: + - id + - name + - enabled + type: object + emailEmailSettingsResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/emailSettings' + required: + - success + - errors + - messages + emailMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + emailModified: + description: The date and time the destination address was last modified. + example: '2014-01-02T02:20:00Z' + format: date-time + readOnly: true + type: string + emailRuleAction: + description: Actions pattern. + properties: + type: + description: Type of supported action. + enum: + - drop + - forward + - worker + example: forward + type: string + x-auditable: true + value: + items: + description: Value for action. + example: destinationaddress@example.net + maxLength: 90 + type: string + x-auditable: true + type: array + required: + - type + type: object + emailRuleActions: + description: List actions patterns. + items: + $ref: '#/components/schemas/emailRuleAction' + maxItems: 1 + minItems: 1 + type: array + emailRuleCatchallAction: + description: Action for the catch-all routing rule. + properties: + type: + description: Type of action for catch-all rule. + enum: + - drop + - forward + - worker + example: forward + type: string + x-auditable: true + value: + items: + description: Input value for action. + example: destinationaddress@example.net + maxLength: 90 + type: string + x-auditable: true + type: array + required: + - type + type: object + emailRuleCatchallActions: + description: List actions for the catch-all routing rule. + items: + $ref: '#/components/schemas/emailRuleCatchallAction' + maxItems: 1 + minItems: 1 + type: array + emailRuleCatchallMatcher: + description: Matcher for catch-all routing rule. + properties: + type: + description: Type of matcher. Default is 'all'. + enum: + - all + example: all + type: string + x-auditable: true + required: + - type + type: object + emailRuleCatchallMatchers: + description: List of matchers for the catch-all routing rule. + items: + $ref: '#/components/schemas/emailRuleCatchallMatcher' + type: array + emailRuleEnabled: + default: true + description: Routing rule status. + enum: + - true + - false + example: true + type: boolean + x-auditable: true + emailRuleIdentifier: + description: Routing rule identifier. + example: a7e6fb77503c41d8a7f3113c6918f10c + maxLength: 32 + readOnly: true + type: string + x-auditable: true + emailRuleMatcher: + description: Matching pattern to forward your actions. + properties: + field: + description: Field for type matcher. + enum: + - to + example: to + type: string + x-auditable: true + type: + description: Type of matcher. + enum: + - all + - literal + example: literal + type: string + x-auditable: true + value: + description: Value for matcher. + example: test@example.com + maxLength: 90 + type: string + x-auditable: true + required: + - type + type: object + emailRuleMatchers: + description: Matching patterns to forward to your actions. + items: + $ref: '#/components/schemas/emailRuleMatcher' + type: array + emailRuleName: + description: Routing rule name. + example: Send to user@example.net rule. + maxLength: 256 + type: string + x-auditable: true + emailRulePriority: + default: 0 + description: Priority of the routing rule. + minimum: 0 + type: number + x-auditable: true + emailRuleProperties: + properties: + actions: + $ref: '#/components/schemas/emailRuleActions' + enabled: + $ref: '#/components/schemas/emailRuleEnabled' + id: + $ref: '#/components/schemas/emailRuleIdentifier' + matchers: + $ref: '#/components/schemas/emailRuleMatchers' + name: + $ref: '#/components/schemas/emailRuleName' + priority: + $ref: '#/components/schemas/emailRulePriority' + tag: + $ref: '#/components/schemas/emailRuleTag' + type: object + emailRuleResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/emailRules' + required: + - success + - errors + - messages + emailRuleTag: + deprecated: true + description: Routing rule tag. (Deprecated, replaced by routing rule identifier) + example: a7e6fb77503c41d8a7f3113c6918f10c + maxLength: 32 + readOnly: true + type: string + emailRules: + type: object + $ref: '#/components/schemas/emailRuleProperties' + emailRulesResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 1 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/emailRules' + type: array + required: + - success + - errors + - messages + emailSettings: + type: object + $ref: '#/components/schemas/emailEmailSettingsProperties' + emailUpdateCatchAllRuleProperties: + properties: + actions: + $ref: '#/components/schemas/emailRuleCatchallActions' + enabled: + $ref: '#/components/schemas/emailRuleEnabled' + matchers: + $ref: '#/components/schemas/emailRuleCatchallMatchers' + name: + $ref: '#/components/schemas/emailRuleName' + required: + - actions + - matchers + type: object + emailUpdateRuleProperties: + properties: + actions: + $ref: '#/components/schemas/emailRuleActions' + enabled: + $ref: '#/components/schemas/emailRuleEnabled' + matchers: + $ref: '#/components/schemas/emailRuleMatchers' + name: + $ref: '#/components/schemas/emailRuleName' + priority: + $ref: '#/components/schemas/emailRulePriority' + required: + - actions + - matchers + type: object + emailVerified: + description: >- + The date and time the destination address has been verified. Null means + not verified yet. + example: '2014-01-02T02:20:00Z' + format: date-time + readOnly: true + type: string + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + addresses: + id: cloudflare.email_routing.addresses + name: addresses + title: Addresses + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1routing~1addresses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1routing~1addresses/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email~1routing~1addresses~1{destination_address_identifier}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email~1routing~1addresses~1{destination_address_identifier}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/addresses/methods/get' + - $ref: '#/components/x-stackQL-resources/addresses/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/addresses/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/addresses/methods/delete' + replace: [] + routing: + id: cloudflare.email_routing.routing + name: routing + title: Routing + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing/get' + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns: + id: cloudflare.email_routing.dns + name: dns + title: Dns + methods: + email_routing_settings_disable_email_routing_dns: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1dns/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1dns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.record + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1dns/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1dns/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dns/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dns/methods/edit' + delete: + - $ref: >- + #/components/x-stackQL-resources/dns/methods/email_routing_settings_disable_email_routing_dns + replace: [] + rules: + id: cloudflare.email_routing.rules + name: rules + title: Rules + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1routing~1rules~1{rule_identifier}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1routing~1rules~1{rule_identifier}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1routing~1rules~1{rule_identifier}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get' + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/rules/methods/update' + catch_alls: + id: cloudflare.email_routing.catch_alls + name: catch_alls + title: Catch Alls + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1rules~1catch_all/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1rules~1catch_all/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/catch_alls/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/catch_alls/methods/update' + suppression: + id: cloudflare.email_routing.suppression + name: suppression + title: Suppression + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1suppression/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_zones_zone_id_email_routing_suppression: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1routing~1suppression/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1routing~1suppression~1{suppression_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_zones_zone_id_email_routing_suppression_suppression_id: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1routing~1suppression~1{suppression_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/suppression/methods/get' + - $ref: '#/components/x-stackQL-resources/suppression/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/suppression/methods/post_zones_zone_id_email_routing_suppression + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/suppression/methods/delete_zones_zone_id_email_routing_suppression_suppression_id + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/email_security.yaml b/providers/src/cloudflare/v00.00.00000/services/email_security.yaml new file mode 100644 index 00000000..00cfb422 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/email_security.yaml @@ -0,0 +1,6341 @@ +openapi: 3.0.3 +info: + title: email_security API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/email-security/investigate: + get: + description: Returns information for each email that matches the search parameter(s). + operationId: email_security_investigate + parameters: + - description: The beginning of the search date range. Defaults to `now - 30 days`. + in: query + name: start + schema: + format: date-time + type: string + - description: The end of the search date range. Defaults to `now`. + in: query + name: end + schema: + format: date-time + type: string + - description: Space-delimited search term. Case-insensitive. + in: query + name: query + schema: + type: string + - description: Whether to include only detections in search results. + in: query + name: detections_only + schema: + default: true + type: boolean + - description: Whether to include the message action log in the response. + in: query + name: action_log + schema: + default: true + type: boolean + - description: Dispositions to filter by. + in: query + name: final_disposition + schema: + enum: + - MALICIOUS + - SUSPICIOUS + - SPOOF + - SPAM + - BULK + - NONE + type: string + - in: query + name: metric + schema: + type: string + - description: Message actions to filter by. + in: query + name: message_action + schema: + enum: + - PREVIEW + - QUARANTINE_RELEASED + - MOVED + type: string + - in: query + name: recipient + schema: + type: string + - in: query + name: sender + schema: + type: string + - in: query + name: alert_id + schema: + type: string + - description: Sender domains to filter by. + in: query + name: domain + schema: + type: string + - in: query + name: message_id + schema: + type: string + - in: query + name: subject + schema: + type: string + - in: query + name: cursor + schema: + type: string + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - deprecated: true + description: >- + Deprecated: Use cursor pagination instead. End of life: November 1, + 2026. + in: query + name: page + schema: + default: 1 + minimum: 1 + nullable: true + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/emailSecurityMessageDetails' + type: array + result_info: + $ref: '#/components/schemas/emailSecurityCursorResultInfo' + required: + - success + - errors + - messages + - result + - result_info + type: object + description: Search results for the provided query. + '202': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + description: >- + Always empty on 202; follow the Location header to + retrieve results. + items: {} + maxItems: 0 + type: array + result_info: + $ref: '#/components/schemas/emailSecurityCursorResultInfo' + required: + - success + - errors + - messages + - result + - result_info + type: object + description: >- + The search is taking longer than expected. Use the Location header + to poll for results. + headers: + Location: + description: URL to poll for search results + schema: + type: string + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search email messages + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + method: list + /accounts/{account_id}/email-security/investigate/move: + post: + description: >- + Moves multiple messages to a specified mailbox folder (Inbox, JunkEmail, + DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). + Requires active integration. + operationId: email_security_post_bulk_move + requestBody: + content: + application/json: + schema: + properties: + destination: + $ref: '#/components/schemas/emailSecurityMailboxDestination' + ids: + description: List of message IDs to move + items: + $ref: '#/components/schemas/emailSecurityInvestigateId' + type: array + x-auditable: true + postfix_ids: + deprecated: true + description: >- + Deprecated, use `ids` instead. End of life: November 1, + 2026. List of message IDs to move. + items: + $ref: '#/components/schemas/emailSecurityPostfixId' + type: array + x-auditable: true + required: + - destination + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/emailSecurityMoveResponseItem' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Bulk move operation results + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Move multiple messages + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/email-security/investigate/preview: + post: + description: >- + Generates a preview image for a message that was not flagged as a + detection. Useful for investigating benign messages. Returns a + base64-encoded PNG screenshot of the email body. + operationId: email_security_post_preview + requestBody: + content: + application/json: + schema: + properties: + postfix_id: + $ref: '#/components/schemas/emailSecurityPostfixId' + required: + - postfix_id + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityMessagePreview' + required: + - success + - errors + - messages + - result + type: object + description: Email preview. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Preview for non-detection messages + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + - preview + method: create + /accounts/{account_id}/email-security/investigate/release: + post: + description: >- + Releases one or more quarantined messages, delivering them to the + intended recipients. Use when a message was incorrectly quarantined. + Returns delivery status for each recipient. + operationId: email_security_post_release + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/emailSecurityInvestigateId' + type: array + description: A list of investigate IDs identifying the messages to release. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/emailSecurityReleaseResponse' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Release operation results. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Release messages from quarantine + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/email-security/investigate/{investigate_id}: + get: + description: >- + Retrieves comprehensive details for a specific email message including + headers, recipients, sender information, and current quarantine status. + Use the investigate_id from search results to fetch detailed + information. + operationId: email_security_get_message + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityMessageDetails' + required: + - success + - errors + - messages + - result + type: object + description: Email message details. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get message details + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + - description: >- + When true, search the submissions datastore only. When false or + omitted, search the regular datastore only. + in: query + name: submission + schema: + type: boolean + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + method: get + /accounts/{account_id}/email-security/investigate/{investigate_id}/action_log: + get: + description: >- + Returns the list of post-delivery actions (moves, quarantine releases, + previews, etc.) that have been applied to a specific email message. + operationId: email_security_get_message_action_log + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/emailSecurityActionEntry' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Action log for the email + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get action log for a message + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + /accounts/{account_id}/email-security/investigate/{investigate_id}/detections: + get: + description: >- + Returns detection details such as threat categories and sender + information for non-benign messages. + operationId: email_security_get_message_detections + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityMessageDetectionDetails' + required: + - success + - errors + - messages + - result + type: object + description: Email message detection details. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get message detection details + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + - detections + method: get + /accounts/{account_id}/email-security/investigate/{investigate_id}/move: + post: + description: >- + Moves a single message to a specified mailbox folder (Inbox, JunkEmail, + DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). + Requires active integration. + operationId: email_security_post_message_move + requestBody: + content: + application/json: + schema: + properties: + destination: + $ref: '#/components/schemas/emailSecurityMailboxDestination' + required: + - destination + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/emailSecurityMoveResponseItem' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Move operation results + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Move a message + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + /accounts/{account_id}/email-security/investigate/{investigate_id}/preview: + get: + description: >- + Returns a preview of the message body as a base64 encoded PNG image for + non-benign messages. + operationId: email_security_get_message_preview + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityMessagePreview' + required: + - success + - errors + - messages + - result + type: object + description: Email preview + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email preview + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + - preview + method: get + /accounts/{account_id}/email-security/investigate/{investigate_id}/raw: + get: + description: Returns the raw eml of any non-benign message. + operationId: email_security_get_message_raw + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityMessageRaw' + required: + - success + - errors + - messages + - result + type: object + description: Raw email content. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get raw email content + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + - raw + method: get + /accounts/{account_id}/email-security/investigate/{investigate_id}/reclassify: + post: + description: >- + Submits a request to reclassify an email's disposition. Use for + reporting false positives or false negatives. Optionally provide the raw + EML content for reanalysis. The reclassification is processed + asynchronously. + operationId: email_security_post_reclassify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityReclassifyRequest' + responses: + '202': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + type: object + required: + - success + - errors + - messages + - result + type: object + description: Reclassification request accepted. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Change email classification + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + - reclassify + method: create + /accounts/{account_id}/email-security/investigate/{investigate_id}/trace: + get: + description: >- + Retrieves delivery and processing trace information for an email + message. Shows the delivery path, retraction history, and move + operations performed on the message. Useful for debugging delivery + issues. + operationId: email_security_get_message_trace + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityMessageTrace' + required: + - success + - errors + - messages + - result + type: object + description: Email trace. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email trace + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: investigate_id + schema: + $ref: '#/components/schemas/emailSecurityInvestigateId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - investigate + - trace + method: get + /accounts/{account_id}/email-security/phishguard/reports: + get: + description: >- + Retrieves PhishGuard security alert reports for a specified date range. + Reports include detected threats, dispositions, and contextual + information. Use for security monitoring and threat analysis. + operationId: email_security_get_phishguard_reports + parameters: + - description: Start of the time range (RFC3339). Takes precedence over from_date. + in: query + name: start + schema: + format: date-time + type: string + - description: End of the time range (RFC3339). Takes precedence over to_date. + in: query + name: end + schema: + format: date-time + type: string + - deprecated: true + description: Deprecated, use `start` instead. Start date in YYYY-MM-DD format. + in: query + name: from_date + schema: + format: date + type: string + - deprecated: true + description: Deprecated, use `end` instead. End date in YYYY-MM-DD format. + in: query + name: to_date + schema: + format: date + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/emailSecurityPhishGuardReport' + type: array + required: + - success + - errors + - messages + - result + type: object + description: List of PhishGuard reports + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get PhishGuard reports + tags: + - Email Security + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + x-stackql-sdk: + service: email_security + resource_chain: + - phishguard + - reports + method: list + /accounts/{account_id}/email-security/settings/allow_policies: + get: + description: >- + Returns a paginated list of email allow policies. These policies exempt + matching emails from security detection, allowing them to bypass + disposition actions. Supports filtering by pattern type and policy + attributes. + operationId: email_security_list_allow_policies + parameters: + - description: Current page within paginated list of results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - description: Search term for filtering records. Behavior may change. + in: query + name: search + schema: + type: string + - description: Field to sort by. + in: query + name: order + schema: + enum: + - pattern + - created_at + type: string + - description: The sorting direction. + in: query + name: direction + schema: + enum: + - asc + - desc + type: string + - description: >- + Filter to show only policies where messages to the recipient bypass + all detections. + in: query + name: is_exempt_recipient + schema: + type: boolean + - description: >- + Filter to show only policies where messages from the sender bypass + all detections and link following. + in: query + name: is_trusted_sender + schema: + type: boolean + - description: >- + Filter to show only policies where messages from the sender are + exempted from Spam, Spoof, and Bulk dispositions (not Malicious or + Suspicious). + in: query + name: is_acceptable_sender + schema: + type: boolean + - description: >- + Filter to show only policies that enforce DMARC, SPF, or DKIM + authentication. + in: query + name: verify_sender + schema: + type: boolean + - in: query + name: pattern_type + schema: + $ref: '#/components/schemas/emailSecurityPatternType' + - in: query + name: pattern + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: '#/components/schemas/emailSecurityAllowPolicyList' + required: + - success + - errors + - messages + description: List of allow policies + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List email allow policies + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - allow_policies + method: list + post: + description: >- + Creates a new allow policy that exempts matching emails from security + detections. Use with caution as this bypasses email security scanning. + Policies can match on sender patterns and apply to specific detections + or all detections. + operationId: email_security_create_allow_policy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityCreateAllowPolicy' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityAllowPolicy' + required: + - success + - errors + - messages + description: Created allow policy + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create email allow policy + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - allow_policies + method: create + /accounts/{account_id}/email-security/settings/allow_policies/batch: + post: + description: >- + Execute multiple operations atomically. All four operation arrays + (deletes, patches, puts, posts) are required and executed in order. Send + empty arrays for unused operations. + operationId: email_security_batch_allow_policies + requestBody: + content: + application/json: + schema: + properties: + deletes: + items: + properties: + id: + $ref: '#/components/schemas/emailSecurityAllowPolicyId' + required: + - id + type: object + maxItems: 1000 + type: array + patches: + items: + description: An email allow policy + minProperties: 1 + properties: + comments: + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityAllowPolicyId' + is_acceptable_sender: + description: >- + Messages from this sender will be exempted from Spam, + Spoof and Bulk dispositions. Note - This will not + exempt messages with Malicious or Suspicious + dispositions. + type: boolean + x-auditable: true + is_exempt_recipient: + description: Messages to this recipient will bypass all detections + type: boolean + x-auditable: true + is_recipient: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use + `is_exempt_recipient` instead. End of life: July 1, + 2026. + type: boolean + x-auditable: true + is_regex: + type: boolean + x-auditable: true + is_sender: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use `is_trusted_sender` + instead. End of life: July 1, 2026. + type: boolean + x-auditable: true + is_spoof: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use + `is_acceptable_sender` instead. End of life: July 1, + 2026. + type: boolean + x-auditable: true + is_trusted_sender: + description: >- + Messages from this sender will bypass all detections + and link following + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: + November 1, 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + pattern_type: + $ref: '#/components/schemas/emailSecurityPatternType' + verify_sender: + description: >- + Enforce DMARC, SPF or DKIM authentication. When on, + Email Security only honors policies that pass + authentication. + type: boolean + x-auditable: true + required: + - id + - created_at + - last_modified + - id + type: object + maxItems: 1000 + type: array + posts: + items: + $ref: '#/components/schemas/emailSecurityCreateAllowPolicy' + maxItems: 1000 + type: array + puts: + items: + description: An email allow policy + properties: + comments: + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityAllowPolicyId' + is_acceptable_sender: + description: >- + Messages from this sender will be exempted from Spam, + Spoof and Bulk dispositions. Note - This will not + exempt messages with Malicious or Suspicious + dispositions. + type: boolean + x-auditable: true + is_exempt_recipient: + description: Messages to this recipient will bypass all detections + type: boolean + x-auditable: true + is_recipient: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use + `is_exempt_recipient` instead. End of life: July 1, + 2026. + type: boolean + x-auditable: true + is_regex: + type: boolean + x-auditable: true + is_sender: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use `is_trusted_sender` + instead. End of life: July 1, 2026. + type: boolean + x-auditable: true + is_spoof: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use + `is_acceptable_sender` instead. End of life: July 1, + 2026. + type: boolean + x-auditable: true + is_trusted_sender: + description: >- + Messages from this sender will bypass all detections + and link following + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: + November 1, 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + pattern_type: + $ref: '#/components/schemas/emailSecurityPatternType' + verify_sender: + description: >- + Enforce DMARC, SPF or DKIM authentication. When on, + Email Security only honors policies that pass + authentication. + type: boolean + x-auditable: true + required: + - id + - created_at + - last_modified + - id + type: object + maxItems: 1000 + type: array + required: + - deletes + - patches + - puts + - posts + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + deletes: + items: + $ref: '#/components/schemas/emailSecurityDeletedAllowPolicy' + type: array + patches: + $ref: '#/components/schemas/emailSecurityAllowPolicyList' + posts: + $ref: '#/components/schemas/emailSecurityAllowPolicyList' + puts: + $ref: '#/components/schemas/emailSecurityAllowPolicyList' + type: object + required: + - success + - errors + - messages + description: Batch operation results + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Batch allow policies operations + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/email-security/settings/allow_policies/{policy_id}: + delete: + description: >- + Removes an allow policy. After deletion, emails matching this pattern + will be subject to normal security scanning and disposition actions. + operationId: email_security_delete_allow_policy + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityDeletedAllowPolicy' + required: + - success + - errors + - messages + description: Deleted allow policy + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an email allow policy + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - allow_policies + method: delete + get: + description: >- + Retrieves details for a specific allow policy including its pattern, + dispositions that are exempted, and whether it applies to all + detections. + operationId: email_security_get_allow_policy + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityAllowPolicy' + required: + - success + - errors + - messages + description: Allow policy details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an email allow policy + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - allow_policies + method: get + patch: + description: >- + Updates an existing allow policy. Only provided fields will be modified. + Changes take effect for new emails matching the pattern. + operationId: email_security_update_allow_policy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityUpdateAllowPolicy' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityAllowPolicy' + required: + - success + - errors + - messages + description: Updated allow policy + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an email allow policy + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - allow_policies + method: edit + /accounts/{account_id}/email-security/settings/block_senders: + get: + description: >- + Returns a paginated list of blocked email sender patterns. These + patterns prevent emails from matching senders from being delivered. + Supports filtering by pattern type and searching across patterns. + operationId: email_security_list_blocked_senders + parameters: + - description: Current page within paginated list of results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - description: Search term for filtering records. Behavior may change. + in: query + name: search + schema: + type: string + - description: Field to sort by. + in: query + name: order + schema: + enum: + - pattern + - created_at + type: string + - description: The sorting direction. + in: query + name: direction + schema: + enum: + - asc + - desc + type: string + - description: Filter by pattern type. + in: query + name: pattern_type + schema: + $ref: '#/components/schemas/emailSecurityPatternType' + - description: Filter by pattern value. + in: query + name: pattern + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: '#/components/schemas/emailSecurityBlockedSenderList' + required: + - success + - errors + - messages + description: List of blocked senders + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List blocked email senders + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - block_senders + method: list + post: + description: >- + Creates a new blocked sender pattern. Emails matching this pattern will + be blocked from delivery. Patterns can be email addresses, domains, or + IP addresses, and support regular expressions. + operationId: email_security_create_blocked_sender + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityCreateBlockedSender' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityBlockedSender' + required: + - success + - errors + - messages + description: Created blocked sender + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create blocked email sender + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - block_senders + method: create + /accounts/{account_id}/email-security/settings/block_senders/batch: + post: + description: >- + Execute multiple operations atomically. All four operation arrays + (deletes, patches, puts, posts) are required and executed in order. Send + empty arrays for unused operations. + operationId: email_security_batch_blocked_senders + requestBody: + content: + application/json: + schema: + properties: + deletes: + items: + properties: + id: + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + required: + - id + type: object + maxItems: 1000 + type: array + patches: + items: + description: A blocked sender pattern + minProperties: 1 + properties: + comments: + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + is_regex: + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: + November 1, 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + pattern_type: + $ref: '#/components/schemas/emailSecurityPatternType' + type: object + required: + - id + maxItems: 1000 + type: array + posts: + items: + $ref: '#/components/schemas/emailSecurityCreateBlockedSender' + maxItems: 1000 + type: array + puts: + items: + description: A blocked sender pattern + properties: + comments: + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + is_regex: + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: + November 1, 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + pattern_type: + $ref: '#/components/schemas/emailSecurityPatternType' + type: object + required: + - id + maxItems: 1000 + type: array + required: + - deletes + - patches + - puts + - posts + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + deletes: + items: + $ref: >- + #/components/schemas/emailSecurityDeletedBlockedSender + type: array + patches: + $ref: '#/components/schemas/emailSecurityBlockedSenderList' + posts: + $ref: '#/components/schemas/emailSecurityBlockedSenderList' + puts: + $ref: '#/components/schemas/emailSecurityBlockedSenderList' + type: object + required: + - success + - errors + - messages + description: Batch operation results + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Batch blocked senders operations + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/email-security/settings/block_senders/{pattern_id}: + delete: + description: >- + Removes a blocked sender pattern. After deletion, emails from this + sender will no longer be automatically blocked based on this rule. + operationId: email_security_delete_blocked_sender + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityDeletedBlockedSender' + required: + - success + - errors + - messages + description: Deleted blocked sender + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a blocked email sender + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pattern_id + schema: + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - block_senders + method: delete + get: + description: >- + Retrieves details for a specific blocked sender pattern including its + pattern type, value, and metadata. + operationId: email_security_get_blocked_sender + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityBlockedSender' + required: + - success + - errors + - messages + description: Blocked sender details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a blocked email sender + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pattern_id + schema: + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - block_senders + method: get + patch: + description: >- + Updates an existing blocked sender pattern. Only provided fields will be + modified. The pattern will continue blocking emails until deleted. + operationId: email_security_update_blocked_sender + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityUpdateBlockedSender' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityBlockedSender' + required: + - success + - errors + - messages + description: Updated blocked sender + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a blocked email sender + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pattern_id + schema: + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - block_senders + method: edit + /accounts/{account_id}/email-security/settings/domains: + get: + description: >- + Returns a paginated list of email domains protected by Email Security. + Includes domain configuration, delivery modes, and authorization status. + Supports filtering by delivery mode and integration ID. + operationId: email_security_list_domains + parameters: + - description: Current page within paginated list of results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - description: Search term for filtering records. Behavior may change. + in: query + name: search + schema: + type: string + - description: Field to sort by. + in: query + name: order + schema: + enum: + - domain + - created_at + type: string + - description: The sorting direction. + in: query + name: direction + schema: + enum: + - asc + - desc + type: string + - description: Delivery mode to filter by. + in: query + name: allowed_delivery_mode + schema: + $ref: '#/components/schemas/emailSecurityDeliveryMode' + - description: Domain names to filter by. + in: query + name: domain + schema: + items: + type: string + type: array + explode: true + - description: Currently active delivery mode to filter by. + in: query + name: active_delivery_mode + schema: + $ref: '#/components/schemas/emailSecurityDeliveryMode' + - description: Integration ID to filter by. + in: query + name: integration_id + schema: + format: uuid + type: string + - description: Filters response to domains with the provided status. + in: query + name: status + schema: + $ref: '#/components/schemas/emailSecurityDomainStatus' + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: '#/components/schemas/emailSecurityDomainList' + required: + - success + - errors + - messages + description: List of domains + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List protected email domains + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - domains + method: list + /accounts/{account_id}/email-security/settings/domains/{domain_id}: + delete: + description: >- + Removes email security protection from a domain. After deletion, emails + for this domain will no longer be processed by Email Security. This + action cannot be undone. + operationId: email_security_delete_domain + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityDeletedDomain' + required: + - success + - errors + - messages + description: Deleted domain + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Unprotect an email domain + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain_id + schema: + $ref: '#/components/schemas/emailSecurityDomainId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - domains + method: delete + get: + description: >- + Retrieves detailed information for a specific protected email domain + including its delivery configuration, SPF/DMARC status, and + authorization state. + operationId: email_security_get_domain + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityDomain' + required: + - success + - errors + - messages + description: Domain details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an email domain + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain_id + schema: + $ref: '#/components/schemas/emailSecurityDomainId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - domains + method: get + patch: + description: >- + Updates configuration for a protected email domain. Only provided fields + will be modified. Changes affect delivery mode, security settings, and + regional processing. + operationId: email_security_update_domain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityUpdateDomain' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityDomain' + required: + - success + - errors + - messages + description: Updated domain + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an email domain + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain_id + schema: + $ref: '#/components/schemas/emailSecurityDomainId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - domains + method: edit + /accounts/{account_id}/email-security/settings/impersonation_registry: + get: + description: >- + Returns a paginated list of protected identities in the impersonation + registry. These entries define identities and email addresses to protect + from impersonation attacks. Can be manually added or automatically + synced from directory integrations. + operationId: email_security_list_impersonation_registry + parameters: + - description: Current page within paginated list of results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - description: Search term for filtering records. Behavior may change. + in: query + name: search + schema: + type: string + - description: Field to sort by. + in: query + name: order + schema: + enum: + - name + - email + - created_at + type: string + - description: The sorting direction. + in: query + name: direction + schema: + enum: + - asc + - desc + type: string + - in: query + name: provenance + schema: + $ref: '#/components/schemas/emailSecurityProvenance' + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: >- + #/components/schemas/emailSecurityImpersonationRegistryList + required: + - success + - errors + - messages + description: List of impersonation registry entries + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List entries in impersonation registry + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - impersonation_registry + method: list + post: + description: >- + Creates a new entry in the impersonation registry to protect against + impersonation. Emails attempting to impersonate this identity will be + flagged. Supports regex patterns for flexible email matching. + operationId: email_security_create_impersonation_registry + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityCreateImpersonationRegistry' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityImpersonationRegistry' + required: + - success + - errors + - messages + description: Created impersonation registry entry + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create impersonation registry entry + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - impersonation_registry + method: create + /accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}: + delete: + description: >- + Removes an entry from the impersonation registry. After deletion, this + identity will no longer be protected from impersonation. + operationId: email_security_delete_impersonation_registry + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/emailSecurityDeletedImpersonationRegistry + required: + - success + - errors + - messages + description: Deleted impersonation registry entry + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an impersonation registry entry + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: impersonation_registry_id + schema: + $ref: '#/components/schemas/emailSecurityImpersonationRegistryId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - impersonation_registry + method: delete + get: + description: >- + Retrieves details for a specific impersonation registry entry including + the protected identity, email pattern, and synchronization source if + directory-synced. + operationId: email_security_get_impersonation_registry + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityImpersonationRegistry' + required: + - success + - errors + - messages + description: Impersonation registry entry details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an impersonation registry entry + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: impersonation_registry_id + schema: + $ref: '#/components/schemas/emailSecurityImpersonationRegistryId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - impersonation_registry + method: get + patch: + description: >- + Updates an existing impersonation registry entry. Only provided fields + will be modified. Directory-synced entries can't be updated. + operationId: email_security_update_impersonation_registry + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityUpdateImpersonationRegistry' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityImpersonationRegistry' + required: + - success + - errors + - messages + description: Updated impersonation registry entry + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an impersonation registry entry + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: impersonation_registry_id + schema: + $ref: '#/components/schemas/emailSecurityImpersonationRegistryId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - impersonation_registry + method: edit + /accounts/{account_id}/email-security/settings/sending_domain_restrictions: + get: + description: >- + Returns a paginated list of sending domain restrictions. These + restrictions enforce TLS requirements for emails from specific domains. + Mail without TLS from restricted domains will be dropped unless the + subdomain is in the exclude list. Supports sorting and searching. + operationId: email_security_list_sending_domain_restrictions + parameters: + - description: Current page within paginated list of results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - description: Search term for filtering records. Behavior may change. + in: query + name: search + schema: + type: string + - description: Field to sort by. + in: query + name: order + schema: + enum: + - domain + - created_at + type: string + - description: The sorting direction. + in: query + name: direction + schema: + enum: + - asc + - desc + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: >- + #/components/schemas/emailSecuritySendingDomainRestrictionList + required: + - success + - errors + - messages + description: List of sending domain restrictions + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List sending domain restrictions + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + post: + description: >- + Creates a new sending domain restriction to enforce TLS requirements for + a domain. Emails without TLS from this domain will be dropped unless the + subdomain is in the exclude list. + operationId: email_security_create_sending_domain_restriction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityCreateSendingDomainRestriction' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecuritySendingDomainRestriction' + required: + - success + - errors + - messages + description: Created sending domain restriction + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a sending domain restriction + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/email-security/settings/sending_domain_restrictions/batch: + post: + description: >- + Executes multiple delete operations on sending domain restrictions + atomically. All operations succeed or fail together as a transaction. + Currently only supports batch deletion. Removes TLS enforcement + requirements for the specified domains. + operationId: email_security_batch_sending_domain_restrictions + requestBody: + content: + application/json: + schema: + properties: + deletes: + items: + properties: + id: + $ref: >- + #/components/schemas/emailSecuritySendingDomainRestrictionId + required: + - id + type: object + maxItems: 1000 + type: array + required: + - deletes + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + deletes: + items: + properties: + id: + $ref: >- + #/components/schemas/emailSecuritySendingDomainRestrictionId + required: + - id + type: object + type: array + required: + - deletes + type: object + required: + - success + - errors + - messages + description: Batch operation results + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Batch sending domain restrictions operations + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}: + delete: + description: >- + Removes a sending domain restriction. After deletion, TLS will no longer + be enforced for emails from this domain. + operationId: email_security_delete_sending_domain_restriction + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/emailSecurityDeletedSendingDomainRestriction + required: + - success + - errors + - messages + description: Deleted sending domain restriction + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a sending domain restriction + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sending_domain_restriction_id + schema: + $ref: '#/components/schemas/emailSecuritySendingDomainRestrictionId' + required: true + get: + description: >- + Retrieves details for a specific sending domain restriction including + the domain requiring TLS and any excluded subdomains exempt from the TLS + requirement. + operationId: email_security_get_sending_domain_restriction + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecuritySendingDomainRestriction' + required: + - success + - errors + - messages + description: Sending domain restriction details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a sending domain restriction + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sending_domain_restriction_id + schema: + $ref: '#/components/schemas/emailSecuritySendingDomainRestrictionId' + required: true + patch: + description: >- + Updates an existing sending domain restriction. Only provided fields + will be modified. Changes affect which domains require TLS and which + subdomains are excluded. + operationId: email_security_update_sending_domain_restriction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityUpdateSendingDomainRestriction' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecuritySendingDomainRestriction' + required: + - success + - errors + - messages + description: Updated sending domain restriction + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a sending domain restriction + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sending_domain_restriction_id + schema: + $ref: '#/components/schemas/emailSecuritySendingDomainRestrictionId' + required: true + /accounts/{account_id}/email-security/settings/trusted_domains: + get: + description: >- + Returns a paginated list of trusted domain patterns. Trusted domains + prevent false positives for recently registered domains and lookalike + domain detections. Patterns can use regular expressions for flexible + matching. + operationId: email_security_list_trusted_domains + parameters: + - description: Current page within paginated list of results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - description: Search term for filtering records. Behavior may change. + in: query + name: search + schema: + type: string + - description: Field to sort by. + in: query + name: order + schema: + enum: + - pattern + - created_at + type: string + - description: The sorting direction. + in: query + name: direction + schema: + enum: + - asc + - desc + type: string + - description: >- + Filter to show only recently registered domains that are trusted to + prevent triggering Suspicious or Malicious dispositions. + in: query + name: is_recent + schema: + type: boolean + - description: >- + Filter to show only proximity domains (partner or approved domains + with similar spelling to connected domains) that prevent Spoof + dispositions. + in: query + name: is_similarity + schema: + type: boolean + - in: query + name: pattern + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: '#/components/schemas/emailSecurityTrustedDomainList' + required: + - success + - errors + - messages + description: List of trusted domains + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List trusted email domains + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - trusted_domains + method: list + post: + description: >- + Creates a new trusted domain pattern. Use for partner domains or + approved senders that should bypass recent domain registration and + similarity checks. Configure whether it prevents recent domain or spoof + dispositions. + operationId: email_security_create_trusted_domain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityCreateTrustedDomain' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityTrustedDomain' + required: + - success + - errors + - messages + description: Created trusted domain + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create trusted email domain + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - trusted_domains + method: create + /accounts/{account_id}/email-security/settings/trusted_domains/batch: + post: + description: >- + Execute multiple operations atomically. All four operation arrays + (deletes, patches, puts, posts) are required and executed in order. Send + empty arrays for unused operations. + operationId: email_security_batch_trusted_domains + requestBody: + content: + application/json: + schema: + properties: + deletes: + items: + properties: + id: + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + required: + - id + type: object + maxItems: 1000 + type: array + patches: + items: + description: A trusted email domain + minProperties: 1 + properties: + comments: + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + is_recent: + description: >- + Select to prevent recently registered domains from + triggering a Suspicious or Malicious disposition. + type: boolean + x-auditable: true + is_regex: + type: boolean + x-auditable: true + is_similarity: + description: >- + Select for partner or other approved domains that have + similar spelling to your connected domains. Prevents + listed domains from triggering a Spoof disposition. + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: + November 1, 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + type: object + required: + - id + maxItems: 1000 + type: array + posts: + items: + $ref: '#/components/schemas/emailSecurityCreateTrustedDomain' + maxItems: 1000 + type: array + puts: + items: + description: A trusted email domain + properties: + comments: + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + is_recent: + description: >- + Select to prevent recently registered domains from + triggering a Suspicious or Malicious disposition. + type: boolean + x-auditable: true + is_regex: + type: boolean + x-auditable: true + is_similarity: + description: >- + Select for partner or other approved domains that have + similar spelling to your connected domains. Prevents + listed domains from triggering a Spoof disposition. + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: + November 1, 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + type: object + required: + - id + maxItems: 1000 + type: array + required: + - deletes + - patches + - puts + - posts + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + deletes: + items: + $ref: >- + #/components/schemas/emailSecurityDeletedTrustedDomain + type: array + patches: + $ref: '#/components/schemas/emailSecurityTrustedDomainList' + posts: + $ref: '#/components/schemas/emailSecurityTrustedDomainList' + puts: + $ref: '#/components/schemas/emailSecurityTrustedDomainList' + type: object + required: + - success + - errors + - messages + description: Batch operation results + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Batch trusted domains operations + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}: + delete: + description: >- + Removes a trusted domain pattern. After deletion, emails from this + domain will be subject to normal recent domain and similarity checks. + operationId: email_security_delete_trusted_domain + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityDeletedTrustedDomain' + required: + - success + - errors + - messages + description: Deleted trusted domain + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a trusted email domain + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trusted_domain_id + schema: + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - trusted_domains + method: delete + get: + description: >- + Retrieves details for a specific trusted domain pattern including its + pattern value, whether it uses regex matching, and which detection types + it affects. + operationId: email_security_get_trusted_domain + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityTrustedDomain' + required: + - success + - errors + - messages + description: Trusted domain details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a trusted email domain + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + - 'Cloud Email Security: Read' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trusted_domain_id + schema: + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - trusted_domains + method: get + patch: + description: >- + Updates an existing trusted domain pattern. Only provided fields will be + modified. Changes take effect for new emails matching the pattern. + operationId: email_security_update_trusted_domain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityUpdateTrustedDomain' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/emailSecurityTrustedDomain' + required: + - success + - errors + - messages + description: Updated trusted domain + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a trusted email domain + tags: + - Email Security Settings + x-api-token-group: + - 'Cloud Email Security: Write' + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trusted_domain_id + schema: + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + required: true + x-stackql-sdk: + service: email_security + resource_chain: + - settings + - trusted_domains + method: edit + /accounts/{account_id}/email-security/submissions: + get: + description: >- + Returns information for submissions made to reclassify emails. Shows the + status, outcome, and disposition changes for reclassification requests + made by users or the security team. Useful for tracking false + positive/negative reports. + operationId: email_security_submissions + parameters: + - description: The beginning of the search date range. Defaults to `now - 30 days`. + in: query + name: start + schema: + format: date-time + type: string + - description: The end of the search date range. Defaults to `now`. + in: query + name: end + schema: + format: date-time + type: string + - in: query + name: type + schema: + enum: + - TEAM + - USER + type: string + - in: query + name: submission_id + schema: + type: string + - in: query + name: original_disposition + schema: + $ref: '#/components/schemas/emailSecuritySubmissionDisposition' + - in: query + name: requested_disposition + schema: + $ref: '#/components/schemas/emailSecuritySubmissionDisposition' + - in: query + name: outcome_disposition + schema: + $ref: '#/components/schemas/emailSecuritySubmissionDisposition' + - in: query + name: status + schema: + type: string + - in: query + name: query + schema: + nullable: true + type: string + - description: Current page within paginated list of results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The number of results per page. Maximum value is 1000. + in: query + name: per_page + schema: + default: 20 + maximum: 1000 + minimum: 1 + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/emailSecurityMessages' + messages: + $ref: '#/components/schemas/emailSecurityMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + items: + $ref: '#/components/schemas/emailSecuritySubmission' + type: array + required: + - success + - errors + - messages + description: List of submissions + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSecurityApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get reclassify submissions + tags: + - Email Security + x-api-token-group: null + x-stackql-sdk: + service: email_security + resource_chain: + - submissions + method: list +components: + schemas: + emailSecurityActionEntry: + properties: + completed_at: + description: Timestamp when the action completed + format: date-time + nullable: true + type: string + operation: + enum: + - PREVIEW + - QUARANTINE_RELEASE + - SUBMISSION + - MOVE + type: string + properties: + nullable: true + type: object + $ref: '#/components/schemas/emailSecurityActionEntryProperties' + started_at: + description: Timestamp when the action was initiated + format: date-time + nullable: true + type: string + status: + nullable: true + type: string + success: + nullable: true + type: boolean + required: + - operation + type: object + emailSecurityActionEntryProperties: + properties: + folder: + nullable: true + type: string + requested_by: + nullable: true + type: string + requested_disposition: + nullable: true + type: string + service: + nullable: true + type: string + submission_id: + nullable: true + type: string + submission_type: + nullable: true + type: string + type: object + emailSecurityActionLogEntry: + properties: + completed_at: + description: Timestamp when action completed + format: date-time + readOnly: true + type: string + completed_timestamp: + deprecated: true + description: >- + Deprecated, use `completed_at` instead. End of life: November 1, + 2026. + readOnly: true + type: string + operation: + description: Type of action performed + enum: + - MOVE + - RELEASE + - RECLASSIFY + - SUBMISSION + - QUARANTINE_RELEASE + - PREVIEW + type: string + properties: + description: Additional properties for the action + properties: + folder: + description: Target folder for move operations + type: string + requested_by: + description: User who requested the action + type: string + type: object + status: + description: Status of the action + nullable: true + type: string + required: + - completed_at + - operation + type: object + emailSecurityAllowPolicy: + description: An email allow policy + properties: + comments: + example: Trust all messages send from test@example.com + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityAllowPolicyId' + is_acceptable_sender: + description: >- + Messages from this sender will be exempted from Spam, Spoof and Bulk + dispositions. Note - This will not exempt messages with Malicious or + Suspicious dispositions. + example: false + type: boolean + x-auditable: true + is_exempt_recipient: + description: Messages to this recipient will bypass all detections + example: false + type: boolean + x-auditable: true + is_recipient: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. + End of life: July 1, 2026. + example: false + type: boolean + x-auditable: true + is_regex: + example: false + type: boolean + x-auditable: true + is_sender: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End + of life: July 1, 2026. + example: true + type: boolean + x-auditable: true + is_spoof: + deprecated: true + description: >- + Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. + End of life: July 1, 2026. + example: false + type: boolean + x-auditable: true + is_trusted_sender: + description: >- + Messages from this sender will bypass all detections and link + following + example: true + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: November 1, + 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + example: test@example.com + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + pattern_type: + $ref: '#/components/schemas/emailSecurityPatternType' + verify_sender: + description: >- + Enforce DMARC, SPF or DKIM authentication. When on, Email Security + only honors policies that pass authentication. + example: true + type: boolean + x-auditable: true + required: + - id + - created_at + - last_modified + type: object + emailSecurityAllowPolicyId: + description: Allow policy identifier + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + emailSecurityAllowPolicyList: + items: + $ref: '#/components/schemas/emailSecurityAllowPolicy' + type: array + emailSecurityApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/emailSecurityMessages' + messages: + example: [] + $ref: '#/components/schemas/emailSecurityMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + emailSecurityAttachment: + properties: + content_type: + description: MIME type of the attachment + nullable: true + type: string + detection: + description: Detection result for this attachment + nullable: true + type: string + $ref: '#/components/schemas/emailSecurityDispositionLabel' + encrypted: + description: Whether the attachment is encrypted + nullable: true + type: boolean + filename: + description: Name of the attached file + nullable: true + type: string + md5: + description: MD5 hash of the attachment + nullable: true + type: string + name: + description: Attachment name (alternative to filename) + nullable: true + type: string + sha1: + description: SHA1 hash of the attachment + nullable: true + type: string + sha256: + description: SHA256 hash of the attachment + nullable: true + type: string + size: + description: Size of the attachment in bytes + minimum: 0 + type: integer + required: + - size + type: object + emailSecurityBlockedSender: + description: A blocked sender pattern + properties: + comments: + example: Block sender with email test@example.com + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + is_regex: + example: false + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: November 1, + 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + example: test@example.com + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + pattern_type: + $ref: '#/components/schemas/emailSecurityPatternType' + type: object + emailSecurityBlockedSenderId: + description: Blocked sender pattern identifier + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + emailSecurityBlockedSenderList: + items: + $ref: '#/components/schemas/emailSecurityBlockedSender' + type: array + emailSecurityCreateAllowPolicy: + description: Create an allow policy + $ref: '#/components/schemas/emailSecurityAllowPolicy' + emailSecurityCreateBlockedSender: + description: Create a blocked sender pattern + $ref: '#/components/schemas/emailSecurityBlockedSender' + emailSecurityCreateImpersonationRegistry: + description: Create an impersonation registry entry + $ref: '#/components/schemas/emailSecurityImpersonationRegistry' + emailSecurityCreateSendingDomainRestriction: + description: Create a sending domain restriction. + $ref: '#/components/schemas/emailSecuritySendingDomainRestriction' + emailSecurityCreateTrustedDomain: + description: Create a trusted domain + $ref: '#/components/schemas/emailSecurityTrustedDomain' + emailSecurityCursorResultInfo: + properties: + count: + description: Number of items in current page + minimum: 0 + type: integer + next: + description: Cursor for next page + nullable: true + type: string + page: + deprecated: true + description: 'Deprecated: Always returns 0. End of life: November 1, 2026.' + minimum: 0 + type: integer + per_page: + description: Number of items per page + minimum: 0 + type: integer + previous: + description: Cursor for previous page + nullable: true + type: string + total_count: + deprecated: true + description: 'Deprecated: Always returns 0. End of life: November 1, 2026.' + minimum: 0 + type: integer + required: + - per_page + - count + - total_count + type: object + emailSecurityCustomerStatus: + enum: + - escalated + - reviewed + - unreviewed + nullable: true + type: string + emailSecurityDeletedAllowPolicy: + properties: + id: + $ref: '#/components/schemas/emailSecurityAllowPolicyId' + required: + - id + type: object + emailSecurityDeletedBlockedSender: + properties: + id: + $ref: '#/components/schemas/emailSecurityBlockedSenderId' + required: + - id + type: object + emailSecurityDeletedDomain: + properties: + id: + $ref: '#/components/schemas/emailSecurityDomainId' + required: + - id + type: object + emailSecurityDeletedImpersonationRegistry: + properties: + id: + $ref: '#/components/schemas/emailSecurityImpersonationRegistryId' + required: + - id + type: object + emailSecurityDeletedSendingDomainRestriction: + properties: + id: + $ref: '#/components/schemas/emailSecuritySendingDomainRestrictionId' + required: + - id + type: object + emailSecurityDeletedTrustedDomain: + properties: + id: + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + required: + - id + type: object + emailSecurityDeliveryMode: + enum: + - DIRECT + - BCC + - JOURNAL + - API + - RETRO_SCAN + type: string + emailSecurityDispositionLabel: + enum: + - MALICIOUS + - MALICIOUS-BEC + - SUSPICIOUS + - SPOOF + - SPAM + - BULK + - ENCRYPTED + - EXTERNAL + - UNKNOWN + - NONE + type: string + emailSecurityDmarcStatus: + enum: + - none + - good + - invalid + type: string + emailSecurityDomain: + properties: + allowed_delivery_modes: + items: + $ref: '#/components/schemas/emailSecurityDeliveryMode' + type: array + authorization: + $ref: '#/components/schemas/emailSecurityDomainAuthorization' + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + dmarc_status: + $ref: '#/components/schemas/emailSecurityDmarcStatus' + domain: + example: example.com + type: string + x-auditable: true + drop_dispositions: + items: + $ref: '#/components/schemas/emailSecurityDispositionLabel' + type: array + emails_processed: + $ref: '#/components/schemas/emailSecurityEmailsProcessed' + folder: + $ref: '#/components/schemas/emailSecurityScannableFolder' + id: + $ref: '#/components/schemas/emailSecurityDomainId' + inbox_provider: + enum: + - Microsoft + - Google + - null + nullable: true + type: string + integration_id: + format: uuid + nullable: true + type: string + ip_restrictions: + example: + - 192.0.2.0/24 + - 2001:db8::/32 + items: + type: string + type: array + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: November 1, + 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + lookback_hops: + type: integer + x-auditable: true + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + o365_tenant_id: + nullable: true + type: string + regions: + items: + $ref: '#/components/schemas/emailSecurityRegion' + type: array + require_tls_inbound: + nullable: true + type: boolean + require_tls_outbound: + nullable: true + type: boolean + spf_status: + $ref: '#/components/schemas/emailSecuritySpfStatus' + status: + $ref: '#/components/schemas/emailSecurityDomainStatus' + transport: + type: string + x-auditable: true + type: object + emailSecurityDomainAuthorization: + properties: + authorized: + type: boolean + status_message: + nullable: true + type: string + timestamp: + format: date-time + readOnly: true + type: string + required: + - authorized + - timestamp + type: object + emailSecurityDomainId: + description: Domain identifier + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + emailSecurityDomainList: + items: + $ref: '#/components/schemas/emailSecurityDomain' + type: array + emailSecurityDomainStatus: + enum: + - pending + - active + - failed + - timeout + type: string + emailSecurityEmailsProcessed: + properties: + timestamp: + format: date-time + readOnly: true + type: string + total_emails_processed: + minimum: 0 + type: integer + total_emails_processed_previous: + minimum: 0 + type: integer + required: + - total_emails_processed + - total_emails_processed_previous + - timestamp + type: object + emailSecurityImpersonationRegistry: + description: An impersonation registry entry + properties: + comments: + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + directory_id: + nullable: true + type: integer + directory_node_id: + nullable: true + type: integer + email: + example: john.doe@example.com + type: string + x-auditable: true + external_directory_node_id: + deprecated: true + nullable: true + type: string + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityImpersonationRegistryId' + is_email_regex: + example: false + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: November 1, + 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + name: + example: John Doe + maxLength: 1024 + type: string + x-auditable: true + provenance: + $ref: '#/components/schemas/emailSecurityProvenance' + type: object + emailSecurityImpersonationRegistryId: + description: Impersonation registry entry identifier + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + title: identifier + type: string + x-auditable: true + emailSecurityImpersonationRegistryList: + items: + $ref: '#/components/schemas/emailSecurityImpersonationRegistry' + type: array + emailSecurityInvestigateId: + description: Unique identifier for a message retrieved from investigation + example: 4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678 + type: string + emailSecurityLink: + properties: + href: + type: string + text: + nullable: true + type: string + required: + - href + type: object + emailSecurityMailboxDestination: + enum: + - Inbox + - JunkEmail + - DeletedItems + - RecoverableItemsDeletions + - RecoverableItemsPurges + type: string + emailSecurityMessageDeliveryMode: + enum: + - DIRECT + - BCC + - JOURNAL + - REVIEW_SUBMISSION + - DMARC_UNVERIFIED + - DMARC_FAILURE_REPORT + - DMARC_AGGREGATE_REPORT + - THREAT_INTEL_SUBMISSION + - SIMULATION_SUBMISSION + - API + - RETRO_SCAN + type: string + emailSecurityMessageDeliveryStatus: + description: Delivery status of the message. + enum: + - delivered + - moved + - quarantined + - rejected + - deferred + - bounced + - queued + type: string + emailSecurityMessageDetails: + properties: + action_log: + deprecated: true + description: >- + Deprecated, use `GET /investigate/{investigate_id}/action_log` + instead. End of life: November 1, 2026. + items: + $ref: '#/components/schemas/emailSecurityActionLogEntry' + type: array + alert_id: + nullable: true + type: string + client_recipients: + items: + type: string + type: array + delivery_mode: + $ref: '#/components/schemas/emailSecurityMessageDeliveryMode' + delivery_status: + items: + $ref: '#/components/schemas/emailSecurityMessageDeliveryStatus' + nullable: true + type: array + detection_reasons: + items: + type: string + type: array + edf_hash: + nullable: true + type: string + envelope_from: + nullable: true + type: string + envelope_to: + items: + type: string + nullable: true + type: array + final_disposition: + $ref: '#/components/schemas/emailSecurityDispositionLabel' + findings: + deprecated: true + description: >- + Deprecated, use the `findings` field from `GET + /investigate/{investigate_id}/detections` instead. End of life: + November 1, 2026. Detection findings for this message. + items: + properties: + attachment: + nullable: true + type: string + detail: + nullable: true + type: string + detection: + $ref: '#/components/schemas/emailSecurityDispositionLabel' + field: + nullable: true + type: string + name: + nullable: true + type: string + portion: + nullable: true + type: string + reason: + nullable: true + type: string + score: + format: double + nullable: true + type: number + value: + nullable: true + type: string + type: object + nullable: true + type: array + from: + nullable: true + type: string + from_name: + nullable: true + type: string + htmltext_structure_hash: + nullable: true + type: string + id: + x-auditable: true + $ref: '#/components/schemas/emailSecurityInvestigateId' + is_phish_submission: + type: boolean + is_quarantined: + type: boolean + message_id: + nullable: true + type: string + post_delivery_operations: + description: Post-delivery operations performed on this message + items: + enum: + - PREVIEW + - QUARANTINE_RELEASE + - SUBMISSION + - MOVE + type: string + nullable: true + type: array + postfix_id: + $ref: '#/components/schemas/emailSecurityPostfixId' + postfix_id_outbound: + nullable: true + type: string + properties: + description: Message processing properties + properties: + allowlisted_pattern: + description: Pattern that allowlisted this message + nullable: true + type: string + allowlisted_pattern_type: + description: Type of allowlist pattern + enum: + - quarantine_release + - acceptable_sender + - allowed_sender + - allowed_recipient + - domain_similarity + - domain_recency + - managed_acceptable_sender + - outbound_ndr + nullable: true + type: string + blocklisted_message: + description: Whether message was blocklisted + nullable: true + type: boolean + blocklisted_pattern: + description: Pattern that blocklisted this message + nullable: true + type: string + whitelisted_pattern_type: + description: Legacy field for allowlist pattern type + enum: + - quarantine_release + - acceptable_sender + - allowed_sender + - allowed_recipient + - domain_similarity + - domain_recency + - managed_acceptable_sender + - outbound_ndr + nullable: true + type: string + type: object + replyto: + nullable: true + type: string + scanned_at: + description: When the message was scanned (UTC) + format: date-time + nullable: true + type: string + sent_at: + description: When the message was sent (UTC) + format: date-time + nullable: true + type: string + sent_date: + nullable: true + type: string + subject: + nullable: true + type: string + threat_categories: + items: + type: string + nullable: true + type: array + to: + items: + type: string + nullable: true + type: array + to_name: + items: + type: string + nullable: true + type: array + ts: + deprecated: true + description: 'Deprecated, use `scanned_at` instead. End of life: November 1, 2026.' + readOnly: true + type: string + validation: + $ref: '#/components/schemas/emailSecurityValidation' + required: + - id + - ts + - client_recipients + - postfix_id + - detection_reasons + - action_log + - is_quarantined + - is_phish_submission + - properties + type: object + emailSecurityMessageDetectionDetails: + properties: + action: + type: string + attachments: + items: + $ref: '#/components/schemas/emailSecurityAttachment' + type: array + final_disposition: + $ref: '#/components/schemas/emailSecurityDispositionLabel' + findings: + items: + properties: + attachment: + nullable: true + type: string + detail: + nullable: true + type: string + detection: + $ref: '#/components/schemas/emailSecurityDispositionLabel' + field: + nullable: true + type: string + name: + nullable: true + type: string + portion: + nullable: true + type: string + reason: + nullable: true + type: string + score: + format: double + nullable: true + type: number + value: + nullable: true + type: string + type: object + nullable: true + type: array + headers: + items: + $ref: '#/components/schemas/emailSecurityMessageHeader' + type: array + links: + items: + $ref: '#/components/schemas/emailSecurityLink' + type: array + sender_info: + properties: + as_name: + description: The name of the autonomous system. + nullable: true + type: string + as_number: + description: The number of the autonomous system. + nullable: true + type: integer + geo: + nullable: true + type: string + ip: + nullable: true + type: string + pld: + nullable: true + type: string + type: object + threat_categories: + items: + $ref: '#/components/schemas/emailSecurityThreatCategory' + type: array + validation: + $ref: '#/components/schemas/emailSecurityValidation' + required: + - validation + - headers + - threat_categories + - sender_info + - links + - action + - attachments + - findings + type: object + emailSecurityMessageHeader: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + emailSecurityMessagePreview: + properties: + screenshot: + description: A base64 encoded PNG image of the email. + type: string + required: + - screenshot + type: object + emailSecurityMessageRaw: + properties: + raw: + description: A UTF-8 encoded eml file of the email. + type: string + required: + - raw + type: object + emailSecurityMessageTrace: + properties: + inbound: + properties: + lines: + items: + $ref: '#/components/schemas/emailSecurityTraceLine' + nullable: true + type: array + pending: + nullable: true + type: boolean + type: object + outbound: + properties: + lines: + items: + $ref: '#/components/schemas/emailSecurityTraceLine' + nullable: true + type: array + pending: + nullable: true + type: boolean + type: object + required: + - inbound + - outbound + type: object + emailSecurityMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + emailSecurityMoveResponseItem: + properties: + completed_at: + description: When the move operation completed (UTC) + format: date-time + nullable: true + type: string + completed_timestamp: + deprecated: true + description: >- + Deprecated, use `completed_at` instead. End of life: November 1, + 2026. + format: date-time + type: string + destination: + description: Destination folder for the message + nullable: true + type: string + item_count: + deprecated: true + description: 'Number of items moved. End of life: November 1, 2026.' + type: integer + message_id: + description: Message identifier + nullable: true + type: string + operation: + description: Type of operation performed + nullable: true + type: string + recipient: + description: Recipient email address + nullable: true + type: string + status: + description: Operation status + nullable: true + type: string + success: + description: Whether the operation succeeded + type: boolean + required: + - success + type: object + emailSecurityOptionalSubmissionDisposition: + nullable: true + type: string + $ref: '#/components/schemas/emailSecuritySubmissionDisposition' + emailSecurityPatternType: + description: >- + Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used + when creating or updating policies, but may be returned for existing + entries. + enum: + - EMAIL + - DOMAIN + - IP + - UNKNOWN + example: EMAIL + type: string + x-auditable: true + emailSecurityPhishGuardReport: + properties: + content: + type: string + created_at: + format: date-time + nullable: true + readOnly: true + type: string + disposition: + $ref: '#/components/schemas/emailSecurityDispositionLabel' + fields: + properties: + from: + nullable: true + type: string + occurred_at: + format: date-time + readOnly: true + type: string + postfix_id: + nullable: true + type: string + to: + items: + type: string + type: array + ts: + deprecated: true + description: Deprecated, use `occurred_at` instead + format: date-time + readOnly: true + type: string + required: + - to + type: object + id: + type: integer + priority: + type: string + tags: + items: + $ref: '#/components/schemas/emailSecurityPhishGuardReportTag' + nullable: true + type: array + title: + type: string + ts: + deprecated: true + description: Deprecated, use `created_at` instead + format: date-time + readOnly: true + type: string + updated_at: + format: date-time + nullable: true + readOnly: true + type: string + required: + - id + - title + - content + - fields + - priority + - disposition + type: object + emailSecurityPhishGuardReportTag: + properties: + category: + type: string + value: + type: string + required: + - category + - value + type: object + emailSecurityPostfixId: + description: The identifier of the message + example: 4Njp3P0STMz2c02Q + type: string + emailSecurityProvenance: + enum: + - A1S_INTERNAL + - SNOOPY-CASB_OFFICE_365 + - SNOOPY-OFFICE_365 + - SNOOPY-GOOGLE_DIRECTORY + type: string + emailSecurityReclassifyRequest: + properties: + eml_content: + description: Base64 encoded content of the EML file. + type: string + escalated_submission_id: + type: string + x-auditable: true + expected_disposition: + enum: + - NONE + - BULK + - MALICIOUS + - SPAM + - SPOOF + - SUSPICIOUS + type: string + required: + - expected_disposition + type: object + emailSecurityRegion: + enum: + - GLOBAL + - AU + - DE + - IN + - US + type: string + emailSecurityReleaseResponse: + properties: + delivered: + items: + type: string + nullable: true + type: array + failed: + items: + type: string + nullable: true + type: array + id: + x-auditable: true + $ref: '#/components/schemas/emailSecurityInvestigateId' + postfix_id: + deprecated: true + description: 'Deprecated, use `id` instead. End of life: November 1, 2026.' + $ref: '#/components/schemas/emailSecurityPostfixId' + undelivered: + items: + type: string + nullable: true + type: array + required: + - id + type: object + emailSecurityScannableFolder: + enum: + - AllItems + - Inbox + type: string + emailSecuritySendingDomainRestriction: + description: >- + A sending domain restriction that enforces TLS (Transport Layer + Security) requirements for emails from specific domains. If TLS is + required, mail without TLS from the specified domain will be dropped. + properties: + comments: + example: Enforce TLS for all mail from this domain + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + domain: + description: Domain that requires TLS enforcement. + example: example.com + type: string + x-auditable: true + exclude: + description: Excluded subdomains that are exempt from TLS requirements. + example: + - subdomain.example.com + items: + type: string + type: array + x-auditable: true + id: + readOnly: true + $ref: '#/components/schemas/emailSecuritySendingDomainRestrictionId' + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: November 1, + 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + type: object + emailSecuritySendingDomainRestrictionId: + description: Sending domain restriction identifier. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + title: identifier + type: string + x-auditable: true + emailSecuritySendingDomainRestrictionList: + items: + $ref: '#/components/schemas/emailSecuritySendingDomainRestriction' + type: array + emailSecuritySpfStatus: + enum: + - none + - good + - neutral + - open + - invalid + type: string + emailSecuritySubmission: + properties: + customer_status: + $ref: '#/components/schemas/emailSecurityCustomerStatus' + escalated_as: + $ref: '#/components/schemas/emailSecurityOptionalSubmissionDisposition' + escalated_at: + format: date-time + nullable: true + type: string + escalated_by: + nullable: true + type: string + escalated_submission_id: + nullable: true + type: string + original_disposition: + $ref: '#/components/schemas/emailSecurityOptionalSubmissionDisposition' + original_edf_hash: + nullable: true + type: string + original_postfix_id: + description: The postfix ID of the original message that was submitted + nullable: true + type: string + outcome: + nullable: true + type: string + outcome_disposition: + $ref: '#/components/schemas/emailSecurityOptionalSubmissionDisposition' + requested_at: + description: When the submission was requested (UTC). + format: date-time + type: string + requested_by: + nullable: true + type: string + requested_disposition: + $ref: '#/components/schemas/emailSecurityOptionalSubmissionDisposition' + requested_ts: + deprecated: true + description: Deprecated, use `requested_at` instead + readOnly: true + type: string + status: + nullable: true + type: string + subject: + nullable: true + type: string + submission_id: + type: string + x-auditable: true + type: + description: Whether the submission was created by a team member or an end user. + enum: + - Team + - User + nullable: true + type: string + required: + - submission_id + - requested_at + type: object + emailSecuritySubmissionDisposition: + enum: + - MALICIOUS + - SUSPICIOUS + - SPOOF + - SPAM + - BULK + - NONE + type: string + emailSecurityThreatCategory: + properties: + description: + nullable: true + type: string + id: + type: integer + name: + nullable: true + type: string + type: object + emailSecurityTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + emailSecurityTraceLine: + properties: + lineno: + description: Line number in the trace log + type: integer + logged_at: + format: date-time + nullable: true + readOnly: true + type: string + message: + type: string + ts: + deprecated: true + description: 'Deprecated, use `logged_at` instead. End of life: November 1, 2026.' + readOnly: true + type: string + type: object + emailSecurityTrustedDomain: + description: A trusted email domain + properties: + comments: + example: Trusted partner domain + maxLength: 1024 + nullable: true + type: string + created_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + id: + readOnly: true + $ref: '#/components/schemas/emailSecurityTrustedDomainId' + is_recent: + description: >- + Select to prevent recently registered domains from triggering a + Suspicious or Malicious disposition. + example: true + type: boolean + x-auditable: true + is_regex: + example: false + type: boolean + x-auditable: true + is_similarity: + description: >- + Select for partner or other approved domains that have similar + spelling to your connected domains. Prevents listed domains from + triggering a Spoof disposition. + example: false + type: boolean + x-auditable: true + last_modified: + deprecated: true + description: >- + Deprecated, use `modified_at` instead. End of life: November 1, + 2026. + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + modified_at: + readOnly: true + $ref: '#/components/schemas/emailSecurityTimestamp' + pattern: + example: example.com + maxLength: 1024 + minLength: 1 + type: string + x-auditable: true + type: object + emailSecurityTrustedDomainId: + description: Trusted domain identifier + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + emailSecurityTrustedDomainList: + items: + $ref: '#/components/schemas/emailSecurityTrustedDomain' + type: array + emailSecurityUpdateAllowPolicy: + description: Update an allow policy + minProperties: 1 + $ref: '#/components/schemas/emailSecurityAllowPolicy' + emailSecurityUpdateBlockedSender: + description: Update a blocked sender pattern + minProperties: 1 + $ref: '#/components/schemas/emailSecurityBlockedSender' + emailSecurityUpdateDomain: + properties: + allowed_delivery_modes: + items: + $ref: '#/components/schemas/emailSecurityDeliveryMode' + type: array + domain: + type: string + x-auditable: true + drop_dispositions: + items: + $ref: '#/components/schemas/emailSecurityDispositionLabel' + type: array + folder: + $ref: '#/components/schemas/emailSecurityScannableFolder' + integration_id: + format: uuid + nullable: true + type: string + x-auditable: true + ip_restrictions: + example: + - 192.0.2.0/24 + - 2001:db8::/32 + items: + type: string + x-auditable: true + type: array + lookback_hops: + maximum: 20 + minimum: 1 + type: integer + x-auditable: true + regions: + items: + $ref: '#/components/schemas/emailSecurityRegion' + type: array + require_tls_inbound: + type: boolean + x-auditable: true + require_tls_outbound: + type: boolean + x-auditable: true + transport: + type: string + x-auditable: true + type: object + emailSecurityUpdateImpersonationRegistry: + description: Update an impersonation registry entry + minProperties: 1 + $ref: '#/components/schemas/emailSecurityImpersonationRegistry' + emailSecurityUpdateSendingDomainRestriction: + description: Update a sending domain restriction. + minProperties: 1 + $ref: '#/components/schemas/emailSecuritySendingDomainRestriction' + emailSecurityUpdateTrustedDomain: + description: Update a trusted domain + minProperties: 1 + $ref: '#/components/schemas/emailSecurityTrustedDomain' + emailSecurityValidation: + properties: + comment: + nullable: true + type: string + dkim: + $ref: '#/components/schemas/emailSecurityValidationStatus' + dmarc: + $ref: '#/components/schemas/emailSecurityValidationStatus' + spf: + $ref: '#/components/schemas/emailSecurityValidationStatus' + type: object + emailSecurityValidationStatus: + enum: + - pass + - neutral + - fail + - error + - none + type: string + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + investigate: + id: cloudflare.email_security.investigate + name: investigate + title: Investigate + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email-security~1investigate/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + release: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1release/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + reclassify: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1reclassify/post + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/investigate/methods/get' + - $ref: '#/components/x-stackQL-resources/investigate/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + move: + id: cloudflare.email_security.move + name: move + title: Move + methods: + email_security_post_bulk_move: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1move/post + response: + mediaType: application/json + openAPIDocKey: '200' + email_security_post_message_move: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1move/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/move/methods/email_security_post_message_move + - $ref: >- + #/components/x-stackQL-resources/move/methods/email_security_post_bulk_move + update: [] + delete: [] + replace: [] + preview: + id: cloudflare.email_security.preview + name: preview + title: Preview + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1preview/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1preview/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/preview/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/preview/methods/create' + update: [] + delete: [] + replace: [] + action_log: + id: cloudflare.email_security.action_log + name: action_log + title: Action Log + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1action_log/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/action_log/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + detections: + id: cloudflare.email_security.detections + name: detections + title: Detections + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1detections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/detections/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + raw: + id: cloudflare.email_security.raw + name: raw + title: Raw + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1raw/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/raw/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + trace: + id: cloudflare.email_security.trace + name: trace + title: Trace + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1investigate~1{investigate_id}~1trace/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/trace/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + reports: + id: cloudflare.email_security.reports + name: reports + title: Reports + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1phishguard~1reports/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reports/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + allow_policies: + id: cloudflare.email_security.allow_policies + name: allow_policies + title: Allow Policies + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1allow_policies/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1allow_policies/post + response: + mediaType: application/json + openAPIDocKey: '201' + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1allow_policies~1batch/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1allow_policies~1{policy_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1allow_policies~1{policy_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1allow_policies~1{policy_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/allow_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/allow_policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/allow_policies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/allow_policies/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/allow_policies/methods/delete' + replace: [] + block_senders: + id: cloudflare.email_security.block_senders + name: block_senders + title: Block Senders + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1block_senders/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1block_senders/post + response: + mediaType: application/json + openAPIDocKey: '201' + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1block_senders~1batch/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1block_senders~1{pattern_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1block_senders~1{pattern_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1block_senders~1{pattern_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/block_senders/methods/get' + - $ref: '#/components/x-stackQL-resources/block_senders/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/block_senders/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/block_senders/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/block_senders/methods/delete' + replace: [] + domains: + id: cloudflare.email_security.domains + name: domains + title: Domains + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1domains/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1domains~1{domain_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1domains~1{domain_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1domains~1{domain_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete' + replace: [] + impersonation_registry: + id: cloudflare.email_security.impersonation_registry + name: impersonation_registry + title: Impersonation Registry + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1impersonation_registry/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1impersonation_registry/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1impersonation_registry~1{impersonation_registry_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1impersonation_registry~1{impersonation_registry_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1impersonation_registry~1{impersonation_registry_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/impersonation_registry/methods/get + - $ref: >- + #/components/x-stackQL-resources/impersonation_registry/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/impersonation_registry/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/impersonation_registry/methods/edit + delete: + - $ref: >- + #/components/x-stackQL-resources/impersonation_registry/methods/delete + replace: [] + sending_domain_restrictions: + id: cloudflare.email_security.sending_domain_restrictions + name: sending_domain_restrictions + title: Sending Domain Restrictions + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1sending_domain_restrictions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + email_security_create_sending_domain_restriction: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1sending_domain_restrictions/post + response: + mediaType: application/json + openAPIDocKey: '201' + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1sending_domain_restrictions~1batch/post + response: + mediaType: application/json + openAPIDocKey: '200' + email_security_delete_sending_domain_restriction: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1sending_domain_restrictions~1{sending_domain_restriction_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1sending_domain_restrictions~1{sending_domain_restriction_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + email_security_update_sending_domain_restriction: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1sending_domain_restrictions~1{sending_domain_restriction_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sending_domain_restrictions/methods/get + - $ref: >- + #/components/x-stackQL-resources/sending_domain_restrictions/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/sending_domain_restrictions/methods/email_security_create_sending_domain_restriction + update: + - $ref: >- + #/components/x-stackQL-resources/sending_domain_restrictions/methods/email_security_update_sending_domain_restriction + delete: + - $ref: >- + #/components/x-stackQL-resources/sending_domain_restrictions/methods/email_security_delete_sending_domain_restriction + replace: [] + trusted_domains: + id: cloudflare.email_security.trusted_domains + name: trusted_domains + title: Trusted Domains + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1trusted_domains/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1trusted_domains/post + response: + mediaType: application/json + openAPIDocKey: '201' + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1trusted_domains~1batch/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1trusted_domains~1{trusted_domain_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1trusted_domains~1{trusted_domain_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1email-security~1settings~1trusted_domains~1{trusted_domain_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/trusted_domains/methods/get' + - $ref: '#/components/x-stackQL-resources/trusted_domains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/trusted_domains/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/trusted_domains/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/trusted_domains/methods/delete' + replace: [] + submissions: + id: cloudflare.email_security.submissions + name: submissions + title: Submissions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email-security~1submissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/submissions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/email_sending.yaml b/providers/src/cloudflare/v00.00.00000/services/email_sending.yaml new file mode 100644 index 00000000..93de21f6 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/email_sending.yaml @@ -0,0 +1,1673 @@ +openapi: 3.0.3 +info: + title: email_sending API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/email/sending/send: + post: + operationId: email-sending-account-send-builder + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingEmailBuilder' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + $ref: '#/components/schemas/emailSendingEmailSendResponse' + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Email sending results. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - '10001' + - '10200' + - '10201' + - '10202' + type: string + message: + enum: + - email.sending.error.invalid_request_schema + - email.sending.error.email.invalid + - email.sending.error.email.no_content_length + - email.sending.error.email.too_big + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: >- + Invalid request, generally because of the format/content of the + email send request. No email will be sent when this happens. + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - 10203 + type: number + message: + enum: + - email.sending.error.email.sending_disabled + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Email sending is disabled for this zone/account. + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - 10004 + type: number + message: + enum: + - email.sending.error.throttled + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: >- + Account/zone has surpassed the rate at which it can send email, + please try again later. No email will be sent when this happens. + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - 10002 + type: number + message: + enum: + - email.sending.error.internal_server + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: >- + An unexpected error while processing the email send request. No + email will be sent when this happens. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Send an email + tags: + - Email Sending + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.create + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: email_sending + resource_chain: [] + method: send + /accounts/{account_id}/email/sending/send_raw: + post: + operationId: email-sending-account-send-raw-message + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingSendRawRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + $ref: '#/components/schemas/emailSendingEmailSendResponse' + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Email sending results. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - '10001' + - '10200' + - '10201' + - '10202' + type: string + message: + enum: + - email.sending.error.invalid_request_schema + - email.sending.error.email.invalid + - email.sending.error.email.no_content_length + - email.sending.error.email.too_big + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: >- + Invalid request, generally because of the format/content of the + email send request. No email will be sent when this happens. + '403': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - 10203 + type: number + message: + enum: + - email.sending.error.email.sending_disabled + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Email sending is disabled for this zone/account. + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - 10004 + type: number + message: + enum: + - email.sending.error.throttled + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: >- + Account/zone has surpassed the rate at which it can send email, + please try again later. No email will be sent when this happens. + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + enum: + - 10002 + type: number + message: + enum: + - email.sending.error.internal_server + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: >- + An unexpected error while processing the email send request. No + email will be sent when this happens. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Send a raw MIME email + tags: + - Email Sending + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.create + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: email_sending + resource_chain: [] + method: send_raw + /zones/{zone_id}/email/sending/subdomains: + get: + description: Lists all sending-enabled subdomains for the zone. + operationId: email-sending-subdomains-list-sending-subdomains + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingSubdomainsResponseCollection' + description: List sending subdomains response + security: + - api_email: [] + api_key: [] + summary: List sending subdomains + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_sending + resource_chain: + - subdomains + method: list + post: + description: >- + Creates a new sending subdomain or re-enables sending on an existing + subdomain that had it disabled. If zone-level Email Sending has not been + enabled yet, the zone flag is automatically set when the entitlement is + present. + operationId: email-sending-subdomains-create-sending-subdomain + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailCreateSendingSubdomainProperties' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingSubdomainResponseSingle' + description: Create a sending subdomain response + security: + - api_email: [] + api_key: [] + summary: Create a sending subdomain + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.create + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_sending + resource_chain: + - subdomains + method: create + /zones/{zone_id}/email/sending/subdomains/preview: + post: + description: >- + Returns the DNS records that would be created for a sending subdomain, + flags which records are missing, and reports any conflicts with existing + DNS records. This is a read-only dry-run — no records are created or + modified. Use before or after creating a subdomain to check DNS status. + operationId: email-sending-subdomains-preview-sending-subdomain + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/emailCreateSendingSubdomainProperties' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingSubdomainPreviewResponse' + description: Preview sending subdomain DNS response + security: + - api_email: [] + api_key: [] + summary: Preview sending subdomain DNS + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}/email/sending/subdomains/{subdomain_id}: + delete: + description: >- + Disables sending on a subdomain and removes its DNS records. If routing + is still active on the subdomain, only sending is disabled. + operationId: email-sending-subdomains-delete-sending-subdomain + parameters: + - in: path + name: subdomain_id + schema: + $ref: '#/components/schemas/emailSendingSubdomainIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailApiResponseSingle' + description: Delete a sending subdomain response + security: + - api_email: [] + api_key: [] + summary: Delete a sending subdomain + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.delete + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_sending + resource_chain: + - subdomains + method: delete + get: + description: Gets information for a specific sending subdomain. + operationId: email-sending-subdomains-get-sending-subdomain + parameters: + - in: path + name: subdomain_id + schema: + $ref: '#/components/schemas/emailSendingSubdomainIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingSubdomainResponseSingle' + description: Get a sending subdomain response + security: + - api_email: [] + api_key: [] + summary: Get a sending subdomain + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_sending + resource_chain: + - subdomains + method: get + /zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns: + get: + description: Returns the expected DNS records for a sending subdomain. + operationId: email-sending-subdomains-get-sending-subdomain-dns + parameters: + - in: path + name: subdomain_id + schema: + $ref: '#/components/schemas/emailSendingSubdomainIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailDnsSettingsResponseCollection' + description: Get sending subdomain DNS records response + security: + - api_email: [] + api_key: [] + summary: Get sending subdomain DNS records + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: email_sending + resource_chain: + - subdomains + - dns + method: get + post: + description: >- + Idempotently re-applies the sending DNS records (creates missing + records, re-applies the email_routing lock on records whose lock has + been cleared). Refuses with a 409 if foreign MX, multiple SPF, multiple + DMARC, or multiple DKIM records exist at the relevant DNS names — those + require manual cleanup. + operationId: email-sending-subdomains-fix-sending-subdomain-dns + parameters: + - in: path + name: subdomain_id + schema: + $ref: '#/components/schemas/emailSendingSubdomainIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingSubdomainDnsStatusResponse' + description: Fix sending subdomain DNS records response + '400': + description: 'Error 2028: subdomain_id is not a valid UUID.' + '403': + description: 'Error 2043: zone is admin-locked and cannot be mutated.' + '404': + description: 'Error 2033: sending subdomain not found.' + '409': + description: >- + Conflict — manual DNS cleanup required. Errors 2008 (foreign MX), + 2026 (multiple SPF), 2027 (multiple DMARC), or a multi-DKIM error. + security: + - api_email: [] + api_key: [] + summary: Fix sending subdomain DNS records + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.create + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns/status: + get: + description: >- + Returns the desired DNS records for a sending subdomain along with a + live diff against actual DNS state. Use this to detect missing, + unlocked, foreign, or multi-record conflicts before deciding whether to + call the fix endpoint. + operationId: email-sending-subdomains-get-sending-subdomain-dns-status + parameters: + - in: path + name: subdomain_id + schema: + $ref: '#/components/schemas/emailSendingSubdomainIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/emailSendingSubdomainDnsStatusResponse' + description: Get sending subdomain DNS status response + '400': + description: 'Error 2028: subdomain_id is not a valid UUID.' + '404': + description: 'Error 2033: sending subdomain not found.' + security: + - api_email: [] + api_key: [] + summary: Get sending subdomain DNS status + tags: + - Email Sending subdomains + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.email.sending.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true +components: + schemas: + emailApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + emailApiResponseSingle: + type: object + $ref: '#/components/schemas/emailApiResponseCommon' + emailCreateSendingSubdomainProperties: + properties: + name: + description: The subdomain name. Must be within the zone. + example: sub.example.com + type: string + required: + - name + type: object + emailCreated: + description: The date and time the destination address has been created. + example: '2014-01-02T02:20:00Z' + format: date-time + readOnly: true + type: string + emailDnsRecord: + description: List of records needed to enable an Email Routing zone. + properties: + content: + description: DNS record content. + example: route1.mx.cloudflare.net + type: string + name: + description: DNS record name (or @ for the zone apex). + example: example.com + maxLength: 255 + type: string + x-auditable: true + priority: + description: >- + Required for MX, SRV and URI records. Unused by other record types. + Records with lower priorities are preferred. + example: 12 + maximum: 65535 + minimum: 0 + type: number + x-auditable: true + ttl: + description: >- + Time to live, in seconds, of the DNS record. Must be between 60 and + 86400, or 1 for 'automatic'. + example: 1 + type: number + x-auditable: true + enum: + - 1 + type: + description: DNS record type. + enum: + - A + - AAAA + - CNAME + - HTTPS + - TXT + - SRV + - LOC + - MX + - NS + - CERT + - DNSKEY + - DS + - NAPTR + - SMIMEA + - SSHFP + - SVCB + - TLSA + - URI + example: NS + readOnly: true + type: string + x-auditable: true + type: object + emailDnsSettingsResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/emailDnsRecord' + type: array + required: + - success + - errors + - messages + emailMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + emailModified: + description: The date and time the destination address was last modified. + example: '2014-01-02T02:20:00Z' + format: date-time + readOnly: true + type: string + emailSendingEmailBuilder: + example: + attachments: + - content: JVBERi0xLjQK... + disposition: attachment + filename: report.pdf + type: application/pdf + from: sender@example.com + html:

Hello

Please find your report attached.

+ subject: Monthly Report + text: |- + Hello + + Please find your report attached. + to: + - recipient@example.com + properties: + attachments: + description: File attachments and inline images. + items: + type: object + example: + content: iVBORw0KGgoAAAANSUhEUgAA... + content_id: logo + disposition: inline + filename: logo.png + type: image/png + properties: + content: + description: Base64-encoded content of the attachment. + example: iVBORw0KGgoAAAANSUhEUgAA... + type: string + content_id: + description: >- + Content ID used to reference this attachment in HTML via cid: + URI (e.g., ). + example: logo + type: string + disposition: + description: >- + Must be 'inline'. Indicates the attachment is embedded in the + email body. + enum: + - inline + type: string + filename: + description: Filename for the attachment. + example: logo.png + type: string + type: + description: MIME type of the attachment (e.g., 'image/png', 'text/plain'). + example: image/png + type: string + required: + - content + - disposition + - filename + - type + type: array + bcc: + description: >- + BCC recipient(s). A single email string or an array of email + strings. + type: string + example: user@example.com + items: + type: string + cc: + description: CC recipient(s). A single email string or an array of email strings. + type: string + example: user@example.com + items: + type: string + from: + description: >- + Sender email address. Either a plain string or an object with + address and name. + type: string + example: user@example.com + properties: + address: + description: Email address (e.g., 'user@example.com'). + example: user@example.com + type: string + name: + description: Display name for the email address (e.g., 'John Doe'). + example: John Doe + type: string + required: + - address + - name + headers: + description: Custom email headers as key-value pairs. + example: + X-Custom-Header: value + type: object + html: + description: >- + HTML body of the email. At least one of text or html must be + provided. + example:

Hello

Please find your report attached.

+ type: string + reply_to: + description: >- + Reply-to address. Either a plain string or an object with address + and name. + type: string + example: user@example.com + properties: + address: + description: Email address (e.g., 'user@example.com'). + example: user@example.com + type: string + name: + description: Display name for the email address (e.g., 'John Doe'). + example: John Doe + type: string + required: + - address + - name + subject: + description: Email subject line. + example: Monthly Report + type: string + text: + description: >- + Plain text body of the email. At least one of text or html must be + provided. + example: |- + Hello + + Please find your report attached. + type: string + to: + description: Recipient(s). A single email string or an array of email strings. + type: string + example: user@example.com + items: + type: string + required: + - from + - to + - subject + type: object + emailSendingEmailSendResponse: + example: + delivered: + - recipient@example.com + permanent_bounces: [] + queued: [] + properties: + delivered: + description: Email addresses to which the message was delivered immediately. + example: + - recipient@example.com + items: + type: string + type: array + permanent_bounces: + description: Email addresses that permanently bounced. + example: [] + items: + type: string + type: array + queued: + description: Email addresses for which delivery was queued for later. + example: [] + items: + type: string + type: array + required: + - delivered + - queued + - permanent_bounces + type: object + emailSendingSendRawRequest: + example: + from: sender@example.com + mime_message: "From: sender@example.com\r\nTo: recipient@example.com\r\nSubject: Hello\r\nContent-Type: text/plain\r\n\r\nHello, World!" + recipients: + - recipient@example.com + properties: + from: + description: Sender email address. + example: sender@example.com + type: string + mime_message: + description: >- + The full MIME-encoded email message. Should include standard RFC + 5322 headers such as From, To, Subject, and Content-Type. The from + and recipients fields in the request body control SMTP envelope + routing; the From and To headers in the MIME message control what + the recipient's email client displays. + example: "From: sender@example.com\r\nTo: recipient@example.com\r\nSubject: Hello\r\nContent-Type: text/plain\r\n\r\nHello, World!" + type: string + recipients: + description: List of recipient email addresses. + example: + - recipient@example.com + items: + type: string + type: array + required: + - from + - recipients + - mime_message + type: object + emailSendingSubdomain: + $ref: '#/components/schemas/emailSendingSubdomainProperties' + emailSendingSubdomainConfigError: + description: A DNS record status detected during preview, status, or fix. + properties: + code: + description: >- + Error code identifying the type of issue. `dkim.conflict` is + reported whenever 2+ TXT records exist at the DKIM selector, even if + one matches the canonical Cloudflare content — multi-record DKIM can + permerror at recipient verification regardless of which entry is + correct. + enum: + - mx.missing + - mx.foreign + - spf.missing + - spf.foreign + - spf.multiple + - dkim.missing + - dkim.conflict + - dmarc.missing + - dmarc.multiple + example: dkim.conflict + type: string + existing: + $ref: '#/components/schemas/emailDnsRecord' + missing: + $ref: '#/components/schemas/emailDnsRecord' + multiple: + items: + $ref: '#/components/schemas/emailDnsRecord' + type: array + required: + - code + type: object + emailSendingSubdomainDnsStatusResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + errors: + description: DNS issues detected against the current zone state. + items: + $ref: '#/components/schemas/emailSendingSubdomainConfigError' + type: array + records: + description: Desired DNS records for the subdomain. + items: + $ref: '#/components/schemas/emailDnsRecord' + type: array + status: + description: >- + Aggregated DNS state for the subdomain. `unlocked` means desired + records exist with correct content but at least one has had its + email_routing/read_only lock cleared. + enum: + - ready + - unconfigured + - unlocked + - misconfigured + type: string + type: object + required: + - success + - errors + - messages + emailSendingSubdomainIdentifier: + description: Sending subdomain identifier. + example: aabbccdd11223344aabbccdd11223344 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + emailSendingSubdomainPreviewResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + errors: + description: >- + DNS issues detected — missing records that will be created and + conflicts with existing records. + items: + $ref: '#/components/schemas/emailSendingSubdomainConfigError' + type: array + records: + description: DNS records that would be created for the subdomain. + items: + $ref: '#/components/schemas/emailDnsRecord' + type: array + type: object + required: + - success + - errors + - messages + emailSendingSubdomainProperties: + properties: + created: + $ref: '#/components/schemas/emailCreated' + dkim_selector: + description: The DKIM selector used for email signing. + example: cf-bounce + readOnly: true + type: string + enabled: + description: Whether Email Sending is enabled on this subdomain. + readOnly: true + type: boolean + modified: + $ref: '#/components/schemas/emailModified' + name: + description: The subdomain domain name. + example: sub.example.com + type: string + x-auditable: true + return_path_domain: + description: The return-path domain used for bounce handling. + example: cf-bounce.sub.example.com + readOnly: true + type: string + tag: + $ref: '#/components/schemas/emailSendingSubdomainIdentifier' + required: + - tag + - name + - enabled + type: object + emailSendingSubdomainResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/emailSendingSubdomain' + required: + - success + - errors + - messages + emailSendingSubdomainsResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/emailMessages' + messages: + $ref: '#/components/schemas/emailMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/emailSendingSubdomain' + type: array + required: + - success + - errors + - messages + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + email: + id: cloudflare.email_sending.email + name: email + title: Email + methods: + send: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1sending~1send/post' + response: + mediaType: application/json + openAPIDocKey: '200' + send_raw: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1email~1sending~1send_raw/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + subdomains: + id: cloudflare.email_sending.subdomains + name: subdomains + title: Subdomains + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1sending~1subdomains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1sending~1subdomains/post' + response: + mediaType: application/json + openAPIDocKey: '200' + preview: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1subdomains~1preview/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1subdomains~1{subdomain_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1subdomains~1{subdomain_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subdomains/methods/get' + - $ref: '#/components/x-stackQL-resources/subdomains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/subdomains/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/subdomains/methods/delete' + replace: [] + dns: + id: cloudflare.email_sending.dns + name: dns + title: Dns + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1subdomains~1{subdomain_id}~1dns/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + email_sending_subdomains_fix_sending_subdomain_dns: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1subdomains~1{subdomain_id}~1dns/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/dns/methods/email_sending_subdomains_fix_sending_subdomain_dns + update: [] + delete: [] + replace: [] + status: + id: cloudflare.email_sending.status + name: status + title: Status + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1subdomains~1{subdomain_id}~1dns~1status/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.records + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/filters.yaml b/providers/src/cloudflare/v00.00.00000/services/filters.yaml new file mode 100644 index 00000000..cc888e08 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/filters.yaml @@ -0,0 +1,955 @@ +openapi: 3.0.3 +info: + title: filters API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/filters: + delete: + deprecated: true + description: Deletes one or more existing filters. + operationId: filters-delete-filters + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: id + schema: + items: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterDeleteResponseCollection' + description: Delete filters response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + properties: + id: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasId + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete filters response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete filters + tags: + - Filters + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: filters + resource_chain: [] + method: bulk_delete + get: + deprecated: true + description: >- + Fetches filters in a zone. You can filter the results using several + optional parameters. + operationId: filters-list-filters + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: paused + schema: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasPaused' + - in: query + name: expression + schema: + description: A case-insensitive string to find in the expression. + type: string + - in: query + name: description + schema: + description: A case-insensitive string to find in the description. + type: string + - in: query + name: ref + schema: + description: >- + The filter ref (a short reference tag) to search for. Must be an + exact match. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 25 + description: Number of filters per page. + maximum: 100 + minimum: 5 + type: number + - in: query + name: id + schema: + description: The unique identifier of the filter. + maxLength: 32 + minLength: 32 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterResponseCollection' + description: List filters response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilter' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List filters response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List filters + tags: + - Filters + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: filters + resource_chain: [] + method: create + post: + deprecated: true + description: Creates one or more filters. + operationId: filters-create-filters + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/firewallFilter' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterResponseCollection' + description: Create filters response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilter' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create filters response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create filters + tags: + - Filters + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + deprecated: true + description: Updates one or more existing filters. + operationId: filters-update-filters + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/firewallFilterRuleUpdateRequest' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterResponseCollection' + description: Update filters response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilter' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update filters response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update filters + tags: + - Filters + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}/filters/{filter_id}: + delete: + deprecated: true + description: Deletes an existing filter. + operationId: filters-delete-a-filter + parameters: + - in: path + name: filter_id + schema: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterDeleteResponseSingle' + description: Delete a filter response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + id: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasId + required: + - id + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Delete a filter response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a filter + tags: + - Filters + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: filters + resource_chain: [] + method: delete + get: + deprecated: true + description: Fetches the details of a filter. + operationId: filters-get-a-filter + parameters: + - in: path + name: filter_id + schema: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterResponseSingle' + description: Get a filter response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + description: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasDescription + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasId + paused: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasPaused + ref: + $ref: '#/components/schemas/firewallSchemasRef' + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Get a filter response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a filter + tags: + - Filters + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: filters + resource_chain: [] + method: get + put: + deprecated: true + description: Updates an existing filter. + operationId: filters-update-a-filter + parameters: + - in: path + name: filter_id + schema: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterResponseSingle' + description: Update a filter response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + description: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasDescription + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasId + paused: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasPaused + ref: + $ref: '#/components/schemas/firewallSchemasRef' + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Update a filter response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a filter + tags: + - Filters + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: filters + resource_chain: [] + method: update +components: + schemas: + firewallExpression: + description: >- + The filter expression. For more information, refer to + [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/). + example: >- + (http.request.uri.path ~ ".*wp-login.php" or http.request.uri.path ~ + ".*xmlrpc.php") and ip.addr ne 172.16.22.155 + type: string + firewallFilter: + properties: + description: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasDescription' + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + paused: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasPaused' + ref: + $ref: '#/components/schemas/firewallSchemasRef' + type: object + firewallFilterDeleteResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + $ref: >- + #/components/schemas/firewallFilterDeleteResponseCollection_result_item + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + firewallFilterDeleteResponseCollection_result_item: + type: object + properties: + id: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + firewallFilterDeleteResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + id: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + required: + - id + type: object + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + firewallFilterResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilter' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + firewallFilterResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallFilter' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + firewallFilterRuleUpdateRequest: + properties: + description: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasDescription' + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + paused: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasPaused' + ref: + $ref: '#/components/schemas/firewallSchemasRef' + type: object + firewallFiltersComponentsSchemasDescription: + description: An informative summary of the filter. + example: Restrict access from these browsers on this address range. + maxLength: 500 + type: string + firewallFiltersComponentsSchemasId: + description: The unique identifier of the filter. + example: 372e67954025e0ba6aaa6d586b9e0b61 + maxLength: 32 + minLength: 32 + readOnly: true + type: string + firewallFiltersComponentsSchemasPaused: + description: When true, indicates that the filter is currently paused. + example: false + type: boolean + firewallMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + firewallResultInfo: + properties: + count: + description: Defines the total number of results for the requested service. + example: 1 + type: number + page: + description: Defines the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Defines the number of results per page of results. + example: 20 + type: number + total_count: + description: Defines the total results available without any search parameters. + example: 2000 + type: number + type: object + firewallSchemasRef: + description: A short reference tag. Allows you to select related filters. + example: FIL-100 + maxLength: 50 + type: string + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + filters: + id: cloudflare.filters.filters + name: filters + title: Filters + methods: + bulk_delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1filters/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1filters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + filters_create_filters: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1filters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + filters_update_filters: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1filters/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1filters~1{filter_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1filters~1{filter_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1filters~1{filter_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/filters/methods/get' + - $ref: '#/components/x-stackQL-resources/filters/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/filters/methods/filters_create_filters + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/filters/methods/delete' + - $ref: '#/components/x-stackQL-resources/filters/methods/bulk_delete' + replace: + - $ref: '#/components/x-stackQL-resources/filters/methods/update' + - $ref: >- + #/components/x-stackQL-resources/filters/methods/filters_update_filters diff --git a/providers/src/cloudflare/v00.00.00000/services/firewall.yaml b/providers/src/cloudflare/v00.00.00000/services/firewall.yaml new file mode 100644 index 00000000..1522e33d --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/firewall.yaml @@ -0,0 +1,7260 @@ +openapi: 3.0.3 +info: + title: firewall API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /user/firewall/access_rules/rules: + get: + description: >- + Fetches IP Access rules of the user. You can filter the results using + several optional parameters. + operationId: ip-access-rules-for-a-user-list-ip-access-rules + parameters: + - in: query + name: mode + schema: + $ref: '#/components/schemas/firewallSchemasMode' + - in: query + name: configuration.target + schema: + description: Defines the target to search in existing rules. + enum: + - ip + - ip_range + - asn + - country + type: string + - in: query + name: configuration.value + schema: + description: >- + Defines the target value to search for in existing rules: an IP + address, an IP address range, or a country code, depending on the + provided `configuration.target`. Notes: You can search for a + single IPv4 address, an IP address range with a subnet of '/16' or + '/24', or a two-letter ISO-3166-1 alpha-2 country code. + type: string + - in: query + name: notes + schema: + description: >- + Defines the string to search for in the notes of existing IP + Access rules. Notes: For example, the string 'attack' would match + IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The + search is case insensitive. + type: string + - in: query + name: match + schema: + default: all + description: >- + Defines the search requirements. When set to `all`, all the search + requirements must match. When set to `any`, only one of the search + requirements has to match. + enum: + - any + - all + type: string + - in: query + name: page + schema: + description: Defines the requested page within paginated list of results. + type: number + - in: query + name: per_page + schema: + description: Defines the maximum number of results requested. + type: number + - in: query + name: order + schema: + description: Defines the field used to sort returned rules. + enum: + - configuration.target + - configuration.value + - mode + type: string + - in: query + name: direction + schema: + description: Defines the direction used to sort returned rules. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRuleCollectionResponse' + description: List IP Access rules response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallRule' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List IP Access rules response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List IP Access rules + tags: + - IP Access rules for a user + x-api-token-group: + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + post: + description: >- + Creates a new IP Access rule for all zones owned by the current user. + Note: To create an IP Access rule that applies to a specific zone, refer + to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) + endpoints. + operationId: ip-access-rules-for-a-user-create-an-ip-access-rule + requestBody: + content: + application/json: + schema: + properties: + configuration: + $ref: '#/components/schemas/firewallConfiguration' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + notes: + $ref: '#/components/schemas/firewallNotes' + default: '' + required: + - mode + - configuration + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRuleSingleResponse' + description: Create an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + required: + - id + - mode + - allowed_modes + - configuration + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an IP Access rule + tags: + - IP Access rules for a user + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /user/firewall/access_rules/rules/{rule_id}: + delete: + description: >- + Deletes an IP Access rule at the user level. Note: Deleting a user-level + rule will affect all zones owned by the user. + operationId: ip-access-rules-for-a-user-delete-an-ip-access-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRuleSingleIdResponse' + description: Delete an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an IP Access rule + tags: + - IP Access rules for a user + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + patch: + description: >- + Updates an IP Access rule defined at the user level. You can only update + the rule action (`mode` parameter) and notes. + operationId: ip-access-rules-for-a-user-update-an-ip-access-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + mode: + $ref: '#/components/schemas/firewallSchemasMode' + notes: + $ref: '#/components/schemas/firewallNotes' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRuleSingleResponse' + description: Update an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + required: + - id + - mode + - allowed_modes + - configuration + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an IP Access rule + tags: + - IP Access rules for a user + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}/firewall/lockdowns: + get: + description: >- + Fetches Zone Lockdown rules. You can filter the results using several + optional parameters. + operationId: zone-lockdown-list-zone-lockdown-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: description + schema: + $ref: '#/components/schemas/firewallSchemasDescriptionSearch' + - in: query + name: modified_on + schema: + $ref: '#/components/schemas/firewallModifiedOn' + - in: query + name: ip + schema: + $ref: '#/components/schemas/firewallIpSearch' + - in: query + name: priority + schema: + $ref: '#/components/schemas/firewallSchemasPriority' + - in: query + name: uri_search + schema: + $ref: '#/components/schemas/firewallUriSearch' + - in: query + name: ip_range_search + schema: + $ref: '#/components/schemas/firewallIpRangeSearch' + - in: query + name: per_page + schema: + default: 20 + description: >- + The maximum number of results per page. You can only set the value + to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: created_on + schema: + description: The timestamp of when the rule was created. + format: date-time + type: string + - in: query + name: description_search + schema: + description: A string to search for in the description of existing rules. + type: string + - in: query + name: ip_search + schema: + description: A single IP address to search for in existing rules. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallZonelockdownResponseCollection' + description: List Zone Lockdown rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallZonelockdown' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: List Zone Lockdown rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zone Lockdown rules + tags: + - Zone Lockdown + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - lockdowns + method: list + post: + description: Creates a new Zone Lockdown rule. + operationId: zone-lockdown-create-a-zone-lockdown-rule + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + configurations: + $ref: '#/components/schemas/firewallConfigurations' + description: + $ref: '#/components/schemas/firewallDescription' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + priority: + $ref: '#/components/schemas/firewallSchemasPriority' + urls: + $ref: '#/components/schemas/firewallUrls' + required: + - urls + - configurations + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallZonelockdownResponseSingle' + description: Create a Zone Lockdown rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + configurations: + $ref: '#/components/schemas/firewallConfigurations' + created_on: + $ref: '#/components/schemas/firewallCreatedOn' + readOnly: true + description: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasDescription + id: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasId + modified_on: + $ref: '#/components/schemas/firewallModifiedOn' + readOnly: true + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + urls: + $ref: '#/components/schemas/firewallSchemasUrls' + required: + - id + - created_on + - modified_on + - paused + - description + - urls + - configurations + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Create a Zone Lockdown rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Zone Lockdown rule + tags: + - Zone Lockdown + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - lockdowns + method: create + /zones/{zone_id}/firewall/lockdowns/{lock_downs_id}: + delete: + description: Deletes an existing Zone Lockdown rule. + operationId: zone-lockdown-delete-a-zone-lockdown-rule + parameters: + - in: path + name: lock_downs_id + schema: + $ref: '#/components/schemas/firewallLockdownsComponentsSchemasId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasId + type: object + type: object + description: Delete a Zone Lockdown rule response + 4XX: + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasId + type: object + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: Delete a Zone Lockdown rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Zone Lockdown rule + tags: + - Zone Lockdown + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - lockdowns + method: delete + get: + description: Fetches the details of a Zone Lockdown rule. + operationId: zone-lockdown-get-a-zone-lockdown-rule + parameters: + - in: path + name: lock_downs_id + schema: + $ref: '#/components/schemas/firewallLockdownsComponentsSchemasId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallZonelockdownResponseSingle' + description: Get a Zone Lockdown rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + configurations: + $ref: '#/components/schemas/firewallConfigurations' + created_on: + $ref: '#/components/schemas/firewallCreatedOn' + readOnly: true + description: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasDescription + id: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasId + modified_on: + $ref: '#/components/schemas/firewallModifiedOn' + readOnly: true + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + urls: + $ref: '#/components/schemas/firewallSchemasUrls' + required: + - id + - created_on + - modified_on + - paused + - description + - urls + - configurations + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Get a Zone Lockdown rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Zone Lockdown rule + tags: + - Zone Lockdown + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - lockdowns + method: get + put: + description: Updates an existing Zone Lockdown rule. + operationId: zone-lockdown-update-a-zone-lockdown-rule + parameters: + - in: path + name: lock_downs_id + schema: + $ref: '#/components/schemas/firewallLockdownsComponentsSchemasId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + configurations: + $ref: '#/components/schemas/firewallConfigurations' + urls: + $ref: '#/components/schemas/firewallUrls' + required: + - urls + - configurations + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallZonelockdownResponseSingle' + description: Update a Zone Lockdown rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + configurations: + $ref: '#/components/schemas/firewallConfigurations' + created_on: + $ref: '#/components/schemas/firewallCreatedOn' + readOnly: true + description: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasDescription + id: + $ref: >- + #/components/schemas/firewallLockdownsComponentsSchemasId + modified_on: + $ref: '#/components/schemas/firewallModifiedOn' + readOnly: true + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + urls: + $ref: '#/components/schemas/firewallSchemasUrls' + required: + - id + - created_on + - modified_on + - paused + - description + - urls + - configurations + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Update a Zone Lockdown rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Zone Lockdown rule + tags: + - Zone Lockdown + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - lockdowns + method: update + /zones/{zone_id}/firewall/rules: + delete: + deprecated: true + description: Deletes existing firewall rules. + operationId: firewall-rules-delete-firewall-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/firewallFilterRulesResponseCollectionDelete + description: Delete firewall rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Delete firewall rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete firewall rules + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + get: + deprecated: true + description: >- + Fetches firewall rules in a zone. You can filter the results using + several optional parameters. + operationId: firewall-rules-list-firewall-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: description + schema: + description: A case-insensitive string to find in the description. + type: string + - in: query + name: action + schema: + description: The action to search for. Must be an exact match. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 25 + description: Number of firewall rules per page. + maximum: 100 + minimum: 5 + type: number + - in: query + name: id + schema: + description: The unique identifier of the firewall rule. + maxLength: 32 + type: string + - in: query + name: paused + schema: + description: When true, indicates that the firewall rule is currently paused. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesResponseCollection' + description: List firewall rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: List firewall rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List firewall rules + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - rules + method: create + patch: + deprecated: true + description: Updates the priority of existing firewall rules. + operationId: firewall-rules-update-priority-of-firewall-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesResponseCollection' + description: Update priority of firewall rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Update priority of firewall rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update priority of firewall rules + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + post: + deprecated: true + description: Create one or more firewall rules. + operationId: firewall-rules-create-firewall-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + $ref: '#/components/schemas/firewallAction' + filter: + $ref: '#/components/schemas/firewallFilter' + required: + - filter + - action + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesResponseCollection' + description: Create firewall rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Create firewall rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create firewall rules + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + deprecated: true + description: Updates one or more existing firewall rules. + operationId: firewall-rules-update-firewall-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesResponseCollection' + description: Update firewall rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Update firewall rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update firewall rules + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}/firewall/rules/{rule_id}: + delete: + deprecated: true + description: Deletes an existing firewall rule. + operationId: firewall-rules-delete-a-firewall-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesSingleResponseDelete' + description: Delete a firewall rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallSchemasAction' + description: + $ref: >- + #/components/schemas/firewallFirewallRulesComponentsSchemasDescription + id: + $ref: >- + #/components/schemas/firewallFirewallRulesComponentsSchemasId + paused: + $ref: '#/components/schemas/firewallComponentsSchemasPaused' + priority: + $ref: '#/components/schemas/firewallComponentsSchemasPriority' + products: + $ref: '#/components/schemas/firewallProducts' + ref: + $ref: '#/components/schemas/firewallRef' + filter: + type: object + properties: + description: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasDescription + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasId + paused: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasPaused + ref: + $ref: '#/components/schemas/firewallSchemasRef' + deleted: + $ref: '#/components/schemas/firewallDeleted' + required: + - id + - deleted + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Delete a firewall rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a firewall rule + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - rules + method: delete + get: + deprecated: true + description: Fetches the details of a firewall rule. + operationId: firewall-rules-get-a-firewall-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesSingleResponse' + description: Get a firewall rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallSchemasAction' + description: + $ref: >- + #/components/schemas/firewallFirewallRulesComponentsSchemasDescription + id: + $ref: >- + #/components/schemas/firewallFirewallRulesComponentsSchemasId + paused: + $ref: '#/components/schemas/firewallComponentsSchemasPaused' + priority: + $ref: '#/components/schemas/firewallComponentsSchemasPriority' + products: + $ref: '#/components/schemas/firewallProducts' + ref: + $ref: '#/components/schemas/firewallRef' + filter: + type: object + properties: + description: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasDescription + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasId + paused: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasPaused + ref: + $ref: '#/components/schemas/firewallSchemasRef' + deleted: + $ref: '#/components/schemas/firewallDeleted' + required: + - id + - deleted + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Get a firewall rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a firewall rule + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - rules + method: edit + patch: + deprecated: true + description: Updates the priority of an existing firewall rule. + operationId: firewall-rules-update-priority-of-a-firewall-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + id: + $ref: '#/components/schemas/firewallComponentsSchemasIdentifier' + required: + - id + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesResponseCollection' + description: Update priority of a firewall rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Update priority of a firewall rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update priority of a firewall rule + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + deprecated: true + description: Updates an existing firewall rule. + operationId: firewall-rules-update-a-firewall-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + $ref: '#/components/schemas/firewallAction' + filter: + $ref: '#/components/schemas/firewallFilter' + id: + $ref: '#/components/schemas/firewallComponentsSchemasIdentifier' + required: + - id + - filter + - action + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFilterRulesSingleResponse' + description: Update a firewall rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallSchemasAction' + description: + $ref: >- + #/components/schemas/firewallFirewallRulesComponentsSchemasDescription + id: + $ref: >- + #/components/schemas/firewallFirewallRulesComponentsSchemasId + paused: + $ref: '#/components/schemas/firewallComponentsSchemasPaused' + priority: + $ref: '#/components/schemas/firewallComponentsSchemasPriority' + products: + $ref: '#/components/schemas/firewallProducts' + ref: + $ref: '#/components/schemas/firewallRef' + filter: + type: object + properties: + description: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasDescription + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasId + paused: + $ref: >- + #/components/schemas/firewallFiltersComponentsSchemasPaused + ref: + $ref: '#/components/schemas/firewallSchemasRef' + deleted: + $ref: '#/components/schemas/firewallDeleted' + required: + - id + - deleted + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Update a firewall rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a firewall rule + tags: + - Firewall rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - rules + method: update + /zones/{zone_id}/firewall/ua_rules: + get: + description: >- + Fetches User Agent Blocking rules in a zone. You can filter the results + using several optional parameters. + operationId: user-agent-blocking-rules-list-user-agent-blocking-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: description + schema: + $ref: '#/components/schemas/firewallDescriptionSearch' + - in: query + name: per_page + schema: + default: 20 + description: >- + The maximum number of results per page. You can only set the value + to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: user_agent + schema: + description: A string to search for in the user agent values of existing rules. + type: string + - in: query + name: paused + schema: + description: When true, indicates that the rule is currently paused. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFirewalluablockResponseCollection' + description: List User Agent Blocking rules response + 4XX: + content: + application/json: + schema: + properties: + result: + items: + $ref: '#/components/schemas/firewallFirewalluablock' + type: object + type: array + enum: + - null + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List User Agent Blocking rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List User Agent Blocking rules + tags: + - User Agent Blocking rules + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - ua_rules + method: list + post: + description: Creates a new User Agent Blocking rule in a zone. + operationId: user-agent-blocking-rules-create-a-user-agent-blocking-rule + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + configuration: + $ref: '#/components/schemas/firewallUaConfiguration' + description: + $ref: '#/components/schemas/firewallDescription' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + required: + - mode + - configuration + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFirewalluablockResponseSingle' + description: Create a User Agent Blocking rule response + 4XX: + content: + application/json: + schema: + properties: + result: + properties: + configuration: + $ref: '#/components/schemas/firewallSchemasConfiguration' + description: + $ref: >- + #/components/schemas/firewallFirewalluablockComponentsSchemasDescription + id: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + mode: + $ref: '#/components/schemas/firewallComponentsSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + type: object + enum: + - null + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create a User Agent Blocking rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a User Agent Blocking rule + tags: + - User Agent Blocking rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - ua_rules + method: create + /zones/{zone_id}/firewall/ua_rules/{ua_rule_id}: + delete: + description: Deletes an existing User Agent Blocking rule. + operationId: user-agent-blocking-rules-delete-a-user-agent-blocking-rule + parameters: + - in: path + name: ua_rule_id + schema: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + configuration: + $ref: '#/components/schemas/firewallSchemasConfiguration' + description: + $ref: >- + #/components/schemas/firewallFirewalluablockComponentsSchemasDescription + mode: + $ref: '#/components/schemas/firewallComponentsSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + type: object + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: Delete a User Agent Blocking rule response + 4XX: + content: + application/json: + schema: + properties: + result: + properties: + configuration: + $ref: '#/components/schemas/firewallSchemasConfiguration' + description: + $ref: >- + #/components/schemas/firewallFirewalluablockComponentsSchemasDescription + id: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + mode: + $ref: '#/components/schemas/firewallComponentsSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + type: object + enum: + - null + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a User Agent Blocking rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a User Agent Blocking rule + tags: + - User Agent Blocking rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - ua_rules + method: delete + get: + description: Fetches the details of a User Agent Blocking rule. + operationId: user-agent-blocking-rules-get-a-user-agent-blocking-rule + parameters: + - in: path + name: ua_rule_id + schema: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFirewalluablockResponseSingle' + description: Get a User Agent Blocking rule response + 4XX: + content: + application/json: + schema: + properties: + result: + properties: + configuration: + $ref: '#/components/schemas/firewallSchemasConfiguration' + description: + $ref: >- + #/components/schemas/firewallFirewalluablockComponentsSchemasDescription + id: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + mode: + $ref: '#/components/schemas/firewallComponentsSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + type: object + enum: + - null + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get a User Agent Blocking rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a User Agent Blocking rule + tags: + - User Agent Blocking rules + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - ua_rules + method: get + put: + description: Updates an existing User Agent Blocking rule. + operationId: user-agent-blocking-rules-update-a-user-agent-blocking-rule + parameters: + - in: path + name: ua_rule_id + schema: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + configuration: + $ref: '#/components/schemas/firewallConfiguration' + description: + $ref: '#/components/schemas/firewallDescription' + id: + $ref: '#/components/schemas/firewallComponentsSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + required: + - id + - mode + - configuration + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallFirewalluablockResponseSingle' + description: Update a User Agent Blocking rule response + 4XX: + content: + application/json: + schema: + properties: + result: + properties: + configuration: + $ref: '#/components/schemas/firewallSchemasConfiguration' + description: + $ref: >- + #/components/schemas/firewallFirewalluablockComponentsSchemasDescription + id: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + mode: + $ref: '#/components/schemas/firewallComponentsSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + type: object + enum: + - null + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a User Agent Blocking rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a User Agent Blocking rule + tags: + - User Agent Blocking rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - ua_rules + method: update + /zones/{zone_id}/firewall/waf/overrides: + get: + deprecated: true + description: >- + Fetches the URI-based WAF overrides in a zone. **Note:** Applies only to + the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-overrides-list-waf-overrides + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: The page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 50 + description: The number of WAF overrides per page. + maximum: 100 + minimum: 5 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallOverrideResponseCollection' + description: List WAF overrides response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallOverride' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: List WAF overrides response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List WAF overrides + tags: + - WAF overrides + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - overrides + method: list + post: + deprecated: true + description: >- + Creates a URI-based WAF override for a zone. **Note:** Applies only to + the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-overrides-create-a-waf-override + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + urls: + $ref: '#/components/schemas/firewallUrls' + required: + - urls + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallOverrideResponseSingle' + description: Create a WAF override response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + description: + $ref: >- + #/components/schemas/firewallComponentsSchemasDescription + groups: + $ref: '#/components/schemas/firewallGroups' + id: + $ref: '#/components/schemas/firewallOverridesId' + paused: + $ref: '#/components/schemas/firewallPaused' + priority: + $ref: '#/components/schemas/firewallPriority' + rewrite_action: + $ref: '#/components/schemas/firewallRewriteAction' + rules: + $ref: '#/components/schemas/firewallRules' + urls: + $ref: '#/components/schemas/firewallUrls' + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Create a WAF override response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a WAF override + tags: + - WAF overrides + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - overrides + method: create + /zones/{zone_id}/firewall/waf/overrides/{overrides_id}: + delete: + deprecated: true + description: >- + Deletes an existing URI-based WAF override. **Note:** Applies only to + the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-overrides-delete-a-waf-override + parameters: + - in: path + name: overrides_id + schema: + $ref: '#/components/schemas/firewallOverridesId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: '#/components/schemas/firewallOverridesId' + type: object + type: object + description: Delete a WAF override response + 4XX: + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: '#/components/schemas/firewallOverridesId' + type: object + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: Delete a WAF override response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a WAF override + tags: + - WAF overrides + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - overrides + method: delete + get: + deprecated: true + description: >- + Fetches the details of a URI-based WAF override. **Note:** Applies only + to the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-overrides-get-a-waf-override + parameters: + - in: path + name: overrides_id + schema: + $ref: '#/components/schemas/firewallOverridesId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallOverrideResponseSingle' + description: Get a WAF override response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + description: + $ref: >- + #/components/schemas/firewallComponentsSchemasDescription + groups: + $ref: '#/components/schemas/firewallGroups' + id: + $ref: '#/components/schemas/firewallOverridesId' + paused: + $ref: '#/components/schemas/firewallPaused' + priority: + $ref: '#/components/schemas/firewallPriority' + rewrite_action: + $ref: '#/components/schemas/firewallRewriteAction' + rules: + $ref: '#/components/schemas/firewallRules' + urls: + $ref: '#/components/schemas/firewallUrls' + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Get a WAF override response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a WAF override + tags: + - WAF overrides + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - overrides + method: get + put: + deprecated: true + description: >- + Updates an existing URI-based WAF override. **Note:** Applies only to + the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-overrides-update-waf-override + parameters: + - in: path + name: overrides_id + schema: + $ref: '#/components/schemas/firewallOverridesId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + id: + $ref: '#/components/schemas/firewallIdentifier' + rewrite_action: + $ref: '#/components/schemas/firewallRewriteAction' + rules: + $ref: '#/components/schemas/firewallRules' + urls: + $ref: '#/components/schemas/firewallUrls' + required: + - id + - urls + - rules + - rewrite_action + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallOverrideResponseSingle' + description: Update WAF override response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + description: + $ref: >- + #/components/schemas/firewallComponentsSchemasDescription + groups: + $ref: '#/components/schemas/firewallGroups' + id: + $ref: '#/components/schemas/firewallOverridesId' + paused: + $ref: '#/components/schemas/firewallPaused' + priority: + $ref: '#/components/schemas/firewallPriority' + rewrite_action: + $ref: '#/components/schemas/firewallRewriteAction' + rules: + $ref: '#/components/schemas/firewallRules' + urls: + $ref: '#/components/schemas/firewallUrls' + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + description: Update WAF override response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update WAF override + tags: + - WAF overrides + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - overrides + method: update + /zones/{zone_id}/firewall/waf/packages: + get: + deprecated: true + description: >- + Fetches WAF packages for a zone. **Note:** Applies only to the [previous + version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-packages-list-waf-packages + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: The page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 50 + description: The number of packages per page. + maximum: 100 + minimum: 5 + type: number + - in: query + name: order + schema: + description: The field used to sort returned packages. + enum: + - name + type: string + - in: query + name: direction + schema: + description: The direction used to sort returned packages. + enum: + - asc + - desc + type: string + - in: query + name: match + schema: + default: all + description: >- + When set to `all`, all the search requirements must match. When + set to `any`, only one of the search requirements has to match. + enum: + - any + - all + type: string + - in: query + name: name + schema: + description: The name of the WAF package. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallPackageResponseCollection' + description: List WAF packages response + 4XX: + content: + application/json: + schema: + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Defines whether the API call was successful. + enum: + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - errors + - messages + - result + - success + type: object + description: List WAF packages response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List WAF packages + tags: + - WAF packages + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + method: list + /zones/{zone_id}/firewall/waf/packages/{package_id}: + get: + deprecated: true + description: >- + Fetches the details of a WAF package. **Note:** Applies only to the + [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-packages-get-a-waf-package + parameters: + - in: path + name: package_id + schema: + $ref: '#/components/schemas/firewallPackageId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallPackageResponseSingle' + description: Get a WAF package response + 4XX: + content: + application/json: + schema: + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Defines whether the API call was successful. + enum: + - false + type: boolean + required: + - errors + - messages + - result + - success + type: object + description: Get a WAF package response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a WAF package + tags: + - WAF packages + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + method: get + patch: + deprecated: true + description: >- + Updates a WAF package. You can update the sensitivity and the action of + an anomaly detection WAF package. **Note:** Applies only to the + [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-packages-update-a-waf-package + parameters: + - in: path + name: package_id + schema: + $ref: '#/components/schemas/firewallPackageId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action_mode: + $ref: '#/components/schemas/firewallActionMode' + sensitivity: + $ref: '#/components/schemas/firewallSensitivity' + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + $ref: '#/components/schemas/firewallAnomalyPackage' + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + type: boolean + type: object + required: + - errors + - success + - result + - messages + description: Update a WAF package response + 4XX: + content: + application/json: + schema: + properties: + result: + required: + - id + - name + - description + - detection_mode + - zone_id + title: Anomaly detection WAF package (OWASP) + properties: + description: + description: A summary of the purpose/function of the WAF package. + readOnly: true + type: string + detection_mode: + description: >- + When a WAF package uses anomaly detection, each rule + is given a score when triggered. If the total score of + all triggered rules exceeds the sensitivity defined on + the WAF package, the action defined on the package + will be taken. + enum: + - anomaly + - traditional + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallIdentifier' + name: + description: The name of the WAF package. + readOnly: true + type: string + status: + $ref: '#/components/schemas/firewallStatus' + zone_id: + $ref: '#/components/schemas/firewallIdentifier' + action_mode: + $ref: '#/components/schemas/firewallActionMode' + sensitivity: + $ref: '#/components/schemas/firewallSensitivity' + type: object + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - false + type: boolean + required: + - errors + - messages + - result + - success + type: object + description: Update a WAF package response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a WAF package + tags: + - WAF packages + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + /zones/{zone_id}/firewall/waf/packages/{package_id}/groups: + get: + deprecated: true + description: >- + Fetches the WAF rule groups in a WAF package. **Note:** Applies only to + the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-rule-groups-list-waf-rule-groups + parameters: + - in: path + name: package_id + schema: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: mode + schema: + $ref: '#/components/schemas/wafManagedRulesMode' + - in: query + name: page + schema: + default: 1 + description: Defines the page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 50 + description: Defines the number of rule groups per page. + maximum: 100 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Defines the field used to sort returned rule groups. + enum: + - mode + - rules_count + type: string + - in: query + name: direction + schema: + description: Defines the direction used to sort returned rule groups. + enum: + - asc + - desc + type: string + - in: query + name: match + schema: + default: all + description: >- + Defines the condition for search requirements. When set to `all`, + all the search requirements must match. When set to `any`, only + one of the search requirements has to match. + enum: + - any + - all + type: string + - in: query + name: name + schema: + description: Defines the name of the rule group. + type: string + - in: query + name: rules_count + schema: + default: 0 + description: Defines the number of rules in the current rule group. + type: number + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafManagedRulesRuleGroupResponseCollection + description: Defines the list WAF rule groups response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/wafManagedRulesResultInfo' + result: + items: + $ref: '#/components/schemas/wafManagedRulesSchemasGroup' + type: array + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Defines the list WAF rule groups response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List WAF rule groups + tags: + - WAF rule groups + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + - groups + method: list + /zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}: + get: + deprecated: true + description: >- + Fetches the details of a WAF rule group. **Note:** Applies only to the + [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-rule-groups-get-a-waf-rule-group + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - in: path + name: package_id + schema: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafManagedRulesRuleGroupResponseSingle' + description: Get a WAF rule group response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get a WAF rule group response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a WAF rule group + tags: + - WAF rule groups + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + - groups + method: get + patch: + deprecated: true + description: >- + Updates a WAF rule group. You can update the state (`mode` parameter) of + a rule group. **Note:** Applies only to the [previous version of WAF + managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-rule-groups-update-a-waf-rule-group + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - in: path + name: package_id + schema: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + mode: + $ref: '#/components/schemas/wafManagedRulesMode' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafManagedRulesRuleGroupResponseSingle' + description: Update a WAF rule group response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a WAF rule group response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a WAF rule group + tags: + - WAF rule groups + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + - groups + method: edit + /zones/{zone_id}/firewall/waf/packages/{package_id}/rules: + get: + deprecated: true + description: >- + Fetches WAF rules in a WAF package. **Note:** Applies only to the + [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-rules-list-waf-rules + parameters: + - in: path + name: package_id + schema: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: mode + schema: + description: Defines the action/mode a rule has been overridden to perform. + enum: + - DIS + - CHL + - BLK + - SIM + type: string + - in: query + name: group_id + schema: + $ref: '#/components/schemas/wafManagedRulesComponentsSchemasIdentifier' + - in: query + name: page + schema: + default: 1 + description: Defines the page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 50 + description: Defines the number of rules per page. + maximum: 100 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Defines the field used to sort returned rules. + enum: + - priority + - group_id + - description + type: string + - in: query + name: direction + schema: + description: Defines the direction used to sort returned rules. + enum: + - asc + - desc + type: string + - in: query + name: match + schema: + default: all + description: >- + Defines the search requirements. When set to `all`, all the search + requirements must match. When set to `any`, only one of the search + requirements has to match. + enum: + - any + - all + type: string + - in: query + name: description + schema: + description: Defines the public description of the WAF rule. + type: string + - in: query + name: priority + schema: + description: >- + Defines the order in which the individual WAF rule is executed + within its rule group. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafManagedRulesRuleResponseCollection' + description: List WAF rules response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/wafManagedRulesResultInfo' + result: + items: + $ref: '#/components/schemas/wafManagedRulesRule' + type: array + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List WAF rules response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List WAF rules + tags: + - WAF rules + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + - rules + method: list + /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}: + get: + deprecated: true + description: >- + Fetches the details of a WAF rule in a WAF package. **Note:** Applies + only to the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-rules-get-a-waf-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - in: path + name: package_id + schema: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafManagedRulesRuleResponseSingle' + description: Get a WAF rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get a WAF rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a WAF rule + tags: + - WAF rules + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + - rules + method: get + patch: + deprecated: true + description: >- + Updates a WAF rule. You can only update the mode/action of the rule. + **Note:** Applies only to the [previous version of WAF managed + rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). + operationId: waf-rules-update-a-waf-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - in: path + name: package_id + schema: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + mode: + description: >- + Defines the mode/action of the rule when triggered. You must + use a value from the `allowed_modes` array of the current + rule. + enum: + - default + - disable + - simulate + - block + - challenge + - 'on' + - 'off' + type: string + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + type: boolean + result: + type: object + title: Anomaly detection WAF rule + description: >- + When triggered, anomaly detection WAF rules contribute to + an overall threat score that will determine if a request + is considered malicious. You can configure the total + scoring threshold through the 'sensitivity' property of + the WAF package. + properties: + description: + $ref: '#/components/schemas/wafManagedRulesSchemasDescription' + group: + $ref: >- + #/components/schemas/unnamedSchemaRef532d8b97684c9032dd36bae8acddebf5 + id: + $ref: >- + #/components/schemas/wafManagedRulesRuleComponentsSchemasIdentifier + package_id: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + priority: + $ref: '#/components/schemas/wafManagedRulesPriority' + allowed_modes: + $ref: >- + #/components/schemas/wafManagedRulesAllowedModesAnomaly + mode: + $ref: '#/components/schemas/wafManagedRulesModeAnomaly' + default_mode: + $ref: '#/components/schemas/wafManagedRulesDefaultMode' + required: + - allowed_modes + - description + - group + - id + - mode + - package_id + - priority + required: + - success + - errors + - messages + - result + description: Update a WAF rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + title: Anomaly detection WAF rule + description: >- + When triggered, anomaly detection WAF rules contribute to + an overall threat score that will determine if a request + is considered malicious. You can configure the total + scoring threshold through the 'sensitivity' property of + the WAF package. + properties: + description: + $ref: '#/components/schemas/wafManagedRulesSchemasDescription' + group: + $ref: >- + #/components/schemas/unnamedSchemaRef532d8b97684c9032dd36bae8acddebf5 + id: + $ref: >- + #/components/schemas/wafManagedRulesRuleComponentsSchemasIdentifier + package_id: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + priority: + $ref: '#/components/schemas/wafManagedRulesPriority' + allowed_modes: + $ref: >- + #/components/schemas/wafManagedRulesAllowedModesAnomaly + mode: + $ref: '#/components/schemas/wafManagedRulesModeAnomaly' + default_mode: + $ref: '#/components/schemas/wafManagedRulesDefaultMode' + required: + - allowed_modes + - description + - group + - id + - mode + - package_id + - priority + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a WAF rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a WAF rule + tags: + - WAF rules + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - waf + - packages + - rules + method: edit + /accounts/{account_id}/firewall/access_rules/rules: + get: + description: >- + Fetches IP Access rules of an account or zone. These rules apply to all + the zones in the account or zone. You can filter the results using + several optional parameters. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: mode + schema: + $ref: '#/components/schemas/firewallSchemasMode' + - in: query + name: configuration.target + schema: + description: Defines the target to search in existing rules. + enum: + - ip + - ip_range + - asn + - country + type: string + - in: query + name: configuration.value + schema: + description: >- + Defines the target value to search for in existing rules: an IP + address, an IP address range, or a country code, depending on the + provided `configuration.target`. Notes: You can search for a + single IPv4 address, an IP address range with a subnet of '/16' or + '/24', or a two-letter ISO-3166-1 alpha-2 country code. + type: string + - in: query + name: notes + schema: + description: >- + Defines the string to search for in the notes of existing IP + Access rules. Notes: For example, the string 'attack' would match + IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The + search is case insensitive. + type: string + - in: query + name: match + schema: + default: all + description: >- + Defines the search requirements. When set to `all`, all the search + requirements must match. When set to `any`, only one of the search + requirements has to match. + enum: + - any + - all + type: string + - in: query + name: page + schema: + description: Defines the requested page within paginated list of results. + type: number + - in: query + name: per_page + schema: + description: Defines the maximum number of results requested. + type: number + - in: query + name: order + schema: + description: Defines the field used to sort returned rules. + enum: + - configuration.target + - configuration.value + - mode + type: string + - in: query + name: direction + schema: + description: Defines the direction used to sort returned rules. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseCollection' + description: List IP Access rules response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallSchemasRule' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List IP Access rules response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List IP Access rules + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + x-cfPermissionsRequired: + enum: + - '#waf:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: list + operationId: get_accounts_account_id_firewall_access_rules_rules + post: + description: >- + Creates a new IP Access rule for an account or zone. The rule will apply + to all zones in the account or zone. Note: To create an IP Access rule + that applies to a single zone, refer to the [IP Access rules for a + zone](#ip-access-rules-for-a-zone) endpoints. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + configuration: + $ref: '#/components/schemas/firewallConfiguration' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + notes: + $ref: '#/components/schemas/firewallNotes' + default: '' + required: + - mode + - configuration + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseSingle' + description: Create an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + required: + - id + - mode + - allowed_modes + - configuration + type: object + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + scope: + description: >- + All zones owned by the user will have the rule + applied. + properties: + email: + $ref: '#/components/schemas/firewallEmail' + id: + $ref: '#/components/schemas/firewallIdentifier' + type: + description: Defines the scope of the rule. + enum: + - user + - organization + readOnly: true + type: string + readOnly: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPermissionsRequired: + enum: + - '#waf:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: create + operationId: post_accounts_account_id_firewall_access_rules_rules + /zones/{zone_id}/firewall/access_rules/rules: + get: + description: >- + Fetches IP Access rules of an account or zone. These rules apply to all + the zones in the account or zone. You can filter the results using + several optional parameters. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: mode + schema: + $ref: '#/components/schemas/firewallSchemasMode' + - in: query + name: configuration.target + schema: + description: Defines the target to search in existing rules. + enum: + - ip + - ip_range + - asn + - country + type: string + - in: query + name: configuration.value + schema: + description: >- + Defines the target value to search for in existing rules: an IP + address, an IP address range, or a country code, depending on the + provided `configuration.target`. Notes: You can search for a + single IPv4 address, an IP address range with a subnet of '/16' or + '/24', or a two-letter ISO-3166-1 alpha-2 country code. + type: string + - in: query + name: notes + schema: + description: >- + Defines the string to search for in the notes of existing IP + Access rules. Notes: For example, the string 'attack' would match + IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The + search is case insensitive. + type: string + - in: query + name: match + schema: + default: all + description: >- + Defines the search requirements. When set to `all`, all the search + requirements must match. When set to `any`, only one of the search + requirements has to match. + enum: + - any + - all + type: string + - in: query + name: page + schema: + description: Defines the requested page within paginated list of results. + type: number + - in: query + name: per_page + schema: + description: Defines the maximum number of results requested. + type: number + - in: query + name: order + schema: + description: Defines the field used to sort returned rules. + enum: + - configuration.target + - configuration.value + - mode + type: string + - in: query + name: direction + schema: + description: Defines the direction used to sort returned rules. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseCollection' + description: List IP Access rules response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallSchemasRule' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List IP Access rules response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List IP Access rules + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + x-cfPermissionsRequired: + enum: + - '#waf:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: list + operationId: get_zones_zone_id_firewall_access_rules_rules + post: + description: >- + Creates a new IP Access rule for an account or zone. The rule will apply + to all zones in the account or zone. Note: To create an IP Access rule + that applies to a single zone, refer to the [IP Access rules for a + zone](#ip-access-rules-for-a-zone) endpoints. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + configuration: + $ref: '#/components/schemas/firewallConfiguration' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + notes: + $ref: '#/components/schemas/firewallNotes' + default: '' + required: + - mode + - configuration + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseSingle' + description: Create an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + required: + - id + - mode + - allowed_modes + - configuration + type: object + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + scope: + description: >- + All zones owned by the user will have the rule + applied. + properties: + email: + $ref: '#/components/schemas/firewallEmail' + id: + $ref: '#/components/schemas/firewallIdentifier' + type: + description: Defines the scope of the rule. + enum: + - user + - organization + readOnly: true + type: string + readOnly: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPermissionsRequired: + enum: + - '#waf:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: create + operationId: post_zones_zone_id_firewall_access_rules_rules + /accounts/{account_id}/firewall/access_rules/rules/{rule_id}: + get: + description: Fetches the details of an IP Access rule defined. + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseSingle' + description: Get an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + required: + - id + - mode + - allowed_modes + - configuration + type: object + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + scope: + description: >- + All zones owned by the user will have the rule + applied. + properties: + email: + $ref: '#/components/schemas/firewallEmail' + id: + $ref: '#/components/schemas/firewallIdentifier' + type: + description: Defines the scope of the rule. + enum: + - user + - organization + readOnly: true + type: string + readOnly: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + x-cfPermissionsRequired: + enum: + - '#waf:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: get + operationId: get_accounts_account_id_firewall_access_rules_rules_rule_id + delete: + description: >- + Deletes an existing IP Access rule defined. Note: This operation will + affect all zones in the account or zone. + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallApiResponseSingleId' + description: Delete an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/firewallIdentifier' + required: + - id + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPermissionsRequired: + enum: + - '#waf:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: delete + operationId: delete_accounts_account_id_firewall_access_rules_rules_rule_id + patch: + description: >- + Updates an IP Access rule defined. Note: This operation will affect all + zones in the account or zone. + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/firewallSchemasRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseSingle' + description: Update an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + required: + - id + - mode + - allowed_modes + - configuration + type: object + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + scope: + description: >- + All zones owned by the user will have the rule + applied. + properties: + email: + $ref: '#/components/schemas/firewallEmail' + id: + $ref: '#/components/schemas/firewallIdentifier' + type: + description: Defines the scope of the rule. + enum: + - user + - organization + readOnly: true + type: string + readOnly: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPermissionsRequired: + enum: + - '#waf:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: edit + operationId: patch_accounts_account_id_firewall_access_rules_rules_rule_id + /zones/{zone_id}/firewall/access_rules/rules/{rule_id}: + get: + description: Fetches the details of an IP Access rule defined. + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseSingle' + description: Get an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + required: + - id + - mode + - allowed_modes + - configuration + type: object + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + scope: + description: >- + All zones owned by the user will have the rule + applied. + properties: + email: + $ref: '#/components/schemas/firewallEmail' + id: + $ref: '#/components/schemas/firewallIdentifier' + type: + description: Defines the scope of the rule. + enum: + - user + - organization + readOnly: true + type: string + readOnly: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + x-cfPermissionsRequired: + enum: + - '#waf:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: get + operationId: get_zones_zone_id_firewall_access_rules_rules_rule_id + delete: + description: >- + Deletes an existing IP Access rule defined. Note: This operation will + affect all zones in the account or zone. + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallApiResponseSingleId' + description: Delete an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/firewallIdentifier' + required: + - id + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPermissionsRequired: + enum: + - '#waf:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: delete + operationId: delete_zones_zone_id_firewall_access_rules_rules_rule_id + patch: + description: >- + Updates an IP Access rule defined. Note: This operation will affect all + zones in the account or zone. + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/firewallSchemasRule' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallResponseSingle' + description: Update an IP Access rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + required: + - id + - mode + - allowed_modes + - configuration + type: object + properties: + allowed_modes: + description: >- + The available actions that a rule can apply to a + matched request. + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + scope: + description: >- + All zones owned by the user will have the rule + applied. + properties: + email: + $ref: '#/components/schemas/firewallEmail' + id: + $ref: '#/components/schemas/firewallIdentifier' + type: + description: Defines the scope of the rule. + enum: + - user + - organization + readOnly: true + type: string + readOnly: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update an IP Access rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an IP Access rule + tags: [] + x-api-token-group: + - Account Firewall Access Rules Write + x-cfPermissionsRequired: + enum: + - '#waf:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: firewall + resource_chain: + - access_rules + method: edit + operationId: patch_zones_zone_id_firewall_access_rules_rules_rule_id +components: + schemas: + firewallAction: + description: >- + The action to perform when the threshold of matched traffic within the + configured period is exceeded. + type: object + properties: + mode: + $ref: '#/components/schemas/firewallMode' + response: + $ref: '#/components/schemas/firewallCustomResponse' + timeout: + $ref: '#/components/schemas/firewallTimeout' + firewallActionMode: + default: challenge + description: The default action performed by the rules in the WAF package. + enum: + - simulate + - block + - challenge + type: string + firewallAnomalyPackage: + required: + - id + - name + - description + - detection_mode + - zone_id + title: Anomaly detection WAF package (OWASP) + properties: + description: + description: A summary of the purpose/function of the WAF package. + example: Covers OWASP Top 10 vulnerabilities and more. + readOnly: true + type: string + detection_mode: + description: >- + When a WAF package uses anomaly detection, each rule is given a + score when triggered. If the total score of all triggered rules + exceeds the sensitivity defined on the WAF package, the action + defined on the package will be taken. + enum: + - anomaly + - traditional + example: anomaly + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallIdentifier' + name: + description: The name of the WAF package. + example: OWASP ModSecurity Core Rule Set + readOnly: true + type: string + status: + $ref: '#/components/schemas/firewallStatus' + zone_id: + $ref: '#/components/schemas/firewallIdentifier' + action_mode: + $ref: '#/components/schemas/firewallActionMode' + sensitivity: + $ref: '#/components/schemas/firewallSensitivity' + type: object + firewallApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/firewallIdentifier' + required: + - id + type: object + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + firewallBody: + description: >- + The response body to return. The value must conform to the configured + content type. + example: This request has been rate-limited. + maxLength: 10240 + type: string + firewallComponentsSchemasDescription: + description: An informative summary of the current URI-based WAF override. + example: Enable Cloudflare Magento ruleset for shop.example.com + maxLength: 1024 + nullable: true + type: string + x-auditable: true + firewallComponentsSchemasIdentifier: + description: The unique identifier of the resource. + example: de677e5818985db1285d0e80225f06e5 + maxLength: 32 + readOnly: true + type: string + firewallComponentsSchemasMode: + description: The action to apply to a matched request. + enum: + - block + - challenge + - js_challenge + - managed_challenge + example: js_challenge + maxLength: 12 + type: string + firewallComponentsSchemasPaused: + description: When true, indicates that the firewall rule is currently paused. + example: false + type: boolean + firewallComponentsSchemasPriority: + description: >- + The priority of the rule. Optional value used to define the processing + order. A lower number indicates a higher priority. If not provided, + rules with a defined priority will be processed before rules without a + priority. + example: 50 + maximum: 2147483647 + minimum: 0 + type: number + firewallComponentsUaRuleId: + description: The unique identifier of the User Agent Blocking rule. + example: 372e67954025e0ba6aaa6d586b9e0b59 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + firewallConfiguration: + description: The rule configuration. + type: object + title: An IP address configuration. + properties: + target: + description: >- + The configuration target. You must set the target to `ip` when + specifying an IP address in the rule. + enum: + - ip + example: ip + type: string + value: + description: >- + The IP address to match. This address will be compared to the IP + address of incoming requests. + example: 198.51.100.4 + type: string + firewallConfigurations: + description: >- + A list of IP addresses or CIDR ranges that will be allowed to access the + URLs specified in the Zone Lockdown rule. You can include any number of + `ip` or `ip_range` configurations. + items: + type: object + title: An IP address configuration. + properties: + target: + description: >- + The configuration target. You must set the target to `ip` when + specifying an IP address in the Zone Lockdown rule. + enum: + - ip + example: ip + type: string + value: + description: >- + The IP address to match. This address will be compared to the IP + address of incoming requests. + example: 198.51.100.4 + type: string + type: array + firewallContentType: + description: >- + The content type of the body. Must be one of the following: + `text/plain`, `text/xml`, or `application/json`. + example: text/xml + maxLength: 50 + type: string + x-auditable: true + firewallCreatedOn: + description: The timestamp of when the rule was created. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + firewallCustomResponse: + description: >- + A custom content type and reponse to return when the threshold is + exceeded. The custom response configured in this object will override + the custom error for the zone. This object is optional. Notes: If you + omit this object, Cloudflare will use the default HTML error page. If + "mode" is "challenge", "managed_challenge", or "js_challenge", + Cloudflare will use the zone challenge pages and you should not provide + the "response" object. + type: object + properties: + body: + $ref: '#/components/schemas/firewallBody' + content_type: + $ref: '#/components/schemas/firewallContentType' + firewallDeleted: + description: When true, indicates that the firewall rule was deleted. + example: true + type: boolean + firewallDescription: + description: >- + An informative summary of the rule. This value is sanitized and any tags + will be removed. + example: Prevent multiple login failures to mitigate brute force attacks + maxLength: 1024 + type: string + x-auditable: true + firewallDescriptionSearch: + description: A string to search for in the description of existing rules. + example: abusive + type: string + x-auditable: true + firewallEmail: + description: The contact email address of the user. + example: user@example.com + maxLength: 90 + type: string + firewallExpression: + description: >- + The filter expression. For more information, refer to + [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/). + example: >- + (http.request.uri.path ~ ".*wp-login.php" or http.request.uri.path ~ + ".*xmlrpc.php") and ip.addr ne 172.16.22.155 + type: string + firewallFilter: + properties: + description: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasDescription' + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + paused: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasPaused' + ref: + $ref: '#/components/schemas/firewallSchemasRef' + type: object + firewallFilterRuleResponse: + type: object + properties: + action: + $ref: '#/components/schemas/firewallSchemasAction' + description: + $ref: >- + #/components/schemas/firewallFirewallRulesComponentsSchemasDescription + id: + $ref: '#/components/schemas/firewallFirewallRulesComponentsSchemasId' + paused: + $ref: '#/components/schemas/firewallComponentsSchemasPaused' + priority: + $ref: '#/components/schemas/firewallComponentsSchemasPriority' + products: + $ref: '#/components/schemas/firewallProducts' + ref: + $ref: '#/components/schemas/firewallRef' + filter: + type: object + properties: + description: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasDescription' + expression: + $ref: '#/components/schemas/firewallExpression' + id: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasId' + paused: + $ref: '#/components/schemas/firewallFiltersComponentsSchemasPaused' + ref: + $ref: '#/components/schemas/firewallSchemasRef' + deleted: + $ref: '#/components/schemas/firewallDeleted' + required: + - id + - deleted + firewallFilterRulesResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + firewallFilterRulesResponseCollectionDelete: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallFilterRuleResponse' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + firewallFilterRulesSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallFilterRuleResponse' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + firewallFilterRulesSingleResponseDelete: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallFilterRuleResponse' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + firewallFiltersComponentsSchemasDescription: + description: An informative summary of the filter. + example: Restrict access from these browsers on this address range. + maxLength: 500 + type: string + firewallFiltersComponentsSchemasId: + description: The unique identifier of the filter. + example: 372e67954025e0ba6aaa6d586b9e0b61 + maxLength: 32 + minLength: 32 + readOnly: true + type: string + firewallFiltersComponentsSchemasPaused: + description: When true, indicates that the filter is currently paused. + example: false + type: boolean + firewallFirewallRulesComponentsSchemasDescription: + description: An informative summary of the firewall rule. + example: Blocks traffic identified during investigation for MIR-31 + maxLength: 500 + type: string + firewallFirewallRulesComponentsSchemasId: + description: The unique identifier of the firewall rule. + example: 372e67954025e0ba6aaa6d586b9e0b60 + maxLength: 32 + type: string + firewallFirewalluablock: + properties: + configuration: + $ref: '#/components/schemas/firewallSchemasConfiguration' + description: + $ref: >- + #/components/schemas/firewallFirewalluablockComponentsSchemasDescription + id: + $ref: '#/components/schemas/firewallComponentsUaRuleId' + mode: + $ref: '#/components/schemas/firewallComponentsSchemasMode' + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + type: object + firewallFirewalluablockComponentsSchemasDescription: + description: An informative summary of the rule. + example: >- + Prevent access from abusive clients identified by this User Agent to + mitigate a DDoS attack + maxLength: 1024 + type: string + firewallFirewalluablockResponseCollection: + properties: + result: + items: + $ref: '#/components/schemas/firewallFirewalluablock' + type: object + type: array + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + type: object + required: + - success + - errors + - messages + - result + firewallFirewalluablockResponseSingle: + properties: + result: + $ref: '#/components/schemas/firewallFirewalluablock' + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + type: object + required: + - success + - errors + - messages + - result + firewallGroups: + description: >- + An object that allows you to enable or disable WAF rule groups for the + current WAF override. Each key of this object must be the ID of a WAF + rule group, and each value must be a valid WAF action (usually `default` + or `disable`). When creating a new URI-based WAF override, you must + provide a `groups` object or a `rules` object. + example: + ea8687e59929c1fd05ba97574ad43f77: default + type: object + firewallIdentifier: + description: Defines an identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + firewallIpRangeSearch: + description: A single IP address range to search for in existing rules. + example: 1.2.3.0/16 + type: string + x-auditable: true + firewallIpSearch: + description: A single IP address to search for in existing rules. + example: 1.2.3.4 + type: string + firewallLockdownsComponentsSchemasDescription: + description: An informative summary of the rule. + example: Restrict access to these endpoints to requests from a known IP address + maxLength: 1024 + type: string + firewallLockdownsComponentsSchemasId: + description: The unique identifier of the Zone Lockdown rule. + example: 372e67954025e0ba6aaa6d586b9e0b59 + maxLength: 32 + type: string + x-auditable: true + firewallMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + firewallMode: + description: The action to perform. + enum: + - simulate + - ban + - challenge + - js_challenge + - managed_challenge + example: challenge + type: string + x-auditable: true + firewallModifiedOn: + description: The timestamp of when the rule was last modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + firewallNotes: + description: >- + An informative summary of the rule, typically used as a reminder or + explanation. + example: This rule is enabled because of an event that occurred on date X. + type: string + x-auditable: true + firewallOverride: + properties: + description: + $ref: '#/components/schemas/firewallComponentsSchemasDescription' + groups: + $ref: '#/components/schemas/firewallGroups' + id: + $ref: '#/components/schemas/firewallOverridesId' + paused: + $ref: '#/components/schemas/firewallPaused' + priority: + $ref: '#/components/schemas/firewallPriority' + rewrite_action: + $ref: '#/components/schemas/firewallRewriteAction' + rules: + $ref: '#/components/schemas/firewallRules' + urls: + $ref: '#/components/schemas/firewallUrls' + type: object + firewallOverrideResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallOverride' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + firewallOverrideResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallOverride' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + firewallOverridesId: + description: The unique identifier of the WAF override. + example: de677e5818985db1285d0e80225f06e5 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + firewallPackageId: + description: Defines a package identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + firewallPackageResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - errors + - success + - result + - messages + firewallPackageResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - errors + - success + - result + - messages + firewallPaused: + description: When true, indicates that the rule is currently paused. + type: boolean + x-auditable: true + firewallPriority: + description: >- + The relative priority of the current URI-based WAF override when + multiple overrides match a single URL. A lower number indicates higher + priority. Higher priority overrides may overwrite values set by lower + priority overrides. + example: 1 + maximum: 1000000000 + minimum: -1000000000 + type: number + x-auditable: true + firewallProducts: + items: + description: >- + A list of products to bypass for a request when using the `bypass` + action. + enum: + - zoneLockdown + - uaBlock + - bic + - hot + - securityLevel + - rateLimit + - waf + example: waf + type: string + type: array + firewallRef: + description: A short reference tag. Allows you to select related firewall rules. + example: MIR-31 + maxLength: 50 + type: string + firewallResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallSchemasRule' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + firewallResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallSchemasRule' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + firewallResultInfo: + properties: + count: + description: Defines the total number of results for the requested service. + example: 1 + type: number + page: + description: Defines the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Defines the number of results per page of results. + example: 20 + type: number + total_count: + description: Defines the total results available without any search parameters. + example: 2000 + type: number + type: object + firewallRewriteAction: + description: >- + Specifies that, when a WAF rule matches, its configured action will be + replaced by the action configured in this object. + properties: + block: + $ref: '#/components/schemas/firewallWafRewriteAction' + challenge: + $ref: '#/components/schemas/firewallWafRewriteAction' + default: + $ref: '#/components/schemas/firewallWafRewriteAction' + disable: + $ref: '#/components/schemas/firewallWafRewriteAction' + simulate: + $ref: '#/components/schemas/firewallWafRewriteAction' + type: object + firewallRule: + properties: + allowed_modes: + description: The available actions that a rule can apply to a matched request. + example: + - whitelist + - block + - challenge + - js_challenge + - managed_challenge + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + required: + - id + - mode + - allowed_modes + - configuration + type: object + firewallRuleCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallRule' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + firewallRuleSingleIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + properties: + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + type: object + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + firewallRuleSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallRule' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + firewallRules: + description: >- + An object that allows you to override the action of specific WAF rules. + Each key of this object must be the ID of a WAF rule, and each value + must be a valid WAF action. Unless you are disabling a rule, ensure that + you also enable the rule group that this WAF rule belongs to. When + creating a new URI-based WAF override, you must provide a `groups` + object or a `rules` object. + example: + '100015': disable + type: object + firewallSchemasAction: + description: >- + The action to apply to a matched request. The `log` action is only + available on an Enterprise plan. + enum: + - block + - challenge + - js_challenge + - managed_challenge + - allow + - log + - bypass + example: block + type: string + firewallSchemasConfiguration: + description: The configuration object for the current rule. + properties: + target: + description: >- + The configuration target for this rule. You must set the target to + `ua` for User Agent Blocking rules. + example: ua + type: string + value: + description: >- + The exact user agent string to match. This value will be compared to + the received `User-Agent` HTTP header value. + example: >- + Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 + (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4 + type: string + type: object + firewallSchemasDescriptionSearch: + description: A string to search for in the description of existing rules. + example: endpoints + type: string + x-auditable: true + firewallSchemasIdentifier: + description: The unique identifier of the IP Access rule. + example: 92f17202ed8bd63d69a66b86a49a8f6b + maxLength: 32 + readOnly: true + type: string + x-auditable: true + firewallSchemasMode: + description: The action to apply to a matched request. + enum: + - block + - challenge + - whitelist + - js_challenge + - managed_challenge + example: challenge + type: string + x-auditable: true + firewallSchemasPaused: + description: When true, indicates that the rule is currently paused. + example: false + type: boolean + x-auditable: true + default: false + firewallSchemasPriority: + description: >- + The priority of the rule to control the processing order. A lower number + indicates higher priority. If not provided, any rules with a configured + priority will be processed before rules without a priority. + example: 5 + type: number + x-auditable: true + firewallSchemasRef: + description: A short reference tag. Allows you to select related filters. + example: FIL-100 + maxLength: 50 + type: string + firewallSchemasRule: + required: + - id + - mode + - allowed_modes + - configuration + type: object + properties: + allowed_modes: + description: The available actions that a rule can apply to a matched request. + example: + - whitelist + - block + - challenge + - js_challenge + - managed_challenge + items: + $ref: '#/components/schemas/firewallSchemasMode' + readOnly: true + type: array + configuration: + $ref: '#/components/schemas/firewallConfiguration' + created_on: + description: The timestamp of when the rule was created. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + id: + $ref: '#/components/schemas/firewallSchemasIdentifier' + mode: + $ref: '#/components/schemas/firewallSchemasMode' + modified_on: + description: The timestamp of when the rule was last modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + notes: + $ref: '#/components/schemas/firewallNotes' + scope: + description: All zones owned by the user will have the rule applied. + properties: + email: + $ref: '#/components/schemas/firewallEmail' + id: + $ref: '#/components/schemas/firewallIdentifier' + type: + description: Defines the scope of the rule. + enum: + - user + - organization + example: user + readOnly: true + type: string + readOnly: true + type: object + firewallSchemasUrls: + description: >- + The URLs to include in the rule definition. You can use wildcards. Each + entered URL will be escaped before use, which means you can only use + simple wildcard patterns. + items: + example: api.mysite.com/some/endpoint* + type: string + x-auditable: true + type: array + firewallSensitivity: + default: high + description: The sensitivity of the WAF package. + enum: + - high + - medium + - low + - 'off' + type: string + firewallStatus: + default: active + description: >- + When set to `active`, indicates that the WAF package will be applied to + the zone. + enum: + - active + readOnly: true + type: string + firewallTimeout: + description: >- + The time in seconds during which Cloudflare will perform the mitigation + action. Must be an integer value greater than or equal to the period. + Notes: If "mode" is "challenge", "managed_challenge", or "js_challenge", + Cloudflare will use the zone's Challenge Passage time and you should not + provide this value. + example: 86400 + maximum: 86400 + minimum: 1 + type: number + x-auditable: true + firewallUaConfiguration: + properties: + target: + description: >- + The configuration target. You must set the target to `ua` when + specifying a user agent in the rule. + enum: + - ua + example: ua + type: string + value: + description: the user agent to exactly match + example: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1) + type: string + x-auditable: true + title: A user agent configuration. + type: object + firewallUriSearch: + description: A single URI to search for in the list of URLs of existing rules. + example: /some/path + type: string + x-auditable: true + firewallUrls: + description: >- + The URLs to include in the current WAF override. You can use wildcards. + Each entered URL will be escaped before use, which means you can only + use simple wildcard patterns. + items: + example: shop.example.com/* + type: string + x-auditable: true + type: array + firewallWafRewriteAction: + description: The WAF rule action to apply. + enum: + - challenge + - block + - simulate + - disable + - default + x-auditable: true + type: string + firewallZonelockdown: + properties: + configurations: + $ref: '#/components/schemas/firewallConfigurations' + created_on: + $ref: '#/components/schemas/firewallCreatedOn' + readOnly: true + description: + $ref: '#/components/schemas/firewallLockdownsComponentsSchemasDescription' + id: + $ref: '#/components/schemas/firewallLockdownsComponentsSchemasId' + modified_on: + $ref: '#/components/schemas/firewallModifiedOn' + readOnly: true + paused: + $ref: '#/components/schemas/firewallSchemasPaused' + urls: + $ref: '#/components/schemas/firewallSchemasUrls' + required: + - id + - created_on + - modified_on + - paused + - description + - urls + - configurations + type: object + firewallZonelockdownResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallZonelockdown' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - result + firewallZonelockdownResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallZonelockdown' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef532d8b97684c9032dd36bae8acddebf5: + description: Defines the rule group to which the current WAF rule belongs. + properties: + id: + $ref: '#/components/schemas/wafManagedRulesComponentsSchemasIdentifier' + name: + $ref: '#/components/schemas/wafManagedRulesName' + readOnly: true + type: object + wafManagedRulesAllowedModes: + description: Defines the available states for the rule group. + example: + - 'on' + - 'off' + items: + $ref: '#/components/schemas/wafManagedRulesMode' + readOnly: true + type: array + wafManagedRulesAllowedModesAnomaly: + description: >- + Defines the available modes for the current WAF rule. Applies to anomaly + detection WAF rules. + example: + - 'on' + - 'off' + items: + $ref: '#/components/schemas/wafManagedRulesModeAnomaly' + readOnly: true + type: array + wafManagedRulesComponentsSchemasIdentifier: + description: Defines the unique identifier of the rule group. + example: de677e5818985db1285d0e80225f06e5 + maxLength: 32 + type: string + x-auditable: true + wafManagedRulesDefaultMode: + description: Defines the default action/mode of a rule. + enum: + - disable + - simulate + - block + - challenge + example: block + readOnly: true + type: string + wafManagedRulesDescription: + description: Defines an informative summary of what the rule group does. + example: >- + Group designed to protect against IP addresses that are a threat and + typically used to launch DDoS attacks + nullable: true + readOnly: true + type: string + x-auditable: true + wafManagedRulesIdentifier: + description: Defines the unique identifier of a WAF package. + example: a25a9a7e9c00afc1fb2e0245519d725b + maxLength: 32 + type: string + x-auditable: true + wafManagedRulesMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + wafManagedRulesMode: + default: 'on' + description: >- + Defines the state of the rules contained in the rule group. When `on`, + the rules in the group are configurable/usable. + enum: + - 'on' + - 'off' + type: string + x-auditable: true + wafManagedRulesModeAnomaly: + description: >- + Defines the mode anomaly. When set to `on`, the current WAF rule will be + used when evaluating the request. Applies to anomaly detection WAF + rules. + enum: + - 'on' + - 'off' + example: 'on' + type: string + x-auditable: true + wafManagedRulesModifiedRulesCount: + default: 0 + description: >- + Defines the number of rules within the group that have been modified + from their default configuration. + example: 2 + readOnly: true + type: number + x-auditable: true + wafManagedRulesName: + description: Defines the name of the rule group. + example: Project Honey Pot + readOnly: true + type: string + x-auditable: true + wafManagedRulesPriority: + description: >- + Defines the order in which the individual WAF rule is executed within + its rule group. + readOnly: true + type: string + x-auditable: true + wafManagedRulesResultInfo: + properties: + count: + description: Defines the total number of results for the requested service. + example: 1 + type: number + page: + description: Defines the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Defines the number of results per page of results. + example: 20 + type: number + total_count: + description: Defines the total results available without any search parameters. + example: 2000 + type: number + type: object + wafManagedRulesRule: + type: object + title: Anomaly detection WAF rule + description: >- + When triggered, anomaly detection WAF rules contribute to an overall + threat score that will determine if a request is considered malicious. + You can configure the total scoring threshold through the 'sensitivity' + property of the WAF package. + properties: + description: + $ref: '#/components/schemas/wafManagedRulesSchemasDescription' + group: + $ref: >- + #/components/schemas/unnamedSchemaRef532d8b97684c9032dd36bae8acddebf5 + id: + $ref: '#/components/schemas/wafManagedRulesRuleComponentsSchemasIdentifier' + package_id: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + priority: + $ref: '#/components/schemas/wafManagedRulesPriority' + allowed_modes: + $ref: '#/components/schemas/wafManagedRulesAllowedModesAnomaly' + mode: + $ref: '#/components/schemas/wafManagedRulesModeAnomaly' + default_mode: + $ref: '#/components/schemas/wafManagedRulesDefaultMode' + required: + - allowed_modes + - description + - group + - id + - mode + - package_id + - priority + wafManagedRulesRuleComponentsSchemasIdentifier: + description: Defines the unique identifier of the WAF rule. + example: f939de3be84e66e757adcdcb87908023 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + wafManagedRulesRuleGroupResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/wafManagedRulesResultInfo' + result: + items: + $ref: '#/components/schemas/wafManagedRulesSchemasGroup' + type: array + required: + - success + - errors + - messages + - result + wafManagedRulesRuleGroupResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + - result + wafManagedRulesRuleResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/wafManagedRulesResultInfo' + result: + items: + $ref: '#/components/schemas/wafManagedRulesRule' + type: array + required: + - success + - errors + - messages + - result + wafManagedRulesRuleResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/wafManagedRulesMessages' + messages: + $ref: '#/components/schemas/wafManagedRulesMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + - result + wafManagedRulesRulesCount: + default: 0 + description: Defines the number of rules in the current rule group. + example: 10 + readOnly: true + type: number + x-auditable: true + wafManagedRulesSchemasDescription: + description: Defines the public description of the WAF rule. + example: SQL injection prevention for SELECT statements + readOnly: true + type: string + x-auditable: true + wafManagedRulesSchemasGroup: + required: + - id + - name + - description + - mode + - rules_count + type: object + properties: + description: + $ref: '#/components/schemas/wafManagedRulesDescription' + id: + $ref: '#/components/schemas/wafManagedRulesComponentsSchemasIdentifier' + modified_rules_count: + $ref: '#/components/schemas/wafManagedRulesModifiedRulesCount' + name: + $ref: '#/components/schemas/wafManagedRulesName' + package_id: + $ref: '#/components/schemas/wafManagedRulesIdentifier' + rules_count: + $ref: '#/components/schemas/wafManagedRulesRulesCount' + allowed_modes: + $ref: '#/components/schemas/wafManagedRulesAllowedModes' + mode: + $ref: '#/components/schemas/wafManagedRulesMode' + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + access_rules_rules: + id: cloudflare.firewall.access_rules_rules + name: access_rules_rules + title: Access Rules Rules + methods: + list_by_user: + operation: + $ref: '#/paths/~1user~1firewall~1access_rules~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/access_rules_rules/methods/list_by_user + insert: [] + update: [] + delete: [] + replace: [] + rules: + id: cloudflare.firewall.rules + name: rules + title: Rules + methods: + ip_access_rules_for_a_user_create_an_ip_access_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1firewall~1access_rules~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + ip_access_rules_for_a_user_delete_an_ip_access_rule: + operation: + $ref: '#/paths/~1user~1firewall~1access_rules~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + ip_access_rules_for_a_user_update_an_ip_access_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1firewall~1access_rules~1rules~1{rule_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + firewall_rules_delete_firewall_rules: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + firewall_rules_update_priority_of_firewall_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + firewall_rules_create_firewall_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + firewall_rules_update_firewall_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + firewall_rules_update_priority_of_a_firewall_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules~1{rule_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules~1{rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/firewall_rules_create_firewall_rules + - $ref: >- + #/components/x-stackQL-resources/rules/methods/ip_access_rules_for_a_user_create_an_ip_access_rule + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/edit' + - $ref: >- + #/components/x-stackQL-resources/rules/methods/firewall_rules_update_priority_of_a_firewall_rule + - $ref: >- + #/components/x-stackQL-resources/rules/methods/ip_access_rules_for_a_user_update_an_ip_access_rule + - $ref: >- + #/components/x-stackQL-resources/rules/methods/firewall_rules_update_priority_of_firewall_rules + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/rules/methods/ip_access_rules_for_a_user_delete_an_ip_access_rule + - $ref: >- + #/components/x-stackQL-resources/rules/methods/firewall_rules_delete_firewall_rules + replace: + - $ref: '#/components/x-stackQL-resources/rules/methods/update' + - $ref: >- + #/components/x-stackQL-resources/rules/methods/firewall_rules_update_firewall_rules + lockdowns: + id: cloudflare.firewall.lockdowns + name: lockdowns + title: Lockdowns + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1lockdowns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1lockdowns/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1lockdowns~1{lock_downs_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1lockdowns~1{lock_downs_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1lockdowns~1{lock_downs_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/lockdowns/methods/get' + - $ref: '#/components/x-stackQL-resources/lockdowns/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/lockdowns/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/lockdowns/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/lockdowns/methods/update' + firewall_rules: + id: cloudflare.firewall.firewall_rules + name: firewall_rules + title: Firewall Rules + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/firewall_rules/methods/get_by_zone + - $ref: >- + #/components/x-stackQL-resources/firewall_rules/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + ua_rules: + id: cloudflare.firewall.ua_rules + name: ua_rules + title: Ua Rules + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1ua_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1ua_rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1ua_rules~1{ua_rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1ua_rules~1{ua_rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1ua_rules~1{ua_rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ua_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/ua_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ua_rules/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/ua_rules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/ua_rules/methods/update' + overrides: + id: cloudflare.firewall.overrides + name: overrides + title: Overrides + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1overrides/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1overrides/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1overrides~1{overrides_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1overrides~1{overrides_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1overrides~1{overrides_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/overrides/methods/get' + - $ref: '#/components/x-stackQL-resources/overrides/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/overrides/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/overrides/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/overrides/methods/update' + packages: + id: cloudflare.firewall.packages + name: packages + title: Packages + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1packages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + waf_packages_update_a_waf_package: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/packages/methods/get' + - $ref: '#/components/x-stackQL-resources/packages/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/packages/methods/waf_packages_update_a_waf_package + delete: [] + replace: [] + groups: + id: cloudflare.firewall.groups + name: groups + title: Groups + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1groups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1groups~1{group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1groups~1{group_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/edit' + delete: [] + replace: [] + packages_rules: + id: cloudflare.firewall.packages_rules + name: packages_rules + title: Packages Rules + methods: + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules~1{rule_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/packages_rules/methods/get_by_zone + - $ref: >- + #/components/x-stackQL-resources/packages_rules/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + access_rules: + id: cloudflare.firewall.access_rules + name: access_rules + title: Access Rules + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1firewall~1access_rules~1rules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1firewall~1access_rules~1rules/post + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1firewall~1access_rules~1rules~1{rule_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1firewall~1access_rules~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + edit_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1firewall~1access_rules~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules~1{rule_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + edit_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1firewall~1access_rules~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/access_rules/methods/get_by_account + - $ref: '#/components/x-stackQL-resources/access_rules/methods/get_by_zone' + - $ref: >- + #/components/x-stackQL-resources/access_rules/methods/list_by_account + - $ref: '#/components/x-stackQL-resources/access_rules/methods/list_by_zone' + insert: + - $ref: >- + #/components/x-stackQL-resources/access_rules/methods/create_by_account + - $ref: >- + #/components/x-stackQL-resources/access_rules/methods/create_by_zone + update: + - $ref: >- + #/components/x-stackQL-resources/access_rules/methods/edit_by_account + - $ref: '#/components/x-stackQL-resources/access_rules/methods/edit_by_zone' + delete: + - $ref: >- + #/components/x-stackQL-resources/access_rules/methods/delete_by_account + - $ref: >- + #/components/x-stackQL-resources/access_rules/methods/delete_by_zone + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/fraud.yaml b/providers/src/cloudflare/v00.00.00000/services/fraud.yaml new file mode 100644 index 00000000..a25681f1 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/fraud.yaml @@ -0,0 +1,311 @@ +openapi: 3.0.3 +info: + title: fraud API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/fraud_detection/settings: + get: + description: Retrieve Fraud Detection settings for a zone. + operationId: fraud-detection-zone-get-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/fraudFraudSettingsResponseBody' + description: Fraud Detection settings response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/fraudMessages' + messages: + $ref: '#/components/schemas/fraudMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + user_profiles: + $ref: '#/components/schemas/fraudUserProfilesStatus' + username_expressions: + $ref: '#/components/schemas/fraudUsernameExpressions' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Fraud Detection settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Fraud Detection Settings + tags: + - Fraud Detection + x-api-token-group: + - Fraud Detection Read + - Fraud Detection Write + x-stackql-sdk: + service: fraud + resource_chain: [] + method: get + put: + description: >- + Update Fraud Detection settings for a zone. Notes on + `username_expressions` behavior: - If omitted or set to null, + expressions are not modified. - If provided as an empty array `[]`, all + expressions will be cleared. + operationId: fraud-detection-zone-update-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/fraudFraudSettings' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/fraudFraudSettingsResponseBody' + description: Updated Fraud Detection settings response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/fraudMessages' + messages: + $ref: '#/components/schemas/fraudMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + user_profiles: + $ref: '#/components/schemas/fraudUserProfilesStatus' + username_expressions: + $ref: '#/components/schemas/fraudUsernameExpressions' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Fraud Detection settings failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Fraud Detection Settings + tags: + - Fraud Detection + x-api-token-group: + - Fraud Detection Write + x-stackql-sdk: + service: fraud + resource_chain: [] + method: update +components: + schemas: + fraudFraudSettings: + properties: + user_profiles: + $ref: '#/components/schemas/fraudUserProfilesStatus' + username_expressions: + $ref: '#/components/schemas/fraudUsernameExpressions' + type: object + fraudFraudSettingsResponseBody: + type: object + properties: + errors: + $ref: '#/components/schemas/fraudMessages' + messages: + $ref: '#/components/schemas/fraudMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/fraudFraudSettings' + required: + - success + - errors + - messages + fraudMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + fraudUserProfilesStatus: + description: Whether Fraud User Profiles is enabled for the zone. + enum: + - enabled + - disabled + example: disabled + type: string + x-auditable: true + fraudUsernameExpressions: + description: >- + List of expressions to detect usernames in write HTTP requests. - + Maximum of 10 expressions. - Omit or set to null to leave unchanged on + update. - Provide an empty array `[]` to clear all expressions on + update. - Invalid expressions will result in a 10400 Bad Request with + details in the `messages` array. + example: + - http.request.body.form["username"][0] + - lookup_json_string(http.request.body.raw, "username") + items: + type: string + x-auditable: true + maxItems: 10 + type: array + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + settings: + id: cloudflare.fraud.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1fraud_detection~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1fraud_detection~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/google_tag_gateway.yaml b/providers/src/cloudflare/v00.00.00000/services/google_tag_gateway.yaml new file mode 100644 index 00000000..94b9365f --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/google_tag_gateway.yaml @@ -0,0 +1,327 @@ +openapi: 3.0.3 +info: + title: google_tag_gateway API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/settings/google-tag-gateway/config: + get: + description: Gets the Google Tag Gateway configuration for a zone. + operationId: zone-settings-get-google-tag-gateway-config + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/googleTagGatewayMessages' + messages: + $ref: '#/components/schemas/googleTagGatewayMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/googleTagGatewayGoogleTagGatewayConfig + required: + - success + - errors + - messages + type: object + description: Get Google Tag Gateway configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/googleTagGatewayApiResponseCommonFailure' + description: Get Google Tag Gateway configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Google Tag Gateway configuration + tags: + - Google Tag Gateway + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPermissionsRequired: + enum: + - '#zone_settings:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: google_tag_gateway + resource_chain: + - config + method: get + put: + description: Updates the Google Tag Gateway configuration for a zone. + operationId: zone-settings-change-google-tag-gateway-config + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/googleTagGatewayGoogleTagGatewayConfig' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/googleTagGatewayMessages' + messages: + $ref: '#/components/schemas/googleTagGatewayMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/googleTagGatewayGoogleTagGatewayConfig + required: + - success + - errors + - messages + type: object + description: Update Google Tag Gateway configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/googleTagGatewayApiResponseCommonFailure' + description: Update Google Tag Gateway configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Google Tag Gateway configuration + tags: + - Google Tag Gateway + x-api-token-group: + - Zone Settings Write + x-cfPermissionsRequired: + enum: + - '#zone_settings:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: google_tag_gateway + resource_chain: + - config + method: update +components: + schemas: + googleTagGatewayApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/googleTagGatewayMessages' + messages: + example: [] + $ref: '#/components/schemas/googleTagGatewayMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + googleTagGatewayGoogleTagGatewayConfig: + description: Google Tag Gateway configuration for a zone. + properties: + enabled: + description: Enables or disables Google Tag Gateway for this zone. + example: true + type: boolean + x-auditable: true + endpoint: + description: >- + Specifies the endpoint path for proxying Google Tag Manager + requests. Use an absolute path starting with '/', with no nested + paths and alphanumeric characters only (e.g. /metrics). + example: /metrics + type: string + x-auditable: true + hideOriginalIp: + description: Hides the original client IP address from Google when enabled. + example: true + type: boolean + x-auditable: true + measurementId: + description: >- + Specify the Google Tag Manager container or measurement ID (e.g. + GTM-XXXXXXX or G-XXXXXXXXXX). + example: GTM-P2F3N47Q + type: string + x-auditable: true + setUpTag: + description: >- + Set up the associated Google Tag on the zone automatically when + enabled. + example: true + nullable: true + type: boolean + x-auditable: true + required: + - enabled + - endpoint + - hideOriginalIp + - measurementId + title: Google Tag Gateway configuration + type: object + googleTagGatewayMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + config: + id: cloudflare.google_tag_gateway.config + name: config + title: Config + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1settings~1google-tag-gateway~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1settings~1google-tag-gateway~1config/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/config/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/config/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/healthchecks.yaml b/providers/src/cloudflare/v00.00.00000/services/healthchecks.yaml new file mode 100644 index 00000000..a105a6ab --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/healthchecks.yaml @@ -0,0 +1,1282 @@ +openapi: 3.0.3 +info: + title: healthchecks API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/healthchecks: + get: + description: List configured health checks. + operationId: health-checks-list-health-checks + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Maximum number of results per page. Must be a multiple of 5. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 5 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksResponseCollection' + description: List Health Checks response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + items: + $ref: '#/components/schemas/healthchecksHealthchecks' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/healthchecksResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Health Checks response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Health Checks + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + - Health Checks Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: [] + method: list + post: + description: Create a new health check. + operationId: health-checks-create-health-check + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksQueryHealthcheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksSingleResponse' + description: Create Health Check response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRefAaa560acadcbf1ae1dc619ba1ea5948e + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Health Check + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: [] + method: create + /zones/{zone_id}/healthchecks/preview: + post: + description: Create a new preview health check. + operationId: health-checks-create-preview-health-check + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksQueryHealthcheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksSingleResponse' + description: Create Preview Health Check response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRefAaa560acadcbf1ae1dc619ba1ea5948e + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Preview Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Preview Health Check + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: + - previews + method: create + /zones/{zone_id}/healthchecks/preview/{healthcheck_id}: + delete: + description: Delete a health check. + operationId: health-checks-delete-preview-health-check + parameters: + - in: path + name: healthcheck_id + schema: + $ref: '#/components/schemas/healthchecksIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksIdResponse' + description: Delete Preview Health Check response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + properties: + id: + $ref: '#/components/schemas/healthchecksIdentifier' + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Preview Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Preview Health Check + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: + - previews + method: delete + get: + description: Fetch a single configured health check preview. + operationId: health-checks-health-check-preview-details + parameters: + - in: path + name: healthcheck_id + schema: + $ref: '#/components/schemas/healthchecksIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksSingleResponse' + description: Health Check Preview Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRefAaa560acadcbf1ae1dc619ba1ea5948e + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Health Check Preview Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Health Check Preview Details + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + - Health Checks Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: + - previews + method: get + /zones/{zone_id}/healthchecks/{healthcheck_id}: + delete: + description: Delete a health check. + operationId: health-checks-delete-health-check + parameters: + - in: path + name: healthcheck_id + schema: + $ref: '#/components/schemas/healthchecksIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksIdResponse' + description: Delete Health Check response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + properties: + id: + $ref: '#/components/schemas/healthchecksIdentifier' + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Health Check + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: [] + method: delete + get: + description: Fetch a single configured health check. + operationId: health-checks-health-check-details + parameters: + - in: path + name: healthcheck_id + schema: + $ref: '#/components/schemas/healthchecksIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksSingleResponse' + description: Health Check Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRefAaa560acadcbf1ae1dc619ba1ea5948e + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Health Check Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Health Check Details + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + - Health Checks Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: [] + method: get + patch: + description: Patch a configured health check. + operationId: health-checks-patch-health-check + parameters: + - in: path + name: healthcheck_id + schema: + $ref: '#/components/schemas/healthchecksIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksQueryHealthcheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksSingleResponse' + description: Patch Health Check response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRefAaa560acadcbf1ae1dc619ba1ea5948e + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Health Check + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: [] + method: edit + put: + description: Update a configured health check. + operationId: health-checks-update-health-check + parameters: + - in: path + name: healthcheck_id + schema: + $ref: '#/components/schemas/healthchecksIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksQueryHealthcheck' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/healthchecksSingleResponse' + description: Update Health Check response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRefAaa560acadcbf1ae1dc619ba1ea5948e + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Health Check response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Health Check + tags: + - Health Checks + x-api-token-group: + - Health Checks Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: healthchecks + resource_chain: [] + method: update +components: + schemas: + healthchecksAddress: + description: The hostname or IP address of the origin server to run health checks on. + example: www.example.com + type: string + x-auditable: true + healthchecksCheckRegions: + description: >- + A list of regions from which to run health checks. Null means Cloudflare + will pick a default region. + example: + - WEU + - ENAM + items: + description: >- + WNAM: Western North America, ENAM: Eastern North America, WEU: Western + Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: + Southern South America, OC: Oceania, ME: Middle East, NAF: North + Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: + North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE + customers only). + enum: + - WNAM + - ENAM + - WEU + - EEU + - NSAM + - SSAM + - OC + - ME + - NAF + - SAF + - IN + - SEAS + - NEAS + - ALL_REGIONS + type: string + nullable: true + type: array + x-auditable: true + healthchecksConsecutiveFails: + default: 1 + description: >- + The number of consecutive fails required from a health check before + changing the health to unhealthy. + type: integer + x-auditable: true + healthchecksConsecutiveSuccesses: + default: 1 + description: >- + The number of consecutive successes required from a health check before + changing the health to healthy. + type: integer + x-auditable: true + healthchecksDescription: + description: A human-readable description of the health check. + example: Health check for www.example.com + type: string + x-auditable: true + healthchecksFailureReason: + description: The current failure reason if status is unhealthy. + example: '' + readOnly: true + type: string + x-auditable: true + healthchecksHealthchecks: + properties: + address: + $ref: '#/components/schemas/healthchecksAddress' + check_regions: + $ref: '#/components/schemas/healthchecksCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/healthchecksConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/healthchecksConsecutiveSuccesses' + created_on: + $ref: '#/components/schemas/healthchecksTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/healthchecksDescription' + failure_reason: + $ref: '#/components/schemas/healthchecksFailureReason' + http_config: + $ref: '#/components/schemas/healthchecksHttpConfig' + id: + $ref: '#/components/schemas/healthchecksIdentifier' + interval: + $ref: '#/components/schemas/healthchecksInterval' + modified_on: + $ref: '#/components/schemas/healthchecksTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/healthchecksName' + retries: + $ref: '#/components/schemas/healthchecksRetries' + status: + $ref: '#/components/schemas/healthchecksStatus' + suspended: + $ref: '#/components/schemas/healthchecksSuspended' + tcp_config: + $ref: '#/components/schemas/healthchecksTcpConfig' + timeout: + $ref: '#/components/schemas/healthchecksTimeout' + type: + $ref: '#/components/schemas/healthchecksType' + type: object + healthchecksHttpConfig: + description: Parameters specific to an HTTP or HTTPS health check. + nullable: true + properties: + allow_insecure: + default: false + description: Do not validate the certificate when the health check uses HTTPS. + type: boolean + x-auditable: true + expected_body: + default: '' + description: >- + A case-insensitive sub-string to look for in the response body. If + this string is not found, the origin will be marked as unhealthy. + example: success + type: string + x-auditable: true + expected_codes: + description: >- + The expected HTTP response codes (e.g. "200") or code ranges (e.g. + "2xx" for all codes starting with 2) of the health check. + example: + - 2xx + - '302' + items: + type: string + nullable: true + type: array + x-auditable: true + follow_redirects: + default: false + description: Follow redirects if the origin returns a 3xx status code. + type: boolean + x-auditable: true + header: + description: >- + The HTTP request headers to send in the health check. It is + recommended you set a Host header by default. The User-Agent header + cannot be overridden. + example: + Host: + - example.com + X-App-ID: + - abc123 + nullable: true + type: object + method: + default: GET + description: The HTTP method to use for the health check. + enum: + - GET + - HEAD + type: string + x-auditable: true + path: + default: / + description: The endpoint path to health check against. + example: /health + type: string + x-auditable: true + port: + default: 80 + description: >- + Port number to connect to for the health check. Defaults to 80 if + type is HTTP or 443 if type is HTTPS. + type: integer + x-auditable: true + type: object + healthchecksIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + properties: + id: + $ref: '#/components/schemas/healthchecksIdentifier' + type: object + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + healthchecksIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + healthchecksInterval: + default: 60 + description: >- + The interval between each health check. Shorter intervals may give + quicker notifications if the origin status changes, but will increase + load on the origin as we check from multiple locations. + type: integer + x-auditable: true + healthchecksMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + healthchecksName: + description: >- + A short name to identify the health check. Only alphanumeric characters, + hyphens and underscores are allowed. + example: server-1 + type: string + x-auditable: true + healthchecksQueryHealthcheck: + properties: + address: + $ref: '#/components/schemas/healthchecksAddress' + check_regions: + $ref: '#/components/schemas/healthchecksCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/healthchecksConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/healthchecksConsecutiveSuccesses' + description: + $ref: '#/components/schemas/healthchecksDescription' + http_config: + $ref: '#/components/schemas/healthchecksHttpConfig' + interval: + $ref: '#/components/schemas/healthchecksInterval' + name: + $ref: '#/components/schemas/healthchecksName' + retries: + $ref: '#/components/schemas/healthchecksRetries' + suspended: + $ref: '#/components/schemas/healthchecksSuspended' + tcp_config: + $ref: '#/components/schemas/healthchecksTcpConfig' + timeout: + $ref: '#/components/schemas/healthchecksTimeout' + x-stainless-naming: + python: + method_argument: healthcheck_timeout + type: + $ref: '#/components/schemas/healthchecksType' + required: + - name + - address + type: object + healthchecksResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + items: + $ref: '#/components/schemas/healthchecksHealthchecks' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/healthchecksResultInfo' + required: + - success + - errors + - messages + - result + healthchecksResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + healthchecksRetries: + default: 2 + description: >- + The number of retries to attempt in case of a timeout before marking the + origin as unhealthy. Retries are attempted immediately. + type: integer + x-auditable: true + healthchecksSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/healthchecksMessages' + messages: + $ref: '#/components/schemas/healthchecksMessages' + result: + $ref: '#/components/schemas/healthchecksHealthchecks' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + healthchecksStatus: + description: The current status of the origin server according to the health check. + enum: + - unknown + - healthy + - unhealthy + - suspended + example: healthy + readOnly: true + type: string + x-auditable: true + healthchecksSuspended: + default: false + description: If suspended, no health checks are sent to the origin. + type: boolean + x-auditable: true + healthchecksTcpConfig: + description: Parameters specific to TCP health check. + nullable: true + properties: + method: + default: connection_established + description: The TCP connection method to use for the health check. + enum: + - connection_established + type: string + x-auditable: true + port: + default: 80 + description: Port number to connect to for the health check. Defaults to 80. + type: integer + x-auditable: true + type: object + healthchecksTimeout: + default: 5 + description: The timeout (in seconds) before marking the health check as failed. + type: integer + x-auditable: true + healthchecksTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + healthchecksType: + default: HTTP + description: >- + The protocol to use for the health check. Currently supported protocols + are 'HTTP', 'HTTPS' and 'TCP'. + example: HTTPS + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRefAaa560acadcbf1ae1dc619ba1ea5948e: + properties: + address: + $ref: '#/components/schemas/healthchecksAddress' + check_regions: + $ref: '#/components/schemas/healthchecksCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/healthchecksConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/healthchecksConsecutiveSuccesses' + created_on: + $ref: '#/components/schemas/healthchecksTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/healthchecksDescription' + failure_reason: + $ref: '#/components/schemas/healthchecksFailureReason' + http_config: + $ref: '#/components/schemas/healthchecksHttpConfig' + id: + $ref: '#/components/schemas/healthchecksIdentifier' + interval: + $ref: '#/components/schemas/healthchecksInterval' + modified_on: + $ref: '#/components/schemas/healthchecksTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/healthchecksName' + retries: + $ref: '#/components/schemas/healthchecksRetries' + status: + $ref: '#/components/schemas/healthchecksStatus' + suspended: + $ref: '#/components/schemas/healthchecksSuspended' + tcp_config: + $ref: '#/components/schemas/healthchecksTcpConfig' + timeout: + $ref: '#/components/schemas/healthchecksTimeout' + type: + $ref: '#/components/schemas/healthchecksType' + type: object + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + healthchecks: + id: cloudflare.healthchecks.healthchecks + name: healthchecks + title: Healthchecks + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1healthchecks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1healthchecks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1healthchecks~1{healthcheck_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1healthchecks~1{healthcheck_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1healthchecks~1{healthcheck_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1healthchecks~1{healthcheck_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/get' + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/update' + previews: + id: cloudflare.healthchecks.previews + name: previews + title: Previews + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1healthchecks~1preview/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1healthchecks~1preview~1{healthcheck_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1healthchecks~1preview~1{healthcheck_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/previews/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/previews/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/previews/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/hostnames.yaml b/providers/src/cloudflare/v00.00.00000/services/hostnames.yaml new file mode 100644 index 00000000..25fcd2ea --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/hostnames.yaml @@ -0,0 +1,760 @@ +openapi: 3.0.3 +info: + title: hostnames API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/hostnames/settings/{setting_id}: + get: + description: List the requested TLS setting for the hostnames under this zone. + operationId: per-hostname-tls-settings-list + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: setting_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSettingId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPerHostnameSettingsResponseCollection + description: List per-hostname TLS settings response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: Total pages available of results + type: number + type: object + result: + items: + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt + readOnly: true + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt + readOnly: true + value: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValue + type: object + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List per-hostname TLS settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List TLS setting for hostnames + tags: + - Per-Hostname TLS Settings + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: hostnames + resource_chain: + - settings + - tls + method: get + /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}: + delete: + description: Delete the tls setting value for the hostname. + operationId: per-hostname-tls-settings-delete + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: setting_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSettingId' + required: true + - in: path + name: hostname + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPerHostnameSettingsResponseDelete + description: Delete TLS setting for hostname response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt + readOnly: true + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt + readOnly: true + value: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValue' + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete TLS setting for hostname response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete TLS setting for hostname + tags: + - Per-Hostname TLS Settings + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: hostnames + resource_chain: + - settings + - tls + method: delete + get: + description: Get the requested TLS setting for the hostname. + operationId: per-hostname-tls-settings-get + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: setting_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSettingId' + required: true + - in: path + name: hostname + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPerHostnameSettingsResponse + description: Get TLS setting for hostname response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt + readOnly: true + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt + readOnly: true + value: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValue' + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get TLS setting for hostname response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get TLS setting for hostname + tags: + - Per-Hostname TLS Settings + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + description: Update the tls setting value for the hostname. + operationId: per-hostname-tls-settings-put + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: setting_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSettingId' + required: true + - in: path + name: hostname + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + required: true + requestBody: + content: + application/json: + schema: + properties: + value: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValue' + required: + - value + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPerHostnameSettingsResponse + description: Edit TLS setting for hostname response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt + readOnly: true + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt + readOnly: true + value: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValue' + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit TLS setting for hostname response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit TLS setting for hostname + tags: + - Per-Hostname TLS Settings + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: hostnames + resource_chain: + - settings + - tls + method: update +components: + schemas: + tlsCertificatesAndHostnamesComponentsSchemasHostname: + description: The hostname for which the tls settings are set. + example: app.example.com + type: string + x-auditable: true + tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt: + description: >- + This is the time the tls setting was originally created for this + hostname. + example: '2023-07-10T20:01:50.219171Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus: + description: Deployment status for the given tls setting. + example: pending_deployment + type: string + x-auditable: true + tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt: + description: This is the time the tls setting was updated. + example: '2023-07-10T20:01:50.219171Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesPerHostnameSettingsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSettingObject' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesPerHostnameSettingsResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 50 + type: number + total_count: + description: Total results available without any search parameters. + example: 1 + type: number + total_pages: + description: Total pages available of results + example: 1 + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPerHostnameSettingsResponseCollection_result_item + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesPerHostnameSettingsResponseCollection_result_item: + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt + readOnly: true + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt + readOnly: true + value: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValue' + type: object + tlsCertificatesAndHostnamesPerHostnameSettingsResponseDelete: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSettingObjectDelete' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesSettingId: + description: >- + The TLS Setting name. The value type depends on the setting: - + `ciphers`: value is an array of cipher suite strings (e.g., + `["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"]`) - + `min_tls_version`: value is a TLS version string (`"1.0"`, `"1.1"`, + `"1.2"`, or `"1.3"`) - `http2`: value is `"on"` or `"off"` + enum: + - ciphers + - min_tls_version + - http2 + type: string + x-auditable: true + tlsCertificatesAndHostnamesSettingObject: + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt + readOnly: true + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt + readOnly: true + value: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValue' + type: object + tlsCertificatesAndHostnamesSettingObjectDelete: + properties: + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasCreatedAt + readOnly: true + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasHostname + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameTlsSettingsComponentsSchemasUpdatedAt + readOnly: true + value: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValue' + type: object + tlsCertificatesAndHostnamesValue: + description: >- + The TLS setting value. The type depends on the `setting_id` used in the + request path: - `ciphers`: an array of allowed cipher suite strings in + BoringSSL format (e.g., `["ECDHE-RSA-AES128-GCM-SHA256", + "AES128-GCM-SHA256"]`) - `min_tls_version`: a string indicating the + minimum TLS version — one of `"1.0"`, `"1.1"`, `"1.2"`, or `"1.3"` + (e.g., `"1.2"`) - `http2`: a string indicating whether HTTP/2 is enabled + — `"on"` or `"off"` (e.g., `"on"`) + type: array + example: + - ECDHE-RSA-AES128-GCM-SHA256 + - AES128-GCM-SHA256 + items: + type: string + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + tls: + id: cloudflare.hostnames.tls + name: tls + title: Tls + methods: + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1hostnames~1settings~1{setting_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1hostnames~1settings~1{setting_id}~1{hostname}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1hostnames~1settings~1{setting_id}~1{hostname}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tls/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tls/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/tls/methods/update' + settings: + id: cloudflare.hostnames.settings + name: settings + title: Settings + methods: + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1hostnames~1settings~1{setting_id}~1{hostname}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/get' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/hyperdrive.yaml b/providers/src/cloudflare/v00.00.00000/services/hyperdrive.yaml new file mode 100644 index 00000000..763287e0 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/hyperdrive.yaml @@ -0,0 +1,855 @@ +openapi: 3.0.3 +info: + title: hyperdrive API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/hyperdrive/configs: + get: + description: Returns a list of Hyperdrives. + operationId: list-hyperdrive + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/hyperdriveMessages' + messages: + $ref: '#/components/schemas/hyperdriveMessages' + result: + type: array + items: + $ref: '#/components/schemas/hyperdriveHyperdriveConfigResponse' + success: + description: Return the status of the API call success. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/hyperdriveResultInfo' + required: + - success + - errors + - messages + - result + description: List Hyperdrives Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveApiResponseCommonFailure' + description: List Hyperdrives Failure Response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Hyperdrives + tags: + - Hyperdrive + x-api-token-group: + - Hyperdrive Write + - Hyperdrive Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.hyperdrive.database.list + x-stackql-sdk: + service: hyperdrive + resource_chain: + - configs + method: list + post: + description: Creates and returns a new Hyperdrive configuration. + operationId: create-hyperdrive + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveHyperdriveConfig' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/hyperdriveMessages' + messages: + $ref: '#/components/schemas/hyperdriveMessages' + result: + type: object + $ref: '#/components/schemas/hyperdriveHyperdriveConfigResponse' + success: + description: Return the status of the API call success. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Create Hyperdrive Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveApiResponseCommonFailure' + description: Create Hyperdrive Failure Response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Hyperdrive + tags: + - Hyperdrive + x-api-token-group: + - Hyperdrive Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.hyperdrive.database.create + x-stackql-sdk: + service: hyperdrive + resource_chain: + - configs + method: create + /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}: + delete: + description: Deletes the specified Hyperdrive. + operationId: delete-hyperdrive + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The unique identifier of the Hyperdrive configuration. + in: path + name: hyperdrive_id + schema: + $ref: '#/components/schemas/hyperdriveIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/hyperdriveMessages' + messages: + $ref: '#/components/schemas/hyperdriveMessages' + result: + type: object + nullable: true + success: + description: Return the status of the API call success. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Delete Hyperdrive Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveApiResponseCommonFailure' + description: Delete Hyperdrive Failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Hyperdrive + tags: + - Hyperdrive + x-api-token-group: + - Hyperdrive Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.hyperdrive.database.delete + x-stackql-sdk: + service: hyperdrive + resource_chain: + - configs + method: delete + get: + description: Returns the specified Hyperdrive configuration. + operationId: get-hyperdrive + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The unique identifier of the Hyperdrive configuration. + in: path + name: hyperdrive_id + schema: + $ref: '#/components/schemas/hyperdriveIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/hyperdriveMessages' + messages: + $ref: '#/components/schemas/hyperdriveMessages' + result: + type: object + $ref: '#/components/schemas/hyperdriveHyperdriveConfigResponse' + success: + description: Return the status of the API call success. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Get Hyperdrive Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveApiResponseCommonFailure' + description: Get Hyperdrive Failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Hyperdrive + tags: + - Hyperdrive + x-api-token-group: + - Hyperdrive Write + - Hyperdrive Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.hyperdrive.database.read + x-stackql-sdk: + service: hyperdrive + resource_chain: + - configs + method: get + patch: + description: >- + Patches and returns the specified Hyperdrive configuration. Custom + caching settings are not kept if caching is disabled. + operationId: patch-hyperdrive + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The unique identifier of the Hyperdrive configuration. + in: path + name: hyperdrive_id + schema: + $ref: '#/components/schemas/hyperdriveIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveHyperdriveConfigPatch' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/hyperdriveMessages' + messages: + $ref: '#/components/schemas/hyperdriveMessages' + result: + type: object + $ref: '#/components/schemas/hyperdriveHyperdriveConfigResponse' + success: + description: Return the status of the API call success. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Patch Hyperdrive Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveApiResponseCommonFailure' + description: Patch Hyperdrive Failure Response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Hyperdrive + tags: + - Hyperdrive + x-api-token-group: + - Hyperdrive Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.hyperdrive.database.update + x-stackql-sdk: + service: hyperdrive + resource_chain: + - configs + method: edit + put: + description: Updates and returns the specified Hyperdrive configuration. + operationId: update-hyperdrive + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The unique identifier of the Hyperdrive configuration. + in: path + name: hyperdrive_id + schema: + $ref: '#/components/schemas/hyperdriveIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveHyperdriveConfig' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/hyperdriveMessages' + messages: + $ref: '#/components/schemas/hyperdriveMessages' + result: + type: object + $ref: '#/components/schemas/hyperdriveHyperdriveConfigResponse' + success: + description: Return the status of the API call success. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Update Hyperdrive Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/hyperdriveApiResponseCommonFailure' + description: Update Hyperdrive Failure Response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Hyperdrive + tags: + - Hyperdrive + x-api-token-group: + - Hyperdrive Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.hyperdrive.database.update + x-stackql-sdk: + service: hyperdrive + resource_chain: + - configs + method: update +components: + schemas: + hyperdriveApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/hyperdriveMessages' + messages: + example: [] + $ref: '#/components/schemas/hyperdriveMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Return the status of the API call success. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + hyperdriveHyperdriveCaching: + type: object + properties: + disabled: + description: Set to true to disable caching of SQL responses. Default is false. + type: boolean + x-auditable: true + max_age: + description: >- + Specify the maximum duration (in seconds) items should persist in + the cache. Defaults to 60 seconds if not specified. + example: 60 + type: integer + x-auditable: true + stale_while_revalidate: + description: >- + Specify the number of seconds the cache may serve a stale response. + Defaults to 15 seconds if not specified. + example: 15 + type: integer + x-auditable: true + hyperdriveHyperdriveConfig: + properties: + caching: + $ref: '#/components/schemas/hyperdriveHyperdriveCaching' + created_on: + description: Defines the creation time of the Hyperdrive configuration. + example: '2017-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/hyperdriveIdentifier' + modified_on: + description: Defines the last modified time of the Hyperdrive configuration. + example: '2017-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + mtls: + $ref: '#/components/schemas/hyperdriveHyperdriveMtls' + name: + $ref: '#/components/schemas/hyperdriveHyperdriveName' + origin: + type: object + title: Public Database + properties: + database: + description: Set the name of your origin database. + example: postgres + type: string + x-auditable: true + password: + description: >- + Set the password needed to access your origin database. The API + never returns this write-only value. + type: string + writeOnly: true + x-sensitive: true + scheme: + $ref: '#/components/schemas/hyperdriveHyperdriveScheme' + user: + description: Set the user of your origin database. + example: postgres + type: string + x-auditable: true + host: + description: Defines the host (hostname or IP) of your origin database. + example: database.example.com + type: string + x-auditable: true + port: + description: >- + Defines the port of your origin database. Defaults to 5432 for + PostgreSQL or 3306 for MySQL if not specified. + example: 5432 + type: integer + x-auditable: true + access_client_id: + description: >- + Defines the Client ID of the Access token to use when connecting + to the origin database. + example: 0123456789abcdef0123456789abcdef.access + type: string + x-auditable: true + access_client_secret: + description: >- + Defines the Client Secret of the Access Token to use when + connecting to the origin database. The API never returns this + write-only value. + example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef + type: string + writeOnly: true + x-sensitive: true + service_id: + description: >- + The identifier of the Workers VPC Service to connect through. + Hyperdrive will egress through the specified VPC Service to + reach the origin database. + example: 0123456789abcdef0123456789abcdef + type: string + x-auditable: true + required: + - database + - password + - scheme + - user + origin_connection_limit: + $ref: '#/components/schemas/hyperdriveHyperdriveOriginConnectionLimit' + required: + - id + - name + - origin + type: object + hyperdriveHyperdriveConfigPatch: + properties: + caching: + $ref: '#/components/schemas/hyperdriveHyperdriveCaching' + mtls: + $ref: '#/components/schemas/hyperdriveHyperdriveMtls' + name: + $ref: '#/components/schemas/hyperdriveHyperdriveName' + origin: + type: object + title: Connection Options + properties: + database: + description: Set the name of your origin database. + example: postgres + type: string + x-auditable: true + password: + description: >- + Set the password needed to access your origin database. The API + never returns this write-only value. + type: string + writeOnly: true + x-sensitive: true + scheme: + $ref: '#/components/schemas/hyperdriveHyperdriveScheme' + user: + description: Set the user of your origin database. + example: postgres + type: string + x-auditable: true + host: + description: Defines the host (hostname or IP) of your origin database. + example: database.example.com + type: string + x-auditable: true + port: + description: >- + Defines the port of your origin database. Defaults to 5432 for + PostgreSQL or 3306 for MySQL if not specified. + example: 5432 + type: integer + x-auditable: true + access_client_id: + description: >- + Defines the Client ID of the Access token to use when connecting + to the origin database. + example: 0123456789abcdef0123456789abcdef.access + type: string + x-auditable: true + access_client_secret: + description: >- + Defines the Client Secret of the Access Token to use when + connecting to the origin database. The API never returns this + write-only value. + example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef + type: string + writeOnly: true + x-sensitive: true + service_id: + description: >- + The identifier of the Workers VPC Service to connect through. + Hyperdrive will egress through the specified VPC Service to + reach the origin database. + example: 0123456789abcdef0123456789abcdef + type: string + x-auditable: true + description: >- + Connect to a database through a Workers VPC Service. TLS settings + (mTLS, sslmode) cannot be configured on the Hyperdrive when using a + VPC Service origin; TLS must be managed on the VPC Service itself. + required: [] + origin_connection_limit: + $ref: '#/components/schemas/hyperdriveHyperdriveOriginConnectionLimit' + type: object + hyperdriveHyperdriveConfigResponse: + type: object + $ref: '#/components/schemas/hyperdriveHyperdriveConfig' + hyperdriveHyperdriveMtls: + description: >- + mTLS configuration for the origin connection. Cannot be used with VPC + Service origins; TLS must be managed on the VPC Service. + properties: + ca_certificate_id: + description: Define CA certificate ID obtained after uploading CA cert. + example: 00000000-0000-0000-0000-0000000000 + type: string + mtls_certificate_id: + description: Define mTLS certificate ID obtained after uploading client cert. + example: 00000000-0000-0000-0000-0000000000 + type: string + sslmode: + description: >- + Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify + the CA. + example: verify-full + type: string + title: mTLS + type: object + hyperdriveHyperdriveName: + description: >- + The name of the Hyperdrive configuration. Used to identify the + configuration in the Cloudflare dashboard and API. + example: example-hyperdrive + type: string + x-auditable: true + hyperdriveHyperdriveOriginConnectionLimit: + description: >- + The (soft) maximum number of connections the Hyperdrive is allowed to + make to the origin database. Maximum allowed: 20 for free tier accounts, + 100 for paid tier accounts. If not specified, defaults to 20 for free + tier and 60 for paid tier. Contact Cloudflare if you need a higher + limit. + example: 60 + maximum: 100 + minimum: 5 + type: integer + x-auditable: true + hyperdriveHyperdriveScheme: + description: Specifies the URL scheme used to connect to your origin database. + enum: + - postgres + - postgresql + - mysql + type: string + x-auditable: true + hyperdriveIdentifier: + description: Define configurations using a unique string identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + hyperdriveMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + hyperdriveResultInfo: + properties: + count: + description: Defines the total number of results for the requested service. + example: 1 + type: number + page: + description: Defines the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Defines the number of results per page of results. + example: 20 + type: number + total_count: + description: Defines the total results available without any search parameters. + example: 2000 + type: number + type: object + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + configs: + id: cloudflare.hyperdrive.configs + name: configs + title: Configs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1hyperdrive~1configs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1hyperdrive~1configs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1hyperdrive~1configs~1{hyperdrive_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1hyperdrive~1configs~1{hyperdrive_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1hyperdrive~1configs~1{hyperdrive_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1hyperdrive~1configs~1{hyperdrive_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configs/methods/get' + - $ref: '#/components/x-stackQL-resources/configs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/configs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/configs/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/configs/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/configs/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/iam.yaml b/providers/src/cloudflare/v00.00.00000/services/iam.yaml new file mode 100644 index 00000000..87feb460 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/iam.yaml @@ -0,0 +1,4607 @@ +openapi: 3.0.3 +info: + title: iam API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/iam/permission_groups: + get: + description: List all the permissions groups for an account. + operationId: account-permission-group-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: id + schema: + description: ID of the permission group to be fetched. + maxLength: 32 + minLength: 32 + type: string + - in: query + name: name + schema: + description: Name of the permission group to be fetched. + type: string + - in: query + name: label + schema: + description: Label of the permission group to be fetched. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of results per page. + maximum: 50 + minimum: 5 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamCollectionPermissionGroupsResponse' + description: List Permission Groups response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Permission Groups response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Account Permission Groups + tags: + - Account Permission Groups + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.iam.permission-group.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - permission_groups + method: list + /accounts/{account_id}/iam/permission_groups/{permission_group_id}: + get: + description: Get information about a specific permission group in an account. + operationId: account-permission-group-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: permission_group_id + schema: + $ref: '#/components/schemas/iamPermissionGroupIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSinglePermissionGroupsResponse' + description: Permission Group Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Permission Group Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Permission Group Details + tags: + - Account Permission Groups + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.iam.permission-group.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - permission_groups + method: get + /accounts/{account_id}/iam/resource_groups: + get: + description: List all the resource groups for an account. + operationId: account-resource-group-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: id + schema: + description: ID of the resource group to be fetched. + $ref: '#/components/schemas/iamResourceGroupIdentifier' + - in: query + name: name + schema: + description: Name of the resource group to be fetched. + type: string + responses: + '200': + content: + application/json: + schema: + title: List of resource groups in the account. + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/iamResourceGroup' + type: array + required: + - success + - errors + - messages + type: object + description: List Resource Groups response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Resource Groups response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Resource Groups + tags: + - Account Resource Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.iam.resource-group.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - resource_groups + method: list + post: + description: Create a new Resource Group under the specified account. + operationId: account-resource-group-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamRequestCreateResourceGroup' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamResourceGroup' + required: + - success + - errors + - messages + description: Add Resource Group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Add Resource Group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Resource Group + tags: + - Account Resource Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.iam.resource-group.create + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - resource_groups + method: create + /accounts/{account_id}/iam/resource_groups/{resource_group_id}: + delete: + description: Remove a resource group from an account. + operationId: account-resource-group-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: resource_group_id + schema: + $ref: '#/components/schemas/iamResourceGroupIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseSingleId' + description: Remove Resource Group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Remove Member response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Remove Resource Group + tags: + - Account Resource Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.iam.resource-group.delete + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - resource_groups + method: delete + get: + description: Get information about a specific resource group in an account. + operationId: account-resource-group-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: resource_group_id + schema: + $ref: '#/components/schemas/iamResourceGroupIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamResourceGroup' + required: + - success + - errors + - messages + description: Resource Group Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Resource Group Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Resource Group Details + tags: + - Account Resource Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.iam.resource-group.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - resource_groups + method: get + put: + description: Modify an existing resource group. + operationId: account-resource-group-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: resource_group_id + schema: + $ref: '#/components/schemas/iamResourceGroupIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamRequestUpdateResourceGroup' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamResourceGroup' + required: + - success + - errors + - messages + description: Update Resource Group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update Resource Group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Resource Group + tags: + - Account Resource Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.iam.resource-group.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - resource_groups + method: update + /accounts/{account_id}/iam/user_groups: + get: + description: List all the user groups for an account. + operationId: account-user-group-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: ID of the user group to be fetched. + in: query + name: id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + - in: query + name: name + schema: + description: Name of the user group to be fetched. + type: string + - in: query + name: fuzzyName + schema: + description: A string used for searching for user groups containing that substring. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 100 + description: Maximum number of results per page. + maximum: 500 + minimum: 1 + type: number + - in: query + name: direction + schema: + default: asc + description: The sort order of returned user groups by name (ascending or descending). + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + $ref: '#/components/schemas/iamUserGroups' + required: + - success + - errors + - messages + description: List User Group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List User Group response failure + security: + - api_email: [] + api_key: [] + - api_email: [] + api_key: [] + summary: List User Groups + tags: + - Account User Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + method: list + post: + description: Create a new user group under the specified account. + operationId: account-user-group-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamCreateUserGroupBody' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamUserGroup' + required: + - success + - errors + - messages + description: Add User Group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Add User Group response failure + security: + - api_email: [] + api_key: [] + summary: Create User Group + tags: + - Account User Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.create + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + method: create + /accounts/{account_id}/iam/user_groups/{user_group_id}: + delete: + description: Remove a user group from an account. + operationId: account-user-group-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseSingleId' + description: Remove User Group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Remove User Group response failure + security: + - api_email: [] + api_key: [] + summary: Remove User Group + tags: + - Account User Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.delete + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + method: delete + get: + description: Get information about a specific user group in an account. + operationId: account-user-group-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamUserGroup' + required: + - success + - errors + - messages + description: User Group Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: User Group Details response failure + security: + - api_email: [] + api_key: [] + summary: User Group Details + tags: + - Account User Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + method: get + put: + description: Modify an existing user group. + operationId: account-user-group-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamUpdateUserGroupBody' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamUserGroup' + required: + - success + - errors + - messages + description: Update User Group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update User Group response failure + security: + - api_email: [] + api_key: [] + summary: Update User Group + tags: + - Account User Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + method: update + /accounts/{account_id}/iam/user_groups/{user_group_id}/members: + get: + description: List all the members attached to a user group. + operationId: account-user-group-member-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 100 + description: Maximum number of results per page. + maximum: 500 + minimum: 1 + type: number + - in: query + name: fuzzyEmail + schema: + description: A string used for filtering members by partial email match. + type: string + - in: query + name: direction + schema: + default: asc + description: The sort order of returned user group members by email. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + title: List of members attached to a user group + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamUserGroupMember' + type: array + required: + - success + - errors + - messages + description: List User Group Members + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: User Group Details response failure + security: + - api_email: [] + api_key: [] + summary: List User Group Members + tags: + - Account User Group Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + - members + method: create + post: + description: Add members to a User Group. + operationId: account-user-group-member-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + requestBody: + content: + application/json: + schema: + items: + properties: + id: + $ref: '#/components/schemas/iamUserGroupMemberIdentifier' + required: + - id + type: object + type: array + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/iamUserGroupMember' + type: array + required: + - success + - errors + - messages + description: Add User Group Members response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Add User Group Members response failure + security: + - api_email: [] + api_key: [] + summary: Add User Group Members + tags: + - Account User Group Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.create + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + put: + description: Replace the set of members attached to a User Group. + operationId: account-user-group-members-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + requestBody: + content: + application/json: + schema: + description: Set/Replace members to a user group. + items: + properties: + id: + $ref: '#/components/schemas/iamUserGroupMemberIdentifier' + required: + - id + type: object + title: Update User Group Members + type: array + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/iamUserGroupMember' + type: array + required: + - success + - errors + - messages + description: Update User Group Members response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update User Group response failure + security: + - api_email: [] + api_key: [] + summary: Update User Group Members + tags: + - Account User Group Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}: + delete: + description: Remove a member from User Group + operationId: account-user-group-member-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + - name: member_id + in: path + required: true + description: The account member ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamUserGroupMember' + required: + - success + - errors + - messages + description: Delete User Group Member response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Delete User Group response failure + security: + - api_email: [] + api_key: [] + summary: Remove User Group Member + tags: + - Account User Group Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.delete + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + - members + method: delete + get: + description: Get details of a specific member in a user group. + operationId: account-user-group-member-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: user_group_id + schema: + $ref: '#/components/schemas/iamUserGroupIdentifier' + required: true + - name: member_id + in: path + required: true + description: The account member ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/iamUserGroupMemberDetailed' + required: + - success + - errors + - messages + description: Get User Group Member response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Get User Group Member response failure + security: + - api_email: [] + api_key: [] + summary: Get User Group Member + tags: + - Account User Group Members + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - user_groups + - members + method: get + /accounts/{account_id}/profile: + get: + description: Retrieves the profile information for a specific Cloudflare account, including organization details, settings, and metadata. This endpoint is commonly used to verify account access and retrieve account-level configuration. + operationId: Accounts_getAccountProfile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiProfile' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Get account profile + tags: + - Accounts + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + put: + description: Updates the profile information for a Cloudflare account. Allows modification of account-level settings and organizational details. Requires Account Settings Write permission. + operationId: Accounts_modifyAccountProfile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiProfile' + responses: + '204': + description: There is no content to send for this request, but the headers may be useful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Modify account profile + tags: + - Accounts + x-api-token-group: + - Account Settings Write + /accounts/{account_id}/scim/v2/Groups: + get: + description: Lists SCIM Group resources for the account. Returns both system groups (backed by Cloudflare permission groups, prefixed `cloudflare-v1-`) and custom user groups. Supports filtering by `displayName` using SCIM filter syntax. + operationId: scim-groups-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: startIndex + schema: + default: 1 + description: The 1-based index of the first result in the current set of list results. Values less than 1 are treated as 1. + minimum: 1 + type: integer + - in: query + name: count + schema: + description: Specifies the desired maximum number of query results per page. + minimum: 0 + type: integer + - in: query + name: filter + schema: + description: SCIM filter expression (RFC 7644 Section 3.4.2.2). Only `displayName eq "value"` is supported. + type: string + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: List SCIM Groups response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: List SCIM Groups response failure + security: + - api_token: [] + summary: List SCIM Groups + tags: + - SCIM Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + post: + description: Creates a new SCIM Group (user group) for the account. The `displayName` must not be empty and must not begin with `CF` (reserved for system groups). + operationId: scim-groups-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimGroupCreateRequest' + responses: + '201': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Create SCIM Group response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Create SCIM Group response failure + security: + - api_token: [] + summary: Create SCIM Group + tags: + - SCIM Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.create + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/scim/v2/Groups/{group_id}: + delete: + description: Deletes a SCIM Group (custom user groups only). System groups backed by Cloudflare permission groups cannot be deleted via SCIM. Returns 204 No Content on success. + operationId: scim-groups-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + responses: + '204': + description: Delete SCIM Group response (no content) + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Delete SCIM Group response failure + security: + - api_token: [] + summary: Delete SCIM Group + tags: + - SCIM Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.delete + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + get: + description: Retrieves a single SCIM Group resource by group ID. + operationId: scim-groups-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Get SCIM Group response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Get SCIM Group response failure + security: + - api_token: [] + summary: Get SCIM Group + tags: + - SCIM Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + patch: + description: Partially updates a SCIM Group via PATCH operations (RFC 7644 Section 3.5.2). Supports add, remove, and replace operations on `members`, `displayName`, and `externalId`. For system groups (prefixed `cloudflare-v1-`), only member management operations are supported. + operationId: scim-groups-patch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + requestBody: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimGroupPatchOpRequest' + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Patch SCIM Group response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Patch SCIM Group response failure + security: + - api_token: [] + summary: Patch SCIM Group + tags: + - SCIM Groups + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.update + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/scim/v2/ResourceTypes: + get: + description: Returns the list of SCIM resource types supported by the Cloudflare SCIM service (RFC 7643 Section 6, RFC 7644 Section 4). Clients use this to discover available resource categories (e.g. Users, Groups) and their associated schemas. Query parameters are not supported on this endpoint. + operationId: scim-resource-types-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: List SCIM Resource Types response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: List SCIM Resource Types response failure + security: + - api_token: [] + summary: List SCIM Resource Types + tags: + - SCIM Discovery + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/scim/v2/ResourceTypes/{resource_type_id}: + get: + description: Returns a single SCIM resource type by ID (RFC 7643 Section 6). Valid IDs are `User` and `Group`. + operationId: scim-resource-types-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: resource_type_id + schema: + description: The resource type identifier. + enum: + - User + - Group + type: string + required: true + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Get SCIM Resource Type response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Get SCIM Resource Type response failure + security: + - api_token: [] + summary: Get SCIM Resource Type + tags: + - SCIM Discovery + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/scim/v2/Schemas: + get: + description: Returns the list of SCIM schemas supported by the Cloudflare SCIM service (RFC 7643 Section 7, RFC 7644 Section 4). Clients use this to introspect the attributes of each resource type. Query parameters are not supported on this endpoint. + operationId: scim-schemas-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: List SCIM Schemas response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: List SCIM Schemas response failure + security: + - api_token: [] + summary: List SCIM Schemas + tags: + - SCIM Discovery + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/scim/v2/Schemas/{schema_id}: + get: + description: Returns a single SCIM schema definition by schema URI ID (RFC 7643 Section 7). Valid IDs are `urn:ietf:params:scim:schemas:core:2.0:User` and `urn:ietf:params:scim:schemas:core:2.0:Group`. + operationId: scim-schemas-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: schema_id + schema: + description: The schema URI identifier. + type: string + required: true + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Get SCIM Schema response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Get SCIM Schema response failure + security: + - api_token: [] + summary: Get SCIM Schema + tags: + - SCIM Discovery + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/scim/v2/ServiceProviderConfig: + get: + description: Returns the SCIM 2.0 Service Provider configuration (RFC 7643 Section 5). IdPs use this endpoint to auto-configure their SCIM integration with Cloudflare, discovering which optional features (patch, bulk, filter, etc.) are supported. + operationId: scim-service-provider-config-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Get SCIM Service Provider Config response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Get SCIM Service Provider Config response failure + security: + - api_token: [] + summary: Get SCIM Service Provider Config + tags: + - SCIM Discovery + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/scim/v2/Users: + get: + description: Lists account members as SCIM User resources. Supports optional filtering by `userName` (email) using the SCIM filter syntax (e.g. `userName eq "user@example.com"`). Pagination is controlled via `startIndex` and `count` query parameters per RFC 7644 Section 3.4.2.4. + operationId: scim-users-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: startIndex + schema: + default: 1 + description: The 1-based index of the first result in the current set of list results. Values less than 1 are treated as 1. + minimum: 1 + type: integer + - in: query + name: count + schema: + description: Specifies the desired maximum number of query results per page. + minimum: 0 + type: integer + - in: query + name: filter + schema: + description: SCIM filter expression (RFC 7644 Section 3.4.2.2). Only `userName eq "value"` is supported. + type: string + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: List SCIM Users response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: List SCIM Users response failure + security: + - api_token: [] + summary: List SCIM Users + tags: + - SCIM Users + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + post: + description: Provisions a new account member via SCIM. The `userName` field must be a valid email address and must match the primary email in `emails`. The account must be an Enterprise account with SCIM entitlements enabled. + operationId: scim-users-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimUserCreateRequest' + responses: + '201': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Create SCIM User response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Create SCIM User response failure + security: + - api_token: [] + summary: Create SCIM User + tags: + - SCIM Users + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.create + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/scim/v2/Users/{user_id}: + get: + description: Retrieves a single account member as a SCIM User resource by user tag. + operationId: scim-users-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Get SCIM User response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Get SCIM User response failure + security: + - api_token: [] + summary: Get SCIM User + tags: + - SCIM Users + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + - Account Settings Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + patch: + description: 'Partially updates a SCIM User via PATCH operations (RFC 7644 Section 3.5.2). Supports updating `userName`, `name.givenName`, `name.familyName`, and `active`. Setting `active: false` deprovisions the user (removes them from the account). For IdP compatibility, `emails[type eq "work"].value` is also accepted as an alias for `userName`.' + operationId: scim-users-patch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + requestBody: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimPatchOpRequest' + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Patch SCIM User response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Patch SCIM User response failure + security: + - api_token: [] + summary: Patch SCIM User + tags: + - SCIM Users + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.update + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + put: + description: Replaces a SCIM User resource (RFC 7644 Section 3.5.1). Fully replaces the mutable attributes of the user. Supports updating `userName`, `name`, `emails`, and `active`. + operationId: scim-users-put + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + requestBody: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimUserReplaceRequest' + responses: + '200': + content: + application/scim+json: + schema: + type: object + properties: + contents: + type: string + description: Replace SCIM User response + 4XX: + content: + application/scim+json: + schema: + $ref: '#/components/schemas/iamScimErrorResponse' + description: Replace SCIM User response failure + security: + - api_token: [] + summary: Replace SCIM User + tags: + - SCIM Users + x-api-token-group: + - SCIM Provisioning + - Account Settings Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.member.update + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/sso_connectors: + get: + operationId: get-all-sso-connectors + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSsoConnectorCollectionResponse' + description: Get all SSO connectors response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Get all SSO connectors response failure + security: + - api_token: [] + summary: Get all SSO connectors + tags: + - SSO + x-api-token-group: + - SSO Connector Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - sso + method: list + post: + operationId: init-new-sso-connector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + begin_verification: + default: true + description: Begin the verification process after creation + type: boolean + x-stainless-terraform-configurability: computed_optional + email_domain: + description: Email domain of the new SSO connector + type: string + use_fedramp_language: + $ref: '#/components/schemas/iamUseFedrampLanguage' + required: + - email_domain + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSsoConnectorResponse' + description: Initialize new SSO connector response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Initialize new SSO connector response failure + security: + - api_token: [] + summary: Initialize new SSO connector + tags: + - SSO + x-api-token-group: + - SSO Connector Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - sso + method: create + /accounts/{account_id}/sso_connectors/{sso_connector_id}: + delete: + operationId: delete-sso-connector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sso_connector_id + schema: + $ref: '#/components/schemas/iamSsoConnectorIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseSingleId' + description: Delete SSO connector response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Delete SSO connector response failure + security: + - api_token: [] + summary: Delete SSO connector + tags: + - SSO + x-api-token-group: + - SSO Connector Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - sso + method: delete + get: + operationId: get-sso-connector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sso_connector_id + schema: + $ref: '#/components/schemas/iamSsoConnectorIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSsoConnectorResponse' + description: Get SSO connector response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Get SSO connector response failure + security: + - api_token: [] + summary: Get single SSO connector + tags: + - SSO + x-api-token-group: + - SSO Connector Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - sso + method: get + patch: + operationId: update-sso-connector-state + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sso_connector_id + schema: + $ref: '#/components/schemas/iamSsoConnectorIdentifier' + required: true + requestBody: + content: + application/json: + schema: + properties: + enabled: + description: SSO Connector enabled state + type: boolean + use_fedramp_language: + $ref: '#/components/schemas/iamUseFedrampLanguage' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSsoConnectorResponse' + description: Update SSO connector state response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update SSO connector state response failure + security: + - api_token: [] + summary: Update SSO connector state + tags: + - SSO + x-api-token-group: + - SSO Connector Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - sso + method: update + /accounts/{account_id}/sso_connectors/{sso_connector_id}/begin_verification: + post: + operationId: begin-sso-connector-verification + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sso_connector_id + schema: + $ref: '#/components/schemas/iamSsoConnectorIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseSingle' + description: Begin SSO connector verification process response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Begin SSO connector verification process response failure + security: + - api_token: [] + summary: Begin SSO connector verification + tags: + - SSO + x-api-token-group: + - SSO Connector Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: iam + resource_chain: + - sso + method: begin_verification +components: + schemas: + iamAccess: + description: Allow or deny operations against the resources. + enum: + - allow + - deny + example: allow + type: string + x-auditable: true + iamApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + iamApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/iamSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/iamSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + iamApiResponseSingle: + type: object + $ref: '#/components/schemas/iamApiResponseCommon' + iamApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + required: + - id + type: object + required: + - success + - errors + - messages + iamCollectionPermissionGroupsResponse: + title: List of Resource groups + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + $ref: '#/components/schemas/iamPermissionGroups' + required: + - success + - errors + - messages + iamCommonComponentsSchemasIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + minLength: 32 + type: string + x-auditable: true + iamCreateResourceGroupScopeScopeKey: + description: This is a combination of pre-defined resource name and identifier (like Account ID etc.) + example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4 + type: string + iamCreateResourceGroupScopeScopeObject: + description: A scope object represents any resource that can have actions applied against invite. + properties: + key: + $ref: '#/components/schemas/iamCreateResourceGroupScopeScopeObjectKey' + required: + - key + type: object + iamCreateResourceGroupScopeScopeObjectKey: + description: This is a combination of pre-defined resource name and identifier (like Zone ID etc.) + example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5 + type: string + iamCreateScope: + description: A scope is a combination of scope objects which provides additional context. + properties: + key: + $ref: '#/components/schemas/iamCreateResourceGroupScopeScopeKey' + objects: + description: A list of scope objects for additional context. The number of Scope objects should not be zero. + items: + $ref: '#/components/schemas/iamCreateResourceGroupScopeScopeObject' + type: array + required: + - key + - objects + type: object + iamCreateUserGroupBody: + properties: + name: + description: Name of the User group. + example: My New User Group + type: string + x-auditable: true + policies: + description: Policies attached to the User group + items: + $ref: '#/components/schemas/iamUserGroupPolicyWriteBody' + title: User Group Policies + type: array + required: + - name + title: Create User group with a set of policies + type: object + iamDnsVerificationCode: + description: DNS verification code. Add this entire string to the DNS TXT record of the email domain to validate ownership. + example: cloudflare_dashboard_sso=023e105f4ecef8ad9ca31a8372d0c353 + type: string + iamEmail: + description: The contact email address of the user. + example: user@example.com + maxLength: 90 + type: string + x-auditable: true + iamPermissionGroup: + description: A named group of permissions that map to a group of operations against resources. + properties: + id: + description: Identifier of the permission group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + type: string + x-auditable: true + meta: + description: Attributes associated to the permission group. + example: + label: load_balancer_admin + scopes: com.cloudflare.api.account + properties: + key: + type: string + x-auditable: true + value: + type: string + x-auditable: true + type: object + name: + description: Name of the permission group. + example: Load Balancer + readOnly: true + type: string + x-auditable: true + required: + - id + type: object + iamPermissionGroupIdentifier: + description: Permission Group identifier tag. + title: Permission Group Identifier + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + iamPermissionGroupIds: + description: A set of permission groups that are specified to the policy. + example: + - id: c8fed203ed3043cba015a93ad1616f1f + - id: 82e64a83756745bbbb1c9c2701bf816b + items: + description: A named group of permissions that map to a group of operations against resources. + properties: + id: + $ref: '#/components/schemas/iamPermissionGroupIdentifier' + required: + - id + type: object + title: Permission Group IDs + type: array + iamPermissionGroups: + description: A set of permission groups that are specified to the policy. + example: + - id: c8fed203ed3043cba015a93ad1616f1f + meta: + label: load_balancer_admin + scopes: com.cloudflare.api.account + name: Zone Read + - id: 82e64a83756745bbbb1c9c2701bf816b + meta: + label: fbm_user + scopes: com.cloudflare.api.account + name: Magic Network Monitoring + items: + $ref: '#/components/schemas/iamPermissionGroup' + type: array + iamPolicyIdentifier: + description: Policy identifier. + example: f267e341f3dd4697bd3b9f71dd96247f + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-always-send: true + iamRequestCreateResourceGroup: + properties: + name: + description: Name of the resource group + example: NewResourceGroup + type: string + scope: + $ref: '#/components/schemas/iamCreateScope' + required: + - name + - scope + title: Create resource group + type: object + iamRequestUpdateResourceGroup: + properties: + name: + description: Name of the resource group + example: UpdatedResourceGroup + type: string + scope: + $ref: '#/components/schemas/iamCreateScope' + title: Update resource group + type: object + iamResourceGroup: + description: A group of scoped resources. + properties: + id: + description: Identifier of the resource group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + readOnly: true + type: string + x-auditable: true + meta: + description: Attributes associated to the resource group. + example: + editable: 'false' + properties: + key: + type: string + value: + type: string + type: object + name: + description: Name of the resource group. + example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4 + readOnly: true + type: string + x-auditable: true + scope: + description: The scope associated to the resource group + items: + $ref: '#/components/schemas/iamScope' + type: array + required: + - id + - scope + type: object + iamResourceGroupIdentifier: + description: Resource Group identifier tag. + title: Resource Group Identifier + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + iamResourceGroupIds: + description: A set of resource groups that are specified to the policy. + example: + - id: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + items: + description: A group of scoped resources. + properties: + id: + $ref: '#/components/schemas/iamResourceGroupIdentifier' + required: + - id + type: object + title: Resource Group IDs + type: array + iamResourceGroups: + description: A list of resource groups that the policy applies to. + items: + $ref: '#/components/schemas/iamResourceGroup' + type: array + iamResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + iamSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + iamScimAuthenticationScheme: + description: An authentication method supported by the SCIM service. + properties: + description: + description: A description of the authentication scheme. + example: Authentication via OAuth 2.0 Bearer Token + type: string + documentationUri: + description: An HTTP-addressable URL pointing to the authentication scheme documentation. + type: string + name: + description: The common authentication scheme name. + example: OAuth Bearer Token + type: string + primary: + description: Indicates if this is the primary authentication scheme. + example: true + type: boolean + specUri: + description: An HTTP-addressable URL pointing to the authentication scheme specification. + example: http://www.rfc-editor.org/info/rfc6750 + type: string + type: + description: The authentication scheme type. + example: oauthbearertoken + type: string + required: + - type + - name + - description + title: SCIM Authentication Scheme + type: object + iamScimBulkFeature: + description: Configuration for SCIM bulk operations. + properties: + maxOperations: + description: The maximum number of operations in a bulk request. + example: 0 + type: integer + maxPayloadSize: + description: The maximum payload size in bytes for a bulk request. + example: 0 + type: integer + supported: + description: Whether bulk operations are supported. + example: false + type: boolean + required: + - supported + - maxOperations + - maxPayloadSize + title: SCIM Bulk Feature + type: object + iamScimErrorResponse: + description: SCIM error envelope (RFC 7644 Section 3.12). Returned on all 4XX and 5XX responses from SCIM endpoints. + properties: + detail: + description: A human-readable message describing the error. + example: 'Invalid SCIM request: userName is required' + type: string + schemas: + example: + - urn:ietf:params:scim:api:messages:2.0:Error + items: + type: string + type: array + scimType: + description: A SCIM detail error keyword (RFC 7644 Section 3.12). Only present for specific error conditions (e.g. `uniqueness` for duplicate member). + example: uniqueness + type: string + status: + description: The HTTP status code as a string. + example: '400' + type: string + required: + - schemas + - status + title: SCIM Error Response + type: object + iamScimFeature: + description: Represents a simple supported/unsupported SCIM feature. + properties: + supported: + description: Whether the feature is supported. + example: true + type: boolean + required: + - supported + title: SCIM Feature + type: object + iamScimFilterFeature: + description: Configuration for SCIM filtering operations. + properties: + maxResults: + description: The maximum number of filter results per page. + example: 100 + type: integer + supported: + description: Whether filtering is supported. + example: true + type: boolean + required: + - supported + - maxResults + title: SCIM Filter Feature + type: object + iamScimGroup: + description: A SCIM 2.0 Group resource representing an account user group (RFC 7643 Section 4.2). May be a system group (backed by a Cloudflare permission group, read-only except for member management) or a custom user group (full CRUD). + properties: + displayName: + description: A human-readable name for the Group. + example: Administrators + type: string + x-auditable: true + externalId: + description: Identifier for the Group as defined by the provisioning client (IdP). + example: idp-group-456 + type: string + x-auditable: true + id: + description: Unique identifier for the Group, assigned by Cloudflare. System groups are prefixed `cloudflare-v1-`; custom groups use a UUID-style tag. + example: cloudflare-v1-023e105f4ecef8ad9ca31a8372d0c353 + readOnly: true + type: string + x-auditable: true + members: + description: A list of members of the Group. Only populated for custom (Phase 2) groups on individual GET requests. Each member object contains a `value` (user tag) and optional `display` (email). + example: + - display: user@example.com + value: 023e105f4ecef8ad9ca31a8372d0c353 + items: + properties: + display: + description: The display name (email) of the group member. + example: user@example.com + type: string + value: + description: The user tag identifier of the group member. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + type: object + readOnly: true + type: array + meta: + $ref: '#/components/schemas/iamScimGroupMeta' + schemas: + example: + - urn:ietf:params:scim:schemas:core:2.0:Group + items: + type: string + type: array + required: + - schemas + - id + - displayName + title: SCIM Group + type: object + iamScimGroupCreateRequest: + description: Request body for creating a SCIM Group. The `displayName` must not be empty and must not begin with `CF` (reserved for system groups). + properties: + displayName: + description: A human-readable name for the Group. REQUIRED. Must not start with `CF` (reserved prefix for Cloudflare-managed virtual groups). + example: My IdP Group + type: string + x-auditable: true + externalId: + description: Identifier for the Group as defined by the provisioning client (IdP). + example: idp-group-456 + type: string + x-auditable: true + required: + - displayName + title: SCIM Group Create Request + type: object + iamScimGroupListResponse: + description: SCIM ListResponse envelope for Group resources (RFC 7644 Section 3.4.2). + properties: + Resources: + items: + $ref: '#/components/schemas/iamScimGroupSummary' + type: array + itemsPerPage: + description: The number of resources returned in this page. + example: 5 + type: integer + schemas: + example: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + items: + type: string + type: array + startIndex: + description: The 1-based index of the first result in this set. + example: 1 + type: integer + totalResults: + description: The total number of results matching the query. + example: 5 + type: integer + required: + - schemas + - totalResults + - Resources + title: SCIM Group List Response + type: object + iamScimGroupMeta: + description: Resource metadata for a SCIM Group. + properties: + resourceType: + description: The name of the resource type. + example: Group + type: string + readOnly: true + title: SCIM Group Meta + type: object + iamScimGroupPatchMemberValue: + description: A member value object used in Group PATCH operations. + properties: + value: + description: The user tag of the member to add or remove. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + x-auditable: true + title: SCIM Group Patch Member Value + type: object + iamScimGroupPatchOpRequest: + description: Request body for a SCIM PATCH operation on a Group resource (RFC 7644 Section 3.5.2). + properties: + Operations: + description: List of PATCH operations to apply. + example: + - op: add + path: members + value: + - value: 023e105f4ecef8ad9ca31a8372d0c353 + items: + $ref: '#/components/schemas/iamScimGroupPatchOperation' + type: array + schemas: + example: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + items: + type: string + type: array + required: + - schemas + - Operations + title: SCIM PatchOp Request (Groups) + type: object + iamScimGroupPatchOperation: + description: A single PATCH operation for a Group resource. Supports `add`, `remove`, and `replace` on `members`, `displayName`, and `externalId`. + properties: + op: + description: The operation to perform. + enum: + - add + - remove + - replace + example: add + type: string + x-auditable: true + path: + description: Attribute path targeted by this operation. Use `members` to modify group membership. May also include a filter expression to target specific members, e.g. `members[value eq "userTag"]`. + example: members + type: string + x-auditable: true + value: + description: The value(s) for the operation. For member add/replace operations, an array of member value objects. For `displayName` or `externalId` updates, a string value. + example: + - value: 023e105f4ecef8ad9ca31a8372d0c353 + type: array + items: + $ref: '#/components/schemas/iamScimGroupPatchMemberValue' + required: + - op + title: SCIM Group Patch Operation + type: object + iamScimGroupSummary: + description: A SCIM 2.0 Group resource as returned in list responses. Does not include members; use the individual GET endpoint to retrieve members. + properties: + displayName: + description: A human-readable name for the Group. + example: Administrators + type: string + x-auditable: true + externalId: + description: Identifier for the Group as defined by the provisioning client (IdP). + example: idp-group-456 + type: string + x-auditable: true + id: + description: Unique identifier for the Group, assigned by Cloudflare. System groups are prefixed `cloudflare-v1-`; custom groups use a UUID-style tag. + example: cloudflare-v1-023e105f4ecef8ad9ca31a8372d0c353 + readOnly: true + type: string + x-auditable: true + meta: + $ref: '#/components/schemas/iamScimGroupMeta' + schemas: + description: Must contain `urn:ietf:params:scim:schemas:core:2.0:Group`. + example: + - urn:ietf:params:scim:schemas:core:2.0:Group + items: + type: string + type: array + required: + - schemas + - id + - displayName + title: SCIM Group Summary + type: object + iamScimPatchOpRequest: + description: Request body for a SCIM PATCH operation on a User resource (RFC 7644 Section 3.5.2). + properties: + Operations: + description: List of PATCH operations to apply. + example: + - op: replace + value: + active: false + items: + $ref: '#/components/schemas/iamScimPatchOperation' + type: array + schemas: + description: Must contain `urn:ietf:params:scim:api:messages:2.0:PatchOp`. + example: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + items: + type: string + type: array + required: + - schemas + - Operations + title: SCIM PatchOp Request (Users) + type: object + iamScimPatchOperation: + description: A single PATCH operation (RFC 7644 Section 3.5.2). + properties: + op: + description: The operation to perform. Only `replace` is currently supported; `add` and `remove` are accepted without error but have no effect. Matched case-insensitively. + enum: + - add + - remove + - replace + example: replace + type: string + x-auditable: true + path: + description: Attribute path targeted by this operation. When absent, `value` must be a singular complex attribute. + example: active + type: string + x-auditable: true + value: + description: The value(s) for the operation. For `replace` without a path, this should be an object of attribute name/value pairs. For member path operations, this should be an array of member value objects. + example: + active: false + required: + - op + title: SCIM Patch Operation + type: object + iamScimResourceType: + description: A SCIM ResourceType resource (RFC 7643 Section 6). Describes a category of SCIM resource (e.g. User, Group) and its associated schema. + properties: + description: + description: The resource type's human-readable description. + example: User Account + type: string + endpoint: + description: The resource type's HTTP-addressable endpoint relative to the base URL. + example: /Users + type: string + id: + description: The resource type's server unique id. + example: User + type: string + meta: + $ref: '#/components/schemas/iamScimResourceTypeMeta' + name: + description: The resource type name. + example: User + type: string + schema: + description: The resource type's primary/base schema URI. + example: urn:ietf:params:scim:schemas:core:2.0:User + type: string + schemaExtensions: + description: A list of URIs of the resource type's schema extensions. + items: + $ref: '#/components/schemas/iamScimSchemaExtension' + type: array + schemas: + example: + - urn:ietf:params:scim:schemas:core:2.0:ResourceType + items: + type: string + type: array + required: + - schemas + - id + - name + - endpoint + - schema + title: SCIM Resource Type + type: object + iamScimResourceTypeListResponse: + description: SCIM ListResponse envelope for ResourceType resources (RFC 7644 Section 4). + properties: + Resources: + items: + $ref: '#/components/schemas/iamScimResourceType' + type: array + itemsPerPage: + example: 2 + type: integer + schemas: + example: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + items: + type: string + type: array + startIndex: + example: 1 + type: integer + totalResults: + example: 2 + type: integer + required: + - schemas + - totalResults + - Resources + title: SCIM Resource Type List Response + type: object + iamScimResourceTypeMeta: + description: Metadata for a SCIM ResourceType resource. + properties: + location: + description: The URI of the resource being returned. + example: https://api.cloudflare.com/accounts/023e105f4ecef8ad9ca31a8372d0c353/scim/v2/ResourceTypes/User + type: string + resourceType: + description: The name of the resource type of the resource. + example: ResourceType + type: string + title: SCIM Resource Type Meta + type: object + iamScimSchema: + description: A SCIM Schema resource (RFC 7643 Section 7). Defines the attributes of a SCIM resource type (e.g. User or Group). + properties: + attributes: + description: A complex attribute that includes the attributes of a schema. + items: + $ref: '#/components/schemas/iamScimSchemaAttr' + type: array + description: + description: The schema's human-readable description. + example: User Account + type: string + id: + description: The unique URI of the schema. + example: urn:ietf:params:scim:schemas:core:2.0:User + type: string + meta: + $ref: '#/components/schemas/iamScimSchemaMeta' + name: + description: The schema's human-readable name. + example: User + type: string + schemas: + example: + - urn:ietf:params:scim:schemas:core:2.0:Schema + items: + type: string + type: array + required: + - schemas + - id + - name + - attributes + title: SCIM Schema + type: object + iamScimSchemaAttr: + description: An attribute definition within a SCIM schema (RFC 7643 Section 7). + properties: + canonicalValues: + description: A collection of canonical values for the attribute. + items: + type: string + type: array + caseExact: + description: Indicates if the string attribute is case-sensitive. + example: false + type: boolean + description: + description: A human-readable description of the attribute. + type: string + multiValued: + description: Indicates if the attribute is multi-valued. + example: false + type: boolean + mutability: + description: Indicates the circumstances under which the value of the attribute can be defined or redefined. + enum: + - readOnly + - readWrite + - immutable + - writeOnly + example: readWrite + type: string + name: + description: The attribute's name. + example: userName + type: string + referenceTypes: + description: A multi-valued attribute that indicates the SCIM resource types that may be referenced. + items: + type: string + type: array + returned: + description: Indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request. + enum: + - always + - never + - default + - request + example: default + type: string + subAttributes: + description: Defines a set of sub-attributes when the attribute type is `complex`. + items: + $ref: '#/components/schemas/iamScimSchemaAttr' + type: array + type: + description: The attribute's data type. + enum: + - string + - boolean + - decimal + - integer + - dateTime + - reference + - complex + example: string + type: string + uniqueness: + description: Indicates how the service provider enforces uniqueness of attribute values. + enum: + - none + - server + - global + example: none + type: string + required: + - name + - type + - multiValued + - description + - required + - caseExact + - mutability + - returned + - uniqueness + title: SCIM Schema Attribute + type: object + iamScimSchemaExtension: + description: An extension schema associated with a resource type. + properties: + schema: + description: The URI of the extension schema. + type: string + required: + - schema + - required + title: SCIM Schema Extension + type: object + iamScimSchemaListResponse: + description: SCIM ListResponse envelope for Schema resources (RFC 7644 Section 4). + properties: + Resources: + items: + $ref: '#/components/schemas/iamScimSchema' + type: array + itemsPerPage: + example: 2 + type: integer + schemas: + example: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + items: + type: string + type: array + startIndex: + example: 1 + type: integer + totalResults: + example: 2 + type: integer + required: + - schemas + - totalResults + - Resources + title: SCIM Schema List Response + type: object + iamScimSchemaMeta: + description: Metadata for a SCIM Schema resource. + properties: + location: + description: The URI of the resource being returned. + example: https://api.cloudflare.com/accounts/023e105f4ecef8ad9ca31a8372d0c353/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User + type: string + resourceType: + description: The name of the resource type of the resource. + example: Schema + type: string + title: SCIM Schema Meta + type: object + iamScimServiceProviderConfig: + description: The SCIM 2.0 Service Provider configuration (RFC 7643 Section 5). Describes which optional SCIM features Cloudflare supports. IdPs use this to auto-configure their SCIM integration. + properties: + authenticationSchemes: + items: + $ref: '#/components/schemas/iamScimAuthenticationScheme' + type: array + bulk: + $ref: '#/components/schemas/iamScimBulkFeature' + changePassword: + $ref: '#/components/schemas/iamScimFeature' + documentationUri: + description: An HTTP-addressable URL pointing to the service provider's human-consumable help documentation. + example: https://developers.cloudflare.com/fundamentals/account/account-security/scim-setup/ + type: string + etag: + $ref: '#/components/schemas/iamScimFeature' + filter: + $ref: '#/components/schemas/iamScimFilterFeature' + patch: + $ref: '#/components/schemas/iamScimFeature' + schemas: + example: + - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig + items: + type: string + type: array + sort: + $ref: '#/components/schemas/iamScimFeature' + required: + - schemas + - patch + - bulk + - filter + - changePassword + - sort + - etag + - authenticationSchemes + title: SCIM Service Provider Config + type: object + iamScimUser: + description: A SCIM 2.0 User resource representing an account member (RFC 7643 Section 4.1). + properties: + active: + description: A Boolean value indicating the user's administrative status. Set to `false` to deprovision the user, removing their membership from the account. + example: true + type: boolean + x-auditable: true + displayName: + description: The display name shown for the user. Falls back to formatted name or userName if not set. + example: Jane Smith + type: string + x-auditable: true + emails: + description: Always contains a single primary work email matching `userName`. + items: + $ref: '#/components/schemas/iamScimUserEmailObject' + type: array + externalId: + description: An identifier for the user as defined by the provisioning client (IdP). This value is stored and returned but not interpreted by Cloudflare. + example: idp-user-abc123 + type: string + x-auditable: true + groups: + description: A list of group identifiers to which the user belongs. Includes both system group tags (prefixed `cloudflare-v1-`) and custom user group tags. + example: + - cloudflare-v1-023e105f4ecef8ad9ca31a8372d0c353 + items: + type: string + readOnly: true + type: array + id: + description: Unique identifier for the user, assigned by Cloudflare (user tag). + example: 023e105f4ecef8ad9ca31a8372d0c353 + readOnly: true + type: string + x-auditable: true + meta: + description: Resource metadata for a SCIM User. + properties: + resourceType: + description: The name of the resource type. + example: User + type: string + readOnly: true + type: object + name: + $ref: '#/components/schemas/iamScimUserNameObject' + schemas: + description: Must contain `urn:ietf:params:scim:schemas:core:2.0:User`. + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + type: array + userName: + description: Unique identifier for the user, equal to the user's email address. + example: user@example.com + format: email + type: string + x-auditable: true + required: + - schemas + - id + - userName + - active + title: SCIM User + type: object + iamScimUserCreateRequest: + description: Request body for creating a SCIM User (POST). The `emails` field is required with a primary email matching `userName`, and `active` must be `true`. + properties: + active: + description: A Boolean value indicating the user's administrative status. Must be `true` for user creation. + example: true + type: boolean + x-auditable: true + displayName: + description: The name of the user, suitable for display to end-users. If not explicitly set, falls back to the formatted name or userName. + example: Jane Smith + type: string + x-auditable: true + emails: + description: Email addresses for the user. The primary email must match `userName`. + items: + $ref: '#/components/schemas/iamScimUserEmailObject' + type: array + externalId: + description: An identifier for the user as defined by the provisioning client (IdP). This value is stored and returned but not interpreted by Cloudflare. + example: idp-user-abc123 + type: string + x-auditable: true + name: + $ref: '#/components/schemas/iamScimUserNameObject' + schemas: + description: Must contain `urn:ietf:params:scim:schemas:core:2.0:User`. + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + type: array + userName: + description: Unique identifier for the user, equal to the user's email address. + example: user@example.com + format: email + type: string + x-auditable: true + required: + - schemas + - userName + - emails + - active + title: SCIM User Create Request + type: object + iamScimUserEmailObject: + description: An email address entry for a SCIM User. + properties: + primary: + description: A Boolean value indicating the preferred email address. + example: true + type: boolean + type: + description: A label indicating the attribute's function, e.g., "work" or "home". + example: work + type: string + value: + description: The email address value. + example: user@example.com + format: email + type: string + required: + - value + title: SCIM User Email + type: object + iamScimUserListResponse: + description: SCIM ListResponse envelope for User resources (RFC 7644 Section 3.4.2). + properties: + Resources: + items: + $ref: '#/components/schemas/iamScimUser' + type: array + itemsPerPage: + description: The number of resources returned in this page. + example: 3 + type: integer + schemas: + example: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + items: + type: string + type: array + startIndex: + description: The 1-based index of the first result in this set. + example: 1 + type: integer + totalResults: + description: The total number of results matching the query. + example: 3 + type: integer + required: + - schemas + - totalResults + - Resources + title: SCIM User List Response + type: object + iamScimUserNameObject: + description: The components of the user's real name. + properties: + familyName: + description: The family name (last name) of the user. + example: Smith + type: string + x-auditable: true + formatted: + description: The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. + example: Jane Smith + readOnly: true + type: string + givenName: + description: The given name (first name) of the user. + example: Jane + type: string + x-auditable: true + title: SCIM User Name + type: object + iamScimUserReplaceRequest: + description: Request body for replacing a SCIM User (PUT). Only `schemas` and `userName` are required; other fields are optional. + properties: + active: + description: A Boolean value indicating the user's administrative status. Optional; if omitted, the current value is preserved. Set to `false` to deprovision the user, removing their membership from the account. + example: true + type: boolean + x-auditable: true + displayName: + description: The name of the user, suitable for display to end-users. If not explicitly set, falls back to the formatted name or userName. + example: Jane Smith + type: string + x-auditable: true + emails: + description: Email addresses for the user. If a primary email is provided, it must match `userName`. + items: + $ref: '#/components/schemas/iamScimUserEmailObject' + type: array + externalId: + description: An identifier for the user as defined by the provisioning client (IdP). This value is stored and returned but not interpreted by Cloudflare. + example: idp-user-abc123 + type: string + x-auditable: true + name: + $ref: '#/components/schemas/iamScimUserNameObject' + schemas: + description: Must contain `urn:ietf:params:scim:schemas:core:2.0:User`. + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + type: array + userName: + description: Unique identifier for the user, equal to the user's email address. + example: user@example.com + format: email + type: string + x-auditable: true + required: + - schemas + - userName + title: SCIM User Replace Request + type: object + iamScope: + description: A scope is a combination of scope objects which provides additional context. + properties: + key: + $ref: '#/components/schemas/iamScopeKey' + objects: + description: A list of scope objects for additional context. + items: + $ref: '#/components/schemas/iamScopeObject' + type: array + required: + - key + - objects + type: object + iamScopeKey: + description: This is a combination of pre-defined resource name and identifier (like Account ID etc.) + example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4 + readOnly: true + x-auditable: true + type: string + iamScopeObject: + description: A scope object represents any resource that can have actions applied against invite. + properties: + key: + $ref: '#/components/schemas/iamScopeObjectKey' + required: + - key + type: object + iamScopeObjectKey: + description: This is a combination of pre-defined resource name and identifier (like Zone ID etc.) + example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5 + readOnly: true + x-auditable: true + type: string + iamSinglePermissionGroupsResponse: + title: Response with Permission Groups + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamPermissionGroup' + required: + - success + - errors + - messages + iamSsoConnector: + properties: + created_on: + description: Timestamp for the creation of the SSO connector + example: '2025-01-01T12:21:02.0000Z' + format: date-time + type: string + readOnly: true + email_domain: + example: example.com + type: string + enabled: + example: false + type: boolean + id: + $ref: '#/components/schemas/iamSsoConnectorIdentifier' + updated_on: + description: Timestamp for the last update of the SSO connector + example: '2025-01-01T12:21:02.0000Z' + format: date-time + type: string + use_fedramp_language: + $ref: '#/components/schemas/iamUseFedrampLanguage' + verification: + $ref: '#/components/schemas/iamSsoConnectorVerificationInfo' + type: object + iamSsoConnectorCollectionResponse: + title: Response of initializing a new sso connector + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamSsoConnector' + type: array + required: + - success + - errors + - messages + iamSsoConnectorIdentifier: + description: SSO Connector identifier tag. + title: SSO Connector Identifier + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + iamSsoConnectorResponse: + title: Response of initializing a new sso connector + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamSsoConnector' + required: + - success + - errors + - messages + iamSsoConnectorVerificationInfo: + properties: + code: + $ref: '#/components/schemas/iamDnsVerificationCode' + status: + description: The status of the verification code from the verification process. + enum: + - awaiting + - pending + - failed + - verified + example: pending + type: string + type: object + iamUpdateUserGroupBody: + properties: + name: + description: Name of the User group. + example: My New User Group + type: string + policies: + description: Policies attached to the User group + items: + properties: + id: + description: Policy identifier. + example: f267e341f3dd4697bd3b9f71dd96247f + type: string + access: + $ref: '#/components/schemas/iamAccess' + permission_groups: + $ref: '#/components/schemas/iamPermissionGroupIds' + resource_groups: + $ref: '#/components/schemas/iamResourceGroupIds' + required: + - id + - access + - permission_groups + - resource_groups + type: object + title: User Group Policies + type: array + title: Create User group with a set of policies + type: object + iamUseFedrampLanguage: + default: false + description: Controls the display of FedRAMP language to the user during SSO login + example: false + type: boolean + x-stainless-terraform-configurability: computed_optional + iamUserGroup: + description: A group of policies resources. + properties: + created_on: + description: Timestamp for the creation of the user group + example: '2024-03-01T12:21:02.0000Z' + format: date-time + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/iamUserGroupIdentifier' + modified_on: + description: Last time the user group was modified. + example: '2024-03-01T12:21:02.0000Z' + format: date-time + readOnly: true + type: string + x-auditable: true + name: + description: Name of the user group. + example: My New User Group + readOnly: true + type: string + x-auditable: true + policies: + description: Policies attached to the User group + items: + description: Policy + properties: + access: + $ref: '#/components/schemas/iamAccess' + id: + $ref: '#/components/schemas/iamPolicyIdentifier' + permission_groups: + $ref: '#/components/schemas/iamPermissionGroups' + resource_groups: + $ref: '#/components/schemas/iamResourceGroups' + title: Authorization Policy + type: object + title: User Group Policies + type: array + required: + - id + - name + - created_on + - modified_on + type: object + iamUserGroupIdentifier: + description: User Group identifier tag. + title: User Group Identifier + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + iamUserGroupMember: + description: Member attached to a User Group. + properties: + email: + $ref: '#/components/schemas/iamEmail' + id: + description: Account member identifier. + example: 4f5f0c14a2a41d5063dd301b2f829f04 + readOnly: true + type: string + status: + description: The member's status in the account. + enum: + - accepted + - pending + example: accepted + readOnly: true + type: string + required: + - id + type: object + iamUserGroupMemberDetailed: + description: Detailed member information for a User Group member. + properties: + created_at: + description: When the member was added to the user group. + example: '2026-01-15T10:30:00Z' + format: date-time + readOnly: true + type: string + email: + $ref: '#/components/schemas/iamEmail' + id: + description: Account member identifier. + example: 4f5f0c14a2a41d5063dd301b2f829f04 + readOnly: true + type: string + status: + description: The member's status in the account. + enum: + - accepted + - pending + example: accepted + readOnly: true + type: string + user: + description: Details of the user associated with this membership. + properties: + email: + $ref: '#/components/schemas/iamEmail' + first_name: + description: User's first name. + example: Alice + readOnly: true + type: string + id: + description: User identifier tag. + example: 7c5dae5552338874e5053f2534d2767a + readOnly: true + type: string + last_name: + description: User's last name. + example: Smith + readOnly: true + type: string + readOnly: true + type: object + required: + - id + type: object + iamUserGroupMemberIdentifier: + description: The identifier of an existing account Member. + title: User Group Member Identifier + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + iamUserGroupPolicyWriteBody: + properties: + access: + $ref: '#/components/schemas/iamAccess' + permission_groups: + $ref: '#/components/schemas/iamPermissionGroupIds' + resource_groups: + $ref: '#/components/schemas/iamResourceGroupIds' + required: + - access + - permission_groups + - resource_groups + type: object + iamUserGroups: + description: A list of user groups for the account. + items: + $ref: '#/components/schemas/iamUserGroup' + title: User Groups + type: array + organizationsApiProfile: + properties: + business_address: + type: string + business_email: + type: string + business_name: + type: string + business_phone: + type: string + external_metadata: + type: string + required: + - business_name + - business_email + - business_phone + - business_address + - external_metadata + type: object + organizationsApiV4ErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + type: object + success: + enum: + - false + type: boolean + required: + - success + - errors + - messages + type: object + organizationsApiV4Message: + $ref: '#/components/schemas/responseInfo' + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + permission_groups: + id: cloudflare.iam.permission_groups + name: permission_groups + title: Permission Groups + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1permission_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1permission_groups~1{permission_group_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/permission_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + resource_groups: + id: cloudflare.iam.resource_groups + name: resource_groups + title: Resource Groups + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1resource_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1resource_groups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1resource_groups~1{resource_group_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1resource_groups~1{resource_group_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1resource_groups~1{resource_group_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/resource_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/resource_groups/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/resource_groups/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/resource_groups/methods/update' + user_groups: + id: cloudflare.iam.user_groups + name: user_groups + title: User Groups + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/user_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/update' + members: + id: cloudflare.iam.members + name: members + title: Members + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + account_user_group_member_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}~1members/post' + response: + mediaType: application/json + openAPIDocKey: '200' + account_user_group_members_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}~1members/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}~1members~1{member_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1iam~1user_groups~1{user_group_id}~1members~1{member_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/members/methods/get' + - $ref: '#/components/x-stackQL-resources/members/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/members/methods/account_user_group_member_create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/members/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/members/methods/account_user_group_members_update' + profile: + id: cloudflare.iam.profile + name: profile + title: Profile + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1profile/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + accounts_modify_account_profile: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1profile/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/profile/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/profile/methods/accounts_modify_account_profile' + groups: + id: cloudflare.iam.groups + name: groups + title: Groups + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Groups/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + scim_groups_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Groups/post' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + scim_groups_delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Groups~1{group_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Groups~1{group_id}/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + scim_groups_patch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Groups~1{group_id}/patch' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/scim_groups_create' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/scim_groups_patch' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/scim_groups_delete' + replace: [] + resource_types: + id: cloudflare.iam.resource_types + name: resource_types + title: Resource Types + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1ResourceTypes/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1ResourceTypes~1{resource_type_id}/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_types/methods/get' + - $ref: '#/components/x-stackQL-resources/resource_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + schemas: + id: cloudflare.iam.schemas + name: schemas + title: Schemas + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Schemas/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Schemas~1{schema_id}/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/schemas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + service_provider_configs: + id: cloudflare.iam.service_provider_configs + name: service_provider_configs + title: Service Provider Configs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1ServiceProviderConfig/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_provider_configs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + users: + id: cloudflare.iam.users + name: users + title: Users + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Users/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + scim_users_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Users/post' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Users~1{user_id}/get' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + scim_users_patch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Users~1{user_id}/patch' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + scim_users_put: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1scim~1v2~1Users~1{user_id}/put' + response: + mediaType: application/scim+json + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/scim_users_create' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/scim_users_patch' + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/users/methods/scim_users_put' + sso: + id: cloudflare.iam.sso + name: sso + title: Sso + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1sso_connectors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1sso_connectors/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1sso_connectors~1{sso_connector_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1sso_connectors~1{sso_connector_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1sso_connectors~1{sso_connector_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + begin_verification: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1sso_connectors~1{sso_connector_id}~1begin_verification/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sso/methods/get' + - $ref: '#/components/x-stackQL-resources/sso/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/sso/methods/begin_verification' + - $ref: '#/components/x-stackQL-resources/sso/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/sso/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/sso/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/image_optimization.yaml b/providers/src/cloudflare/v00.00.00000/services/image_optimization.yaml deleted file mode 100644 index 58805016..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/image_optimization.yaml +++ /dev/null @@ -1,1239 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Cloudflare Images - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - image_optimization - version: 4.0.0 -components: - schemas: - images_components-schemas-account_identifier: - description: Account identifier tag. - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - image_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/images' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - images: - properties: - filename: - $ref: '#/components/schemas/filename' - id: - $ref: '#/components/schemas/images_components-schemas-identifier' - metadata: - $ref: '#/components/schemas/metadata' - requireSignedURLs: - $ref: '#/components/schemas/schemas-requireSignedURLs' - uploaded: - $ref: '#/components/schemas/schemas-uploaded' - variants: - $ref: '#/components/schemas/schemas-variants' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - filename: - description: Image file name. - example: logo.png - maxLength: 32 - readOnly: true - type: string - images_components-schemas-identifier: - description: Image unique identifier. - example: 107b9558-dd06-4bbd-5fef-9c2c16bb7900 - maxLength: 32 - readOnly: true - type: string - metadata: - description: User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes. - example: - key: value - type: object - schemas-requireSignedURLs: - default: false - description: 'Indicates whether the image can be a accessed only using it''s UID. If set to true, a signed token needs to be generated with a signing key to view the image.' - example: true - type: boolean - schemas-uploaded: - description: When the media item was uploaded. - example: '2014-01-02T02:20:00Z' - format: date-time - readOnly: true - type: string - schemas-variants: - description: Object specifying available variants for an image. - example: - - 'https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail' - - 'https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero' - - 'https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original' - items: - anyOf: - - $ref: '#/components/schemas/schemas-thumbnail_url' - - $ref: '#/components/schemas/hero_url' - - $ref: '#/components/schemas/original_url' - readOnly: true - type: array - schemas-thumbnail_url: - description: URI to thumbnail variant for an image. - example: 'https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail' - format: uri - readOnly: true - type: string - hero_url: - description: URI to hero variant for an image. - example: 'https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero' - format: uri - readOnly: true - type: string - original_url: - description: URI to original variant for an image. - example: 'https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original' - format: uri - readOnly: true - type: string - image_basic_upload_via_url: - properties: - metadata: - description: User modifiable key-value store. Can use used for keeping references to another system of record for managing images. - type: object - requireSignedURLs: - default: false - description: Indicates whether the image requires a signature token for the access. - example: true - type: boolean - url: - description: A URL to fetch an image from origin. - example: 'https://example.com/path/to/logo.png' - type: string - required: - - url - type: object - image_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - schemas-direct_upload_request: - properties: - expiry: - default: Now + 30 minutes - description: 'The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.' - example: '2021-01-02T02:20:00Z' - format: date-time - type: string - type: object - schemas-direct_upload_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/images_components-schemas-identifier' - uploadURL: - description: The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request. - example: 'https://upload.imagedelivery.net/e22e9e6b-c02b-42fd-c405-6c32af5fe623' - type: string - images_stats: - properties: - count: - $ref: '#/components/schemas/images_count' - type: object - images_count: - properties: - allowed: - $ref: '#/components/schemas/allowed' - current: - $ref: '#/components/schemas/current' - type: object - allowed: - description: Cloudflare Images allowed usage. - example: 100000 - readOnly: true - type: number - current: - description: Cloudflare Images current usage. - example: 1000 - readOnly: true - type: number - schemas-deleted_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - example: {} - type: object - image_patch_request: - properties: - metadata: - description: User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified. - type: object - requireSignedURLs: - description: 'Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified.' - example: true - type: boolean - type: object - image_response_blob: - anyOf: - - type: string - - type: object - example: - direct_upload_request_v2: - properties: - expiry: - default: Now + 30 minutes - description: 'The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.' - example: '2021-01-02T02:20:00Z' - format: date-time - type: string - metadata: - description: 'User modifiable key-value store. Can be used for keeping references to another system of record, for managing images.' - type: object - requireSignedURLs: - default: false - description: Indicates whether the image requires a signature token to be accessed. - example: true - type: boolean - type: object - direct_upload_response_v2: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - description: Image unique identifier. - example: e22e9e6b-c02b-42fd-c405-6c32af5fe600 - maxLength: 32 - readOnly: true - type: string - uploadURL: - description: The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request. - example: 'https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600' - type: string - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - schemas-key_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/keys_response' - keys_response: - properties: - keys: - items: - $ref: '#/components/schemas/schemas-keys' - type: array - type: object - schemas-keys: - properties: - name: - $ref: '#/components/schemas/keys_components-schemas-name' - value: - $ref: '#/components/schemas/keys_components-schemas-value' - type: object - keys_components-schemas-name: - description: Key name. - example: default - readOnly: true - type: string - keys_components-schemas-value: - description: Key value. - example: Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5= - readOnly: true - type: string - variant_list_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/variants_response' - variants_response: - properties: - variants: - $ref: '#/components/schemas/variant_public_request' - type: object - variant_public_request: - properties: - hero: - type: object - type: object - variant_generation_request: - properties: - id: - $ref: '#/components/schemas/variants_components-schemas-identifier' - neverRequireSignedURLs: - $ref: '#/components/schemas/neverRequireSignedURLs' - options: - $ref: '#/components/schemas/options' - required: - - id - - options - type: object - variant_simple_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/variant_response' - variants_components-schemas-identifier: - example: hero - maxLength: 99 - pattern: '^[a-zA-Z0-9]$' - neverRequireSignedURLs: - default: false - description: 'Indicates whether the variant can access an image without a signature, regardless of image access control.' - example: true - type: boolean - options: - description: Allows you to define image resizing sizes for different use cases. - properties: - fit: - $ref: '#/components/schemas/fit' - height: - $ref: '#/components/schemas/schemas-height' - metadata: - $ref: '#/components/schemas/schemas-metadata' - width: - $ref: '#/components/schemas/schemas-width' - required: - - fit - - metadata - - width - - height - type: object - variant_response: - properties: - variant: - type: object - type: object - fit: - description: The fit property describes how the width and height dimensions should be interpreted. - enum: - - scale-down - - contain - - cover - - crop - - pad - example: scale-down - type: string - schemas-height: - description: Maximum height in image pixels. - example: 768 - minimum: 1 - type: number - schemas-metadata: - description: What EXIF data should be preserved in the output image. - enum: - - keep - - copyright - - none - example: none - type: string - schemas-width: - description: Maximum width in image pixels. - example: 1366 - minimum: 1 - type: number - variant_patch_request: - properties: - neverRequireSignedURLs: - $ref: '#/components/schemas/neverRequireSignedURLs' - options: - $ref: '#/components/schemas/options' - required: - - options - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_images: - id: cloudflare.image_optimization.accounts_images - name: accounts_images - title: Accounts Images - methods: - cloudflare_images_list_images: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _cloudflare_images_list_images: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1/get' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_upload_an_image_via_url: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1/post' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_delete_image: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_image_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _cloudflare_images_image_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_update_image: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_images_usage_statistics: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1stats/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _cloudflare_images_images_usage_statistics: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1stats/get' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_base_image: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1{identifier}~1blob/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _cloudflare_images_base_image: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1{identifier}~1blob/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_images/methods/cloudflare_images_list_images' - - $ref: '#/components/x-stackQL-resources/accounts_images/methods/cloudflare_images_image_details' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_images/methods/cloudflare_images_delete_image' - accounts_images_direct_upload: - id: cloudflare.image_optimization.accounts_images_direct_upload - name: accounts_images_direct_upload - title: Accounts Images Direct Upload - methods: - cloudflare_images_create_authenticated_direct_upload_url: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1direct_upload/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/accounts_images_direct_upload/methods/cloudflare_images_create_authenticated_direct_upload_url' - update: [] - delete: [] - accounts_images_direct_upload_v2: - id: cloudflare.image_optimization.accounts_images_direct_upload_v2 - name: accounts_images_direct_upload_v2 - title: Accounts Images Direct Upload V2 - methods: - cloudflare_images_create_authenticated_direct_upload_url_v2: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v2~1direct_upload/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/accounts_images_direct_upload_v2/methods/cloudflare_images_create_authenticated_direct_upload_url_v2' - update: [] - delete: [] - accounts_images_keys: - id: cloudflare.image_optimization.accounts_images_keys - name: accounts_images_keys - title: Accounts Images Keys - methods: - cloudflare_images_keys_list_signing_keys: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1keys/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.keys - _cloudflare_images_keys_list_signing_keys: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1keys/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_images_keys/methods/cloudflare_images_keys_list_signing_keys' - insert: [] - update: [] - delete: [] - accounts_images_variants: - id: cloudflare.image_optimization.accounts_images_variants - name: accounts_images_variants - title: Accounts Images Variants - methods: - cloudflare_images_variants_list_variants: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1variants/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _cloudflare_images_variants_list_variants: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1variants/get' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_variants_create_a_variant: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1variants/post' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_variants_delete_a_variant: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1variants~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_variants_variant_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1variants~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _cloudflare_images_variants_variant_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1variants~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - cloudflare_images_variants_update_a_variant: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1images~1v1~1variants~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/accounts_images_variants/methods/cloudflare_images_variants_create_a_variant' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_images_variants/methods/cloudflare_images_variants_delete_a_variant' -paths: - '/accounts/{account_identifier}/images/v1': - get: - description: List up to 100 images with one request. Use the optional parameters below to get a specific range of images. - operationId: cloudflare-images-list-images - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/image_response_collection' - description: List images response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/image_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List images response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List images - tags: - - Cloudflare Images - post: - description: Upload an image via URL with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request. - operationId: cloudflare-images-upload-an-image-via-url - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/image_basic_upload_via_url' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/image_response_single' - description: Upload an image via URL response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/image_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Upload an image via URL response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Upload an image via URL - tags: - - Cloudflare Images - '/accounts/{account_identifier}/images/v1/direct_upload': - post: - deprecated: true - description: 'Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images.' - operationId: cloudflare-images-create-authenticated-direct-upload-url - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-direct_upload_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-direct_upload_response' - description: Create authenticated direct upload URL response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-direct_upload_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create authenticated direct upload URL response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create authenticated direct upload URL - tags: - - Cloudflare Images - x-cfDeprecation: - $ref: '#/components/schemas/images/x-cfDeprecations/direct_upload_v1_deprecation' - '/accounts/{account_identifier}/images/v1/stats': - get: - description: Fetch usage statistics details for Cloudflare Images. - operationId: cloudflare-images-images-usage-statistics - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/images_stats' - description: Images usage statistics response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/images_stats' - - $ref: '#/components/schemas/api-response-common-failure' - description: Images usage statistics response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Images usage statistics - tags: - - Cloudflare Images - '/accounts/{account_identifier}/images/v1/{identifier}': - delete: - description: 'Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache.' - operationId: cloudflare-images-delete-image - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-deleted_response' - description: Delete image response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-deleted_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete image response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete image - tags: - - Cloudflare Images - get: - description: Fetch details for a single image. - operationId: cloudflare-images-image-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/image_response_single' - description: Image details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/image_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Image details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Image details - tags: - - Cloudflare Images - patch: - description: 'Update image access control. On access control change, all copies of the image are purged from cache.' - operationId: cloudflare-images-update-image - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/image_patch_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/image_response_single' - description: Update image response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/image_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update image response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update image - tags: - - Cloudflare Images - '/accounts/{account_identifier}/images/v1/{identifier}/blob': - get: - description: Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original. - operationId: cloudflare-images-base-image - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/image_response_blob' - description: Base image response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/image_response_blob' - - $ref: '#/components/schemas/api-response-common-failure' - description: Base image response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Base image - tags: - - Cloudflare Images - '/accounts/{account_identifier}/images/v2/direct_upload': - post: - description: 'Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.' - operationId: cloudflare-images-create-authenticated-direct-upload-url-v-2 - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/images_components-schemas-account_identifier' - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/direct_upload_request_v2' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/direct_upload_response_v2' - description: Create authenticated direct upload URL V2 response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/direct_upload_response_v2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create authenticated direct upload URL V2 response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create authenticated direct upload URL V2 - tags: - - Cloudflare Images - '/accounts/{account_identifier}/images/v1/keys': - get: - description: Lists your signing keys. These can be found on your Cloudflare Images dashboard. - operationId: cloudflare-images-keys-list-signing-keys - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-key_response_collection' - description: List Signing Keys response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-key_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Signing Keys response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Signing Keys - tags: - - Cloudflare Images Keys - '/accounts/{account_identifier}/images/v1/variants': - get: - description: Lists existing variants. - operationId: cloudflare-images-variants-list-variants - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/variant_list_response' - description: List variants response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/variant_list_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List variants response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List variants - tags: - - Cloudflare Images Variants - post: - description: Specify variants that allow you to resize images for different use cases. - operationId: cloudflare-images-variants-create-a-variant - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/variant_generation_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/variant_simple_response' - description: Create a variant response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/variant_simple_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a variant response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a variant - tags: - - Cloudflare Images Variants - '/accounts/{account_identifier}/images/v1/variants/{identifier}': - delete: - description: Deleting a variant purges the cache for all images associated with the variant. - operationId: cloudflare-images-variants-delete-a-variant - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/variants_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-deleted_response' - description: Delete a variant response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-deleted_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a variant response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a variant - tags: - - Cloudflare Images Variants - get: - description: Fetch details for a single variant. - operationId: cloudflare-images-variants-variant-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/variants_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/variant_simple_response' - description: Variant details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/variant_simple_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Variant details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Variant details - tags: - - Cloudflare Images Variants - patch: - description: Updating a variant purges the cache for all images associated with the variant. - operationId: cloudflare-images-variants-update-a-variant - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/variants_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/variant_patch_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/variant_simple_response' - description: Update a variant response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/variant_simple_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a variant response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a variant - tags: - - Cloudflare Images Variants diff --git a/providers/src/cloudflare/v00.00.00000/services/images.yaml b/providers/src/cloudflare/v00.00.00000/services/images.yaml new file mode 100644 index 00000000..eb96f90c --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/images.yaml @@ -0,0 +1,2209 @@ +openapi: 3.0.3 +info: + title: images API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/images/v1: + get: + deprecated: true + description: List up to 100 images with one request. Use the optional parameters below to get a specific range of images. + operationId: cloudflare-images-list-images + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 1000 + description: Number of items per page. + maximum: 10000 + minimum: 10 + type: number + - in: query + name: creator + schema: + description: Internal user ID set within the creator field. Setting to empty string "" will return images where creator field is not set + nullable: true + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImagesListResponse' + description: List images response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + images: + items: + $ref: '#/components/schemas/imagesImage' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List images response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List images + tags: + - Cloudflare Images + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + method: list + post: + description: Upload an image with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request. An image can be uploaded by sending an image file or passing an accessible to an API url. + operationId: cloudflare-images-upload-an-image-via-url + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/imagesImageBasicUpload' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageResponseSingle' + description: Upload an image response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefE8461c343d70f42d35d6d68f1a58d05a' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Upload an image response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload an image + tags: + - Cloudflare Images + x-api-token-group: + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + method: create + /accounts/{account_id}/images/v1/keys: + get: + description: Lists your signing keys. These can be found on your Cloudflare Images dashboard. + operationId: cloudflare-images-keys-list-signing-keys + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageKeyResponseCollection' + description: List Signing Keys response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef918e794287a67b5e85126e00cf2d9a95' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List Signing Keys response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Signing Keys + tags: + - Cloudflare Images Keys + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - keys + method: list + /accounts/{account_id}/images/v1/keys/{signing_key_name}: + delete: + description: Delete signing key with specified name. Returns all keys available. When last key is removed, a new default signing key will be generated. + operationId: cloudflare-images-keys-delete-signing-key + parameters: + - in: path + name: signing_key_name + schema: + $ref: '#/components/schemas/imagesSigningKeyIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageKeyResponseCollection' + description: Delete Signing Key response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef918e794287a67b5e85126e00cf2d9a95' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete Signing Key response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Signing Key + tags: + - Cloudflare Images Keys + x-stackql-sdk: + service: images + resource_chain: + - v1 + - keys + method: delete + put: + description: Create a new signing key with specified name. Returns all keys available. + operationId: cloudflare-images-keys-add-signing-key + parameters: + - in: path + name: signing_key_name + schema: + $ref: '#/components/schemas/imagesSigningKeyIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageKeyResponseCollection' + description: Add Signing Key response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef918e794287a67b5e85126e00cf2d9a95' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Add Signing Key response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Signing Key + tags: + - Cloudflare Images Keys + x-stackql-sdk: + service: images + resource_chain: + - v1 + - keys + method: update + /accounts/{account_id}/images/v1/stats: + get: + description: Fetch image statistics details for Cloudflare Images. The returned statistics detail storage usage, including the current image count vs this account's allowance. + operationId: cloudflare-images-images-usage-statistics + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImagesStatsResponse' + description: Images usage statistics response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + count: + $ref: '#/components/schemas/imagesImagesStatsCount' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Images usage statistics response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Images usage statistics + tags: + - Cloudflare Images + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - stats + method: get + /accounts/{account_id}/images/v1/variants: + get: + description: Lists existing variants. + operationId: cloudflare-images-variants-list-variants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageVariantListResponse' + description: List variants response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + variants: + $ref: '#/components/schemas/imagesImageVariantPublicRequest' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List variants response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List variants + tags: + - Cloudflare Images Variants + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - variants + method: list + post: + description: Specify variants that allow you to resize images for different use cases. + operationId: cloudflare-images-variants-create-a-variant + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageVariantDefinition' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageVariantSimpleResponse' + description: Create a variant response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefD02195de7dadf27801875f36cddfa3a3' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create a variant response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a variant + tags: + - Cloudflare Images Variants + x-api-token-group: + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - variants + method: create + /accounts/{account_id}/images/v1/variants/{variant_id}: + delete: + description: Deleting a variant purges the cache for all images associated with the variant. + operationId: cloudflare-images-variants-delete-a-variant + parameters: + - in: path + name: variant_id + schema: + $ref: '#/components/schemas/imagesImageVariantIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesDeletedResponse' + description: Delete a variant response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + type: object + enum: + - null + nullable: true + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a variant response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a variant + tags: + - Cloudflare Images Variants + x-api-token-group: + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - variants + method: delete + get: + description: Fetch details for a single variant. + operationId: cloudflare-images-variants-variant-details + parameters: + - in: path + name: variant_id + schema: + $ref: '#/components/schemas/imagesImageVariantIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageVariantSimpleResponse' + description: Variant details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefD02195de7dadf27801875f36cddfa3a3' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Variant details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Variant details + tags: + - Cloudflare Images Variants + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - variants + method: get + patch: + description: Updating a variant purges the cache for all images associated with the variant. + operationId: cloudflare-images-variants-update-a-variant + parameters: + - in: path + name: variant_id + schema: + $ref: '#/components/schemas/imagesImageVariantIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageVariantPatchRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageVariantSimpleResponse' + description: Update a variant response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefD02195de7dadf27801875f36cddfa3a3' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a variant response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a variant + tags: + - Cloudflare Images Variants + x-api-token-group: + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - variants + method: edit + /accounts/{account_id}/images/v1/variants/{variant_id}/flat: + get: + description: Fetch details for a single variant with properties at the top level of the result. + operationId: cloudflare-images-variants-variant-details-flat + parameters: + - in: path + name: variant_id + schema: + $ref: '#/components/schemas/imagesImageVariantIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageVariantFlatResponse' + description: Variant details flat response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + id: + $ref: '#/components/schemas/imagesImageVariantIdentifier' + neverRequireSignedURLs: + $ref: '#/components/schemas/imagesImageVariantNeverRequireSignedURLs' + options: + $ref: '#/components/schemas/imagesImageVariantOptions' + required: + - id + - options + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Variant details flat response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Variant details (flat) + tags: + - Cloudflare Images Variants + x-api-token-group: + - Images Read + - Images Write + /accounts/{account_id}/images/v1/{image_id}: + delete: + description: Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache. + operationId: cloudflare-images-delete-image + parameters: + - in: path + name: image_id + schema: + $ref: '#/components/schemas/imagesImageIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesDeletedResponse' + description: Delete image response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + type: object + enum: + - null + nullable: true + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete image response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete image + tags: + - Cloudflare Images + x-api-token-group: + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + method: delete + get: + description: Fetch details for a single image. + operationId: cloudflare-images-image-details + parameters: + - in: path + name: image_id + schema: + $ref: '#/components/schemas/imagesImageIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageResponseSingle' + description: Image details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefE8461c343d70f42d35d6d68f1a58d05a' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Image details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Image details + tags: + - Cloudflare Images + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + method: get + patch: + description: Update image access control. On access control change, all copies of the image are purged from cache. + operationId: cloudflare-images-update-image + parameters: + - in: path + name: image_id + schema: + $ref: '#/components/schemas/imagesImageIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImagePatchRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageResponseSingle' + description: Update image response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefE8461c343d70f42d35d6d68f1a58d05a' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update image response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update image + tags: + - Cloudflare Images + x-api-token-group: + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + method: edit + /accounts/{account_id}/images/v1/{image_id}/blob: + get: + description: Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original. + operationId: cloudflare-images-base-image + parameters: + - in: path + name: image_id + schema: + $ref: '#/components/schemas/imagesImageIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + image/*: + schema: + type: object + properties: + contents: + type: string + description: Base image response. Returns uploaded image data. + 4XX: + content: + application/json: + schema: + properties: + errors: + minLength: 1 + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + type: object + description: Base image response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Base image + tags: + - Cloudflare Images + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v1 + - blobs + method: get + /accounts/{account_id}/images/v2: + get: + description: List up to 10000 images with up to 1000 results per page. Use the optional parameters below to get a specific range of images. Pagination is supported via continuation_token. **Metadata Filtering (Optional):** You can optionally filter images by custom metadata fields using the `meta.[]=` syntax. **Supported Operators:** - `eq` / `eq:string` / `eq:number` / `eq:boolean` - Exact match - `in` / `in:string` / `in:number` - Match any value in list (pipe-separated) **Metadata Filter Constraints:** - Maximum 5 metadata filters per request - Maximum 5 levels of nesting (e.g., `meta.first.second.third.fourth.fifth`) - Maximum 10 elements for list operators (`in`) - Supports string, number, and boolean value types **Examples:** ``` **List all images:** /images/v2 **Filter by metadata [eq]:** /images/v2?meta.status[eq:string]=active **Filter by metadata [in]:** /images/v2?meta.status[in]=pending|deleted|flagged **Filter by metadata [in:number]:** /images/v2?meta.ratings[in:number]=4|5 + **Filter by nested metadata:** /images/v2?meta.region.name[eq]=eu-west **Combine metadata filters with creator:** /images/v2?meta.status[eq]=active&creator=user123 **Multiple metadata filters (AND logic):** /images/v2?meta.status[eq]=active&meta.priority[eq:number]=5 ``` + operationId: cloudflare-images-list-images-v2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: continuation_token + schema: + $ref: '#/components/schemas/imagesImagesListContinuationToken' + - in: query + name: per_page + schema: + default: 1000 + description: Number of items per page + maximum: 10000 + minimum: 10 + type: number + - in: query + name: sort_order + schema: + default: desc + description: Sorting order by upload time + enum: + - asc + - desc + type: string + - in: query + name: creator + schema: + description: Internal user ID set within the creator field. Setting to empty string "" will return images where creator field is not set + nullable: true + type: string + - description: Optional metadata filter(s). Multiple filters can be combined with AND logic. **Operators:** - `eq`, `eq:string`, `eq:number`, `eq:boolean` - Exact match - `in`, `in:string`, `in:number` - Match any value in pipe-separated list **Examples:** - `meta.status[eq]=active` - `meta.priority[eq:number]=5` - `meta.enabled[eq:boolean]=true` - `meta.region[in]=us-east|us-west|eu-west` + explode: true + in: query + name: meta.[] + schema: + type: string + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImagesListResponseV2' + description: List images response + '400': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + continuation_token: + $ref: '#/components/schemas/imagesImagesListContinuationToken' + images: + items: + $ref: '#/components/schemas/imagesImage' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Bad request + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + continuation_token: + $ref: '#/components/schemas/imagesImagesListContinuationToken' + images: + items: + $ref: '#/components/schemas/imagesImage' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List images response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List images V2 + tags: + - Cloudflare Images + x-api-token-group: + - Images Read + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v2 + method: list + /accounts/{account_id}/images/v2/direct_upload: + post: + description: 'Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.' + operationId: cloudflare-images-create-authenticated-direct-upload-url-v-2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/imagesImageDirectUploadRequestV2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/imagesImageDirectUploadResponseV2' + description: Create authenticated direct upload URL V2 response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + id: + description: Image unique identifier. + maxLength: 32 + readOnly: true + type: string + x-auditable: true + uploadURL: + description: The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request. + type: string + x-auditable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create authenticated direct upload URL V2 response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create authenticated direct upload URL V2 + tags: + - Cloudflare Images + x-api-token-group: + - Images Write + x-stackql-sdk: + service: images + resource_chain: + - v2 + - direct_uploads + method: create +components: + schemas: + imagesDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + example: {} + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + imagesImage: + properties: + creator: + $ref: '#/components/schemas/imagesImageCreator' + filename: + $ref: '#/components/schemas/imagesImageFilename' + id: + $ref: '#/components/schemas/imagesImageIdentifier' + meta: + $ref: '#/components/schemas/imagesImageMetadata' + requireSignedURLs: + $ref: '#/components/schemas/imagesImageRequireSignedURLs' + uploaded: + $ref: '#/components/schemas/imagesImageUploaded' + variants: + $ref: '#/components/schemas/imagesImageVariants' + type: object + imagesImageBasicUpload: + properties: + creator: + description: Can set the creator field with an internal user ID. + maxLength: 1024 + type: string + file: + description: An image binary data. Only needed when type is uploading a file. + format: binary + type: string + x-auditable: true + id: + description: An optional custom unique identifier for your image. + type: string + x-auditable: true + metadata: + description: User modifiable key-value store. Can use used for keeping references to another system of record for managing images. + type: object + requireSignedURLs: + default: false + description: Indicates whether the image requires a signature token for the access. + example: true + type: boolean + x-auditable: true + url: + description: A URL to fetch an image from origin. Only needed when type is uploading from a URL. + example: https://example.com/path/to/logo.png + type: string + x-auditable: true + type: object + imagesImageCreator: + description: Can set the creator field with an internal user ID. + example: 107b9558-dd06-4bbd-5fef-9c2c16bb7900 + maxLength: 1024 + nullable: true + type: string + x-auditable: true + imagesImageDirectUploadRequestV2: + properties: + creator: + description: Can set the creator field with an internal user ID. + type: string + expiry: + description: 'The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.' + example: '2021-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + id: + description: Optional Image Custom ID. Up to 1024 chars. Can include any number of subpaths, and utf8 characters. Cannot start nor end with a / (forward slash). Cannot be a UUID. + example: this/is/my-customid + maxLength: 1024 + type: string + x-auditable: true + metadata: + description: User modifiable key-value store. Can be used for keeping references to another system of record, for managing images. + type: object + requireSignedURLs: + default: false + description: Indicates whether the image requires a signature token to be accessed. + example: true + type: boolean + x-auditable: true + type: object + imagesImageDirectUploadResponseV2: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + id: + description: Image unique identifier. + maxLength: 32 + readOnly: true + type: string + x-auditable: true + uploadURL: + description: The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request. + example: https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600 + type: string + x-auditable: true + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + imagesImageFilename: + description: Image file name. + example: logo.png + maxLength: 255 + readOnly: true + type: string + x-auditable: true + imagesImageIdentifier: + description: Image unique identifier. + maxLength: 32 + readOnly: true + type: string + x-auditable: true + imagesImageKeyName: + description: Key name. + example: default + readOnly: true + type: string + x-auditable: true + imagesImageKeyResponseCollection: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/imagesImageKeysResponse' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + type: object + imagesImageKeyValue: + description: Key value. + example: Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5= + readOnly: true + type: string + x-auditable: true + imagesImageKeys: + properties: + name: + $ref: '#/components/schemas/imagesImageKeyName' + value: + $ref: '#/components/schemas/imagesImageKeyValue' + type: object + imagesImageKeysResponse: + properties: + keys: + items: + $ref: '#/components/schemas/imagesImageKeys' + type: array + type: object + imagesImageMetadata: + description: User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes. + example: + key: value + type: object + imagesImagePatchRequest: + properties: + creator: + description: Can set the creator field with an internal user ID. + type: string + metadata: + description: User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified. + type: object + requireSignedURLs: + description: Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified. + example: true + type: boolean + x-auditable: true + type: object + imagesImageRequireSignedURLs: + default: false + description: Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image. + example: true + type: boolean + x-auditable: true + imagesImageResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/imagesImage' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + imagesImageUploaded: + description: When the media item was uploaded. + example: '2014-01-02T02:20:00.123Z' + format: date-time + readOnly: true + type: string + x-auditable: true + imagesImageVariantDefinition: + properties: + id: + $ref: '#/components/schemas/imagesImageVariantIdentifier' + neverRequireSignedURLs: + $ref: '#/components/schemas/imagesImageVariantNeverRequireSignedURLs' + options: + $ref: '#/components/schemas/imagesImageVariantOptions' + required: + - id + - options + type: object + imagesImageVariantFit: + description: The fit property describes how the width and height dimensions should be interpreted. + enum: + - scale-down + - contain + - cover + - crop + - pad + example: scale-down + type: string + x-auditable: true + imagesImageVariantFlatResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/imagesImageVariantDefinition' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + imagesImageVariantHeight: + description: Maximum height in image pixels. + example: 768 + minimum: 1 + type: number + x-auditable: true + imagesImageVariantIdentifier: + example: hero + maxLength: 99 + type: string + x-auditable: true + imagesImageVariantListResponse: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/imagesImageVariantsResponse' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + type: object + imagesImageVariantNeverRequireSignedURLs: + default: false + description: Indicates whether the variant can access an image without a signature, regardless of image access control. + example: true + type: boolean + x-auditable: true + imagesImageVariantOptions: + description: Allows you to define image resizing sizes for different use cases. + properties: + fit: + $ref: '#/components/schemas/imagesImageVariantFit' + height: + $ref: '#/components/schemas/imagesImageVariantHeight' + metadata: + $ref: '#/components/schemas/imagesImageVariantSchemasMetadata' + width: + $ref: '#/components/schemas/imagesImageVariantWidth' + required: + - fit + - metadata + - width + - height + type: object + imagesImageVariantPatchRequest: + properties: + neverRequireSignedURLs: + $ref: '#/components/schemas/imagesImageVariantNeverRequireSignedURLs' + options: + $ref: '#/components/schemas/imagesImageVariantOptions' + required: + - options + type: object + imagesImageVariantPublicRequest: + properties: + hero: + properties: + id: + $ref: '#/components/schemas/imagesImageVariantIdentifier' + neverRequireSignedURLs: + $ref: '#/components/schemas/imagesImageVariantNeverRequireSignedURLs' + options: + $ref: '#/components/schemas/imagesImageVariantOptions' + required: + - id + - options + type: object + type: object + imagesImageVariantResponse: + properties: + variant: + $ref: '#/components/schemas/imagesImageVariantDefinition' + type: object + imagesImageVariantSchemasMetadata: + description: What EXIF data should be preserved in the output image. + enum: + - keep + - copyright + - none + example: none + type: string + x-auditable: true + imagesImageVariantSimpleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/imagesImageVariantResponse' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + imagesImageVariantWidth: + description: Maximum width in image pixels. + example: 1366 + minimum: 1 + type: number + x-auditable: true + imagesImageVariants: + description: Object specifying available variants for an image. + example: + - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail + - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero + - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original + items: + type: string + format: uri + description: URI to thumbnail variant for an image. + example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail + readOnly: true + type: array + imagesImageVariantsResponse: + properties: + variants: + $ref: '#/components/schemas/imagesImageVariantPublicRequest' + type: object + imagesImagesListContinuationToken: + description: Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint. + maxLength: 32 + nullable: true + readOnly: true + type: string + x-auditable: true + imagesImagesListResponse: + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + images: + items: + $ref: '#/components/schemas/imagesImage' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + type: object + imagesImagesListResponseV2: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + properties: + continuation_token: + $ref: '#/components/schemas/imagesImagesListContinuationToken' + images: + items: + $ref: '#/components/schemas/imagesImage' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + imagesImagesStats: + properties: + count: + $ref: '#/components/schemas/imagesImagesStatsCount' + type: object + imagesImagesStatsAllowed: + description: Cloudflare Images allowed usage. + example: 100000 + readOnly: true + type: number + x-auditable: true + imagesImagesStatsCount: + properties: + allowed: + $ref: '#/components/schemas/imagesImagesStatsAllowed' + current: + $ref: '#/components/schemas/imagesImagesStatsCurrent' + type: object + imagesImagesStatsCurrent: + description: Cloudflare Images current usage. + example: 1000 + readOnly: true + type: number + x-auditable: true + imagesImagesStatsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/imagesMessages' + messages: + $ref: '#/components/schemas/imagesMessages' + result: + $ref: '#/components/schemas/imagesImagesStats' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + imagesMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + imagesSigningKeyIdentifier: + example: someKey + maxLength: 20 + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef918e794287a67b5e85126e00cf2d9a95: + properties: + keys: + items: + $ref: '#/components/schemas/imagesImageKeys' + type: array + type: object + enum: + - null + unnamedSchemaRefD02195de7dadf27801875f36cddfa3a3: + properties: + variant: + $ref: '#/components/schemas/imagesImageVariantDefinition' + type: object + enum: + - null + unnamedSchemaRefE8461c343d70f42d35d6d68f1a58d05a: + properties: + creator: + $ref: '#/components/schemas/imagesImageCreator' + filename: + $ref: '#/components/schemas/imagesImageFilename' + id: + $ref: '#/components/schemas/imagesImageIdentifier' + meta: + $ref: '#/components/schemas/imagesImageMetadata' + requireSignedURLs: + $ref: '#/components/schemas/imagesImageRequireSignedURLs' + uploaded: + $ref: '#/components/schemas/imagesImageUploaded' + variants: + $ref: '#/components/schemas/imagesImageVariants' + type: object + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + v1: + id: cloudflare.images.v1 + name: v1 + title: V1 + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.images + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1{image_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1{image_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1{image_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v1/methods/get' + - $ref: '#/components/x-stackQL-resources/v1/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/v1/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/v1/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/v1/methods/delete' + replace: [] + keys: + id: cloudflare.images.keys + name: keys + title: Keys + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.keys + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1keys~1{signing_key_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1keys~1{signing_key_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/keys/methods/update' + stats: + id: cloudflare.images.stats + name: stats + title: Stats + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stats/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + variants: + id: cloudflare.images.variants + name: variants + title: Variants + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1variants/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1variants/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1variants~1{variant_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1variants~1{variant_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1variants~1{variant_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/variants/methods/get' + - $ref: '#/components/x-stackQL-resources/variants/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/variants/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/variants/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/variants/methods/delete' + replace: [] + flat: + id: cloudflare.images.flat + name: flat + title: Flat + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1variants~1{variant_id}~1flat/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/flat/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + blobs: + id: cloudflare.images.blobs + name: blobs + title: Blobs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v1~1{image_id}~1blob/get' + response: + mediaType: image/* + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/blobs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + v2: + id: cloudflare.images.v2 + name: v2 + title: V2 + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v2/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + images: + id: cloudflare.images.images + name: images + title: Images + methods: + create_direct_upload_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1images~1v2~1direct_upload/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/intel.yaml b/providers/src/cloudflare/v00.00.00000/services/intel.yaml new file mode 100644 index 00000000..1aeb97ed --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/intel.yaml @@ -0,0 +1,4861 @@ +openapi: 3.0.3 +info: + title: intel API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/intel/asn/{asn}: + get: + description: Gets an overview of the Autonomous System Number (ASN) and a list of subnets for it. + operationId: asn-intelligence-get-asn-overview + parameters: + - in: path + name: asn + schema: + $ref: '#/components/schemas/intelAsn' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelAsnComponentsSchemasResponse' + description: Get ASN Overview response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + type: integer + x-auditable: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get ASN Overview response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get ASN Overview. + tags: + - ASN Intelligence + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - asn + method: get + /accounts/{account_id}/intel/asn/{asn}/subnets: + get: + description: Get ASN Subnets. + operationId: asn-intelligence-get-asn-subnets + parameters: + - in: path + name: asn + schema: + $ref: '#/components/schemas/intelAsn' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + asn: + $ref: '#/components/schemas/intelAsn' + count: + $ref: '#/components/schemas/intelCount' + ip_count_total: + type: integer + page: + $ref: '#/components/schemas/intelPage' + per_page: + $ref: '#/components/schemas/intelPerPage' + subnets: + items: + type: string + type: array + type: object + description: Get ASN Subnets response. + 4XX: + content: + application/json: + schema: + properties: + asn: + $ref: '#/components/schemas/intelAsn' + count: + $ref: '#/components/schemas/intelCount' + ip_count_total: + type: integer + page: + $ref: '#/components/schemas/intelPage' + per_page: + $ref: '#/components/schemas/intelPerPage' + subnets: + items: + type: string + type: array + errors: + minLength: 1 + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: Get ASN Subnets response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get ASN Subnets + tags: + - ASN Intelligence + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - asn + - subnets + method: get + /accounts/{account_id}/intel/attack-surface-report/issue-types: + get: + description: Lists all available issue types in Security Center, describing categories of security issues. + operationId: get-security-center-issue-types + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + type: string + type: array + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Issues Types + tags: + - Security Center Insights + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - attack_surface_report + - issue_types + method: get + /accounts/{account_id}/intel/attack-surface-report/issues: + get: + deprecated: true + description: Lists all Security Center issues for the account, showing active security problems requiring attention. + operationId: get-security-center-issues + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: page + schema: + default: 1 + $ref: '#/components/schemas/securityCenterPage' + - in: query + name: per_page + schema: + default: 25 + $ref: '#/components/schemas/securityCenterPerPage' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + count: + $ref: '#/components/schemas/securityCenterCount' + issues: + items: + $ref: '#/components/schemas/securityCenterIssue' + type: array + page: + $ref: '#/components/schemas/securityCenterPage' + per_page: + $ref: '#/components/schemas/securityCenterPerPage' + type: object + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Issues + tags: + - Security Center Insights + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - attack_surface_report + - issues + method: list + /accounts/{account_id}/intel/attack-surface-report/issues/class: + get: + deprecated: true + description: Retrieves Security Center issue counts aggregated by classification class. + operationId: get-security-center-issue-counts-by-class + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Issue Counts by Class + tags: + - Security Center Insights + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - attack_surface_report + - issues + method: class_ + /accounts/{account_id}/intel/attack-surface-report/issues/severity: + get: + deprecated: true + description: Retrieves Security Center issue counts aggregated by severity level. + operationId: get-security-center-issue-counts-by-severity + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Issue Counts by Severity + tags: + - Security Center Insights + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - attack_surface_report + - issues + method: severity + /accounts/{account_id}/intel/attack-surface-report/issues/type: + get: + deprecated: true + description: Retrieves Security Center issue counts aggregated by issue type. + operationId: get-security-center-issue-counts-by-type + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Issue Counts by Type + tags: + - Security Center Insights + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - attack_surface_report + - issues + method: type + /accounts/{account_id}/intel/attack-surface-report/{issue_id}/dismiss: + put: + deprecated: true + description: Deprecated endpoint for archiving Security Center insights. Use the newer archive-security-center-insight endpoint instead. + operationId: archive-security-center-insight-deprecated + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + dismiss: + default: true + type: boolean + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseSingle' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Archives Security Center Insight + tags: + - Security Center Insights + x-stackql-sdk: + service: intel + resource_chain: + - attack_surface_report + - issues + method: dismiss + /accounts/{account_id}/intel/dns: + get: + description: Gets a list of all the domains that have resolved to a specific IP address. + operationId: passive-dns-by-ip-get-passive-dns-by-ip + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: start_end_params + schema: + $ref: '#/components/schemas/intelStartEndParams' + - in: query + name: ipv4 + schema: + type: string + - in: query + name: page + schema: + description: Requested page within paginated list of results. + type: number + - in: query + name: per_page + schema: + description: Maximum number of results requested. + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelComponentsSchemasSingleResponse' + description: Get Passive DNS by IP response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/intelSchemasResultInfo' + result: + properties: + count: + description: Total results returned based on your search parameters. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + reverse_records: + description: Reverse DNS look-ups observed during the time period. + items: + properties: + first_seen: + description: First seen date of the DNS record during the time period. + format: date + type: string + x-auditable: true + hostname: + description: Hostname that the IP was observed resolving to. + type: string + x-auditable: true + last_seen: + description: Last seen date of the DNS record during the time period. + format: date + type: string + x-auditable: true + type: object + type: array + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Passive DNS by IP response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Passive DNS by IP + tags: + - Passive DNS by IP + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - dns + method: list + /accounts/{account_id}/intel/domain: + get: + description: Gets security details and statistics about a domain. + operationId: domain-intelligence-get-domain-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: domain + schema: + type: string + - description: Skip DNS resolution lookups for faster response. + in: query + name: skip_dns + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelSingleResponse' + description: Get Domain Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + additional_information: + $ref: '#/components/schemas/intelAdditionalInformation' + application: + $ref: '#/components/schemas/intelApplication' + content_categories: + $ref: '#/components/schemas/intelContentCategories' + domain: + $ref: '#/components/schemas/intelDomainName' + inherited_content_categories: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + inherited_from: + $ref: '#/components/schemas/intelInheritedFrom' + inherited_risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + popularity_rank: + $ref: '#/components/schemas/intelPopularityRank' + resolves_to_refs: + $ref: '#/components/schemas/intelResolvesToRefs' + risk_score: + $ref: '#/components/schemas/intelRiskScore' + risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Domain Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Domain Details + tags: + - Domain Intelligence + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - domains + method: get + /accounts/{account_id}/intel/domain-history: + get: + description: Gets historical security threat and content categories currently and previously assigned to a domain. + operationId: domain-history-get-domain-history + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: domain + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelResponse' + description: Get Domain History response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + $ref: '#/components/schemas/intelDomainHistory' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Domain History response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Domain History + tags: + - Domain History + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - domain_history + method: get + /accounts/{account_id}/intel/domain/bulk: + get: + description: Same as summary. + operationId: domain-intelligence-get-multiple-domain-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Accepts multiple values like `?domain=cloudflare.com&domain=example.com`. + explode: true + in: query + name: domain + schema: + items: + type: string + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelCollectionResponse' + description: Get Multiple Domain Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + properties: + additional_information: + $ref: '#/components/schemas/intelAdditionalInformation' + application: + $ref: '#/components/schemas/intelApplication' + content_categories: + $ref: '#/components/schemas/intelContentCategories' + domain: + $ref: '#/components/schemas/intelDomainName' + inherited_content_categories: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + inherited_from: + $ref: '#/components/schemas/intelInheritedFrom' + inherited_risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + popularity_rank: + $ref: '#/components/schemas/intelPopularityRank' + risk_score: + $ref: '#/components/schemas/intelRiskScore' + risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + type: object + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Multiple Domain Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Multiple Domain Details + tags: + - Domain Intelligence + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - domains + - bulks + method: get + /accounts/{account_id}/intel/indicator-feeds: + get: + description: Retrieves details for all accessible custom threat indicator feeds. + operationId: custom-indicator-feeds-get-indicator-feeds + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsIndicatorFeedResponse' + description: Get indicator feeds response + 4XX: + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/customIndicatorFeedsIndicatorFeedItem' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: Get indicator feeds owned by this account + tags: + - Custom Indicator Feeds + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + method: list + post: + description: Creates a new custom threat indicator feed for sharing threat intelligence data. + operationId: custom-indicator-feeds-create-indicator-feeds + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsCreateFeed' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsCreateFeedResponse' + description: Create indicator feed response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_on: + description: The date and time when the data entry was created + format: date-time + type: string + x-auditable: true + readOnly: true + description: + $ref: '#/components/schemas/customIndicatorFeedsDescription' + id: + $ref: '#/components/schemas/customIndicatorFeedsId' + is_attributable: + $ref: '#/components/schemas/customIndicatorFeedsIsAttributable' + is_downloadable: + $ref: '#/components/schemas/customIndicatorFeedsIsDownloadable' + is_public: + $ref: '#/components/schemas/customIndicatorFeedsIsPublic' + modified_on: + description: The date and time when the data entry was last modified + format: date-time + type: string + x-auditable: true + readOnly: true + name: + $ref: '#/components/schemas/customIndicatorFeedsName' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get indicator feeds failure response + security: + - api_email: [] + api_key: [] + summary: Create new indicator feed + tags: + - Custom Indicator Feeds + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + method: create + /accounts/{account_id}/intel/indicator-feeds/permissions/add: + put: + description: Grants access permissions for a custom threat indicator feed to other accounts. + operationId: custom-indicator-feeds-add-permission + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsPermissionsResponse' + description: Get indicator feed metadata + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + success: + description: Whether the update succeeded or not + type: boolean + x-auditable: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: Grant permission to indicator feed + tags: + - Custom Indicator Feeds + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + - permissions + method: create + /accounts/{account_id}/intel/indicator-feeds/permissions/remove: + put: + description: Revokes access permissions for a custom threat indicator feed. + operationId: custom-indicator-feeds-remove-permission + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsPermissionsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsPermissionsResponse' + description: Get indicator feed metadata + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + success: + description: Whether the update succeeded or not + type: boolean + x-auditable: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: Revoke permission to indicator feed + tags: + - Custom Indicator Feeds + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + - permissions + method: delete + /accounts/{account_id}/intel/indicator-feeds/permissions/view: + get: + description: Lists current access permissions for custom threat indicator feeds. + operationId: custom-indicator-feeds-view-permissions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsPermissionListItemResponse' + description: Get indicator feed metadata + 4XX: + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/customIndicatorFeedsPermissionListItem' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: List indicator feed permissions + tags: + - Custom Indicator Feeds + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + - permissions + method: list + /accounts/{account_id}/intel/indicator-feeds/{feed_id}: + get: + description: Retrieves details for a specific custom threat indicator feed. + operationId: custom-indicator-feeds-get-indicator-feed-metadata + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: feed_id + in: path + required: true + description: The Intel indicator feed ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsIndicatorFeedMetadataResponse' + description: Get indicator feed metadata + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_on: + description: The date and time when the data entry was created + format: date-time + type: string + x-auditable: true + readOnly: true + description: + $ref: '#/components/schemas/customIndicatorFeedsDescription' + id: + $ref: '#/components/schemas/customIndicatorFeedsId' + is_attributable: + $ref: '#/components/schemas/customIndicatorFeedsIsAttributable' + is_downloadable: + $ref: '#/components/schemas/customIndicatorFeedsIsDownloadable' + is_public: + $ref: '#/components/schemas/customIndicatorFeedsIsPublic' + latest_upload_status: + description: Status of the latest snapshot uploaded + enum: + - Mirroring + - Unifying + - Loading + - Provisioning + - Complete + - Error + type: string + x-auditable: true + modified_on: + description: The date and time when the data entry was last modified + format: date-time + type: string + x-auditable: true + readOnly: true + name: + $ref: '#/components/schemas/customIndicatorFeedsName' + provider_id: + $ref: '#/components/schemas/customIndicatorFeedsProviderId' + provider_name: + $ref: '#/components/schemas/customIndicatorFeedsProviderName' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: Get indicator feed metadata + tags: + - Custom Indicator Feeds + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + method: get + put: + description: Revises details for a specific custom threat indicator feed. + operationId: custom-indicator-feeds-update-indicator-feed-metadata + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: feed_id + in: path + required: true + description: The Intel indicator feed ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsUpdatePublicFieldRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsUpdatePublicFieldResponse' + description: Get update public field response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_on: + description: The date and time when the data entry was created + format: date-time + type: string + x-auditable: true + readOnly: true + description: + $ref: '#/components/schemas/customIndicatorFeedsDescription' + id: + $ref: '#/components/schemas/customIndicatorFeedsId' + is_attributable: + $ref: '#/components/schemas/customIndicatorFeedsIsAttributable' + is_downloadable: + $ref: '#/components/schemas/customIndicatorFeedsIsDownloadable' + is_public: + $ref: '#/components/schemas/customIndicatorFeedsIsPublic' + modified_on: + description: The date and time when the data entry was last modified + format: date-time + type: string + x-auditable: true + readOnly: true + name: + $ref: '#/components/schemas/customIndicatorFeedsName' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get update public field response failure + security: + - api_email: [] + api_key: [] + summary: Update indicator feed metadata + tags: + - Custom Indicator Feeds + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + method: update + /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data: + get: + description: Retrieves the raw data entries in a custom threat indicator feed. + operationId: custom-indicator-feeds-get-indicator-feed-data + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: feed_id + in: path + required: true + description: The Intel indicator feed ID. + schema: + type: string + responses: + '200': + content: + text/csv: + schema: + type: object + properties: + contents: + type: string + description: Get indicator feed metadata + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsApiResponseCommonFailure' + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: Get indicator feed data + tags: + - Custom Indicator Feeds + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + method: data + /accounts/{account_id}/intel/indicator-feeds/{feed_id}/download: + get: + description: Downloads the content of a custom threat indicator feed. + operationId: custom-indicator-feeds-download-indicator-feed-data + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: feed_id + in: path + required: true + description: The Intel indicator feed ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsUpdateFeedResponse' + description: Get indicator feed metadata + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsApiResponseCommonFailure' + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: Download indicator feed data + tags: + - Custom Indicator Feeds + x-api-token-group: + - Intel Write + - Intel Read + /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot: + put: + description: Revises the raw data entries in a custom threat indicator feed. + operationId: custom-indicator-feeds-update-indicator-feed-data + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: feed_id + in: path + required: true + description: The Intel indicator feed ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + properties: + source: + description: The file to upload + type: string + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsUpdateFeedResponse' + description: Get indicator feed metadata + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/customIndicatorFeedsApiResponseCommonFailure' + description: Get indicator feeds response failure + security: + - api_email: [] + api_key: [] + summary: Update indicator feed data + tags: + - Custom Indicator Feeds + x-stackql-sdk: + service: intel + resource_chain: + - indicator_feeds + - snapshots + method: update + /accounts/{account_id}/intel/ip: + get: + description: Gets the geolocation, ASN, infrastructure type of the ASN, and any security threat categories of an IP address. **Must provide ip query parameters.** For example, `/intel/ip?ipv4=1.1.1.1` or `/intel/ip?ipv6=2001:db8::1`. + operationId: ip-intelligence-get-ip-overview + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: ipv4 + schema: + type: string + - in: query + name: ipv6 + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelSchemasResponse' + description: Get IP Overview response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + $ref: '#/components/schemas/intelSchemasIp' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get IP Overview response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get IP Overview + tags: + - IP Intelligence + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - ips + method: get + /accounts/{account_id}/intel/ip-lists: + get: + description: Returns a list of available IP list categories (e.g., anonymizer, botnetcc, malware, tor, vpn, open_proxies). This endpoint provides metadata about which IP lists are available in the system. + operationId: ip-list-get-ip-lists + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelComponentsSchemasResponse' + description: Get Available IP Lists response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + $ref: '#/components/schemas/intelIpList' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Available IP Lists response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Available IP Lists + tags: + - IP List + x-api-token-group: + - Intel Write + - Intel Read + /accounts/{account_id}/intel/miscategorization: + post: + description: "Allows you to submit requests to change a domain\u2019s category." + operationId: miscategorization-create-miscategorization + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/intelMiscategorization' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelApiResponseSingle' + description: Create Miscategorization response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Miscategorization response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Miscategorization + tags: + - Miscategorization + x-stackql-sdk: + service: intel + resource_chain: + - miscategorizations + method: create + /accounts/{account_id}/intel/sinkholes: + get: + operationId: sinkhole-config-get-sinkholes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/intelSinkholesGetSinkholesResponse' + description: Successful Response + security: + - api_email: [] + api_key: [] + summary: List sinkholes owned by this account + tags: + - Sinkhole Config + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - sinkholes + method: list + /accounts/{account_id}/intel/whois: + get: + description: Retrieves WHOIS registration data for a domain, including registrant and nameserver information. + operationId: whois-record-get-whois-record + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: domain + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cloudforceOneWhoisSchemasSingleResponse' + description: Get WHOIS Record response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Returns a boolean for the success/failure of the API call. + enum: + - true + - false + type: boolean + result: + properties: + administrative_city: + type: string + administrative_country: + type: string + administrative_email: + type: string + administrative_fax: + type: string + administrative_fax_ext: + type: string + administrative_id: + type: string + administrative_name: + type: string + administrative_org: + type: string + administrative_phone: + type: string + administrative_phone_ext: + type: string + administrative_postal_code: + type: string + administrative_province: + type: string + administrative_referral_url: + type: string + administrative_street: + type: string + billing_city: + type: string + billing_country: + type: string + billing_email: + type: string + billing_fax: + type: string + billing_fax_ext: + type: string + billing_id: + type: string + billing_name: + type: string + billing_org: + type: string + billing_phone: + type: string + billing_phone_ext: + type: string + billing_postal_code: + type: string + billing_province: + type: string + billing_referral_url: + type: string + billing_street: + type: string + created_date: + format: date-time + type: string + created_date_raw: + type: string + dnssec: + type: boolean + domain: + $ref: '#/components/schemas/cloudforceOneWhoisDomainName' + expiration_date: + format: date-time + type: string + expiration_date_raw: + type: string + extension: + type: string + found: + type: boolean + id: + type: string + nameservers: + items: + type: string + type: array + punycode: + type: string + registrant: + type: string + registrant_city: + type: string + registrant_country: + type: string + registrant_email: + type: string + registrant_fax: + type: string + registrant_fax_ext: + type: string + registrant_id: + type: string + registrant_name: + type: string + registrant_org: + type: string + registrant_phone: + type: string + registrant_phone_ext: + type: string + registrant_postal_code: + type: string + registrant_province: + type: string + registrant_referral_url: + type: string + registrant_street: + type: string + registrar: + type: string + registrar_city: + type: string + registrar_country: + type: string + registrar_email: + type: string + registrar_fax: + type: string + registrar_fax_ext: + type: string + registrar_id: + type: string + registrar_name: + type: string + registrar_org: + type: string + registrar_phone: + type: string + registrar_phone_ext: + type: string + registrar_postal_code: + type: string + registrar_province: + type: string + registrar_referral_url: + type: string + registrar_street: + type: string + status: + items: + type: string + type: array + technical_city: + type: string + technical_country: + type: string + technical_email: + type: string + technical_fax: + type: string + technical_fax_ext: + type: string + technical_id: + type: string + technical_name: + type: string + technical_org: + type: string + technical_phone: + type: string + technical_phone_ext: + type: string + technical_postal_code: + type: string + technical_province: + type: string + technical_referral_url: + type: string + technical_street: + type: string + updated_date: + format: date-time + type: string + updated_date_raw: + type: string + whois_server: + type: string + required: + - found + - domain + - dnssec + - extension + - nameservers + - punycode + - registrar + - registrant + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get WHOIS Record response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get WHOIS Record + tags: + - WHOIS Record + x-api-token-group: + - Intel Write + - Intel Read + x-stackql-sdk: + service: intel + resource_chain: + - whois + method: get +components: + schemas: + cloudforceOneWhoisDomainName: + example: cloudflare.com + type: string + cloudforceOneWhoisSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + cloudforceOneWhoisSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/cloudforceOneWhoisSchemasMessages' + messages: + $ref: '#/components/schemas/cloudforceOneWhoisSchemasMessages' + success: + description: Returns a boolean for the success/failure of the API call. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/cloudforceOneWhoisWhois' + required: + - success + - errors + - messages + cloudforceOneWhoisWhois: + properties: + administrative_city: + type: string + administrative_country: + type: string + administrative_email: + type: string + administrative_fax: + type: string + administrative_fax_ext: + type: string + administrative_id: + type: string + administrative_name: + type: string + administrative_org: + type: string + administrative_phone: + type: string + administrative_phone_ext: + type: string + administrative_postal_code: + type: string + administrative_province: + type: string + administrative_referral_url: + type: string + administrative_street: + type: string + billing_city: + type: string + billing_country: + type: string + billing_email: + type: string + billing_fax: + type: string + billing_fax_ext: + type: string + billing_id: + type: string + billing_name: + type: string + billing_org: + type: string + billing_phone: + type: string + billing_phone_ext: + type: string + billing_postal_code: + type: string + billing_province: + type: string + billing_referral_url: + type: string + billing_street: + type: string + created_date: + example: '2009-02-17T22:07:54.000Z' + format: date-time + type: string + created_date_raw: + example: '2009-02-17T22:07:54Z' + type: string + dnssec: + example: true + type: boolean + domain: + $ref: '#/components/schemas/cloudforceOneWhoisDomainName' + expiration_date: + example: '2033-02-17T22:07:54.000Z' + format: date-time + type: string + expiration_date_raw: + example: '2033-02-17T22:07:54Z' + type: string + extension: + example: com + type: string + found: + example: true + type: boolean + id: + example: 1542998887_DOMAIN_COM-VRSN + type: string + nameservers: + example: + - ns3.cloudflare.com + - ns4.cloudflare.com + - ns5.cloudflare.com + - ns6.cloudflare.com + - ns7.cloudflare.com + items: + type: string + type: array + punycode: + example: cloudflare.com + type: string + registrant: + type: string + registrant_city: + type: string + registrant_country: + type: string + registrant_email: + type: string + registrant_fax: + type: string + registrant_fax_ext: + type: string + registrant_id: + type: string + registrant_name: + type: string + registrant_org: + type: string + registrant_phone: + type: string + registrant_phone_ext: + type: string + registrant_postal_code: + type: string + registrant_province: + type: string + registrant_referral_url: + type: string + registrant_street: + type: string + registrar: + example: Cloudflare, Inc. + type: string + registrar_city: + type: string + registrar_country: + type: string + registrar_email: + type: string + registrar_fax: + type: string + registrar_fax_ext: + type: string + registrar_id: + type: string + registrar_name: + type: string + registrar_org: + type: string + registrar_phone: + type: string + registrar_phone_ext: + type: string + registrar_postal_code: + type: string + registrar_province: + type: string + registrar_referral_url: + type: string + registrar_street: + type: string + status: + example: + - clientdeleteprohibited + - clienttransferprohibited + - clientupdateprohibited + - serverdeleteprohibited + - servertransferprohibited + - serverupdateprohibited + items: + type: string + type: array + technical_city: + type: string + technical_country: + type: string + technical_email: + type: string + technical_fax: + type: string + technical_fax_ext: + type: string + technical_id: + type: string + technical_name: + type: string + technical_org: + type: string + technical_phone: + type: string + technical_phone_ext: + type: string + technical_postal_code: + type: string + technical_province: + type: string + technical_referral_url: + type: string + technical_street: + type: string + updated_date: + example: '2024-01-09T16:45:28.000Z' + format: date-time + type: string + updated_date_raw: + example: '2024-01-09T16:45:28Z' + type: string + whois_server: + example: whois.cloudflare.com + type: string + required: + - found + - domain + - dnssec + - extension + - nameservers + - punycode + - registrar + - registrant + type: object + customIndicatorFeedsApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/customIndicatorFeedsMessages' + messages: + example: [] + $ref: '#/components/schemas/customIndicatorFeedsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + customIndicatorFeedsCreateFeed: + example: + description: example feed description + name: example_feed_1 + properties: + description: + $ref: '#/components/schemas/customIndicatorFeedsDescription' + name: + $ref: '#/components/schemas/customIndicatorFeedsName' + type: object + customIndicatorFeedsCreateFeedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + messages: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/customIndicatorFeedsIndicatorFeedItem' + required: + - success + - errors + - messages + customIndicatorFeedsDescription: + description: The description of the example test + type: string + x-auditable: true + customIndicatorFeedsId: + description: The unique identifier for the indicator feed + type: integer + x-auditable: true + customIndicatorFeedsIndicatorFeedItem: + example: + created_on: '2023-05-12T12:21:56.777653Z' + description: example feed description + id: 1 + is_attributable: false + is_downloadable: false + is_public: false + modified_on: '2023-06-18T03:13:34.123321Z' + name: example_feed_1 + properties: + created_on: + description: The date and time when the data entry was created + format: date-time + type: string + x-auditable: true + readOnly: true + description: + $ref: '#/components/schemas/customIndicatorFeedsDescription' + id: + $ref: '#/components/schemas/customIndicatorFeedsId' + is_attributable: + $ref: '#/components/schemas/customIndicatorFeedsIsAttributable' + is_downloadable: + $ref: '#/components/schemas/customIndicatorFeedsIsDownloadable' + is_public: + $ref: '#/components/schemas/customIndicatorFeedsIsPublic' + modified_on: + description: The date and time when the data entry was last modified + format: date-time + type: string + x-auditable: true + readOnly: true + name: + $ref: '#/components/schemas/customIndicatorFeedsName' + type: object + customIndicatorFeedsIndicatorFeedMetadata: + example: + created_on: '2023-05-12T12:21:56.777653Z' + description: example feed description + id: 1 + is_attributable: false + is_downloadable: false + is_public: false + latest_upload_status: Complete + modified_on: '2023-06-18T03:13:34.123321Z' + name: example_feed_1 + properties: + created_on: + description: The date and time when the data entry was created + format: date-time + type: string + x-auditable: true + readOnly: true + description: + $ref: '#/components/schemas/customIndicatorFeedsDescription' + id: + $ref: '#/components/schemas/customIndicatorFeedsId' + is_attributable: + $ref: '#/components/schemas/customIndicatorFeedsIsAttributable' + is_downloadable: + $ref: '#/components/schemas/customIndicatorFeedsIsDownloadable' + is_public: + $ref: '#/components/schemas/customIndicatorFeedsIsPublic' + latest_upload_status: + description: Status of the latest snapshot uploaded + enum: + - Mirroring + - Unifying + - Loading + - Provisioning + - Complete + - Error + type: string + x-auditable: true + modified_on: + description: The date and time when the data entry was last modified + format: date-time + type: string + x-auditable: true + readOnly: true + name: + $ref: '#/components/schemas/customIndicatorFeedsName' + provider_id: + $ref: '#/components/schemas/customIndicatorFeedsProviderId' + provider_name: + $ref: '#/components/schemas/customIndicatorFeedsProviderName' + type: object + customIndicatorFeedsIndicatorFeedMetadataResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + messages: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/customIndicatorFeedsIndicatorFeedMetadata' + required: + - success + - errors + - messages + customIndicatorFeedsIndicatorFeedResponse: + properties: + errors: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + messages: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + example: + - created_on: '2023-05-12T12:21:56.777653Z' + description: user specified description 1 + id: 1 + modified_on: '2023-06-18T03:13:34.123321Z' + name: user_specified_name_1 + - created_on: '2023-05-21T21:43:52.867525Z' + description: User specified description 2 + id: 2 + modified_on: '2023-06-28T18:46:18.764425Z' + name: user_specified_name_2 + items: + $ref: '#/components/schemas/customIndicatorFeedsIndicatorFeedItem' + type: array + required: + - success + - errors + - messages + type: object + customIndicatorFeedsIsAttributable: + description: Whether the indicator feed can be attributed to a provider + type: boolean + x-auditable: true + customIndicatorFeedsIsDownloadable: + description: Whether the indicator feed can be downloaded + type: boolean + x-auditable: true + customIndicatorFeedsIsPublic: + description: Whether the indicator feed is exposed to customers + type: boolean + x-auditable: true + customIndicatorFeedsMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + customIndicatorFeedsName: + description: The name of the indicator feed + type: string + x-auditable: true + customIndicatorFeedsPermissionListItem: + properties: + description: + $ref: '#/components/schemas/customIndicatorFeedsDescription' + id: + $ref: '#/components/schemas/customIndicatorFeedsId' + is_attributable: + $ref: '#/components/schemas/customIndicatorFeedsIsAttributable' + is_downloadable: + $ref: '#/components/schemas/customIndicatorFeedsIsDownloadable' + is_public: + $ref: '#/components/schemas/customIndicatorFeedsIsPublic' + name: + $ref: '#/components/schemas/customIndicatorFeedsName' + type: object + customIndicatorFeedsPermissionListItemResponse: + properties: + errors: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + messages: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + example: + - description: An important indicator list + id: 1 + is_attributable: false + is_downloadable: false + is_public: false + name: indicator_list_1 + - description: An even more important indicator list + id: 2 + is_attributable: true + is_downloadable: false + is_public: true + name: indicator_list_2 + items: + $ref: '#/components/schemas/customIndicatorFeedsPermissionListItem' + type: array + required: + - success + - errors + - messages + type: object + customIndicatorFeedsPermissionsRequest: + properties: + account_tag: + description: The Cloudflare account tag of the account to change permissions on + example: 823f45f16fd2f7e21e1e054aga4d2859 + type: string + x-auditable: true + feed_id: + description: The ID of the feed to add/remove permissions on + example: 1 + type: integer + x-auditable: true + type: object + customIndicatorFeedsPermissionsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + messages: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/customIndicatorFeedsPermissionsUpdate' + required: + - success + - errors + - messages + customIndicatorFeedsPermissionsUpdate: + properties: + success: + description: Whether the update succeeded or not + type: boolean + x-auditable: true + type: object + customIndicatorFeedsProviderId: + description: The unique identifier for the provider + type: string + x-auditable: true + customIndicatorFeedsProviderName: + description: The provider of the indicator feed + type: string + x-auditable: true + customIndicatorFeedsSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + customIndicatorFeedsUpdateFeed: + properties: + file_id: + description: Feed id + example: 1 + type: integer + x-auditable: true + filename: + description: Name of the file unified in our system + example: snapshot_file.unified + type: string + x-auditable: true + status: + description: Current status of upload, should be unified + example: unified + type: string + x-auditable: true + type: object + customIndicatorFeedsUpdateFeedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + messages: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/customIndicatorFeedsUpdateFeed' + required: + - success + - errors + - messages + customIndicatorFeedsUpdatePublicFieldRequest: + properties: + description: + description: The new description of the feed + example: This is an example description + type: string + x-auditable: true + is_attributable: + description: The new is_attributable value of the feed + example: true + type: boolean + x-auditable: true + is_downloadable: + description: The new is_downloadable value of the feed + example: true + type: boolean + x-auditable: true + is_public: + description: The new is_public value of the feed + example: true + type: boolean + x-auditable: true + name: + description: The new name of the feed + example: indicator_list + type: string + x-auditable: true + type: object + customIndicatorFeedsUpdatePublicFieldResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + messages: + $ref: '#/components/schemas/customIndicatorFeedsSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/customIndicatorFeedsIndicatorFeedItem' + required: + - success + - errors + - messages + intelAdditionalInformation: + description: Additional information related to the host name. + properties: + suspected_malware_family: + description: Suspected DGA malware family. + example: '' + type: string + x-auditable: true + type: object + intelApiResponseSingle: + type: object + $ref: '#/components/schemas/intelSchemasApiResponseCommon' + intelApplication: + description: Application that the hostname belongs to. + properties: + id: + type: integer + x-auditable: true + name: + example: CLOUDFLARE + type: string + x-auditable: true + type: object + intelAsn: + type: integer + x-auditable: true + intelAsnComponentsSchemasResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/intelSchemasMessages' + messages: + $ref: '#/components/schemas/intelSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/intelAsn' + required: + - success + - errors + - messages + intelCategoriesWithSuperCategoryIdsExampleEmpty: + example: [] + items: + $ref: '#/components/schemas/intelCategoryWithSuperCategoryId' + type: array + intelCategoryWithSuperCategoryId: + properties: + id: + type: integer + x-auditable: true + name: + type: string + x-auditable: true + super_category_id: + type: integer + x-auditable: true + type: object + intelCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + $ref: '#/components/schemas/intelCollectionResponse_result_item' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + intelCollectionResponse_result_item: + properties: + additional_information: + $ref: '#/components/schemas/intelAdditionalInformation' + application: + $ref: '#/components/schemas/intelApplication' + content_categories: + $ref: '#/components/schemas/intelContentCategories' + domain: + $ref: '#/components/schemas/intelDomainName' + inherited_content_categories: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + inherited_from: + $ref: '#/components/schemas/intelInheritedFrom' + inherited_risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + popularity_rank: + $ref: '#/components/schemas/intelPopularityRank' + risk_score: + $ref: '#/components/schemas/intelRiskScore' + risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + type: object + intelComponentsSchemasResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + $ref: '#/components/schemas/intelIpList' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + intelComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/intelSchemasMessages' + messages: + $ref: '#/components/schemas/intelSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/intelSchemasResultInfo' + result: + $ref: '#/components/schemas/intelPassiveDnsByIp' + required: + - success + - errors + - messages + intelContentCategories: + example: + - id: 155 + name: Technology + super_category_id: 26 + items: + description: Current content categories. + properties: + id: + type: integer + x-auditable: true + name: + type: string + x-auditable: true + super_category_id: + type: integer + x-auditable: true + type: object + type: array + intelCount: + description: Total results returned based on your search parameters. + example: 1 + type: number + intelDomain: + properties: + additional_information: + $ref: '#/components/schemas/intelAdditionalInformation' + application: + $ref: '#/components/schemas/intelApplication' + content_categories: + $ref: '#/components/schemas/intelContentCategories' + domain: + $ref: '#/components/schemas/intelDomainName' + inherited_content_categories: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + inherited_from: + $ref: '#/components/schemas/intelInheritedFrom' + inherited_risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + popularity_rank: + $ref: '#/components/schemas/intelPopularityRank' + resolves_to_refs: + $ref: '#/components/schemas/intelResolvesToRefs' + risk_score: + $ref: '#/components/schemas/intelRiskScore' + risk_types: + $ref: '#/components/schemas/intelCategoriesWithSuperCategoryIdsExampleEmpty' + type: object + intelDomainHistory: + properties: + categorizations: + items: + properties: + categories: + example: + - id: 155 + name: Technology + items: + properties: + id: + example: 155 + type: integer + name: + example: Technology + type: string + type: object + type: array + end: + example: '2021-04-30' + format: date + type: string + x-auditable: true + start: + example: '2021-04-01' + format: date + type: string + x-auditable: true + type: object + type: array + domain: + $ref: '#/components/schemas/intelDomainName' + type: object + intelDomainName: + example: cloudflare.com + type: string + x-auditable: true + intelInheritedFrom: + description: Domain from which `inherited_content_categories` and `inherited_risk_types` are inherited, if applicable. + type: string + x-auditable: true + intelIp: + type: string + x-auditable: true + format: ipv4 + example: 192.0.2.0 + intelIpList: + properties: + description: + type: string + x-auditable: true + id: + type: integer + x-auditable: true + name: + example: Malware + type: string + x-auditable: true + type: object + intelMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + intelMiscategorization: + properties: + content_adds: + description: Content category IDs to add. + example: + - 82 + items: + type: integer + x-auditable: true + type: array + content_removes: + description: Content category IDs to remove. + example: + - 155 + items: + type: integer + x-auditable: true + type: array + indicator_type: + enum: + - domain + - ipv4 + - ipv6 + - url + example: domain + type: string + x-auditable: true + ip: + description: Provide only if indicator_type is `ipv4` or `ipv6`. + nullable: true + type: string + x-auditable: true + security_adds: + description: Security category IDs to add. + example: + - 117 + - 131 + items: + type: integer + x-auditable: true + type: array + security_removes: + description: Security category IDs to remove. + example: + - 83 + items: + type: integer + x-auditable: true + type: array + url: + description: 'Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`.' + type: string + x-auditable: true + type: object + intelPage: + description: Current page within paginated list of results. + example: 1 + type: number + intelPassiveDnsByIp: + properties: + count: + description: Total results returned based on your search parameters. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + reverse_records: + description: Reverse DNS look-ups observed during the time period. + items: + properties: + first_seen: + description: First seen date of the DNS record during the time period. + example: '2021-04-01' + format: date + type: string + x-auditable: true + hostname: + description: Hostname that the IP was observed resolving to. + type: string + x-auditable: true + last_seen: + description: Last seen date of the DNS record during the time period. + example: '2021-04-30' + format: date + type: string + x-auditable: true + type: object + type: array + type: object + intelPerPage: + description: Number of results per page of results. + example: 20 + type: number + intelPopularityRank: + description: Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000. + type: integer + x-auditable: true + intelResolvesToRef: + properties: + id: + $ref: '#/components/schemas/intelStixIdentifier' + value: + description: IP address or domain name. + example: 192.0.2.0 + type: string + x-auditable: true + type: object + intelResolvesToRefs: + description: Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to. + items: + $ref: '#/components/schemas/intelResolvesToRef' + type: array + intelResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + $ref: '#/components/schemas/intelDomainHistory' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + intelResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + intelRiskScore: + description: Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk). + type: number + intelSchemasApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/intelSchemasMessages' + messages: + $ref: '#/components/schemas/intelSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + intelSchemasIp: + properties: + belongs_to_ref: + description: Specifies a reference to the autonomous systems (AS) that the IP address belongs to. + properties: + country: + example: US + type: string + x-auditable: true + description: + example: CLOUDFLARENET + type: string + x-auditable: true + id: + example: autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8 + type: string + x-auditable: true + type: + description: Infrastructure type of this ASN. + enum: + - hosting_provider + - isp + - organization + example: hosting_provider + type: string + x-auditable: true + value: + type: string + x-auditable: true + type: object + ip: + $ref: '#/components/schemas/intelIp' + risk_types: + example: + - id: 131 + name: Phishing + super_category_id: 21 + items: + properties: + id: + type: number + name: + type: string + x-auditable: true + super_category_id: + type: number + type: object + type: array + type: object + intelSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + intelSchemasResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/intelMessages' + messages: + $ref: '#/components/schemas/intelMessages' + result: + items: + $ref: '#/components/schemas/intelSchemasIp' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/intelResultInfo' + required: + - success + - errors + - messages + - result + intelSchemasResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + intelSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/intelSchemasMessages' + messages: + $ref: '#/components/schemas/intelSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/intelDomain' + required: + - success + - errors + - messages + intelSinkholesGetSinkholesResponse: + properties: + errors: + $ref: '#/components/schemas/intelSinkholesMessages' + messages: + $ref: '#/components/schemas/intelSinkholesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + example: + - account_tag: 233f45e61fd1f7e21e1e154ede4q2859 + created_on: '2023-05-12T12:21:56.777653Z' + description: user specified description 1 + id: 1 + modified_on: '2023-06-18T03:13:34.123321Z' + name: sinkhole_1 + r2_bucket: my_bucket + r2_id: + - account_tag: 233f45e61fd1f7e21e1e154ede4q2859 + created_on: '2023-05-21T21:43:52.867525Z' + description: user specified description 2 + id: 2 + modified_on: '2023-06-28T18:46:18.764425Z' + name: sinkhole_1 + r2_bucket: my_bucket + r2_id: + items: + $ref: '#/components/schemas/intelSinkholesSinkholeItem' + type: array + required: + - success + - errors + - messages + type: object + intelSinkholesId: + description: The unique identifier for the sinkhole + type: integer + intelSinkholesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + intelSinkholesName: + description: The name of the sinkhole + type: string + intelSinkholesSinkholeItem: + example: + account_tag: 233f45e61fd1f7e21e1e154ede4q2859 + created_on: '2023-05-12T12:21:56.777653Z' + description: user specified description 1 + id: 1 + modified_on: '2023-06-18T03:13:34.123321Z' + name: sinkhole_1 + r2_bucket: my_bucket + r2_id: + properties: + account_tag: + description: The account tag that owns this sinkhole + type: string + created_on: + description: The date and time when the sinkhole was created + format: date-time + type: string + readOnly: true + id: + $ref: '#/components/schemas/intelSinkholesId' + modified_on: + description: The date and time when the sinkhole was last modified + format: date-time + type: string + readOnly: true + name: + $ref: '#/components/schemas/intelSinkholesName' + r2_bucket: + description: The name of the R2 bucket to store results + type: string + r2_id: + description: The id of the R2 instance + type: string + type: object + intelStartEndParams: + properties: + end: + description: Defaults to the current date. + example: '2021-04-30' + format: date + type: string + x-auditable: true + start: + description: Defaults to 30 days before the end parameter value. + example: '2021-04-01' + format: date + type: string + x-auditable: true + type: object + intelStixIdentifier: + description: 'STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c.' + example: ipv4-addr--baa568ec-6efe-5902-be55-0663833db537 + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securityCenterApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + securityCenterApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/securityCenterMessages' + messages: + example: [] + $ref: '#/components/schemas/securityCenterMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + securityCenterApiResponseSingle: + type: object + $ref: '#/components/schemas/securityCenterApiResponseCommon' + securityCenterCount: + description: Indicates the total number of results. + example: 1 + type: integer + x-auditable: true + securityCenterDismissed: + example: false + type: boolean + x-auditable: true + securityCenterIssue: + properties: + dismissed: + example: false + type: boolean + x-auditable: true + has_extended_context: + description: Indicates whether the insight has a large payload that requires fetching via the context endpoint. + example: false + type: boolean + x-auditable: true + id: + type: string + x-auditable: true + issue_class: + $ref: '#/components/schemas/securityCenterIssueClass' + issue_type: + $ref: '#/components/schemas/securityCenterIssueType' + payload: + properties: + detection_method: + description: Describes the method used to detect insight. + example: We detected security rules referencing multiple IP addresses directly in the rules. + type: string + x-auditable: true + zone_tag: + type: string + x-auditable: true + type: object + resolve_link: + type: string + x-auditable: true + resolve_text: + type: string + x-auditable: true + severity: + enum: + - Low + - Moderate + - Critical + type: string + x-auditable: true + since: + format: date-time + type: string + x-auditable: true + status: + description: The current status of the insight. + enum: + - active + - resolved + example: active + type: string + x-auditable: true + subject: + $ref: '#/components/schemas/securityCenterSubject' + timestamp: + format: date-time + type: string + x-auditable: true + user_classification: + $ref: '#/components/schemas/securityCenterUserClassification' + type: object + securityCenterIssueClass: + example: always_use_https_not_enabled + type: string + x-auditable: true + securityCenterIssueClasses: + example: + - a_record_dangling + - always_use_https_not_enabled + items: + $ref: '#/components/schemas/securityCenterIssueClass' + type: array + securityCenterIssueType: + enum: + - compliance_violation + - email_security + - exposed_infrastructure + - insecure_configuration + - weak_authentication + - configuration_suggestion + type: string + x-auditable: true + securityCenterIssueTypes: + example: + - compliance_violation + - email_security + items: + $ref: '#/components/schemas/securityCenterIssueType' + type: array + securityCenterMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + securityCenterPage: + description: Specifies the current page within paginated list of results. + example: 1 + type: integer + securityCenterPerPage: + description: Sets the number of results per page of results. + example: 25 + maximum: 1000 + minimum: 1 + type: integer + securityCenterProducts: + example: + - access + - dns + items: + type: string + x-auditable: true + type: array + securityCenterSeverityQueryParam: + example: + - low + - moderate + items: + enum: + - low + - moderate + - critical + type: string + x-auditable: true + type: array + securityCenterSubject: + example: example.com + type: string + x-auditable: true + securityCenterSubjects: + items: + $ref: '#/components/schemas/securityCenterSubject' + type: array + securityCenterUserClassification: + description: User-defined classification for the insight. Can be 'false_positive', 'accept_risk', 'other', or null. + enum: + - false_positive + - accept_risk + - other + - null + example: false_positive + nullable: true + type: string + x-auditable: true + securityCenterValueCountsResponse: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/securityCenterValueCountsResponse_result_item' + type: array + required: + - success + - errors + - messages + type: object + securityCenterValueCountsResponse_result_item: + properties: + count: + example: 1 + type: integer + x-auditable: true + value: + type: string + x-auditable: true + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + asn: + id: cloudflare.intel.asn + name: asn + title: Asn + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1asn~1{asn}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asn/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + subnets: + id: cloudflare.intel.subnets + name: subnets + title: Subnets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1asn~1{asn}~1subnets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subnets/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + issue_types: + id: cloudflare.intel.issue_types + name: issue_types + title: Issue Types + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1attack-surface-report~1issue-types/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issue_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + attack_surface_report_issues: + id: cloudflare.intel.attack_surface_report_issues + name: attack_surface_report_issues + title: Attack Surface Report Issues + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1attack-surface-report~1issues/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/attack_surface_report_issues/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + issues_class: + id: cloudflare.intel.issues_class + name: issues_class + title: Issues Class + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1attack-surface-report~1issues~1class/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issues_class/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + issues_severity: + id: cloudflare.intel.issues_severity + name: issues_severity + title: Issues Severity + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1attack-surface-report~1issues~1severity/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issues_severity/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + issues_type: + id: cloudflare.intel.issues_type + name: issues_type + title: Issues Type + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1attack-surface-report~1issues~1type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issues_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + intel: + id: cloudflare.intel.intel + name: intel + title: Intel + methods: + dismiss: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1attack-surface-report~1{issue_id}~1dismiss/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_miscategorization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1miscategorization/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + dns: + id: cloudflare.intel.dns + name: dns + title: Dns + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1dns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + domains: + id: cloudflare.intel.domains + name: domains + title: Domains + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1domain/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + domain_history: + id: cloudflare.intel.domain_history + name: domain_history + title: Domain History + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1domain-history/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domain_history/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bulks: + id: cloudflare.intel.bulks + name: bulks + title: Bulks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1domain~1bulk/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bulks/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + intel_indicator_feeds: + id: cloudflare.intel.intel_indicator_feeds + name: intel_indicator_feeds + title: Intel Indicator Feeds + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/intel_indicator_feeds/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + indicator_feeds: + id: cloudflare.intel.indicator_feeds + name: indicator_feeds + title: Indicator Feeds + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1{feed_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1{feed_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + snapshot: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1{feed_id}~1snapshot/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indicator_feeds/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/indicator_feeds/methods/create' + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/indicator_feeds/methods/update' + permissions: + id: cloudflare.intel.permissions + name: permissions + title: Permissions + methods: + update_add: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1permissions~1add/put' + response: + mediaType: application/json + openAPIDocKey: '200' + update_remove: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1permissions~1remove/put' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1permissions~1view/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + datas: + id: cloudflare.intel.datas + name: datas + title: Datas + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1{feed_id}~1data/get' + response: + mediaType: text/csv + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/datas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + download: + id: cloudflare.intel.download + name: download + title: Download + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1indicator-feeds~1{feed_id}~1download/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/download/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ips: + id: cloudflare.intel.ips + name: ips + title: Ips + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1ip/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ips/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ip_lists: + id: cloudflare.intel.ip_lists + name: ip_lists + title: Ip Lists + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1ip-lists/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_lists/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + sinkholes: + id: cloudflare.intel.sinkholes + name: sinkholes + title: Sinkholes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1sinkholes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sinkholes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + whois: + id: cloudflare.intel.whois + name: whois + title: Whois + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1intel~1whois/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/whois/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/intelligence.yaml b/providers/src/cloudflare/v00.00.00000/services/intelligence.yaml deleted file mode 100644 index 1c8659f0..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/intelligence.yaml +++ /dev/null @@ -1,1183 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: ASN Intelligence - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - intelligence - version: 4.0.0 -components: - schemas: - asn_components-schemas-asn: - properties: - asn: - $ref: '#/components/schemas/components-schemas-asn' - country: - $ref: '#/components/schemas/asn_country' - description: - $ref: '#/components/schemas/asn_description' - domain_count: - type: integer - top_domains: - example: - - example.com - items: - type: string - type: array - type: - $ref: '#/components/schemas/asn_type' - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - asn_components-schemas-response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/asn_components-schemas-asn' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - components-schemas-asn: - type: integer - asn_country: - example: US - type: string - asn_description: - example: CLOUDFLARENET - type: string - asn_type: - description: Infrastructure type of this ASN. - enum: - - hosting_provider - - isp - - organization - example: hosting_provider - type: string - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - schemas-count: - description: Total results returned based on your search parameters. - example: 1 - type: number - page: - description: Current page within paginated list of results. - example: 1 - type: number - per_page: - description: Number of results per page of results. - example: 20 - type: number - response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/domain-history' - type: array - domain-history: - properties: - categorizations: - items: - properties: - categories: - example: - - id: 155 - name: Technology - end: - example: '2021-04-30' - format: date - type: string - start: - example: '2021-04-01' - format: date - type: string - type: object - type: array - domain: - $ref: '#/components/schemas/components-schemas-domain_name' - components-schemas-domain_name: - example: cloudflare.com - type: string - domain_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/domain_components-schemas-domain' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - domain_components-schemas-domain: - properties: - additional_information: - $ref: '#/components/schemas/additional_information' - application: - $ref: '#/components/schemas/schemas-application' - content_categories: - $ref: '#/components/schemas/content_categories' - domain: - $ref: '#/components/schemas/components-schemas-domain_name' - popularity_rank: - $ref: '#/components/schemas/popularity_rank' - resolves_to_refs: - $ref: '#/components/schemas/resolves_to_refs' - risk_score: - $ref: '#/components/schemas/risk_score' - risk_types: - $ref: '#/components/schemas/risk_types' - additional_information: - description: Additional information related to the host name. - properties: - suspected_malware_family: - description: Suspected DGA malware family. - example: '' - type: string - type: object - schemas-application: - description: Application that the hostname belongs to. - properties: - id: - type: integer - name: - example: CLOUDFLARE - type: string - type: object - content_categories: - description: Current content categories. - example: - - id: 155 - name: Technology - super_category_id: 26 - popularity_rank: - description: 'Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.' - type: integer - resolves_to_refs: - description: Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to. - items: - $ref: '#/components/schemas/resolves_to_ref' - type: array - risk_score: - description: 'Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk).' - type: number - risk_types: - example: [] - resolves_to_ref: - properties: - id: - $ref: '#/components/schemas/stix_identifier' - value: - description: IP address or domain name. - example: 192.0.2.0 - type: string - type: object - stix_identifier: - description: 'STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c' - example: ipv4-addr--baa568ec-6efe-5902-be55-0663833db537 - type: string - schemas-collection_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - properties: - additional_information: - $ref: '#/components/schemas/additional_information' - application: - $ref: '#/components/schemas/schemas-application' - content_categories: - $ref: '#/components/schemas/content_categories' - domain: - $ref: '#/components/schemas/components-schemas-domain_name' - popularity_rank: - $ref: '#/components/schemas/popularity_rank' - risk_score: - $ref: '#/components/schemas/risk_score' - risk_types: - $ref: '#/components/schemas/risk_types' - type: array - schemas-response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/ip_components-schemas-ip' - type: array - ip_components-schemas-ip: - properties: - belongs_to_ref: - description: Specifies a reference to the autonomous systems (AS) that the IP address belongs to. - properties: - country: - example: US - type: string - description: - example: CLOUDFLARENET - type: string - id: - example: autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8 - type: - description: Infrastructure type of this ASN. - enum: - - hosting_provider - - isp - - organization - example: hosting_provider - type: string - value: - type: string - type: object - ip: - $ref: '#/components/schemas/common_components-schemas-ip' - risk_types: - example: - - id: 131 - name: Phishing - super_category_id: 21 - common_components-schemas-ip: - anyOf: - - $ref: '#/components/schemas/ipv4' - - $ref: '#/components/schemas/schemas-ipv6' - ipv4: - example: 192.0.2.0 - format: ipv4 - type: string - schemas-ipv6: - example: '2001:0DB8::' - format: ipv6 - type: string - components-schemas-response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/ip-list' - type: array - ip-list: - properties: - description: - type: string - id: - type: integer - name: - example: Malware - type: string - miscategorization: - properties: - content_adds: - description: Content category IDs to add. - example: - - 82 - content_removes: - description: Content category IDs to remove. - example: - - 155 - indicator_type: - enum: - - domain - - ipv4 - - ipv6 - - url - example: domain - ip: - description: Provide only if indicator_type is `ipv4` or `ipv6`. - security_adds: - description: Security category IDs to add. - example: - - 117 - - 131 - security_removes: - description: Security category IDs to remove. - example: - - 83 - url: - description: 'Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`.' - type: string - passive-dns-by-ip_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/passive-dns-by-ip' - passive-dns-by-ip: - properties: - count: - description: Total results returned based on your search parameters. - example: 1 - type: number - page: - description: Current page within paginated list of results. - example: 1 - type: number - per_page: - description: Number of results per page of results. - example: 20 - type: number - reverse_records: - description: Reverse DNS look-ups observed during the time period. - items: - properties: - first_seen: - description: First seen date of the DNS record during the time period. - example: '2021-04-01' - format: date - type: string - hostname: - description: Hostname that the IP was observed resolving to. - last_seen: - description: Last seen date of the DNS record during the time period. - example: '2021-04-30' - format: date - type: string - type: object - type: array - phishing_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/phishing' - phishing: - properties: - classifier: - description: Type of classifier that labelled this URL. - example: MACHINE_LEARNING_v2 - type: string - phishing: - description: Whether the URL has been classified as phishing. - example: false - type: boolean - score: - description: Score reported from the classifer for the given URL. - example: 0.99 - type: number - url: - description: URL that was scanned. - example: 'https://www.cloudflare.com' - type: string - verified: - description: Whether the URL has been hand verified. - example: false - type: boolean - whois_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/whois' - whois: - properties: - created_date: - example: '2009-02-17' - format: date - type: string - domain: - $ref: '#/components/schemas/components-schemas-domain_name' - nameservers: - example: - - ns3.cloudflare.com - - ns4.cloudflare.com - - ns5.cloudflare.com - - ns6.cloudflare.com - - ns7.cloudflare.com - items: - type: string - type: array - registrant: - example: DATA REDACTED - type: string - registrant_country: - example: United States - type: string - registrant_email: - example: 'https://domaincontact.cloudflareregistrar.com/cloudflare.com' - type: string - registrant_org: - example: DATA REDACTED - type: string - registrar: - example: 'Cloudflare, Inc.' - type: string - updated_date: - example: '2017-05-24' - format: date - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_intel_asn: - id: cloudflare.intelligence.accounts_intel_asn - name: accounts_intel_asn - title: Accounts Intel Asn - methods: - asn_intelligence_get_asn_overview: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1asn~1{asn}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _asn_intelligence_get_asn_overview: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1asn~1{asn}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_asn/methods/asn_intelligence_get_asn_overview' - insert: [] - update: [] - delete: [] - accounts_intel_asn_subnets: - id: cloudflare.intelligence.accounts_intel_asn_subnets - name: accounts_intel_asn_subnets - title: Accounts Intel Asn Subnets - methods: - asn_intelligence_get_asn_subnets: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1asn~1{asn}~1subnets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _asn_intelligence_get_asn_subnets: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1asn~1{asn}~1subnets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_asn_subnets/methods/asn_intelligence_get_asn_subnets' - insert: [] - update: [] - delete: [] - accounts_intel_domain_history: - id: cloudflare.intelligence.accounts_intel_domain_history - name: accounts_intel_domain_history - title: Accounts Intel Domain History - methods: - domain_history_get_domain_history: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1domain-history/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _domain_history_get_domain_history: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1domain-history/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_domain_history/methods/domain_history_get_domain_history' - insert: [] - update: [] - delete: [] - accounts_intel_domain: - id: cloudflare.intelligence.accounts_intel_domain - name: accounts_intel_domain - title: Accounts Intel Domain - methods: - domain_intelligence_get_domain_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1domain/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _domain_intelligence_get_domain_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1domain/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_domain/methods/domain_intelligence_get_domain_details' - insert: [] - update: [] - delete: [] - accounts_intel_domain_bulk: - id: cloudflare.intelligence.accounts_intel_domain_bulk - name: accounts_intel_domain_bulk - title: Accounts Intel Domain Bulk - methods: - domain_intelligence_get_multiple_domain_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1domain~1bulk/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _domain_intelligence_get_multiple_domain_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1domain~1bulk/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_domain_bulk/methods/domain_intelligence_get_multiple_domain_details' - insert: [] - update: [] - delete: [] - accounts_intel_ip: - id: cloudflare.intelligence.accounts_intel_ip - name: accounts_intel_ip - title: Accounts Intel Ip - methods: - ip_intelligence_get_ip_overview: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1ip/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _ip_intelligence_get_ip_overview: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1ip/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_ip/methods/ip_intelligence_get_ip_overview' - insert: [] - update: [] - delete: [] - accounts_intel_ip_list: - id: cloudflare.intelligence.accounts_intel_ip_list - name: accounts_intel_ip_list - title: Accounts Intel Ip List - methods: - ip_list_get_ip_lists: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1ip-list/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _ip_list_get_ip_lists: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1ip-list/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_ip_list/methods/ip_list_get_ip_lists' - insert: [] - update: [] - delete: [] - accounts_intel_miscategorization: - id: cloudflare.intelligence.accounts_intel_miscategorization - name: accounts_intel_miscategorization - title: Accounts Intel Miscategorization - methods: - miscategorization_create_miscategorization: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1miscategorization/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/accounts_intel_miscategorization/methods/miscategorization_create_miscategorization' - update: [] - delete: [] - accounts_intel_dns: - id: cloudflare.intelligence.accounts_intel_dns - name: accounts_intel_dns - title: Accounts Intel Dns - methods: - passive_dns_by_ip_get_passive_dns_by_ip: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1dns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _passive_dns_by_ip_get_passive_dns_by_ip: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1dns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_dns/methods/passive_dns_by_ip_get_passive_dns_by_ip' - insert: [] - update: [] - delete: [] - accounts_intel_phishing_predict: - id: cloudflare.intelligence.accounts_intel_phishing_predict - name: accounts_intel_phishing_predict - title: Accounts Intel Phishing Predict - methods: - phishing_url_scanner_scan_suspicious_url: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel-phishing~1predict/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _phishing_url_scanner_scan_suspicious_url: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel-phishing~1predict/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_intel_whois: - id: cloudflare.intelligence.accounts_intel_whois - name: accounts_intel_whois - title: Accounts Intel Whois - methods: - whois_record_get_whois_record: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1whois/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _whois_record_get_whois_record: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1intel~1whois/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_intel_whois/methods/whois_record_get_whois_record' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/intel/asn/{asn}': - get: - operationId: asn-intelligence-get-asn-overview - parameters: - - in: path - name: asn - required: true - schema: - $ref: '#/components/schemas/asn_components-schemas-asn' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/asn_components-schemas-response' - description: Get ASN Overview response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/asn_components-schemas-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get ASN Overview response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get ASN Overview - tags: - - ASN Intelligence - '/accounts/{account_identifier}/intel/asn/{asn}/subnets': - get: - operationId: asn-intelligence-get-asn-subnets - parameters: - - in: path - name: asn - required: true - schema: - $ref: '#/components/schemas/asn_components-schemas-asn' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - properties: - asn: - $ref: '#/components/schemas/components-schemas-asn' - count: - $ref: '#/components/schemas/schemas-count' - ip_count_total: - type: integer - page: - $ref: '#/components/schemas/page' - per_page: - $ref: '#/components/schemas/per_page' - subnets: - example: - - 192.0.2.0/24 - - '2001:DB8::/32' - items: - type: string - type: array - type: object - description: Get ASN Subnets response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - asn: - $ref: '#/components/schemas/components-schemas-asn' - count: - $ref: '#/components/schemas/schemas-count' - ip_count_total: - type: integer - page: - $ref: '#/components/schemas/page' - per_page: - $ref: '#/components/schemas/per_page' - subnets: - example: - - 192.0.2.0/24 - - '2001:DB8::/32' - items: - type: string - type: array - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get ASN Subnets response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get ASN Subnets - tags: - - ASN Intelligence - '/accounts/{account_identifier}/intel/domain-history': - get: - operationId: domain-history-get-domain-history - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response' - description: Get Domain History response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Domain History response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Domain History - tags: - - Domain History - '/accounts/{account_identifier}/intel/domain': - get: - operationId: domain-intelligence-get-domain-details - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain_components-schemas-single_response' - description: Get Domain Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Domain Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Domain Details - tags: - - Domain Intelligence - '/accounts/{account_identifier}/intel/domain/bulk': - get: - operationId: domain-intelligence-get-multiple-domain-details - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-collection_response' - description: Get Multiple Domain Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Multiple Domain Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Multiple Domain Details - tags: - - Domain Intelligence - '/accounts/{account_identifier}/intel/ip': - get: - operationId: ip-intelligence-get-ip-overview - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response' - description: Get IP Overview response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get IP Overview response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get IP Overview - tags: - - IP Intelligence - '/accounts/{account_identifier}/intel/ip-list': - get: - operationId: ip-list-get-ip-lists - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-response' - description: Get IP Lists response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get IP Lists response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get IP Lists - tags: - - IP List - '/accounts/{account_identifier}/intel/miscategorization': - post: - operationId: miscategorization-create-miscategorization - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/miscategorization' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Create Miscategorization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Miscategorization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Miscategorization - tags: - - Miscategorization - '/accounts/{account_identifier}/intel/dns': - get: - operationId: passive-dns-by-ip-get-passive-dns-by-ip - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/passive-dns-by-ip_components-schemas-single_response' - description: Get Passive DNS by IP response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/passive-dns-by-ip_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Passive DNS by IP response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Passive DNS by IP - tags: - - Passive DNS by IP - '/accounts/{account_identifier}/intel-phishing/predict': - get: - operationId: phishing-url-scanner-scan-suspicious-url - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/phishing_components-schemas-single_response' - description: Scan suspicious url response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/phishing_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Scan suspicious url response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Scan suspicious url - tags: - - Phishing URL Scanner - '/accounts/{account_identifier}/intel/whois': - get: - operationId: whois-record-get-whois-record - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/whois_components-schemas-single_response' - description: Get WHOIS Record response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/whois_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get WHOIS Record response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get WHOIS Record - tags: - - WHOIS Record diff --git a/providers/src/cloudflare/v00.00.00000/services/ip_address_management.yaml b/providers/src/cloudflare/v00.00.00000/services/ip_address_management.yaml deleted file mode 100644 index 49836902..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/ip_address_management.yaml +++ /dev/null @@ -1,1674 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: IP Address Management Address Maps - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - ip_address_management - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - address-maps_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/address-maps' - type: array - address-maps: - properties: - can_delete: - $ref: '#/components/schemas/can_delete' - can_modify_ips: - $ref: '#/components/schemas/can_modify_ips' - created_at: - $ref: '#/components/schemas/timestamp' - default_sni: - $ref: '#/components/schemas/default_sni' - description: - $ref: '#/components/schemas/address-maps_components-schemas-description' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - modified_at: - $ref: '#/components/schemas/timestamp' - type: object - can_delete: - description: 'If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.' - example: true - readOnly: true - type: boolean - can_modify_ips: - description: 'If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.' - example: true - readOnly: true - type: boolean - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - default_sni: - description: 'If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.' - example: '*.example.com' - nullable: true - type: string - address-maps_components-schemas-description: - description: An optional description field which may be used to describe the types of IPs or zones on the map. - example: My Ecommerce zones - nullable: true - type: string - full_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - $ref: '#/components/schemas/address-maps' - - properties: - ips: - $ref: '#/components/schemas/schemas-ips' - memberships: - $ref: '#/components/schemas/memberships' - type: object - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - schemas-ips: - description: The set of IPs on the Address Map. - items: - $ref: '#/components/schemas/address-maps-ip' - type: array - memberships: - description: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership. - items: - $ref: '#/components/schemas/address-maps-membership' - type: array - address-maps-ip: - properties: - created_at: - $ref: '#/components/schemas/created-on' - ip: - $ref: '#/components/schemas/schemas-ip' - type: object - address-maps-membership: - properties: - can_delete: - $ref: '#/components/schemas/schemas-can_delete' - created_at: - $ref: '#/components/schemas/created-on' - identifier: - $ref: '#/components/schemas/common_components-schemas-identifier' - kind: - $ref: '#/components/schemas/components-schemas-kind' - type: object - created-on: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - schemas-ip: - description: An IPv4 or IPv6 address. - example: 192.0.2.1 - type: string - schemas-can_delete: - description: Controls whether the membership can be deleted via the API or not. - example: true - type: boolean - components-schemas-kind: - description: The type of the membership. - enum: - - zone - - account - example: zone - type: string - address-maps_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/address-maps' - ip_address: - description: An IPv4 or IPv6 address. - example: 192.0.2.1 - type: string - advertised_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - advertised: - $ref: '#/components/schemas/schemas-advertised' - advertised_modified_at: - $ref: '#/components/schemas/modified_at_nullable' - type: object - schemas-advertised: - description: Enablement of prefix advertisement to the Internet. - example: true - type: boolean - modified_at_nullable: - description: Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - nullable: true - type: string - ipam-delegations_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/ipam-delegations' - type: array - ipam-delegations: - properties: - cidr: - $ref: '#/components/schemas/cidr' - created_at: - $ref: '#/components/schemas/timestamp' - delegated_account_id: - $ref: '#/components/schemas/delegated_account_identifier' - id: - $ref: '#/components/schemas/delegation_identifier' - modified_at: - $ref: '#/components/schemas/timestamp' - parent_prefix_id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: object - cidr: - description: IP Prefix in Classless Inter-Domain Routing format. - example: 192.0.2.0/24 - type: string - delegated_account_identifier: - description: Account identifier for the account to which prefix is being delegated. - example: b1946ac92492d2347c6235b4d2611184 - maxLength: 32 - readOnly: true - type: string - delegation_identifier: - description: Delegation identifier tag. - example: d933b1530bc56c9953cf8ce166da8004 - maxLength: 32 - readOnly: true - type: string - ipam-delegations_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/ipam-delegations' - ipam-delegations_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/delegation_identifier' - type: object - loa_upload_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - filename: - description: Name of LOA document. - example: document.pdf - type: string - type: object - loa_document_identifier: - description: Identifier for the uploaded LOA document. - example: d933b1530bc56c9953cf8ce166da8004 - maxLength: 32 - nullable: true - readOnly: true - type: string - ipam-prefixes_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/ipam-prefixes' - type: array - ipam-prefixes: - properties: - account_id: - $ref: '#/components/schemas/common_components-schemas-identifier' - advertised: - $ref: '#/components/schemas/advertised' - advertised_modified_at: - $ref: '#/components/schemas/modified_at_nullable' - approved: - $ref: '#/components/schemas/approved' - asn: - $ref: '#/components/schemas/asn' - cidr: - $ref: '#/components/schemas/cidr' - created_at: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/ipam-prefixes_components-schemas-description' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - loa_document_id: - $ref: '#/components/schemas/loa_document_identifier' - modified_at: - $ref: '#/components/schemas/timestamp' - on_demand_enabled: - $ref: '#/components/schemas/on_demand_enabled' - on_demand_locked: - $ref: '#/components/schemas/on_demand_locked' - type: object - advertised: - description: Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled. - example: true - nullable: true - type: boolean - approved: - description: 'Approval state of the prefix (P = pending, V = active).' - example: P - type: string - asn: - description: Autonomous System Number (ASN) the prefix will be advertised under. - nullable: true - type: integer - ipam-prefixes_components-schemas-description: - description: Description of the prefix. - example: Internal test prefix - maxLength: 1000 - type: string - on_demand_enabled: - description: Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. - example: true - type: boolean - on_demand_locked: - description: 'Whether advertisement status of the prefix is locked, meaning it cannot be changed.' - example: false - type: boolean - ipam-prefixes_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/ipam-prefixes' - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_addressing_address_maps_accounts: - id: cloudflare.ip_address_management.accounts_addressing_address_maps_accounts - name: accounts_addressing_address_maps_accounts - title: Accounts Addressing Address Maps Accounts - methods: - address_maps_remove_an_account_membership_from_an_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier1}~1addressing~1address_maps~1{address_map_identifier}~1accounts~1{account_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - address_maps_add_an_account_membership_to_an_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier1}~1addressing~1address_maps~1{address_map_identifier}~1accounts~1{account_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_address_maps_accounts/methods/address_maps_remove_an_account_membership_from_an_address_map' - accounts_addressing_address_maps: - id: cloudflare.ip_address_management.accounts_addressing_address_maps - name: accounts_addressing_address_maps - title: Accounts Addressing Address Maps - methods: - address_maps_list_address_maps: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _address_maps_list_address_maps: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - address_maps_create_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps/post' - response: - mediaType: application/json - openAPIDocKey: '200' - address_maps_delete_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - address_maps_address_map_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _address_maps_address_map_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - address_maps_update_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_address_maps/methods/address_maps_list_address_maps' - - $ref: '#/components/x-stackQL-resources/accounts_addressing_address_maps/methods/address_maps_address_map_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_address_maps/methods/address_maps_create_address_map' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_address_maps/methods/address_maps_delete_address_map' - accounts_addressing_address_maps_ips: - id: cloudflare.ip_address_management.accounts_addressing_address_maps_ips - name: accounts_addressing_address_maps_ips - title: Accounts Addressing Address Maps Ips - methods: - address_maps_remove_an_ip_from_an_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}~1ips~1{ip_address}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - address_maps_add_an_ip_to_an_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}~1ips~1{ip_address}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_address_maps_ips/methods/address_maps_remove_an_ip_from_an_address_map' - accounts_addressing_address_maps_zones: - id: cloudflare.ip_address_management.accounts_addressing_address_maps_zones - name: accounts_addressing_address_maps_zones - title: Accounts Addressing Address Maps Zones - methods: - address_maps_remove_a_zone_membership_from_an_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}~1zones~1{zone_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - address_maps_add_a_zone_membership_to_an_address_map: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1address_maps~1{address_map_identifier}~1zones~1{zone_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_address_maps_zones/methods/address_maps_remove_a_zone_membership_from_an_address_map' - accounts_addressing_prefixes_bgp_status: - id: cloudflare.ip_address_management.accounts_addressing_prefixes_bgp_status - name: accounts_addressing_prefixes_bgp_status - title: Accounts Addressing Prefixes Bgp Status - methods: - dynamic_advertisement_get_advertisement_status: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}~1bgp~1status/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dynamic_advertisement_get_advertisement_status: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}~1bgp~1status/get' - response: - mediaType: application/json - openAPIDocKey: '200' - dynamic_advertisement_update_prefix_dynamic_advertisement_status: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}~1bgp~1status/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_prefixes_bgp_status/methods/dynamic_advertisement_get_advertisement_status' - insert: [] - update: [] - delete: [] - accounts_addressing_prefixes_delegations: - id: cloudflare.ip_address_management.accounts_addressing_prefixes_delegations - name: accounts_addressing_prefixes_delegations - title: Accounts Addressing Prefixes Delegations - methods: - prefix_delegation_list_prefix_delegations: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}~1delegations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _prefix_delegation_list_prefix_delegations: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}~1delegations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - prefix_delegation_create_prefix_delegation: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}~1delegations/post' - response: - mediaType: application/json - openAPIDocKey: '200' - prefix_delegation_delete_prefix_delegation: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}~1delegations~1{delegation_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_prefixes_delegations/methods/prefix_delegation_list_prefix_delegations' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_prefixes_delegations/methods/prefix_delegation_create_prefix_delegation' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_prefixes_delegations/methods/prefix_delegation_delete_prefix_delegation' - accounts_addressing_loa_documents: - id: cloudflare.ip_address_management.accounts_addressing_loa_documents - name: accounts_addressing_loa_documents - title: Accounts Addressing Loa Documents - methods: - prefixes_upload_loa_document: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1loa_documents/post' - response: - mediaType: application/json - openAPIDocKey: '200' - prefixes_download_loa_document: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1loa_documents~1{loa_document_identifier}~1download/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _prefixes_download_loa_document: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1loa_documents~1{loa_document_identifier}~1download/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_addressing_prefixes: - id: cloudflare.ip_address_management.accounts_addressing_prefixes - name: accounts_addressing_prefixes - title: Accounts Addressing Prefixes - methods: - prefixes_list_prefixes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _prefixes_list_prefixes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - prefixes_add_prefix: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes/post' - response: - mediaType: application/json - openAPIDocKey: '200' - prefixes_delete_prefix: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - prefixes_prefix_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _prefixes_prefix_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - prefixes_update_prefix_description: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1addressing~1prefixes~1{prefix_identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_prefixes/methods/prefixes_list_prefixes' - - $ref: '#/components/x-stackQL-resources/accounts_addressing_prefixes/methods/prefixes_prefix_details' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_addressing_prefixes/methods/prefixes_delete_prefix' -paths: - '/accounts/{account_identifier1}/addressing/address_maps/{address_map_identifier}/accounts/{account_identifier}': - delete: - description: Remove an account as a member of a particular address map. - operationId: ip-address-management-address-maps-remove-an-account-membership-from-an-address-map - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier1 - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Remove an account membership from an Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Remove an account membership from an Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Remove an account membership from an Address Map - tags: - - IP Address Management Address Maps - put: - description: Add an account as a member of a particular address map. - operationId: ip-address-management-address-maps-add-an-account-membership-to-an-address-map - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier1 - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Add an account membership to an Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add an account membership to an Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add an account membership to an Address Map - tags: - - IP Address Management Address Maps - '/accounts/{account_identifier}/addressing/address_maps': - get: - description: List all address maps owned by the account. - operationId: ip-address-management-address-maps-list-address-maps - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/address-maps_components-schemas-response_collection' - description: List Address Maps response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/address-maps_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Address Maps response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Address Maps - tags: - - IP Address Management Address Maps - post: - description: Create a new address map under the account. - operationId: ip-address-management-address-maps-create-address-map - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/address-maps_components-schemas-description' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/full_response' - description: Create Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/full_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Address Map - tags: - - IP Address Management Address Maps - '/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}': - delete: - description: Delete a particular address map owned by the account. - operationId: ip-address-management-address-maps-delete-address-map - parameters: - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Delete Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Address Map - tags: - - IP Address Management Address Maps - get: - description: Show a particular address map owned by the account. - operationId: ip-address-management-address-maps-address-map-details - parameters: - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/full_response' - description: Address Map Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/full_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Address Map Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Address Map Details - tags: - - IP Address Management Address Maps - patch: - description: Modify the description or default SNI for an address map owned by the account. - operationId: ip-address-management-address-maps-update-address-map - parameters: - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - default_sni: - $ref: '#/components/schemas/default_sni' - description: - $ref: '#/components/schemas/address-maps_components-schemas-description' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/address-maps_components-schemas-single_response' - description: Update Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/address-maps_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Address Map - tags: - - IP Address Management Address Maps - '/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/ips/{ip_address}': - delete: - description: Remove an IP from a particular address map. - operationId: ip-address-management-address-maps-remove-an-ip-from-an-address-map - parameters: - - in: path - name: ip_address - required: true - schema: - $ref: '#/components/schemas/ip_address' - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Remove an IP from an Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Remove an IP from an Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Remove an IP from an Address Map - tags: - - IP Address Management Address Maps - put: - description: Add an IP from a prefix owned by the account to a particular address map. - operationId: ip-address-management-address-maps-add-an-ip-to-an-address-map - parameters: - - in: path - name: ip_address - required: true - schema: - $ref: '#/components/schemas/ip_address' - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Add an IP to an Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add an IP to an Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add an IP to an Address Map - tags: - - IP Address Management Address Maps - '/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/zones/{zone_identifier}': - delete: - description: Remove a zone as a member of a particular address map. - operationId: ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Remove a zone membership from an Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Remove a zone membership from an Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Remove a zone membership from an Address Map - tags: - - IP Address Management Address Maps - put: - description: Add a zone as a member of a particular address map. - operationId: ip-address-management-address-maps-add-a-zone-membership-to-an-address-map - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: address_map_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Add a zone membership to an Address Map response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add a zone membership to an Address Map response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add a zone membership to an Address Map - tags: - - IP Address Management Address Maps - '/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/bgp/status': - get: - description: List the current advertisement state for a prefix. - operationId: ip-address-management-dynamic-advertisement-get-advertisement-status - parameters: - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/advertised_response' - description: Get Advertisement Status response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/advertised_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Advertisement Status response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Advertisement Status - tags: - - IP Address Management Dynamic Advertisement - patch: - description: Advertise or withdraw BGP route for a prefix. - operationId: ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status - parameters: - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - advertised: - $ref: '#/components/schemas/schemas-advertised' - required: - - advertised - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/advertised_response' - description: Update Prefix Dynamic Advertisement Status response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/advertised_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Prefix Dynamic Advertisement Status response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Prefix Dynamic Advertisement Status - tags: - - IP Address Management Dynamic Advertisement - '/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations': - get: - description: List all delegations for a given account IP prefix. - operationId: ip-address-management-prefix-delegation-list-prefix-delegations - parameters: - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ipam-delegations_components-schemas-response_collection' - description: List Prefix Delegations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ipam-delegations_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Prefix Delegations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Prefix Delegations - tags: - - IP Address Management Prefix Delegation - post: - description: Create a new account delegation for a given IP prefix. - operationId: ip-address-management-prefix-delegation-create-prefix-delegation - parameters: - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - cidr: - $ref: '#/components/schemas/cidr' - delegated_account_id: - $ref: '#/components/schemas/delegated_account_identifier' - required: - - cidr - - delegated_account_id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ipam-delegations_components-schemas-single_response' - description: Create Prefix Delegation response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ipam-delegations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Prefix Delegation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Prefix Delegation - tags: - - IP Address Management Prefix Delegation - '/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations/{delegation_identifier}': - delete: - description: Delete an account delegation for a given IP prefix. - operationId: ip-address-management-prefix-delegation-delete-prefix-delegation - parameters: - - in: path - name: delegation_identifier - required: true - schema: - $ref: '#/components/schemas/delegation_identifier' - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ipam-delegations_components-schemas-id_response' - description: Delete Prefix Delegation response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ipam-delegations_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Prefix Delegation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Prefix Delegation - tags: - - IP Address Management Prefix Delegation - '/accounts/{account_identifier}/addressing/loa_documents': - post: - description: Submit LOA document (pdf format) under the account. - operationId: ip-address-management-prefixes-upload-loa-document - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - multipart/form-data: - schema: - properties: - loa_document: - description: LOA document to upload. - example: '@document.pdf' - type: string - required: - - loa_document - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/loa_upload_response' - description: Upload LOA Document response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/loa_upload_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Upload LOA Document response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Upload LOA Document - tags: - - IP Address Management Prefixes - '/accounts/{account_identifier}/addressing/loa_documents/{loa_document_identifier}/download': - get: - description: Download specified LOA document under the account. - operationId: ip-address-management-prefixes-download-loa-document - parameters: - - in: path - name: loa_document_identifier - required: true - schema: - $ref: '#/components/schemas/loa_document_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: {} - description: Download LOA Document response - 4xx: - content: - application/json: - schema: - allOf: - - {} - - $ref: '#/components/schemas/api-response-common-failure' - description: Download LOA Document response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Download LOA Document - tags: - - IP Address Management Prefixes - '/accounts/{account_identifier}/addressing/prefixes': - get: - description: List all prefixes owned by the account. - operationId: ip-address-management-prefixes-list-prefixes - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ipam-prefixes_components-schemas-response_collection' - description: List Prefixes response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ipam-prefixes_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Prefixes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Prefixes - tags: - - IP Address Management Prefixes - post: - description: Add a prefix under the account. - operationId: ip-address-management-prefixes-add-prefix - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - asn: - $ref: '#/components/schemas/asn' - cidr: - $ref: '#/components/schemas/cidr' - loa_document_id: - $ref: '#/components/schemas/loa_document_identifier' - required: - - cidr - - loa_document_id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response' - description: Add Prefix response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add Prefix response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add Prefix - tags: - - IP Address Management Prefixes - '/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}': - delete: - description: Delete an unapproved prefix owned by the account. - operationId: ip-address-management-prefixes-delete-prefix - parameters: - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Delete Prefix response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Prefix response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Prefix - tags: - - IP Address Management Prefixes - get: - description: List a particular prefix owned by the account. - operationId: ip-address-management-prefixes-prefix-details - parameters: - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response' - description: Prefix Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Prefix Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Prefix Details - tags: - - IP Address Management Prefixes - patch: - description: Modify the description for a prefix owned by the account. - operationId: ip-address-management-prefixes-update-prefix-description - parameters: - - in: path - name: prefix_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/ipam-prefixes_components-schemas-description' - required: - - description - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response' - description: Update Prefix Description response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Prefix Description response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Prefix Description - tags: - - IP Address Management Prefixes diff --git a/providers/src/cloudflare/v00.00.00000/services/ips.yaml b/providers/src/cloudflare/v00.00.00000/services/ips.yaml new file mode 100644 index 00000000..252d2056 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/ips.yaml @@ -0,0 +1,231 @@ +openapi: 3.0.3 +info: + title: ips API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /ips: + get: + description: >- + Get IPs used on the Cloudflare/JD Cloud network, see + https://www.cloudflare.com/ips for Cloudflare IPs or + https://developers.cloudflare.com/china-network/reference/infrastructure/ + for JD Cloud IPs. + operationId: cloudflare-ips-cloudflare-ip-details + parameters: + - description: Specified as `jdcloud` to list IPs used by JD Cloud data centers. + in: query + name: networks + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/publicIpMessages' + messages: + $ref: '#/components/schemas/publicIpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + type: object + properties: + etag: + $ref: '#/components/schemas/publicIpEtag' + ipv4_cidrs: + $ref: '#/components/schemas/publicIpIpv4Cidrs' + ipv6_cidrs: + $ref: '#/components/schemas/publicIpIpv6Cidrs' + jdcloud_cidrs: + $ref: '#/components/schemas/publicIpJdcloudCidrs' + required: + - success + - errors + - messages + description: Cloudflare IP Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/publicIpMessages' + messages: + $ref: '#/components/schemas/publicIpMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + type: object + properties: + etag: + $ref: '#/components/schemas/publicIpEtag' + ipv4_cidrs: + $ref: '#/components/schemas/publicIpIpv4Cidrs' + ipv6_cidrs: + $ref: '#/components/schemas/publicIpIpv6Cidrs' + jdcloud_cidrs: + $ref: '#/components/schemas/publicIpJdcloudCidrs' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Cloudflare IP Details response failure + security: + - {} + summary: Cloudflare/JD Cloud IP Details + tags: + - Cloudflare IPs + x-stackql-sdk: + service: ips + resource_chain: [] + method: list +components: + schemas: + publicIpEtag: + description: A digest of the IP data. Useful for determining if the data has changed. + example: a8e453d9d129a3769407127936edfdb0 + type: string + publicIpIpv4Cidrs: + description: List of Cloudflare IPv4 CIDR addresses. + items: + description: IPv4 CIDR. + example: 199.27.128.0/21 + type: string + type: array + publicIpIpv6Cidrs: + description: List of Cloudflare IPv6 CIDR addresses. + items: + description: IPv6 CIDR. + example: 2400:cb00::/32 + type: string + type: array + publicIpJdcloudCidrs: + description: List IPv4 and IPv6 CIDRs, only populated if `?networks=jdcloud` is used. + items: + description: IPv4 or IPv6 CIDR. + example: 199.27.128.0/21 + type: string + type: array + publicIpMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + ips: + id: cloudflare.ips.ips + name: ips + title: Ips + methods: + list: + operation: + $ref: '#/paths/~1ips/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ips/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/keyless_certificates.yaml b/providers/src/cloudflare/v00.00.00000/services/keyless_certificates.yaml new file mode 100644 index 00000000..3a75d4ca --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/keyless_certificates.yaml @@ -0,0 +1,943 @@ +openapi: 3.0.3 +info: + title: keyless_certificates API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/keyless_certificates: + get: + description: List all Keyless SSL configurations for a given zone. + operationId: keyless-ssl-for-a-zone-list-keyless-ssl-configurations + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessResponseCollection + description: List Keyless SSL Configurations response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessCertificate + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Keyless SSL Configurations response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Keyless SSL Configurations + tags: + - Keyless SSL for a Zone + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: keyless_certificates + resource_chain: [] + method: list + post: + description: >- + Creates a Keyless SSL configuration that allows SSL/TLS termination + without exposing private keys to Cloudflare. Keys remain on your + infrastructure. + operationId: keyless-ssl-for-a-zone-create-keyless-ssl-configuration + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + bundle_method: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBundleMethod' + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificate + host: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHost' + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesNameWrite' + port: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPort' + tunnel: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessTunnel + required: + - host + - port + - certificate + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessResponseSingle + description: Create Keyless SSL Configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefA91f0bd72ee433f010eecfdc94ccf298 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Keyless SSL Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Keyless SSL Configuration + tags: + - Keyless SSL for a Zone + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: keyless_certificates + resource_chain: [] + method: create + /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}: + delete: + description: >- + Removes a Keyless SSL configuration. SSL connections will no longer use + the keyless server for cryptographic operations. + operationId: keyless-ssl-for-a-zone-delete-keyless-ssl-configuration + parameters: + - in: path + name: keyless_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessResponseSingleId + description: Delete Keyless SSL Configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/identifier' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Keyless SSL Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Keyless SSL Configuration + tags: + - Keyless SSL for a Zone + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: keyless_certificates + resource_chain: [] + method: delete + get: + description: Get details for one Keyless SSL configuration. + operationId: keyless-ssl-for-a-zone-get-keyless-ssl-configuration + parameters: + - in: path + name: keyless_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessResponseSingle + description: Get Keyless SSL Configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefA91f0bd72ee433f010eecfdc94ccf298 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Keyless SSL Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Keyless SSL Configuration + tags: + - Keyless SSL for a Zone + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - 'Zero Trust: PII Read' + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + - 'Access: Apps and Policies Revoke' + - 'Access: Mutual TLS Certificates Write' + - 'Access: Organizations, Identity Providers, and Groups Write' + - Zone Settings Write + - Zone Settings Read + - Zone Read + - DNS Read + - Workers Scripts Write + - Workers Scripts Read + - Zone Write + - Workers Routes Write + - Workers Routes Read + - Stream Write + - Stream Read + - SSL and Certificates Write + - SSL and Certificates Read + - Logs Write + - Logs Read + - Cache Purge + - Page Rules Write + - Page Rules Read + - Load Balancers Write + - Load Balancers Read + - Firewall Services Write + - Firewall Services Read + - DNS Write + - Apps Write + - Analytics Read + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: keyless_certificates + resource_chain: [] + method: get + patch: + description: >- + This will update attributes of a Keyless SSL. Consists of one or more of + the following: host,name,port. + operationId: keyless-ssl-for-a-zone-edit-keyless-ssl-configuration + parameters: + - in: path + name: keyless_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + enabled: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesEnabledWrite' + host: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHost' + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesNameWrite' + port: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPort' + tunnel: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessTunnel + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesKeylessResponseSingle + description: Edit Keyless SSL Configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefA91f0bd72ee433f010eecfdc94ccf298 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit Keyless SSL Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Keyless SSL Configuration + tags: + - Keyless SSL for a Zone + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: keyless_certificates + resource_chain: [] + method: edit +components: + schemas: + identifier: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + enum: + - null + tlsCertificatesAndHostnamesBase: + properties: + created_on: + description: When the Keyless SSL was created. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + enabled: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesEnabled' + host: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHost' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasIdentifier' + modified_on: + description: When the Keyless SSL was last modified. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesName' + permissions: + description: >- + Available permissions for the Keyless SSL for the current user + requesting the item. + example: + - '#ssl:read' + - '#ssl:edit' + items: + type: string + x-auditable: true + readOnly: true + type: array + port: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPort' + status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasStatus' + tunnel: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessTunnel' + required: + - id + - name + - host + - port + - status + - enabled + - permissions + - created_on + - modified_on + type: object + tlsCertificatesAndHostnamesBundleMethod: + $ref: '#/components/schemas/unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1' + tlsCertificatesAndHostnamesEnabled: + description: Whether or not the Keyless SSL is on or off. + example: false + readOnly: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesEnabledWrite: + deprecated: true + description: Whether or not the Keyless SSL is on or off. + example: false + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesHost: + description: The keyless SSL name. + example: example.com + format: hostname + maxLength: 253 + type: string + x-auditable: true + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesKeylessCertificate: + type: object + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBase' + tlsCertificatesAndHostnamesKeylessPrivateIp: + description: Private IP of the Key Server Host + example: 10.0.0.1 + type: string + x-auditable: true + tlsCertificatesAndHostnamesKeylessResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessCertificate' + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesKeylessResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBase' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesKeylessResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesKeylessTunnel: + description: Configuration for using Keyless SSL through a Cloudflare Tunnel + properties: + private_ip: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessPrivateIp' + vnet_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessVnetId' + required: + - private_ip + - vnet_id + type: object + tlsCertificatesAndHostnamesKeylessVnetId: + description: Cloudflare Tunnel Virtual Network ID + example: 7365377a-85a4-4390-9480-531ef7dc7a3c + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesName: + description: The keyless SSL name. + example: example.com Keyless SSL + maxLength: 180 + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesNameWrite: + description: The keyless SSL name. + example: example.com Keyless SSL + maxLength: 180 + type: string + x-auditable: true + tlsCertificatesAndHostnamesPort: + default: 24008 + description: >- + The keyless SSL port used to communicate between Cloudflare and the + client's Keyless SSL server. + example: 24008 + maxLength: 65535 + type: number + x-auditable: true + tlsCertificatesAndHostnamesSchemasCertificate: + description: The zone's SSL certificate or SSL certificate and intermediate(s). + example: |- + -----BEGIN CERTIFICATE----- + MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV + BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX + aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF + MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 + ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB + CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ + LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N + nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO + fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 + 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ + qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ + sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV + RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV + BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF + MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 + UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt + vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 + uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs + ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 + /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= + -----END CERTIFICATE----- + type: string + tlsCertificatesAndHostnamesSchemasIdentifier: + description: Keyless certificate identifier tag. + example: 4d2844d2ce78891c34d0b6c0535a291e + maxLength: 32 + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasStatus: + description: Status of the Keyless SSL. + enum: + - active + - deleted + example: active + readOnly: true + type: string + x-auditable: true + unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1: + default: ubiquitous + description: >- + A ubiquitous bundle has the highest probability of being verified + everywhere, even by clients using outdated or unusual trust stores. An + optimal bundle uses the shortest chain and newest intermediates. And the + force bundle verifies the chain, but does not otherwise modify it. + enum: + - ubiquitous + - optimal + - force + example: ubiquitous + type: string + x-auditable: true + unnamedSchemaRefA91f0bd72ee433f010eecfdc94ccf298: + type: object + properties: + created_on: + description: When the Keyless SSL was created. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + enabled: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesEnabled' + host: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHost' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasIdentifier' + modified_on: + description: When the Keyless SSL was last modified. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesName' + permissions: + description: >- + Available permissions for the Keyless SSL for the current user + requesting the item. + example: + - '#ssl:read' + - '#ssl:edit' + items: + type: string + x-auditable: true + readOnly: true + type: array + port: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPort' + status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasStatus' + tunnel: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesKeylessTunnel' + required: + - id + - name + - host + - port + - status + - enabled + - permissions + - created_on + - modified_on + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + keyless_certificates: + id: cloudflare.keyless_certificates.keyless_certificates + name: keyless_certificates + title: Keyless Certificates + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1keyless_certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1keyless_certificates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1keyless_certificates~1{keyless_certificate_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1keyless_certificates~1{keyless_certificate_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1keyless_certificates~1{keyless_certificate_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keyless_certificates/methods/get' + - $ref: '#/components/x-stackQL-resources/keyless_certificates/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/keyless_certificates/methods/create + update: + - $ref: '#/components/x-stackQL-resources/keyless_certificates/methods/edit' + delete: + - $ref: >- + #/components/x-stackQL-resources/keyless_certificates/methods/delete + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/kv.yaml b/providers/src/cloudflare/v00.00.00000/services/kv.yaml new file mode 100644 index 00000000..2f84179c --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/kv.yaml @@ -0,0 +1,1429 @@ +openapi: 3.0.3 +info: + title: kv API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/storage/kv/namespaces: + get: + description: Returns the namespaces owned by an account. + operationId: workers-kv-namespace-list-namespaces + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of results per page. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: order + schema: + description: Field to order results by. + enum: + - id + - title + type: string + - in: query + name: direction + schema: + description: Direction to order namespaces. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/workersKvResultInfo' + result: + items: + $ref: '#/components/schemas/workersKvNamespace' + type: array + required: + - success + - errors + - messages + description: List Namespaces response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: List Namespaces response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Namespaces + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + - Workers KV Storage Read + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + method: list + post: + description: Creates a namespace under the given title. A `400` is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced. + operationId: workers-kv-namespace-create-a-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvCreateRenameNamespaceBody' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersKvNamespace' + required: + - success + - errors + - messages + type: object + description: Create a Namespace response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Create a Namespace response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Namespace + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + method: create + /accounts/{account_id}/storage/kv/namespaces/{namespace_id}: + delete: + description: Deletes the namespace corresponding to the given ID. + operationId: workers-kv-namespace-remove-a-namespace + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonNoResult' + description: Remove a Namespace response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Remove a Namespace response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Remove a Namespace + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + method: delete + get: + description: Get the namespace corresponding to the given ID. + operationId: workers-kv-namespace-get-a-namespace + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersKvNamespace' + required: + - success + - errors + - messages + type: object + description: Get a Namespace response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Get a Namespace response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Namespace + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + - Workers KV Storage Read + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + method: get + put: + description: Modifies a namespace's title. + operationId: workers-kv-namespace-rename-a-namespace + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvCreateRenameNamespaceBody' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersKvNamespace' + required: + - success + - errors + - messages + - result + type: object + description: Rename a Namespace response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Rename a Namespace response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Rename a Namespace + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + method: update + /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk: + delete: + deprecated: true + description: Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed. + operationId: workers-kv-namespace-delete-multiple-key-value-pairs-deprecated + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + $ref: '#/components/schemas/workersKvBulkResult' + required: + - success + - errors + - messages + type: object + description: Delete multiple key-value pairs response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + $ref: '#/components/schemas/workersKvBulkResult' + required: + - success + - errors + - messages + type: object + description: Delete multiple key-value pairs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete multiple key-value pairs + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + put: + description: Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less. + operationId: workers-kv-namespace-write-multiple-key-value-pairs + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvBulkWrite' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + $ref: '#/components/schemas/workersKvBulkResult' + required: + - success + - errors + - messages + type: object + description: Write multiple key-value pairs response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + $ref: '#/components/schemas/workersKvBulkResult' + required: + - success + - errors + - messages + type: object + description: Write multiple key-value pairs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Write multiple key-value pairs + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - keys + method: bulk_update + /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete: + post: + description: Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed. + operationId: workers-kv-namespace-delete-multiple-key-value-pairs + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvBulkDelete' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + $ref: '#/components/schemas/workersKvBulkResult' + required: + - success + - errors + - messages + type: object + description: Delete multiple key-value pairs response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + $ref: '#/components/schemas/workersKvBulkResult' + required: + - success + - errors + - messages + type: object + description: Delete multiple key-value pairs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete multiple key-value pairs + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - keys + method: bulk_delete + /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/get: + post: + description: Retrieve up to 100 KV pairs from the namespace. Keys must contain text-based values. JSON values can optionally be parsed instead of being returned as a string value. Metadata can be included if `withMetadata` is true. + operationId: workers-kv-namespace-get-multiple-key-value-pairs + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + keys: + description: Array of keys to retrieve (maximum of 100). + items: + $ref: '#/components/schemas/workersKvKeyNameBulk' + maxItems: 100 + type: array + type: + default: text + description: Whether to parse JSON values in the response. + enum: + - text + - json + type: string + withMetadata: + default: false + description: Whether to include metadata in the response. + type: boolean + required: + - keys + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + properties: + values: + description: Requested keys are paired with their values in an object. + type: object + required: + - success + - errors + - messages + type: object + description: Get multiple key-value pairs response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Get multiple key-value pairs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get multiple key-value pairs + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + - Workers KV Storage Read + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - keys + method: bulk_get + /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys: + get: + description: Lists a namespace's keys. + operationId: workers-kv-namespace-list-a-namespace'-s-keys + parameters: + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: limit + schema: + default: 1000 + description: Limits the number of keys returned in the response. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit. + maximum: 1000 + minimum: 10 + type: number + - in: query + name: prefix + schema: + description: Filters returned keys by a name prefix. Exact matches and any key names that begin with the prefix will be returned. + type: string + - in: query + name: cursor + schema: + description: Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the `cursors` object in the `result_info` structure. + type: string + x-stainless-pagination-property: + purpose: next_cursor_param + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/workersKvKey' + type: array + x-stainless-pagination-property: + purpose: items + result_info: + $ref: '#/components/schemas/workersKvCursorResultInfo' + required: + - success + - errors + - messages + type: object + description: List a Namespace's Keys response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: List a Namespace's Keys response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List a Namespace's Keys + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + - Workers KV Storage Read + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - keys + method: list + /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}: + get: + description: Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. + operationId: workers-kv-namespace-read-the-metadata-for-a-key + parameters: + - in: path + name: key_name + schema: + $ref: '#/components/schemas/workersKvKeyName' + required: true + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersKvListMetadata' + required: + - success + - errors + - messages + type: object + description: Read the metadata for a key response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Read the metadata for a key response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read the metadata for a key + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + - Workers KV Storage Read + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - metadata + method: get + /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}: + delete: + description: Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. + operationId: workers-kv-namespace-delete-key-value-pair + parameters: + - in: path + name: key_name + schema: + $ref: '#/components/schemas/workersKvKeyName' + required: true + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonNoResult' + description: Delete key-value pair response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Delete key-value pair response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete key-value pair + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - values + method: delete + get: + description: Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the `expiration` response header. + operationId: workers-kv-namespace-read-key-value-pair + parameters: + - in: path + name: key_name + schema: + $ref: '#/components/schemas/workersKvKeyName' + required: true + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/octet-stream: + schema: + type: object + properties: + contents: + type: string + description: Read key-value pair response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Read key-value pair response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read key-value pair + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + - Workers KV Storage Read + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - values + method: get + put: + description: Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. Body should be the value to be stored. If JSON metadata to be associated with the key/value pair is needed, use `multipart/form-data` content type for your PUT request (see dropdown below in `REQUEST BODY SCHEMA`). Existing values, expirations, and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. + operationId: workers-kv-namespace-write-key-value-pair-with-metadata + parameters: + - in: path + name: key_name + schema: + $ref: '#/components/schemas/workersKvKeyName' + required: true + - name: namespace_id + in: path + required: true + description: The Workers KV namespace ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: expiration + schema: + $ref: '#/components/schemas/workersKvExpiration' + - in: query + name: expiration_ttl + schema: + $ref: '#/components/schemas/workersKvExpirationTtl' + requestBody: + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/workersKvValue' + x-stainless-only: + - http + multipart/form-data: + encoding: + metadata: + contentType: application/json + schema: + properties: + metadata: + $ref: '#/components/schemas/workersKvMetadata' + value: + $ref: '#/components/schemas/workersKvValue' + required: + - value + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonNoResult' + description: Write key-value pair with metadata response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersKvApiResponseCommonFailure' + description: Write key-value pair with metadata response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Write key-value pair with optional metadata + tags: + - Workers KV Namespace + x-api-token-group: + - Workers KV Storage Write + x-stackql-sdk: + service: kv + resource_chain: + - namespaces + - values + method: update +components: + schemas: + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + workersKvAny: + type: unknown + workersKvApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/workersKvMessages' + messages: + example: [] + $ref: '#/components/schemas/workersKvMessages' + result: + nullable: true + type: object + x-stainless-empty-object: true + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + workersKvApiResponseCommonNoResult: + properties: + errors: + $ref: '#/components/schemas/workersKvMessages' + messages: + $ref: '#/components/schemas/workersKvMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + type: object + x-stainless-empty-object: true + required: + - success + - errors + - messages + type: object + workersKvBulkDelete: + items: + $ref: '#/components/schemas/workersKvKeyNameBulk' + type: array + workersKvBulkResult: + properties: + successful_key_count: + description: Number of keys successfully updated. + example: 100 + type: number + unsuccessful_keys: + description: Name of the keys that failed to be fully updated. They should be retried. + items: + type: string + type: array + type: object + workersKvBulkWrite: + items: + properties: + base64: + default: false + description: Indicates whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images. + type: boolean + expiration: + $ref: '#/components/schemas/workersKvExpiration' + expiration_ttl: + $ref: '#/components/schemas/workersKvExpirationTtl' + key: + $ref: '#/components/schemas/workersKvKeyNameBulk' + metadata: + $ref: '#/components/schemas/workersKvListMetadata' + value: + description: A UTF-8 encoded string to be stored, up to 25 MiB in length. + example: Some string + maxLength: 26214400 + type: string + required: + - key + - value + type: object + type: array + workersKvCreateRenameNamespaceBody: + properties: + title: + $ref: '#/components/schemas/workersKvNamespaceTitle' + required: + - title + type: object + workersKvCursor: + description: Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure. + example: 6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw + type: string + x-stainless-pagination-property: + purpose: next_cursor_field + workersKvCursorResultInfo: + properties: + count: + description: Total results returned based on your list parameters. + example: 1 + type: number + cursor: + $ref: '#/components/schemas/workersKvCursor' + type: object + workersKvExpiration: + description: Expires the key at a certain time, measured in number of seconds since the UNIX epoch. + example: 1578435000 + type: number + workersKvExpirationTtl: + description: Expires the key after a number of seconds. Must be at least 60. + example: 300 + minimum: 60 + type: number + workersKvKey: + description: A name for a value. A value stored under a given key may be retrieved via the same key. + properties: + expiration: + description: The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire. + example: 1577836800 + type: number + metadata: + $ref: '#/components/schemas/workersKvListMetadata' + name: + $ref: '#/components/schemas/workersKvKeyName' + required: + - name + type: object + workersKvKeyName: + description: A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL. + example: My-Key + maxLength: 512 + type: string + workersKvKeyNameBulk: + description: A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. + example: My-Key + maxLength: 512 + type: string + workersKvListMetadata: + $ref: '#/components/schemas/workersKvAny' + description: Arbitrary JSON that is associated with a key. + workersKvMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + uniqueItems: true + workersKvMetadata: + $ref: '#/components/schemas/workersKvAny' + description: Associates arbitrary JSON data with a key/value pair. + workersKvNamespace: + properties: + id: + $ref: '#/components/schemas/workersKvNamespaceIdentifier' + supports_url_encoding: + description: True if keys written on the URL will be URL-decoded before storing. For example, if set to "true", a key written on the URL as "%3F" will be stored as "?". + example: true + readOnly: true + type: boolean + x-auditable: true + title: + $ref: '#/components/schemas/workersKvNamespaceTitle' + required: + - id + - title + type: object + workersKvNamespaceIdentifier: + description: Namespace identifier tag. + example: 0f2ac74b498b48028cb68387c421e279 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + workersKvNamespaceTitle: + description: A human-readable string name for a Namespace. + example: My Own Namespace + maxLength: 512 + type: string + x-auditable: true + workersKvResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + workersKvValue: + description: A byte sequence to be stored, up to 25 MiB in length. + example: Some Value + type: string + format: binary + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + namespaces: + id: cloudflare.kv.namespaces + name: namespaces + title: Namespaces + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/get' + - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/update' + keys: + id: cloudflare.kv.keys + name: keys + title: Keys + methods: + bulk: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1bulk/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1bulk/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_delete: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1bulk~1delete/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1bulk~1get/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/keys/methods/bulk_update' + key_metadata: + id: cloudflare.kv.key_metadata + name: key_metadata + title: Key Metadata + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1metadata~1{key_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/key_metadata/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + values: + id: cloudflare.kv.values + name: values + title: Values + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1values~1{key_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1values~1{key_name}/get' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1storage~1kv~1namespaces~1{namespace_id}~1values~1{key_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/values/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/values/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/values/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/leaked_credential_checks.yaml b/providers/src/cloudflare/v00.00.00000/services/leaked_credential_checks.yaml new file mode 100644 index 00000000..cd75979c --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/leaked_credential_checks.yaml @@ -0,0 +1,866 @@ +openapi: 3.0.3 +info: + title: leaked_credential_checks API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/leaked-credential-checks: + get: + description: Retrieves the current status of Leaked Credential Checks. + operationId: waf-product-api-leaked-credentials-get-status + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleResponseStatus' + description: Get Leaked Credential Checks status response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + description: Defines the overall status for Leaked Credential Checks. + properties: + enabled: + description: >- + Determines whether or not Leaked Credential Checks are + enabled. + type: boolean + x-auditable: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Leaked Credential Checks status failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Leaked Credential Checks Status + tags: + - Leaked Credential Checks + x-api-token-group: + - Zone WAF Write + - Zone WAF Read + - Account WAF Write + - Account WAF Read + x-stackql-sdk: + service: leaked_credential_checks + resource_chain: [] + method: get + post: + description: Updates the current status of Leaked Credential Checks. + operationId: waf-product-api-leaked-credentials-set-status + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleStatus' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleResponseStatus' + description: Set Leaked Credential Checks status response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + description: Defines the overall status for Leaked Credential Checks. + properties: + enabled: + description: >- + Determines whether or not Leaked Credential Checks are + enabled. + type: boolean + x-auditable: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set Leaked Credential Checks status failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set Leaked Credential Checks Status + tags: + - Leaked Credential Checks + x-api-token-group: + - Zone WAF Write + - Account WAF Write + x-stackql-sdk: + service: leaked_credential_checks + resource_chain: [] + method: create + /zones/{zone_id}/leaked-credential-checks/detections: + get: + description: List user-defined detection patterns for Leaked Credential Checks. + operationId: waf-product-api-leaked-credentials-list-detections + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleResponseCustomDetectionCollection + description: List Leaked Credential Checks custom detections response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + items: + type: object + $ref: '#/components/schemas/wafProductApiBundleCustomDetection' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Leaked Credential Checks custom detections failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Leaked Credential Checks Custom Detections + tags: + - Leaked Credential Checks + x-api-token-group: + - Zone WAF Write + - Zone WAF Read + - Account WAF Write + - Account WAF Read + x-stackql-sdk: + service: leaked_credential_checks + resource_chain: + - detections + method: list + post: + description: Create user-defined detection pattern for Leaked Credential Checks. + operationId: waf-product-api-leaked-credentials-create-detection + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleCustomDetection' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleResponseCustomDetection + description: Create Leaked Credential Checks custom detection response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + description: >- + Defines a custom set of username/password expressions to + match Leaked Credential Checks on. + properties: + id: + $ref: '#/components/schemas/wafProductApiBundleDetectionId' + password: + description: >- + Defines ehe ruleset expression to use in matching the + password in a request. + type: string + x-auditable: true + username: + description: >- + Defines the ruleset expression to use in matching the + username in a request. + type: string + x-auditable: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Leaked Credential Checks custom detection failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Leaked Credential Checks Custom Detection + tags: + - Leaked Credential Checks + x-api-token-group: + - Zone WAF Write + - Account WAF Write + x-stackql-sdk: + service: leaked_credential_checks + resource_chain: + - detections + method: create + /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}: + delete: + description: Remove user-defined detection pattern for Leaked Credential Checks. + operationId: waf-product-api-leaked-credentials-delete-detection + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: detection_id + schema: + $ref: '#/components/schemas/wafProductApiBundleDetectionId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleApiResponseCommon' + description: Delete Leaked Credential Checks custom detection response. + 4XX: + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleApiResponseCommonFailure + description: Delete Leaked Credential Checks custom detection failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Leaked Credential Checks Custom Detection + tags: + - Leaked Credential Checks + x-api-token-group: + - Zone WAF Write + - Account WAF Write + x-stackql-sdk: + service: leaked_credential_checks + resource_chain: + - detections + method: delete + get: + description: Get user-defined detection pattern for Leaked Credential Checks. + operationId: waf-product-api-leaked-credentials-get-detection + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: detection_id + schema: + $ref: '#/components/schemas/wafProductApiBundleDetectionId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleResponseCustomDetection + description: Get Leaked Credential Checks custom detection response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + description: >- + Defines a custom set of username/password expressions to + match Leaked Credential Checks on. + properties: + id: + $ref: '#/components/schemas/wafProductApiBundleDetectionId' + password: + description: >- + Defines ehe ruleset expression to use in matching the + password in a request. + type: string + x-auditable: true + username: + description: >- + Defines the ruleset expression to use in matching the + username in a request. + type: string + x-auditable: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Leaked Credential Checks custom detection failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Leaked Credential Checks Custom Detection + tags: + - Leaked Credential Checks + x-api-token-group: + - Zone WAF Write + - Zone WAF Read + - Account WAF Write + - Account WAF Read + x-stackql-sdk: + service: leaked_credential_checks + resource_chain: + - detections + method: get + put: + description: Update user-defined detection pattern for Leaked Credential Checks. + operationId: waf-product-api-leaked-credentials-update-detection + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: detection_id + schema: + $ref: '#/components/schemas/wafProductApiBundleDetectionId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/wafProductApiBundleCustomDetection' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/wafProductApiBundleResponseCustomDetection + description: Update Leaked Credential Checks custom detection response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + description: >- + Defines a custom set of username/password expressions to + match Leaked Credential Checks on. + properties: + id: + $ref: '#/components/schemas/wafProductApiBundleDetectionId' + password: + description: >- + Defines ehe ruleset expression to use in matching the + password in a request. + type: string + x-auditable: true + username: + description: >- + Defines the ruleset expression to use in matching the + username in a request. + type: string + x-auditable: true + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Leaked Credential Checks custom detection failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Leaked Credential Checks Custom Detection + tags: + - Leaked Credential Checks + x-api-token-group: + - Zone WAF Write + - Account WAF Write + x-stackql-sdk: + service: leaked_credential_checks + resource_chain: + - detections + method: update +components: + schemas: + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + wafProductApiBundleApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: {} + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + wafProductApiBundleApiResponseCommonFailure: + properties: + errors: + example: + - code: 10100 + message: Unknown error occured, please try again + minLength: 1 + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + example: [] + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Defines whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + wafProductApiBundleCustomDetection: + description: >- + Defines a custom set of username/password expressions to match Leaked + Credential Checks on. + properties: + id: + $ref: '#/components/schemas/wafProductApiBundleDetectionId' + password: + description: >- + Defines ehe ruleset expression to use in matching the password in a + request. + example: lookup_json_string(http.request.body.raw, "secret") + type: string + x-auditable: true + username: + description: >- + Defines the ruleset expression to use in matching the username in a + request. + example: lookup_json_string(http.request.body.raw, "user") + type: string + x-auditable: true + type: object + wafProductApiBundleDetectionId: + description: Defines the unique ID for this custom detection. + example: 18a14bafaa8eb1df04ce683ec18c765e + x-auditable: true + $ref: '#/components/schemas/wafProductApiBundleIdentifier' + wafProductApiBundleIdentifier: + description: Defines an identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + wafProductApiBundleMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + wafProductApiBundleResponseCustomDetection: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + $ref: '#/components/schemas/wafProductApiBundleCustomDetection' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + wafProductApiBundleResponseCustomDetectionCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + items: + type: object + $ref: '#/components/schemas/wafProductApiBundleCustomDetection' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + wafProductApiBundleResponseStatus: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + $ref: '#/components/schemas/wafProductApiBundleStatus' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + wafProductApiBundleStatus: + description: Defines the overall status for Leaked Credential Checks. + properties: + enabled: + description: Determines whether or not Leaked Credential Checks are enabled. + example: true + type: boolean + x-auditable: true + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + leaked_credential_checks: + id: cloudflare.leaked_credential_checks.leaked_credential_checks + name: leaked_credential_checks + title: Leaked Credential Checks + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1leaked-credential-checks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1leaked-credential-checks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/leaked_credential_checks/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/leaked_credential_checks/methods/create + update: [] + delete: [] + replace: [] + detections: + id: cloudflare.leaked_credential_checks.detections + name: detections + title: Detections + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1leaked-credential-checks~1detections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1leaked-credential-checks~1detections/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1leaked-credential-checks~1detections~1{detection_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1leaked-credential-checks~1detections~1{detection_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1leaked-credential-checks~1detections~1{detection_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/detections/methods/get' + - $ref: '#/components/x-stackQL-resources/detections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/detections/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/detections/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/detections/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/lists.yaml b/providers/src/cloudflare/v00.00.00000/services/lists.yaml deleted file mode 100644 index fb9c9f33..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/lists.yaml +++ /dev/null @@ -1,1062 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Lists - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - lists - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - lists-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - allOf: - - $ref: '#/components/schemas/list' - - required: - - id - - name - - kind - - num_items - - created_on - - modified_on - type: object - type: array - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - list: - properties: - created_on: - $ref: '#/components/schemas/components-schemas-created_on' - description: - $ref: '#/components/schemas/lists_components-schemas-description' - id: - $ref: '#/components/schemas/list_id' - kind: - $ref: '#/components/schemas/kind' - modified_on: - $ref: '#/components/schemas/lists_components-schemas-modified_on' - name: - $ref: '#/components/schemas/lists_components-schemas-name' - num_items: - $ref: '#/components/schemas/num_items' - num_referencing_filters: - $ref: '#/components/schemas/num_referencing_filters' - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - components-schemas-created_on: - description: The RFC 3339 timestamp of when the list was created. - example: '2020-01-01T08:00:00Z' - type: string - lists_components-schemas-description: - description: An informative summary of the list. - example: This is a note. - maxLength: 500 - type: string - list_id: - description: The unique ID of the list. - example: 2c0fc9fa937b11eaa1b71c4d701ab86e - maxLength: 32 - minLength: 32 - readOnly: true - type: string - kind: - description: The type of the list. Each type supports specific list items (IP addresses or redirects). - enum: - - ip - - redirect - example: ip - type: string - lists_components-schemas-modified_on: - description: The RFC 3339 timestamp of when the list was last modified. - example: '2020-01-10T14:00:00Z' - type: string - lists_components-schemas-name: - description: An informative name for the list. Use this name in filter and rule expressions. - example: list1 - maxLength: 50 - pattern: '^[a-zA-Z0-9_]+$' - type: string - num_items: - description: The number of items in the list. - example: 10 - type: number - num_referencing_filters: - description: 'The number of [filters](#filters) referencing the list.' - example: 2 - type: number - list-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/list' - type: object - schemas-operation_id: - description: The unique operation ID of the asynchronous action. - example: 4da8780eeb215e6cb7f48dd981c4ea02 - readOnly: true - type: string - bulk-operation-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/schemas-operation' - type: object - schemas-operation: - properties: - completed: - description: The RFC 3339 timestamp of when the operation was completed. - example: '2020-01-01T08:00:00Z' - readOnly: true - type: string - error: - description: A message describing the error when the status is `failed`. - example: This list is at the maximum number of items - readOnly: true - type: string - id: - $ref: '#/components/schemas/schemas-operation_id' - status: - description: The current status of the asynchronous operation. - enum: - - pending - - running - - completed - - failed - example: failed - readOnly: true - type: string - required: - - id - - status - type: object - list-delete-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/item_id' - type: object - type: object - item_id: - description: The unique ID of the item in the List. - example: 34b12448945f11eaa1b71c4d701ab86e - type: string - lists-async-response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - properties: - operation_id: - $ref: '#/components/schemas/schemas-operation_id' - type: object - type: object - items-list-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/items' - result_info: - properties: - cursors: - properties: - after: - example: yyy - type: string - before: - example: xxx - type: string - type: object - type: object - type: object - items: - items: - $ref: '#/components/schemas/item' - type: array - item: - example: - comment: Private IP address - created_on: '2020-01-01T08:00:00Z' - id: 2c0fc9fa937b11eaa1b71c4d701ab86e - ip: 10.0.0.1 - modified_on: '2020-01-10T14:00:00Z' - oneOf: - - required: - - ip - - required: - - redirect - properties: - comment: - $ref: '#/components/schemas/item_comment' - created_on: - description: The RFC 3339 timestamp of when the item was created. - example: '2020-01-01T08:00:00Z' - readOnly: true - type: string - id: - $ref: '#/components/schemas/list_id' - ip: - $ref: '#/components/schemas/item_ip' - modified_on: - description: The RFC 3339 timestamp of when the item was last modified. - example: '2020-01-10T14:00:00Z' - readOnly: true - type: string - redirect: - $ref: '#/components/schemas/item_redirect' - type: object - item_comment: - description: An informative summary of the list item. - example: Private IP address - type: string - item_ip: - description: 'An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.' - example: 10.0.0.1 - type: string - item_redirect: - description: The definition of the redirect. - properties: - include_subdomains: - default: false - type: boolean - preserve_path_suffix: - default: true - type: boolean - preserve_query_string: - default: false - type: boolean - source_url: - example: example.com/arch - type: string - status_code: - default: 301 - enum: - - 301 - - 302 - - 307 - - 308 - type: integer - subpath_matching: - default: false - type: boolean - target_url: - example: 'https://archlinux.org/' - type: string - required: - - source_url - - target_url - type: object - items-update-request-collection: - items: - allOf: - - oneOf: - - required: - - ip - - required: - - redirect - properties: - comment: - $ref: '#/components/schemas/item_comment' - ip: - $ref: '#/components/schemas/item_ip' - redirect: - $ref: '#/components/schemas/item_redirect' - type: object - type: array - item-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/item' - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_rules: - id: cloudflare.lists.accounts_rules - name: accounts_rules - title: Accounts Rules - methods: - get_lists: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_lists: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create_a_list: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_a_list: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get_a_list: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_a_list: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_a_list: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_rules/methods/get_lists' - - $ref: '#/components/x-stackQL-resources/accounts_rules/methods/get_a_list' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_rules/methods/create_a_list' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_rules/methods/delete_a_list' - accounts_rules_bulk_operations: - id: cloudflare.lists.accounts_rules_bulk_operations - name: accounts_rules_bulk_operations - title: Accounts Rules Bulk Operations - methods: - get_bulk_operation_status: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1bulk_operations~1{operation_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_bulk_operation_status: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1bulk_operations~1{operation_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_rules_bulk_operations/methods/get_bulk_operation_status' - insert: [] - update: [] - delete: [] - accounts_rules_items: - id: cloudflare.lists.accounts_rules_items - name: accounts_rules_items - title: Accounts Rules Items - methods: - delete_list_items: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}~1items/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get_list_items: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}~1items/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_list_items: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}~1items/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create_list_items: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}~1items/post' - response: - mediaType: application/json - openAPIDocKey: '200' - update_all_list_items: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}~1items/put' - response: - mediaType: application/json - openAPIDocKey: '200' - get_a_list_item: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}~1items~1{item_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_a_list_item: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1rules~1lists~1{list_id}~1items~1{item_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_rules_items/methods/get_list_items' - - $ref: '#/components/x-stackQL-resources/accounts_rules_items/methods/get_a_list_item' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_rules_items/methods/create_list_items' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_rules_items/methods/delete_list_items' -paths: - '/accounts/{account_identifier}/rules/lists': - get: - description: Fetches all lists in the account. - operationId: lists-get-lists - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists-response-collection' - description: Get lists response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get lists response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get lists - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Creates a new list of the specified type. - operationId: lists-create-a-list - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/lists_components-schemas-description' - kind: - $ref: '#/components/schemas/kind' - name: - $ref: '#/components/schemas/lists_components-schemas-name' - required: - - name - - kind - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/list-response-collection' - description: Create a list response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/list-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a list response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a list - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}': - get: - description: |- - Gets the current status of an asynchronous operation on a list. - - The `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error. - operationId: lists-get-bulk-operation-status - parameters: - - in: path - name: operation_id - required: true - schema: - $ref: '#/components/schemas/schemas-operation_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/bulk-operation-response-collection' - description: Get bulk operation status response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/bulk-operation-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get bulk operation status response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get bulk operation status - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/rules/lists/{list_id}': - delete: - description: Deletes a specific list and all its items. - operationId: lists-delete-a-list - parameters: - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/list-delete-response-collection' - description: Delete a list response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/list-delete-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a list response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a list - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the details of a list. - operationId: lists-get-a-list - parameters: - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/list-response-collection' - description: Get a list response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/list-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a list response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a list - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates the description of a list. - operationId: lists-update-a-list - parameters: - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/lists_components-schemas-description' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/list-response-collection' - description: Update a list response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/list-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a list response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a list - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/rules/lists/{list_id}/items': - delete: - description: |- - Removes one or more items from a list. - - This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`. - operationId: lists-delete-list-items - parameters: - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - items: - items: - properties: - id: - $ref: '#/components/schemas/item_id' - minItems: 1 - type: array - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists-async-response' - description: Delete list items response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists-async-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete list items response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete list items - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches all the items in the list. - operationId: lists-get-list-items - parameters: - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/items-list-response-collection' - description: Get list items response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/items-list-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get list items response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get list items - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: |- - Appends new items to the list. - - This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`. - operationId: lists-create-list-items - parameters: - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/items-update-request-collection' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists-async-response' - description: Create list items response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists-async-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create list items response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create list items - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: |- - Removes all existing items from the list and adds the provided items to the list. - - This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`. - operationId: lists-update-all-list-items - parameters: - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/items-update-request-collection' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists-async-response' - description: Update all list items response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists-async-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update all list items response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update all list items - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}': - get: - description: Fetches a list item in the list. - operationId: lists-get-a-list-item - parameters: - - in: path - name: item_id - required: true - schema: - $ref: '#/components/schemas/item_id' - - in: path - name: list_id - required: true - schema: - $ref: '#/components/schemas/list_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/item-response-collection' - description: Get a list item response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/item-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a list item response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a list item - tags: - - Lists - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true diff --git a/providers/src/cloudflare/v00.00.00000/services/load_balancers.yaml b/providers/src/cloudflare/v00.00.00000/services/load_balancers.yaml index d7723804..9a67c0f8 100644 --- a/providers/src/cloudflare/v00.00.00000/services/load_balancers.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/load_balancers.yaml @@ -1,2888 +1,2828 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Account Load Balancer Monitors - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - load_balancers + title: load_balancers API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - monitor_components-schemas-response_collection-2: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-monitor' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - components-schemas-monitor: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - consecutive_down: - $ref: '#/components/schemas/consecutive_down' - consecutive_up: - $ref: '#/components/schemas/consecutive_up' - created_on: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/schemas-expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - id: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - modified_on: - $ref: '#/components/schemas/timestamp' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/monitor_components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/load_balancers/monitor_groups: + get: + description: List configured monitor groups. + operationId: account-load-balancer-monitor-groups-list-monitor-groups + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - allow_insecure: - default: false - description: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. - example: true - type: boolean - consecutive_down: - default: 0 - description: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. - type: integer - consecutive_up: - default: 0 - description: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. - type: integer - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - monitor_components-schemas-description: - description: Object description. - example: Login page monitor - type: string - expected_body: - description: 'A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.' - example: alive - type: string - schemas-expected_codes: - default: '200' - description: 'The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.' - example: 2xx - type: string - follow_redirects: - default: false - description: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. - example: true - type: boolean - header: - description: The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors. - example: - Host: - - example.com - X-App-ID: - - abc123 - type: object - monitor_components-schemas-identifier: - example: f1aba936b94213e5b8dca0c0dbf1f9cc - interval: - default: 60 - description: 'The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.' - type: integer - schemas-method: - default: GET - description: The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks. - example: GET - type: string - path: - default: / - description: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. - example: /health - type: string - monitor_components-schemas-port: - default: 0 - description: 'The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).' - type: integer - probe_zone: - description: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. - example: example.com - type: string - retries: - default: 2 - description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. - type: integer - schemas-timeout: - default: 5 - description: The timeout (in seconds) before marking the health check as failed. - type: integer - monitor_components-schemas-type: - default: http - description: 'The protocol to use for the health check. Currently supported protocols are ''HTTP'',''HTTPS'', ''TCP'', ''ICMP-PING'', ''UDP-ICMP'', and ''SMTP''.' - enum: - - http - - https - - tcp - - udp_icmp - - icmp_ping - - smtp - example: https - type: string - monitor_components-schemas-single_response-2: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/components-schemas-monitor' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - monitor_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - type: object - preview_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - pools: - additionalProperties: true - example: - abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter - ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter - type: object - x-patternProperties: - '^[a-z0-9]{32}$': - type: string - preview_id: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - type: object - references_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - description: List of resources that reference a given monitor. - example: - - reference_type: referrer - resource_id: 17b5962d775c646f3f9725cbc7a53df4 - resource_name: primary-dc-1 - resource_type: pool - items: + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/loadBalancingMonitorGroupResponseCollection + description: List Monitor Groups response + 4XX: + content: + application/json: + schema: properties: - reference_type: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/loadBalancingMonitorGroup' + type: array enum: - - '*' - - referral - - referrer - type: string - resource_id: - type: string - resource_name: - type: string - resource_type: - type: string + - null + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result type: object - type: array - schemas-preview_id: - example: p1aba936b94213e5b8dca0c0dbf1f9cc - preview_result_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/preview_result' - preview_result: - additionalProperties: true - description: Resulting health data from a preview operation. - example: - abwlnp5jbqn45ecgxd03erbgtxtqai0d: - healthy: true - origins: - - originone.example.com.: - $ref: '#/components/schemas/origin_health_data/example' - type: object - pool_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/pool' - type: array - pool: - properties: - check_regions: - $ref: '#/components/schemas/check_regions' - created_on: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/pool_components-schemas-description' - disabled_at: - $ref: '#/components/schemas/schemas-disabled_at' - enabled: - $ref: '#/components/schemas/pool_components-schemas-enabled' - id: - $ref: '#/components/schemas/pool_components-schemas-identifier' - latitude: - $ref: '#/components/schemas/latitude' - load_shedding: - $ref: '#/components/schemas/load_shedding' - longitude: - $ref: '#/components/schemas/longitude' - minimum_origins: - $ref: '#/components/schemas/minimum_origins' - modified_on: - $ref: '#/components/schemas/timestamp' - monitor: - $ref: '#/components/schemas/schemas-monitor' - name: - $ref: '#/components/schemas/pool_components-schemas-name' - notification_email: - $ref: '#/components/schemas/notification_email' - notification_filter: - $ref: '#/components/schemas/notification_filter' - origin_steering: - $ref: '#/components/schemas/origin_steering' - origins: - $ref: '#/components/schemas/origins' - type: object - check_regions: - description: A list of regions from which to run health checks. Null means every Cloudflare data center. - example: - - WEU - - ENAM - items: - description: 'WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).' - enum: - - WNAM - - ENAM - - WEU - - EEU - - NSAM - - SSAM - - OC - - ME - - NAF - - SAF - - SAS - - SEAS - - NEAS - - ALL_REGIONS - type: string - nullable: true - type: array - pool_components-schemas-description: - description: A human-readable description of the pool. - example: Primary data center - Provider XYZ - type: string - schemas-disabled_at: - description: This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - format: date-time - readOnly: true - type: string - pool_components-schemas-enabled: - default: true - description: Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - example: false - type: boolean - pool_components-schemas-identifier: - example: 17b5962d775c646f3f9725cbc7a53df4 - latitude: - description: 'The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.' - type: number - load_shedding: - description: Configures load shedding policies and percentages for the pool. - properties: - default_percent: - default: 0 - description: 'The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.' - maximum: 100 - minimum: 0 - type: number - default_policy: - default: random - description: The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - enum: - - random - - hash - type: string - session_percent: - default: 0 - description: 'The percent of existing sessions to shed from the pool, according to the session policy.' - maximum: 100 - minimum: 0 - type: number - session_policy: - default: hash - description: Only the hash policy is supported for existing sessions (to avoid exponential decay). - enum: - - hash - type: string - type: object - longitude: - description: 'The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.' - type: number - minimum_origins: - default: 1 - description: 'The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.' - type: integer - schemas-monitor: - description: The ID of the Monitor to use for checking the health of origins within this pool. - pool_components-schemas-name: - description: 'A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.' - example: primary-dc-1 - type: string - notification_email: - description: The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - example: 'someone@example.com,sometwo@example.com' - type: string - notification_filter: - description: Filter pool and origin health notifications by resource type or health status. Use null to reset. - example: - origin: - disable: true - pool: - healthy: false - nullable: true - properties: - origin: - $ref: '#/components/schemas/filter_options' - pool: - $ref: '#/components/schemas/filter_options' - type: object - origin_steering: - description: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - properties: - policy: - default: random - description: 'The type of origin steering policy to use, either "random" or "hash" (based on CF-Connecting-IP).' - enum: - - random - - hash - type: string - type: object - origins: - description: 'The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.' - items: - $ref: '#/components/schemas/schemas-origin' - type: array - filter_options: - description: Filter options for a particular resource type (pool or origin). Use null to reset. - nullable: true - properties: - disable: - default: false - description: 'If set true, disable notifications for this type of resource (pool or origin).' - type: boolean - healthy: - description: 'If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).' - nullable: true - type: boolean - type: object - schemas-origin: - properties: - address: - $ref: '#/components/schemas/address' - disabled_at: - $ref: '#/components/schemas/disabled_at' - enabled: - $ref: '#/components/schemas/origin_components-schemas-enabled' - header: - $ref: '#/components/schemas/schemas-header' - name: - $ref: '#/components/schemas/origin_components-schemas-name' - weight: - $ref: '#/components/schemas/weight' - type: object - address: - description: 'The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare.' - example: 0.0.0.0 - type: string - disabled_at: - description: This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - format: date-time - readOnly: true - type: string - origin_components-schemas-enabled: - default: true - description: Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - example: true - type: boolean - schemas-header: - description: The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - properties: - Host: - $ref: '#/components/schemas/Host' - type: object - origin_components-schemas-name: - description: A human-identifiable name for the origin. - example: app-server-1 - type: string - weight: - default: 1 - description: The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - example: 0.6 - maximum: 1 - minimum: 0 - multipleOf: 0.01 - type: number - Host: - description: The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - items: - example: example.com - type: string - type: array - patch_pools_notification_email: - description: 'The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `""` is accepted.' - enum: - - '""' - example: '' - type: string - pool_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/pool' - pool_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/pool_components-schemas-identifier' - type: object - health_details: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - description: A list of regions from which to run health checks. Null means every Cloudflare data center. - example: - pool_id: 17b5962d775c646f3f9725cbc7a53df4 - pop_health: - 'Amsterdam, NL': - healthy: true - origins: - - '2001:DB8::5': - failure_reason: No failures - healthy: true - response_code: 401 - rtt: 12.1ms - type: object - schemas-references_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - description: List of resources that reference a given pool. - example: - - reference_type: referrer - resource_id: 699d98642c564d2e855e9661899b7252 - resource_name: www.example.com - resource_type: load_balancer - - reference_type: referral - resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc - resource_name: Login page monitor - resource_type: monitor - items: + description: List Monitor Groups response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Monitor Groups + tags: + - Account Load Balancer Monitor Groups + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitor_groups + method: list + post: + description: Create a new monitor group. + operationId: account-load-balancer-monitor-groups-create-monitor-group + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroupSingleResponse' + description: Create Monitor Group response + '412': + content: + application/json: + schema: properties: - reference_type: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object enum: - - '*' - - referral - - referrer - type: string - resource_id: - type: string - resource_name: - type: string - resource_type: - type: string + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result type: object - type: array - search_result: - properties: - result: - $ref: '#/components/schemas/search' - type: object - search: - properties: - resources: - description: A list of resources matching the search query. - items: - $ref: '#/components/schemas/resource_reference' - type: array - type: object - resource_reference: - description: A reference to a load balancer resource. - properties: - reference_type: - description: 'When listed as a reference, the type (direction) of the reference.' - enum: - - referral - - referrer - type: string - references: - description: A list of references to (referrer) or from (referral) this resource. - example: - - reference_type: referrer - resource_id: 699d98642c564d2e855e9661899b7252 - resource_name: www.example.com - resource_type: load_balancer - - reference_type: referral - resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc - resource_name: Login page monitor - resource_type: monitor - items: - description: A reference to a load balancer resource. - type: object - type: array - resource_id: - example: 17b5962d775c646f3f9725cbc7a53df4 - resource_name: - description: The human-identifiable name of the resource. - example: primary-dc-1 - type: string - resource_type: - description: The type of the resource. - enum: - - load_balancer - - monitor - - pool - example: pool - type: string - type: object - analytics_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/analytics' - type: array - analytics: - properties: - id: - default: 1 - type: integer - origins: - example: - - address: 198.51.100.4 - changed: true - enabled: true - failure_reason: No failures - healthy: true - ip: 198.51.100.4 - name: some-origin - items: {} - type: array - pool: - example: - changed: true - healthy: true - id: 74bc6a8b9b0dda3d651707a2928bad0c - minimum_origins: 1 - name: some-pool - type: object - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - type: string - type: object - monitor_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/monitor' - type: array - monitor: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - created_on: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - id: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - modified_on: - $ref: '#/components/schemas/timestamp' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/components-schemas-port' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - type: object - expected_codes: - default: '200' - description: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. - example: 2xx - type: string - components-schemas-port: - default: 0 - description: 'Port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).' - type: integer - monitor_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/monitor' - preview_id: - example: f1aba936b94213e5b8dca0c0dbf1f9cc - region_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - region_code: - description: 'A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).' - enum: - - WNAM - - ENAM - - WEU - - EEU - - NSAM - - SSAM - - OC - - ME - - NAF - - SAF - - SAS - - SEAS - - NEAS - example: WNAM - type: string - region_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - description: A list of countries and subdivisions mapped to a region. - example: - iso_standard: Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2 - regions: - - countries: - - country_code_a2: CA - country_name: Canada - country_subdivisions: - - subdivision_code_a2: AB - subdivision_name: Alberta - - subdivision_code_a2: BC - subdivision_name: British Columbia - - country_code_a2: HT - country_name: Haiti - - country_code_a2: MX - country_name: Mexico - - country_code_a2: US - country_name: United States - country_subdivisions: - - subdivision_code_a2: AZ - subdivision_name: Arizona - - subdivision_code_a2: CA - subdivision_name: California - - subdivision_code_a2: CO - subdivision_name: Colorado - - subdivision_code_a2: HI - subdivision_name: Hawaii - - subdivision_code_a2: MN - subdivision_name: Minnesota - - subdivision_code_a2: MO - subdivision_name: Missouri - - subdivision_code_a2: NV - subdivision_name: Nevada - - subdivision_code_a2: OR - subdivision_name: Oregon - - subdivision_code_a2: TX - subdivision_name: Texas - - subdivision_code_a2: UT - subdivision_name: Utah - - subdivision_code_a2: WA - subdivision_name: Washington - region_code: WNAM - type: object - load-balancer_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - load-balancer_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - type: object - load-balancer_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/load-balancer' - load-balancer: - properties: - adaptive_routing: - $ref: '#/components/schemas/adaptive_routing' - country_pools: - $ref: '#/components/schemas/country_pools' - created_on: - $ref: '#/components/schemas/timestamp' - default_pools: - $ref: '#/components/schemas/default_pools' - description: - $ref: '#/components/schemas/load-balancer_components-schemas-description' - enabled: - $ref: '#/components/schemas/load-balancer_components-schemas-enabled' - fallback_pool: - $ref: '#/components/schemas/fallback_pool' - id: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - location_strategy: - $ref: '#/components/schemas/location_strategy' - modified_on: - $ref: '#/components/schemas/timestamp' - name: - $ref: '#/components/schemas/load-balancer_components-schemas-name' - pop_pools: - $ref: '#/components/schemas/pop_pools' - proxied: - $ref: '#/components/schemas/schemas-proxied' - random_steering: - $ref: '#/components/schemas/random_steering' - region_pools: - $ref: '#/components/schemas/region_pools' - rules: - $ref: '#/components/schemas/load-balancer_components-schemas-rules' - session_affinity: - $ref: '#/components/schemas/session_affinity' - session_affinity_attributes: - $ref: '#/components/schemas/session_affinity_attributes' - session_affinity_ttl: - $ref: '#/components/schemas/session_affinity_ttl' - steering_policy: - $ref: '#/components/schemas/steering_policy' - ttl: - $ref: '#/components/schemas/schemas-ttl' - type: object - adaptive_routing: - description: 'Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.' - properties: - failover_across_pools: - default: false - description: 'Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.' - example: true - type: boolean - type: object - country_pools: - description: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools. - example: - GB: - - abd90f38ced07c2e2f4df50b1f61d4194 - US: - - de90f38ced07c2e2f4df50b1f61d4194 - - 00920f38ce07c2e2f4df50b1f61d4194 - type: object - default_pools: - description: 'A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.' - example: - - 17b5962d775c646f3f9725cbc7a53df4 - - 9290f38c5d07c2e2f4df57b1f61d4196 - - 00920f38ce07c2e2f4df50b1f61d4194 - items: - description: A pool ID. - type: string - type: array - load-balancer_components-schemas-description: - description: Object description. - example: Load Balancer for www.example.com - type: string - load-balancer_components-schemas-enabled: - default: true - description: Whether to enable (the default) this load balancer. - example: true - type: boolean - fallback_pool: - description: The pool ID to use when all other pools are detected as unhealthy. - location_strategy: - description: Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. - properties: - mode: - default: pop - description: |- - Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful. - - `"pop"`: Use the Cloudflare PoP location. - - `"resolver_ip"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location. - enum: - - pop - - resolver_ip - example: resolver_ip - type: string - prefer_ecs: - default: proximity - description: |- - Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location. - - `"always"`: Always prefer ECS. - - `"never"`: Never prefer ECS. - - `"proximity"`: Prefer ECS only when `steering_policy="proximity"`. - - `"geo"`: Prefer ECS only when `steering_policy="geo"`. - enum: - - always - - never - - proximity - - geo - example: always - type: string - type: object - load-balancer_components-schemas-name: - description: 'The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare''s DNS, the Load Balancer will take precedence and the DNS record will not be used.' - example: www.example.com - type: string - pop_pools: - description: '(Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.' - example: - LAX: - - de90f38ced07c2e2f4df50b1f61d4194 - - 9290f38c5d07c2e2f4df57b1f61d4196 - LHR: - - abd90f38ced07c2e2f4df50b1f61d4194 - - f9138c5d07c2e2f4df57b1f61d4196 - SJC: - - 00920f38ce07c2e2f4df50b1f61d4194 - type: object - schemas-proxied: - default: false - description: Whether the hostname should be gray clouded (false) or orange clouded (true). - example: true - type: boolean - random_steering: - description: 'Configures pool weights for random steering. When steering_policy is ''random'', a random pool is selected with probability proportional to these pool weights.' - properties: - default_weight: - default: 1 - description: The default weight for pools in the load balancer that are not specified in the pool_weights map. - example: 0.2 - maximum: 1 - minimum: 0 - multipleOf: 0.1 - type: number - pool_weights: - description: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer. - example: - 9290f38c5d07c2e2f4df57b1f61d4196: 0.5 - de90f38ced07c2e2f4df50b1f61d4194: 0.3 - type: object - type: object - region_pools: - description: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. - example: - ENAM: - - 00920f38ce07c2e2f4df50b1f61d4194 - WNAM: - - de90f38ced07c2e2f4df50b1f61d4194 - - 9290f38c5d07c2e2f4df57b1f61d4196 - type: object - load-balancer_components-schemas-rules: - description: 'BETA Field Not General Access: A list of rules for this load balancer to execute.' - items: - additionalProperties: false - description: A rule object containing conditions and overrides for this load balancer to evaluate. - properties: - condition: - description: 'The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.' - example: http.request.uri.path contains "/testing" + description: Precondition Failed - Referenced monitor does not exist + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create Monitor Group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Monitor Group + tags: + - Account Load Balancer Monitor Groups + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitor_groups + method: create + /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}: + delete: + description: Delete a configured monitor group. + operationId: account-load-balancer-monitor-groups-delete-monitor-group + parameters: + - in: path + name: monitor_group_id + schema: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - disabled: - default: false - description: Disable this specific rule. It will no longer be evaluated by this load balancer. - type: boolean - fixed_response: - description: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates. - properties: - content_type: - description: The http 'Content-Type' header to include in the response. - example: application/json - maxLength: 32 - type: string - location: - description: The http 'Location' header to include in the response. - example: www.example.com - maxLength: 2048 - type: string - message_body: - description: Text to include as the http body. - example: Testing Hello - maxLength: 1024 - type: string - status_code: - description: The http status code to respond with. - type: integer - type: object - name: - description: Name of this rule. Only used for human readability. - example: route the path /testing to testing datacenter. - maxLength: 200 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroupSingleResponse' + description: Delete Monitor Group response + '412': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Precondition Failed - Monitor group is in use by one or more pools + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete Monitor Group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Monitor Group + tags: + - Account Load Balancer Monitor Groups + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitor_groups + method: delete + get: + description: Fetch a single configured monitor group. + operationId: account-load-balancer-monitor-groups-monitor-group-details + parameters: + - in: path + name: monitor_group_id + schema: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - overrides: - description: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional. - properties: - adaptive_routing: - $ref: '#/components/schemas/adaptive_routing' - country_pools: - $ref: '#/components/schemas/country_pools' - default_pools: - $ref: '#/components/schemas/default_pools' - fallback_pool: - $ref: '#/components/schemas/fallback_pool' - location_strategy: - $ref: '#/components/schemas/location_strategy' - pop_pools: - $ref: '#/components/schemas/pop_pools' - random_steering: - $ref: '#/components/schemas/random_steering' - region_pools: - $ref: '#/components/schemas/region_pools' - session_affinity: - $ref: '#/components/schemas/session_affinity' - session_affinity_attributes: - $ref: '#/components/schemas/session_affinity_attributes' - session_affinity_ttl: - $ref: '#/components/schemas/session_affinity_ttl' - steering_policy: - $ref: '#/components/schemas/steering_policy' - ttl: - $ref: '#/components/schemas/schemas-ttl' - type: object - priority: - default: 0 - description: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority. - type: integer - terminates: - default: false - description: 'If this rule''s condition is true, this causes rule evaluation to stop after processing this rule.' - type: boolean - type: object - type: array - session_affinity: - default: '""' - description: 'The session_affinity specifies the type of session affinity the load balancer should use unless specified as "none" or ""(default). The supported types are "cookie" and "ip_cookie". "cookie" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. "ip_cookie" behaves the same as "cookie" except the initial origin selection is stable and based on the client’s ip address.' - enum: - - none - - cookie - - ip_cookie - - '""' - example: cookie - type: string - session_affinity_attributes: - description: Configures cookie attributes for session affinity cookie. - properties: - drain_duration: - description: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer. - example: 100 - type: number - samesite: - default: Auto - description: 'Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".' - enum: - - Auto - - Lax - - None - - Strict - example: Auto - type: string - secure: - default: Auto - description: 'Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.' - enum: - - Auto - - Always - - Never - example: Auto - type: string - zero_downtime_failover: - default: none - description: 'Configures the zero-downtime failover between origins within a pool when session affinity is enabled. Value "none" means no failover takes place for sessions pinned to the origin (default). Value "temporary" means traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. Value "sticky" means the session affinity cookie is updated and subsequent requests are sent to the new origin. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance.' - enum: - - none - - temporary - - sticky - example: sticky - type: string - type: object - session_affinity_ttl: - description: 'Time, in seconds, until this load balancer''s session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.' - example: 5000 - type: number - steering_policy: - default: '""' - description: |- - Steering Policy for this load balancer. - - `"off"`: Use `default_pools`. - - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`. - - `"random"`: Select a pool randomly. - - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks). - - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests. - - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`. - enum: - - 'off' - - geo - - random - - dynamic_latency - - proximity - - '""' - example: dynamic_latency - type: string - schemas-ttl: - description: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. - example: 30 - type: number - load-balancer_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/load-balancer' - type: array - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_monitors: - id: cloudflare.load_balancers.accounts_monitors - name: accounts_monitors - title: Accounts Monitors - methods: - account_load_balancer_monitors_list_monitors: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_monitors_list_monitors: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_monitors_create_monitor: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors/post' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_monitors_delete_monitor: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_monitors_monitor_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_monitors_monitor_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_monitors_patch_monitor: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_monitors_update_monitor: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_monitors_preview_monitor: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}~1preview/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_monitors/methods/account_load_balancer_monitors_list_monitors' - - $ref: '#/components/x-stackQL-resources/accounts_monitors/methods/account_load_balancer_monitors_monitor_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_monitors/methods/account_load_balancer_monitors_create_monitor' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_monitors/methods/account_load_balancer_monitors_delete_monitor' - accounts_monitors_references: - id: cloudflare.load_balancers.accounts_monitors_references - name: accounts_monitors_references - title: Accounts Monitors References - methods: - account_load_balancer_monitors_list_monitor_references: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_monitors_list_monitor_references: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1monitors~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_monitors_references/methods/account_load_balancer_monitors_list_monitor_references' - insert: [] - update: [] - delete: [] - accounts_preview: - id: cloudflare.load_balancers.accounts_preview - name: accounts_preview - title: Accounts Preview - methods: - account_load_balancer_monitors_preview_result: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1preview~1{preview_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_monitors_preview_result: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1preview~1{preview_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_pools: - id: cloudflare.load_balancers.accounts_pools - name: accounts_pools - title: Accounts Pools - methods: - account_load_balancer_pools_list_pools: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_pools_list_pools: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_pools_patch_pools: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_pools_create_pool: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools/post' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_pools_delete_pool: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_pools_pool_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_pools_pool_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_pools_patch_pool: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_pools_update_pool: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - account_load_balancer_pools_preview_pool: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}~1preview/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_pools/methods/account_load_balancer_pools_list_pools' - - $ref: '#/components/x-stackQL-resources/accounts_pools/methods/account_load_balancer_pools_pool_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_pools/methods/account_load_balancer_pools_create_pool' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_pools/methods/account_load_balancer_pools_delete_pool' - accounts_pools_health: - id: cloudflare.load_balancers.accounts_pools_health - name: accounts_pools_health - title: Accounts Pools Health - methods: - account_load_balancer_pools_pool_health_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}~1health/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_load_balancer_pools_pool_health_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}~1health/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_pools_health/methods/account_load_balancer_pools_pool_health_details' - insert: [] - update: [] - delete: [] - accounts_pools_references: - id: cloudflare.load_balancers.accounts_pools_references - name: accounts_pools_references - title: Accounts Pools References - methods: - account_load_balancer_pools_list_pool_references: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_pools_list_pool_references: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1pools~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_pools_references/methods/account_load_balancer_pools_list_pool_references' - insert: [] - update: [] - delete: [] - accounts_search: - id: cloudflare.load_balancers.accounts_search - name: accounts_search - title: Accounts Search - methods: - account_load_balancer_search_search_resources: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_load_balancer_search_search_resources: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - user_load_balancing_analytics_events: - id: cloudflare.load_balancers.user_load_balancing_analytics_events - name: user_load_balancing_analytics_events - title: User Load Balancing Analytics Events - methods: - load_balancer_healthcheck_events_list_healthcheck_events: - operation: - $ref: '#/paths/~1user~1load_balancing_analytics~1events/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_healthcheck_events_list_healthcheck_events: - operation: - $ref: '#/paths/~1user~1load_balancing_analytics~1events/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_load_balancing_analytics_events/methods/load_balancer_healthcheck_events_list_healthcheck_events' - insert: [] - update: [] - delete: [] - user_monitors: - id: cloudflare.load_balancers.user_monitors - name: user_monitors - title: User Monitors - methods: - load_balancer_monitors_list_monitors: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_monitors_list_monitors: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors/get' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_monitors_create_monitor: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors/post' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_monitors_delete_monitor: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_monitors_monitor_details: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_monitors_monitor_details: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_monitors_patch_monitor: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_monitors_update_monitor: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_monitors_preview_monitor: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}~1preview/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_monitors/methods/load_balancer_monitors_list_monitors' - - $ref: '#/components/x-stackQL-resources/user_monitors/methods/load_balancer_monitors_monitor_details' - insert: - - $ref: '#/components/x-stackQL-resources/user_monitors/methods/load_balancer_monitors_create_monitor' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/user_monitors/methods/load_balancer_monitors_delete_monitor' - user_monitors_references: - id: cloudflare.load_balancers.user_monitors_references - name: user_monitors_references - title: User Monitors References - methods: - load_balancer_monitors_list_monitor_references: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_monitors_list_monitor_references: - operation: - $ref: '#/paths/~1user~1load_balancers~1monitors~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_monitors_references/methods/load_balancer_monitors_list_monitor_references' - insert: [] - update: [] - delete: [] - user_preview: - id: cloudflare.load_balancers.user_preview - name: user_preview - title: User Preview - methods: - load_balancer_monitors_preview_result: - operation: - $ref: '#/paths/~1user~1load_balancers~1preview~1{preview_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_monitors_preview_result: - operation: - $ref: '#/paths/~1user~1load_balancers~1preview~1{preview_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - user_pools: - id: cloudflare.load_balancers.user_pools - name: user_pools - title: User Pools - methods: - load_balancer_pools_list_pools: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_pools_list_pools: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools/get' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_pools_patch_pools: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_pools_create_pool: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools/post' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_pools_delete_pool: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_pools_pool_details: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_pools_pool_details: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_pools_patch_pool: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_pools_update_pool: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_pools_preview_pool: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}~1preview/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_pools/methods/load_balancer_pools_list_pools' - - $ref: '#/components/x-stackQL-resources/user_pools/methods/load_balancer_pools_pool_details' - insert: - - $ref: '#/components/x-stackQL-resources/user_pools/methods/load_balancer_pools_create_pool' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/user_pools/methods/load_balancer_pools_delete_pool' - user_pools_health: - id: cloudflare.load_balancers.user_pools_health - name: user_pools_health - title: User Pools Health - methods: - load_balancer_pools_pool_health_details: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}~1health/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _load_balancer_pools_pool_health_details: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}~1health/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_pools_health/methods/load_balancer_pools_pool_health_details' - insert: [] - update: [] - delete: [] - user_pools_references: - id: cloudflare.load_balancers.user_pools_references - name: user_pools_references - title: User Pools References - methods: - load_balancer_pools_list_pool_references: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_pools_list_pool_references: - operation: - $ref: '#/paths/~1user~1load_balancers~1pools~1{identifier}~1references/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_pools_references/methods/load_balancer_pools_list_pool_references' - insert: [] - update: [] - delete: [] - accounts_regions: - id: cloudflare.load_balancers.accounts_regions - name: accounts_regions - title: Accounts Regions - methods: - load_balancer_regions_list_regions: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1regions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _load_balancer_regions_list_regions: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1regions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_regions_get_region: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1regions~1{region_code}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _load_balancer_regions_get_region: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1load_balancers~1regions~1{region_code}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_regions/methods/load_balancer_regions_list_regions' - - $ref: '#/components/x-stackQL-resources/accounts_regions/methods/load_balancer_regions_get_region' - insert: [] - update: [] - delete: [] - zones: - id: cloudflare.load_balancers.zones - name: zones - title: Zones - methods: - delete_load_balancer: - operation: - $ref: '#/paths/~1zones~1{identifier1}~1load_balancers~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - load_balancer_details: - operation: - $ref: '#/paths/~1zones~1{identifier1}~1load_balancers~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _load_balancer_details: - operation: - $ref: '#/paths/~1zones~1{identifier1}~1load_balancers~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - patch_load_balancer: - operation: - $ref: '#/paths/~1zones~1{identifier1}~1load_balancers~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - update_load_balancer: - operation: - $ref: '#/paths/~1zones~1{identifier1}~1load_balancers~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - list_load_balancers: - operation: - $ref: '#/paths/~1zones~1{identifier}~1load_balancers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_load_balancers: - operation: - $ref: '#/paths/~1zones~1{identifier}~1load_balancers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create_load_balancer: - operation: - $ref: '#/paths/~1zones~1{identifier}~1load_balancers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones/methods/load_balancer_details' - - $ref: '#/components/x-stackQL-resources/zones/methods/list_load_balancers' - insert: - - $ref: '#/components/x-stackQL-resources/zones/methods/create_load_balancer' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones/methods/delete_load_balancer' -paths: - '/accounts/{account_identifier}/load_balancers/monitors': + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroupSingleResponse' + description: Monitor Group Details response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Monitor Group Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Monitor Group Details + tags: + - Account Load Balancer Monitor Groups + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitor_groups + method: get + patch: + description: >- + Apply changes to an existing monitor group, overwriting the supplied + properties. + operationId: account-load-balancer-monitor-groups-patch-monitor-group + parameters: + - in: path + name: monitor_group_id + schema: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroupSingleResponse' + description: Patch Monitor Group response + '412': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Precondition Failed - Referenced monitor does not exist + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Patch Monitor Group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Monitor Group + tags: + - Account Load Balancer Monitor Groups + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitor_groups + method: edit + put: + description: Modify a configured monitor group. + operationId: account-load-balancer-monitor-groups-update-monitor-group + parameters: + - in: path + name: monitor_group_id + schema: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorGroupSingleResponse' + description: Update Monitor Group response + '412': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Precondition Failed - Referenced monitor does not exist + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + description: The timestamp of when the monitor group was created + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: >- + The timestamp of when the monitor group was last + updated + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update Monitor Group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Monitor Group + tags: + - Account Load Balancer Monitor Groups + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitor_groups + method: update + /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}/references: get: - description: List configured monitors for an account. - operationId: account-load-balancer-monitors-list-monitors + description: Get the list of resources that reference the provided monitor group. + operationId: account-load-balancer-monitor-groups-list-monitor-group-references parameters: - in: path - name: account_identifier + name: monitor_group_id + schema: + $ref: '#/components/schemas/loadBalancingIdentifier' required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-response_collection-2' - description: List Monitors response - 4xx: + $ref: >- + #/components/schemas/loadBalancingMonitorGroupReferencesResponse + description: List Monitor Group References response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-response_collection-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Monitors response failure + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: List of resources that reference a given monitor group. + items: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + type: array + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List Monitor Group References response failure. security: + - api_token: [] - api_email: [] api_key: [] + summary: List Monitor Group References + tags: + - Account Load Balancer Monitor Groups + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitor_groups + - references + method: get + /accounts/{account_id}/load_balancers/monitors: + get: + description: List configured monitors for an account. + operationId: account-load-balancer-monitors-list-monitors + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorResponseCollection' + description: List Monitors response. + 4XX: + content: + application/json: + schema: + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingMonitor' + type: array + enum: + - null + description: List Monitors response failure. + security: - api_token: [] + - api_email: [] + api_key: [] summary: List Monitors tags: - Account Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + method: list post: description: Create a configured monitor. operationId: account-load-balancer-monitors-create-monitor parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - consecutive_down: - $ref: '#/components/schemas/consecutive_down' - consecutive_up: - $ref: '#/components/schemas/consecutive_up' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/schemas-expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/monitor_components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - description: Create Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Create Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Monitor tags: - Account Load Balancer Monitors - '/accounts/{account_identifier}/load_balancers/monitors/{identifier}': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + method: create + /accounts/{account_id}/load_balancers/monitors/{monitor_id}: delete: description: Delete a configured monitor. operationId: account-load-balancer-monitors-delete-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-id_response' - description: Delete Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingIdResponse' + description: Delete Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Monitor tags: - Account Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + method: delete get: description: List a single configured monitor for an account. operationId: account-load-balancer-monitors-monitor-details parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - description: Monitor Details response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Monitor Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Monitor Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Monitor Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Monitor Details tags: - Account Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + method: get patch: - description: 'Apply changes to an existing monitor, overwriting the supplied properties.' + description: >- + Apply changes to an existing monitor, overwriting the supplied + properties. operationId: account-load-balancer-monitors-patch-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - consecutive_down: - $ref: '#/components/schemas/consecutive_down' - consecutive_up: - $ref: '#/components/schemas/consecutive_up' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/schemas-expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/monitor_components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - description: Patch Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Patch Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Monitor tags: - Account Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + method: edit put: description: Modify a configured monitor. operationId: account-load-balancer-monitors-update-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - consecutive_down: - $ref: '#/components/schemas/consecutive_down' - consecutive_up: - $ref: '#/components/schemas/consecutive_up' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/schemas-expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/monitor_components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - description: Update Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Update Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update Monitor tags: - Account Load Balancer Monitors - '/accounts/{account_identifier}/load_balancers/monitors/{identifier}/preview': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + method: update + /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview: post: - description: Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. + description: >- + Preview pools using the specified monitor with provided monitor details. + The returned preview_id can be used in the preview endpoint to retrieve + the results. operationId: account-load-balancer-monitors-preview-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/schemas-expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/monitor_components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview_response' - description: Preview Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingPreviewResponse' + description: Preview Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/preview_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Preview Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRef025497b7e63379c31929636b5186e45c + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Preview Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Preview Monitor tags: - Account Load Balancer Monitors - '/accounts/{account_identifier}/load_balancers/monitors/{identifier}/references': + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + - previews + method: create + /accounts/{account_id}/load_balancers/monitors/{monitor_id}/references: get: description: Get the list of resources that reference the provided monitor. operationId: account-load-balancer-monitors-list-monitor-references parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/references_response' - description: List Monitor References response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorReferencesResponse' + description: List Monitor References response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/references_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Monitor References response failure + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: List of resources that reference a given monitor. + items: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + type: array + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List Monitor References response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: List Monitor References - tags: - - Account Load Balancer Monitors - '/accounts/{account_identifier}/load_balancers/preview/{preview_id}': - get: - description: Get the result of a previous preview operation using the provided preview_id. - operationId: account-load-balancer-monitors-preview-result - parameters: - - in: path - name: preview_id - required: true - schema: - $ref: '#/components/schemas/schemas-preview_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview_result_response' - description: Preview Result response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/preview_result_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Preview Result response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: Preview Result + summary: List Monitor References tags: - Account Load Balancer Monitors - '/accounts/{account_identifier}/load_balancers/pools': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - monitors + - references + method: get + /accounts/{account_id}/load_balancers/pools: get: description: List configured pools. operationId: account-load-balancer-pools-list-pools parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - in: query + name: monitor + schema: + description: >- + The ID of the Monitor to use for checking the health of origins + within this pool. + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-response_collection' - description: List Pools response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasResponseCollection' + description: List Pools response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Pools response failure + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingPool' + type: array + enum: + - null + description: List Pools response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: List Pools tags: - Account Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + method: list patch: - description: 'Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.' + description: >- + Apply changes to a number of existing pools, overwriting the supplied + properties. Pools are ordered by ascending `name`. Returns the list of + affected pools. Supports the standard pagination query parameters, + either `limit`/`offset` or `per_page`/`page`. operationId: account-load-balancer-pools-patch-pools parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: notification_email: - $ref: '#/components/schemas/patch_pools_notification_email' - required: true + $ref: >- + #/components/schemas/loadBalancingPatchPoolsNotificationEmail + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-response_collection' - description: Patch Pools response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasResponseCollection' + description: Patch Pools response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Pools response failure + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingPool' + type: array + enum: + - null + description: Patch Pools response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Pools tags: - Account Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' post: description: Create a new pool. operationId: account-load-balancer-pools-create-pool parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: description: - $ref: '#/components/schemas/pool_components-schemas-description' + $ref: '#/components/schemas/loadBalancingSchemasDescription' enabled: - $ref: '#/components/schemas/pool_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingEnabled' latitude: - $ref: '#/components/schemas/latitude' + $ref: '#/components/schemas/loadBalancingLatitude' load_shedding: - $ref: '#/components/schemas/load_shedding' + $ref: '#/components/schemas/loadBalancingLoadShedding' longitude: - $ref: '#/components/schemas/longitude' + $ref: '#/components/schemas/loadBalancingLongitude' minimum_origins: - $ref: '#/components/schemas/minimum_origins' + $ref: '#/components/schemas/loadBalancingMinimumOrigins' monitor: - $ref: '#/components/schemas/schemas-monitor' + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' name: - $ref: '#/components/schemas/pool_components-schemas-name' + $ref: '#/components/schemas/loadBalancingName' notification_email: - $ref: '#/components/schemas/notification_email' + $ref: '#/components/schemas/loadBalancingNotificationEmail' notification_filter: - $ref: '#/components/schemas/notification_filter' + $ref: '#/components/schemas/loadBalancingNotificationFilter' origin_steering: - $ref: '#/components/schemas/origin_steering' + $ref: '#/components/schemas/loadBalancingOriginSteering' origins: - $ref: '#/components/schemas/origins' + $ref: '#/components/schemas/loadBalancingOrigins' required: - origins - name - required: true + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Create Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Create Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Pool tags: - Account Load Balancer Pools - '/accounts/{account_identifier}/load_balancers/pools/{identifier}': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + method: create + /accounts/{account_id}/load_balancers/pools/{pool_id}: delete: description: Delete a configured pool. operationId: account-load-balancer-pools-delete-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-id_response' - description: Delete Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasIdResponse' + description: Delete Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Pool tags: - Account Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + method: delete get: description: Fetch a single configured pool. operationId: account-load-balancer-pools-pool-details parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Pool Details response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Pool Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Pool Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Pool Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Pool Details tags: - Account Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + method: get patch: - description: 'Apply changes to an existing pool, overwriting the supplied properties.' + description: Apply changes to an existing pool, overwriting the supplied properties. operationId: account-load-balancer-pools-patch-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: check_regions: - $ref: '#/components/schemas/check_regions' + $ref: '#/components/schemas/loadBalancingCheckRegions' description: - $ref: '#/components/schemas/pool_components-schemas-description' + $ref: '#/components/schemas/loadBalancingSchemasDescription' disabled_at: - $ref: '#/components/schemas/schemas-disabled_at' + $ref: '#/components/schemas/loadBalancingSchemasDisabledAt' + readOnly: true enabled: - $ref: '#/components/schemas/pool_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingEnabled' latitude: - $ref: '#/components/schemas/latitude' + $ref: '#/components/schemas/loadBalancingLatitude' load_shedding: - $ref: '#/components/schemas/load_shedding' + $ref: '#/components/schemas/loadBalancingLoadShedding' longitude: - $ref: '#/components/schemas/longitude' + $ref: '#/components/schemas/loadBalancingLongitude' minimum_origins: - $ref: '#/components/schemas/minimum_origins' + $ref: '#/components/schemas/loadBalancingMinimumOrigins' monitor: - $ref: '#/components/schemas/schemas-monitor' + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' name: - $ref: '#/components/schemas/pool_components-schemas-name' + $ref: '#/components/schemas/loadBalancingName' notification_email: - $ref: '#/components/schemas/notification_email' + $ref: '#/components/schemas/loadBalancingNotificationEmail' notification_filter: - $ref: '#/components/schemas/notification_filter' + $ref: '#/components/schemas/loadBalancingNotificationFilter' origin_steering: - $ref: '#/components/schemas/origin_steering' + $ref: '#/components/schemas/loadBalancingOriginSteering' origins: - $ref: '#/components/schemas/origins' - required: true + $ref: '#/components/schemas/loadBalancingOrigins' + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Patch Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Patch Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Pool tags: - Account Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + method: edit put: description: Modify a configured pool. operationId: account-load-balancer-pools-update-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: check_regions: - $ref: '#/components/schemas/check_regions' + $ref: '#/components/schemas/loadBalancingCheckRegions' description: - $ref: '#/components/schemas/pool_components-schemas-description' + $ref: '#/components/schemas/loadBalancingSchemasDescription' disabled_at: - $ref: '#/components/schemas/schemas-disabled_at' + $ref: '#/components/schemas/loadBalancingSchemasDisabledAt' + readOnly: true enabled: - $ref: '#/components/schemas/pool_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingEnabled' latitude: - $ref: '#/components/schemas/latitude' + $ref: '#/components/schemas/loadBalancingLatitude' load_shedding: - $ref: '#/components/schemas/load_shedding' + $ref: '#/components/schemas/loadBalancingLoadShedding' longitude: - $ref: '#/components/schemas/longitude' + $ref: '#/components/schemas/loadBalancingLongitude' minimum_origins: - $ref: '#/components/schemas/minimum_origins' + $ref: '#/components/schemas/loadBalancingMinimumOrigins' monitor: - $ref: '#/components/schemas/schemas-monitor' + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' name: - $ref: '#/components/schemas/pool_components-schemas-name' + $ref: '#/components/schemas/loadBalancingName' notification_email: - $ref: '#/components/schemas/notification_email' + $ref: '#/components/schemas/loadBalancingNotificationEmail' notification_filter: - $ref: '#/components/schemas/notification_filter' + $ref: '#/components/schemas/loadBalancingNotificationFilter' origin_steering: - $ref: '#/components/schemas/origin_steering' + $ref: '#/components/schemas/loadBalancingOriginSteering' origins: - $ref: '#/components/schemas/origins' + $ref: '#/components/schemas/loadBalancingOrigins' required: - origins - name - required: true + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Update Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Update Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update Pool tags: - Account Load Balancer Pools - '/accounts/{account_identifier}/load_balancers/pools/{identifier}/health': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + method: update + /accounts/{account_id}/load_balancers/pools/{pool_id}/health: get: description: Fetch the latest pool health status for a single pool. operationId: account-load-balancer-pools-pool-health-details parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/health_details' - description: Pool Health Details response - 4xx: + $ref: '#/components/schemas/loadBalancingHealthDetails' + description: Pool Health Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/health_details' - - $ref: '#/components/schemas/api-response-common-failure' - description: Pool Health Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: >- + A list of regions from which to run health checks. Null + means every Cloudflare data center. + properties: + pool_id: + description: Pool ID. + type: string + x-auditable: true + pop_health: + description: List of regions and associated health status. + properties: + healthy: + description: Whether health check in region is healthy. + type: boolean + x-auditable: true + origins: + items: + $ref: '#/components/schemas/loadBalancingOriginHealth' + type: array + type: object + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Pool Health Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Pool Health Details tags: - Account Load Balancer Pools - '/accounts/{account_identifier}/load_balancers/pools/{identifier}/preview': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + - health + method: get + /accounts/{account_id}/load_balancers/pools/{pool_id}/preview: post: - description: Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. + description: >- + Preview pool health using provided monitor details. The returned + preview_id can be used in the preview endpoint to retrieve the results. operationId: account-load-balancer-pools-preview-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path + required: true + description: The Load Balancer pool ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingMonitorEditable' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingPreviewResponse' + description: Preview Pool response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRef025497b7e63379c31929636b5186e45c + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Preview Pool response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Preview Pool + tags: + - Account Load Balancer Pools + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + - health + method: create + /accounts/{account_id}/load_balancers/pools/{pool_id}/references: + get: + description: Get the list of resources that reference the provided pool. + operationId: account-load-balancer-pools-list-pool-references + parameters: + - name: pool_id + in: path + required: true + description: The Load Balancer pool ID. + schema: + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingPoolsReferencesResponse' + description: List Pool References response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: List of resources that reference a given pool. + items: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + type: array + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List Pool References response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Pool References + tags: + - Account Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - pools + - references + method: get + /accounts/{account_id}/load_balancers/preview/{preview_id}: + get: + description: >- + Get the result of a previous preview operation using the provided + preview_id. + operationId: account-load-balancer-monitors-preview-result + parameters: - in: path - name: account_identifier + name: preview_id + schema: + $ref: '#/components/schemas/loadBalancingSchemasPreviewId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingPreviewResultResponse' + description: Preview Result response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: Resulting health data from a preview operation. + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Preview Result response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Preview Result + tags: + - Account Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - previews + method: get + /accounts/{account_id}/load_balancers/regions: + get: + description: List all region mappings. + operationId: load-balancer-regions-list-regions + parameters: + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/schemas-expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/monitor_components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + type: string + - in: query + name: subdivision_code + schema: + $ref: '#/components/schemas/loadBalancingSubdivisionCodeA2' + - in: query + name: subdivision_code_a2 + schema: + $ref: '#/components/schemas/loadBalancingSubdivisionCodeA2' + - in: query + name: country_code_a2 + schema: + description: Two-letter alpha-2 country code followed in ISO 3166-1. + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview_response' - description: Preview Pool response - 4xx: + $ref: >- + #/components/schemas/loadBalancingRegionComponentsSchemasResponseCollection + description: List Regions response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/preview_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Preview Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Regions response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Preview Pool + summary: List Regions tags: - - Account Load Balancer Pools - '/accounts/{account_identifier}/load_balancers/pools/{identifier}/references': + - Load Balancer Regions + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - regions + method: list + /accounts/{account_id}/load_balancers/regions/{region_id}: get: - description: Get the list of resources that reference the provided pool. - operationId: account-load-balancer-pools-list-pool-references + description: Get a single region mapping. + operationId: load-balancer-regions-get-region parameters: - in: path - name: identifier - required: true + name: region_id schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' - - in: path - name: account_identifier + $ref: '#/components/schemas/loadBalancingRegionCode' + required: true + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-references_response' - description: List Pool References response - 4xx: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasSingleResponse + description: Get Region response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-references_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Pool References response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: A list of countries and subdivisions mapped to a region. + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Region response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List Pool References + summary: Get Region tags: - - Account Load Balancer Pools - '/accounts/{account_identifier}/load_balancers/search': + - Load Balancer Regions + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - regions + method: get + /accounts/{account_id}/load_balancers/search: get: description: Search for Load Balancing resources. operationId: account-load-balancer-search-search-resources parameters: - - in: path - name: account_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - in: query + name: query + schema: + default: '' + description: Search query term. + type: string + - in: query + name: references + schema: + default: '' + description: >- + The type of references to include. "*" to include both referral + and referrer references. "" to not include any reference + information. + enum: + - '' + - '*' + - referral + - referrer + type: string + - in: query + name: page + schema: + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 1 + type: number responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/search_result' - description: Search Resources response - 4xx: + required: + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + $ref: '#/components/schemas/loadBalancingSearch' + description: Search Resources response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/search_result' - - $ref: '#/components/schemas/api-response-common-failure' - description: Search Resources response failure + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + properties: + resources: + description: A list of resources matching the search query. + items: + $ref: '#/components/schemas/loadBalancingResourceReference' + type: array + type: object + enum: + - null + description: Search Resources response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Search Resources tags: - Account Load Balancer Search - /user/load_balancing_analytics/events: - get: - description: List origin health changes. - operationId: load-balancer-healthcheck-events-list-healthcheck-events - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/analytics_components-schemas-response_collection' - description: List Healthcheck Events response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/analytics_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Healthcheck Events response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Healthcheck Events - tags: - - Load Balancer Healthcheck Events + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + x-stackql-sdk: + service: load_balancers + resource_chain: + - searches + method: list /user/load_balancers/monitors: get: description: List configured monitors for a user. @@ -2892,23 +2832,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-response_collection' - description: List Monitors response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseCollection' + description: Successful list monitors response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Monitors response failure + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingMonitor' + type: array + enum: + - null + description: Failed list monitors response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: List Monitors tags: - Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' post: description: Create a configured monitor. operationId: load-balancer-monitors-create-monitor @@ -2916,413 +2885,679 @@ paths: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response' - description: Create Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Create Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Monitor tags: - Load Balancer Monitors - '/user/load_balancers/monitors/{identifier}': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + /user/load_balancers/monitors/{monitor_id}: delete: description: Delete a configured monitor. operationId: load-balancer-monitors-delete-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-id_response' - description: Delete Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingIdResponse' + description: Delete Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Monitor tags: - Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' get: description: List a single configured monitor for a user. operationId: load-balancer-monitors-monitor-details parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response' - description: Monitor Details response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Monitor Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Monitor Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Monitor Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Monitor Details tags: - Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' patch: - description: 'Apply changes to an existing monitor, overwriting the supplied properties.' + description: >- + Apply changes to an existing monitor, overwriting the supplied + properties. operationId: load-balancer-monitors-patch-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response' - description: Patch Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Patch Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Monitor tags: - Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' put: description: Modify a configured monitor. operationId: load-balancer-monitors-update-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - description: - $ref: '#/components/schemas/monitor_components-schemas-description' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - interval: - $ref: '#/components/schemas/interval' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/components-schemas-port' - probe_zone: - $ref: '#/components/schemas/probe_zone' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/monitor_components-schemas-single_response' - description: Update Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorResponseSingle' + description: Update Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/monitor_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update Monitor tags: - Load Balancer Monitors - '/user/load_balancers/monitors/{identifier}/preview': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + /user/load_balancers/monitors/{monitor_id}/preview: post: - description: Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. + description: >- + Preview pools using the specified monitor with provided monitor details. + The returned preview_id can be used in the preview endpoint to retrieve + the results. operationId: load-balancer-monitors-preview-monitor parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/components-schemas-port' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview_response' - description: Preview Monitor response - 4xx: + $ref: '#/components/schemas/loadBalancingPreviewResponse' + description: Preview Monitor response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/preview_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Preview Monitor response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRef025497b7e63379c31929636b5186e45c + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Preview Monitor response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Preview Monitor tags: - Load Balancer Monitors - '/user/load_balancers/monitors/{identifier}/references': + /user/load_balancers/monitors/{monitor_id}/references: get: description: Get the list of resources that reference the provided monitor. operationId: load-balancer-monitors-list-monitor-references parameters: - - in: path - name: identifier + - name: monitor_id + in: path required: true + description: The Load Balancer monitor ID. schema: - $ref: '#/components/schemas/monitor_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/references_response' - description: List Monitor References response - 4xx: + $ref: '#/components/schemas/loadBalancingMonitorReferencesResponse' + description: List Monitor References response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/references_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Monitor References response failure + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: List of resources that reference a given monitor. + items: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + type: array + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List Monitor References response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: List Monitor References - tags: - - Load Balancer Monitors - '/user/load_balancers/preview/{preview_id}': - get: - description: Get the result of a previous preview operation using the provided preview_id. - operationId: load-balancer-monitors-preview-result - parameters: - - in: path - name: preview_id - required: true - schema: - $ref: '#/components/schemas/preview_id' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview_result_response' - description: Preview Result response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/preview_result_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Preview Result response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: Preview Result + summary: List Monitor References tags: - Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' /user/load_balancers/pools: get: description: List configured pools. operationId: load-balancer-pools-list-pools + parameters: + - in: query + name: monitor + schema: + description: >- + The ID of the Monitor to use for checking the health of origins + within this pool. + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-response_collection' - description: List Pools response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasResponseCollection' + description: List Pools response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Pools response failure + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingPool' + type: array + enum: + - null + description: List Pools response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: List Pools tags: - Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' patch: - description: 'Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.' + description: >- + Apply changes to a number of existing pools, overwriting the supplied + properties. Pools are ordered by ascending `name`. Returns the list of + affected pools. Supports the standard pagination query parameters, + either `limit`/`offset` or `per_page`/`page`. operationId: load-balancer-pools-patch-pools requestBody: content: @@ -3330,30 +3565,59 @@ paths: schema: properties: notification_email: - $ref: '#/components/schemas/patch_pools_notification_email' - required: true + $ref: >- + #/components/schemas/loadBalancingPatchPoolsNotificationEmail + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-response_collection' - description: Patch Pools response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasResponseCollection' + description: Patch Pools response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Pools response failure + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingPool' + type: array + enum: + - null + description: Patch Pools response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Pools tags: - Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' post: description: Create a new pool. operationId: load-balancer-pools-create-pool @@ -3363,793 +3627,4136 @@ paths: schema: properties: check_regions: - $ref: '#/components/schemas/check_regions' + $ref: '#/components/schemas/loadBalancingCheckRegions' description: - $ref: '#/components/schemas/pool_components-schemas-description' + $ref: '#/components/schemas/loadBalancingSchemasDescription' enabled: - $ref: '#/components/schemas/pool_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingEnabled' latitude: - $ref: '#/components/schemas/latitude' + $ref: '#/components/schemas/loadBalancingLatitude' load_shedding: - $ref: '#/components/schemas/load_shedding' + $ref: '#/components/schemas/loadBalancingLoadShedding' longitude: - $ref: '#/components/schemas/longitude' + $ref: '#/components/schemas/loadBalancingLongitude' minimum_origins: - $ref: '#/components/schemas/minimum_origins' + $ref: '#/components/schemas/loadBalancingMinimumOrigins' monitor: - $ref: '#/components/schemas/schemas-monitor' + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' name: - $ref: '#/components/schemas/pool_components-schemas-name' + $ref: '#/components/schemas/loadBalancingName' + networks: + $ref: '#/components/schemas/loadBalancingNetworks' notification_email: - $ref: '#/components/schemas/notification_email' + $ref: '#/components/schemas/loadBalancingNotificationEmail' notification_filter: - $ref: '#/components/schemas/notification_filter' + $ref: '#/components/schemas/loadBalancingNotificationFilter' origin_steering: - $ref: '#/components/schemas/origin_steering' + $ref: '#/components/schemas/loadBalancingOriginSteering' origins: - $ref: '#/components/schemas/origins' + $ref: '#/components/schemas/loadBalancingOrigins' required: - origins - name - required: true + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Create Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Create Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Pool tags: - Load Balancer Pools - '/user/load_balancers/pools/{identifier}': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + /user/load_balancers/pools/{pool_id}: delete: description: Delete a configured pool. operationId: load-balancer-pools-delete-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-id_response' - description: Delete Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasIdResponse' + description: Delete Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Pool tags: - Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' get: description: Fetch a single configured pool. operationId: load-balancer-pools-pool-details parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Pool Details response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Pool Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Pool Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Pool Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Pool Details tags: - Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' patch: - description: 'Apply changes to an existing pool, overwriting the supplied properties.' + description: Apply changes to an existing pool, overwriting the supplied properties. operationId: load-balancer-pools-patch-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: check_regions: - $ref: '#/components/schemas/check_regions' + $ref: '#/components/schemas/loadBalancingCheckRegions' description: - $ref: '#/components/schemas/pool_components-schemas-description' + $ref: '#/components/schemas/loadBalancingSchemasDescription' disabled_at: - $ref: '#/components/schemas/schemas-disabled_at' + $ref: '#/components/schemas/loadBalancingSchemasDisabledAt' + readOnly: true enabled: - $ref: '#/components/schemas/pool_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingEnabled' latitude: - $ref: '#/components/schemas/latitude' + $ref: '#/components/schemas/loadBalancingLatitude' load_shedding: - $ref: '#/components/schemas/load_shedding' + $ref: '#/components/schemas/loadBalancingLoadShedding' longitude: - $ref: '#/components/schemas/longitude' + $ref: '#/components/schemas/loadBalancingLongitude' minimum_origins: - $ref: '#/components/schemas/minimum_origins' + $ref: '#/components/schemas/loadBalancingMinimumOrigins' monitor: - $ref: '#/components/schemas/schemas-monitor' + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' name: - $ref: '#/components/schemas/pool_components-schemas-name' + $ref: '#/components/schemas/loadBalancingName' notification_email: - $ref: '#/components/schemas/notification_email' + $ref: '#/components/schemas/loadBalancingNotificationEmail' notification_filter: - $ref: '#/components/schemas/notification_filter' + $ref: '#/components/schemas/loadBalancingNotificationFilter' origin_steering: - $ref: '#/components/schemas/origin_steering' + $ref: '#/components/schemas/loadBalancingOriginSteering' origins: - $ref: '#/components/schemas/origins' - required: true + $ref: '#/components/schemas/loadBalancingOrigins' + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Patch Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Patch Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Pool tags: - Load Balancer Pools + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' put: description: Modify a configured pool. operationId: load-balancer-pools-update-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: check_regions: - $ref: '#/components/schemas/check_regions' + $ref: '#/components/schemas/loadBalancingCheckRegions' description: - $ref: '#/components/schemas/pool_components-schemas-description' + $ref: '#/components/schemas/loadBalancingSchemasDescription' disabled_at: - $ref: '#/components/schemas/schemas-disabled_at' + $ref: '#/components/schemas/loadBalancingSchemasDisabledAt' + readOnly: true enabled: - $ref: '#/components/schemas/pool_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingEnabled' latitude: - $ref: '#/components/schemas/latitude' + $ref: '#/components/schemas/loadBalancingLatitude' load_shedding: - $ref: '#/components/schemas/load_shedding' + $ref: '#/components/schemas/loadBalancingLoadShedding' longitude: - $ref: '#/components/schemas/longitude' + $ref: '#/components/schemas/loadBalancingLongitude' minimum_origins: - $ref: '#/components/schemas/minimum_origins' + $ref: '#/components/schemas/loadBalancingMinimumOrigins' monitor: - $ref: '#/components/schemas/schemas-monitor' + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' name: - $ref: '#/components/schemas/pool_components-schemas-name' + $ref: '#/components/schemas/loadBalancingName' + networks: + $ref: '#/components/schemas/loadBalancingNetworks' notification_email: - $ref: '#/components/schemas/notification_email' + $ref: '#/components/schemas/loadBalancingNotificationEmail' notification_filter: - $ref: '#/components/schemas/notification_filter' + $ref: '#/components/schemas/loadBalancingNotificationFilter' origin_steering: - $ref: '#/components/schemas/origin_steering' + $ref: '#/components/schemas/loadBalancingOriginSteering' origins: - $ref: '#/components/schemas/origins' + $ref: '#/components/schemas/loadBalancingOrigins' required: - origins - name - required: true + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pool_components-schemas-single_response' - description: Update Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingSchemasSingleResponse' + description: Update Pool response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pool_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Pool response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/loadBalancerPool' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Pool response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update Pool tags: - Load Balancer Pools - '/user/load_balancers/pools/{identifier}/health': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + /user/load_balancers/pools/{pool_id}/health: get: description: Fetch the latest pool health status for a single pool. operationId: load-balancer-pools-pool-health-details parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/health_details' - description: Pool Health Details response - 4xx: + $ref: '#/components/schemas/loadBalancingHealthDetails' + description: Pool Health Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/health_details' - - $ref: '#/components/schemas/api-response-common-failure' - description: Pool Health Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: >- + A list of regions from which to run health checks. Null + means every Cloudflare data center. + properties: + pool_id: + description: Pool ID. + type: string + x-auditable: true + pop_health: + description: List of regions and associated health status. + properties: + healthy: + description: Whether health check in region is healthy. + type: boolean + x-auditable: true + origins: + items: + $ref: '#/components/schemas/loadBalancingOriginHealth' + type: array + type: object + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Pool Health Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Pool Health Details tags: - Load Balancer Pools - '/user/load_balancers/pools/{identifier}/preview': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + /user/load_balancers/pools/{pool_id}/preview: post: - description: Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. + description: >- + Preview pool health using provided monitor details. The returned + preview_id can be used in the preview endpoint to retrieve the results. operationId: load-balancer-pools-preview-pool parameters: - - in: path - name: identifier + - name: pool_id + in: path required: true + description: The Load Balancer pool ID. schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - allow_insecure: - $ref: '#/components/schemas/allow_insecure' - expected_body: - $ref: '#/components/schemas/expected_body' - expected_codes: - $ref: '#/components/schemas/expected_codes' - follow_redirects: - $ref: '#/components/schemas/follow_redirects' - header: - $ref: '#/components/schemas/header' - method: - $ref: '#/components/schemas/schemas-method' - path: - $ref: '#/components/schemas/path' - port: - $ref: '#/components/schemas/components-schemas-port' - retries: - $ref: '#/components/schemas/retries' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/monitor_components-schemas-type' - required: - - expected_codes - required: true + $ref: '#/components/schemas/loadBalancingMonitorEditable' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/loadBalancingPreviewResponse' + description: Preview Pool response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRef025497b7e63379c31929636b5186e45c + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Preview Pool response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Preview Pool + tags: + - Load Balancer Pools + /user/load_balancers/pools/{pool_id}/references: + get: + description: Get the list of resources that reference the provided pool. + operationId: load-balancer-pools-list-pool-references + parameters: + - name: pool_id + in: path + required: true + description: The Load Balancer pool ID. + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview_response' - description: Preview Pool response - 4xx: + $ref: '#/components/schemas/loadBalancingPoolsReferencesResponse' + description: List Pool References response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/preview_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Preview Pool response failure + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: List of resources that reference a given pool. + items: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + type: array + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List Pool References response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Preview Pool + summary: List Pool References tags: - Load Balancer Pools - '/user/load_balancers/pools/{identifier}/references': + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + /user/load_balancers/preview/{preview_id}: get: - description: Get the list of resources that reference the provided pool. - operationId: load-balancer-pools-list-pool-references + description: >- + Get the result of a previous preview operation using the provided + preview_id. + operationId: load-balancer-monitors-preview-result parameters: - in: path - name: identifier - required: true + name: preview_id schema: - $ref: '#/components/schemas/pool_components-schemas-identifier' + $ref: '#/components/schemas/loadBalancingPreviewId' + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-references_response' - description: List Pool References response - 4xx: + $ref: '#/components/schemas/loadBalancingPreviewResultResponse' + description: Preview Result response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-references_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Pool References response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: Resulting health data from a preview operation. + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Preview Result response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List Pool References + summary: Preview Result tags: - - Load Balancer Pools - '/accounts/{account_identifier}/load_balancers/regions': + - Load Balancer Monitors + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + /zones/{zone_id}/load_balancers: get: - description: List all region mappings. - operationId: load-balancer-regions-list-regions + description: List configured load balancers. + operationId: load-balancers-list-load-balancers parameters: - - in: path - name: account_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/region_components-schemas-response_collection' - description: List Regions response - 4xx: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasResponseCollection + description: List Load Balancers response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/region_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Regions response failure + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingLoadBalancer' + type: array + enum: + - null + description: List Load Balancers response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List Regions + summary: List Load Balancers tags: - - Load Balancer Regions - '/accounts/{account_identifier}/load_balancers/regions/{region_code}': - get: - description: Get a single region mapping. - operationId: load-balancer-regions-get-region + - Load Balancers + x-api-token-group: + - Load Balancers Write + - Load Balancers Read + x-stackql-sdk: + service: load_balancers + resource_chain: [] + method: list + post: + description: Create a new load balancer. + operationId: load-balancers-create-load-balancer parameters: - - in: path - name: region_code - required: true - schema: - $ref: '#/components/schemas/region_code' - - in: path - name: account_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + properties: + adaptive_routing: + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' + country_pools: + $ref: '#/components/schemas/loadBalancingCountryPools' + default_pools: + $ref: '#/components/schemas/loadBalancingDefaultPools' + description: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasDescription + fallback_pool: + $ref: '#/components/schemas/loadBalancingFallbackPool' + location_strategy: + $ref: '#/components/schemas/loadBalancingLocationStrategy' + name: + $ref: '#/components/schemas/loadBalancingComponentsSchemasName' + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + pop_pools: + $ref: '#/components/schemas/loadBalancingPopPools' + proxied: + $ref: '#/components/schemas/loadBalancingProxied' + random_steering: + $ref: '#/components/schemas/loadBalancingRandomSteering' + region_pools: + $ref: '#/components/schemas/loadBalancingRegionPools' + rules: + $ref: '#/components/schemas/loadBalancingRules' + session_affinity: + $ref: '#/components/schemas/loadBalancingSessionAffinity' + session_affinity_attributes: + $ref: '#/components/schemas/loadBalancingSessionAffinityAttributes' + session_affinity_ttl: + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' + steering_policy: + $ref: '#/components/schemas/loadBalancingSteeringPolicy' + ttl: + $ref: '#/components/schemas/loadBalancingTtl' + required: + - name + - default_pools + - fallback_pool + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/region_components-schemas-single_response' - description: Get Region response - 4xx: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasSingleResponse + description: Create Load Balancer response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/region_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Region response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + adaptive_routing: + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' + country_pools: + $ref: '#/components/schemas/loadBalancingCountryPools' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + default_pools: + $ref: '#/components/schemas/loadBalancingDefaultPools' + description: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasDescription + enabled: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasEnabled + fallback_pool: + $ref: '#/components/schemas/loadBalancingFallbackPool' + id: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasIdentifier + location_strategy: + $ref: '#/components/schemas/loadBalancingLocationStrategy' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasName + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + pop_pools: + $ref: '#/components/schemas/loadBalancingPopPools' + proxied: + $ref: '#/components/schemas/loadBalancingProxied' + random_steering: + $ref: '#/components/schemas/loadBalancingRandomSteering' + region_pools: + $ref: '#/components/schemas/loadBalancingRegionPools' + rules: + $ref: '#/components/schemas/loadBalancingRules' + session_affinity: + $ref: '#/components/schemas/loadBalancingSessionAffinity' + session_affinity_attributes: + $ref: >- + #/components/schemas/loadBalancingSessionAffinityAttributes + session_affinity_ttl: + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' + steering_policy: + $ref: '#/components/schemas/loadBalancingSteeringPolicy' + ttl: + $ref: '#/components/schemas/loadBalancingTtl' + zone_name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasZoneName + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Load Balancer response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Region + summary: Create Load Balancer tags: - - Load Balancer Regions - '/zones/{identifier1}/load_balancers/{identifier}': + - Load Balancers + x-api-token-group: + - Load Balancers Write + x-stackql-sdk: + service: load_balancers + resource_chain: [] + method: create + /zones/{zone_id}/load_balancers/{load_balancer_id}: delete: description: Delete a configured load balancer. operationId: load-balancers-delete-load-balancer parameters: - - in: path - name: identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - - in: path - name: identifier1 + type: string + - name: load_balancer_id + in: path required: true + description: The Load Balancer ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/load-balancer_components-schemas-id_response' - description: Delete Load Balancer response - 4xx: + $ref: '#/components/schemas/loadBalancingComponentsSchemasIdResponse' + description: Delete Load Balancer response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/load-balancer_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Load Balancer response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasIdentifier + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Load Balancer response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Load Balancer tags: - Load Balancers + x-api-token-group: + - Load Balancers Write + x-stackql-sdk: + service: load_balancers + resource_chain: [] + method: delete get: description: Fetch a single configured load balancer. operationId: load-balancers-load-balancer-details parameters: - - in: path - name: identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - - in: path - name: identifier1 + type: string + - name: load_balancer_id + in: path required: true + description: The Load Balancer ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - description: Load Balancer Details response - 4xx: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasSingleResponse + description: Load Balancer Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Load Balancer Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + adaptive_routing: + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' + country_pools: + $ref: '#/components/schemas/loadBalancingCountryPools' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + default_pools: + $ref: '#/components/schemas/loadBalancingDefaultPools' + description: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasDescription + enabled: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasEnabled + fallback_pool: + $ref: '#/components/schemas/loadBalancingFallbackPool' + id: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasIdentifier + location_strategy: + $ref: '#/components/schemas/loadBalancingLocationStrategy' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasName + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + pop_pools: + $ref: '#/components/schemas/loadBalancingPopPools' + proxied: + $ref: '#/components/schemas/loadBalancingProxied' + random_steering: + $ref: '#/components/schemas/loadBalancingRandomSteering' + region_pools: + $ref: '#/components/schemas/loadBalancingRegionPools' + rules: + $ref: '#/components/schemas/loadBalancingRules' + session_affinity: + $ref: '#/components/schemas/loadBalancingSessionAffinity' + session_affinity_attributes: + $ref: >- + #/components/schemas/loadBalancingSessionAffinityAttributes + session_affinity_ttl: + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' + steering_policy: + $ref: '#/components/schemas/loadBalancingSteeringPolicy' + ttl: + $ref: '#/components/schemas/loadBalancingTtl' + zone_name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasZoneName + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Load Balancer Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Load Balancer Details tags: - Load Balancers + x-api-token-group: + - Load Balancers Write + - Load Balancers Read + x-stackql-sdk: + service: load_balancers + resource_chain: [] + method: get patch: - description: 'Apply changes to an existing load balancer, overwriting the supplied properties.' + description: >- + Apply changes to an existing load balancer, overwriting the supplied + properties. operationId: load-balancers-patch-load-balancer parameters: - - in: path - name: identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - - in: path - name: identifier1 + type: string + - name: load_balancer_id + in: path required: true + description: The Load Balancer ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: adaptive_routing: - $ref: '#/components/schemas/adaptive_routing' + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' country_pools: - $ref: '#/components/schemas/country_pools' + $ref: '#/components/schemas/loadBalancingCountryPools' default_pools: - $ref: '#/components/schemas/default_pools' + $ref: '#/components/schemas/loadBalancingDefaultPools' description: - $ref: '#/components/schemas/load-balancer_components-schemas-description' + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasDescription enabled: - $ref: '#/components/schemas/load-balancer_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingComponentsSchemasEnabled' fallback_pool: - $ref: '#/components/schemas/fallback_pool' + $ref: '#/components/schemas/loadBalancingFallbackPool' location_strategy: - $ref: '#/components/schemas/location_strategy' + $ref: '#/components/schemas/loadBalancingLocationStrategy' name: - $ref: '#/components/schemas/load-balancer_components-schemas-name' + $ref: '#/components/schemas/loadBalancingComponentsSchemasName' pop_pools: - $ref: '#/components/schemas/pop_pools' + $ref: '#/components/schemas/loadBalancingPopPools' proxied: - $ref: '#/components/schemas/schemas-proxied' + $ref: '#/components/schemas/loadBalancingProxied' random_steering: - $ref: '#/components/schemas/random_steering' + $ref: '#/components/schemas/loadBalancingRandomSteering' region_pools: - $ref: '#/components/schemas/region_pools' + $ref: '#/components/schemas/loadBalancingRegionPools' rules: - $ref: '#/components/schemas/load-balancer_components-schemas-rules' + $ref: '#/components/schemas/loadBalancingRules' session_affinity: - $ref: '#/components/schemas/session_affinity' + $ref: '#/components/schemas/loadBalancingSessionAffinity' session_affinity_attributes: - $ref: '#/components/schemas/session_affinity_attributes' + $ref: '#/components/schemas/loadBalancingSessionAffinityAttributes' session_affinity_ttl: - $ref: '#/components/schemas/session_affinity_ttl' + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' steering_policy: - $ref: '#/components/schemas/steering_policy' + $ref: '#/components/schemas/loadBalancingSteeringPolicy' ttl: - $ref: '#/components/schemas/schemas-ttl' - required: true + $ref: '#/components/schemas/loadBalancingTtl' + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - description: Patch Load Balancer response - 4xx: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasSingleResponse + description: Patch Load Balancer response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Load Balancer response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + adaptive_routing: + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' + country_pools: + $ref: '#/components/schemas/loadBalancingCountryPools' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + default_pools: + $ref: '#/components/schemas/loadBalancingDefaultPools' + description: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasDescription + enabled: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasEnabled + fallback_pool: + $ref: '#/components/schemas/loadBalancingFallbackPool' + id: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasIdentifier + location_strategy: + $ref: '#/components/schemas/loadBalancingLocationStrategy' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasName + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + pop_pools: + $ref: '#/components/schemas/loadBalancingPopPools' + proxied: + $ref: '#/components/schemas/loadBalancingProxied' + random_steering: + $ref: '#/components/schemas/loadBalancingRandomSteering' + region_pools: + $ref: '#/components/schemas/loadBalancingRegionPools' + rules: + $ref: '#/components/schemas/loadBalancingRules' + session_affinity: + $ref: '#/components/schemas/loadBalancingSessionAffinity' + session_affinity_attributes: + $ref: >- + #/components/schemas/loadBalancingSessionAffinityAttributes + session_affinity_ttl: + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' + steering_policy: + $ref: '#/components/schemas/loadBalancingSteeringPolicy' + ttl: + $ref: '#/components/schemas/loadBalancingTtl' + zone_name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasZoneName + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch Load Balancer response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Load Balancer tags: - Load Balancers + x-api-token-group: + - Load Balancers Write + x-stackql-sdk: + service: load_balancers + resource_chain: [] + method: edit put: description: Update a configured load balancer. operationId: load-balancers-update-load-balancer parameters: - - in: path - name: identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - - in: path - name: identifier1 + type: string + - name: load_balancer_id + in: path required: true + description: The Load Balancer ID. schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: adaptive_routing: - $ref: '#/components/schemas/adaptive_routing' + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' country_pools: - $ref: '#/components/schemas/country_pools' + $ref: '#/components/schemas/loadBalancingCountryPools' default_pools: - $ref: '#/components/schemas/default_pools' + $ref: '#/components/schemas/loadBalancingDefaultPools' description: - $ref: '#/components/schemas/load-balancer_components-schemas-description' + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasDescription enabled: - $ref: '#/components/schemas/load-balancer_components-schemas-enabled' + $ref: '#/components/schemas/loadBalancingComponentsSchemasEnabled' fallback_pool: - $ref: '#/components/schemas/fallback_pool' + $ref: '#/components/schemas/loadBalancingFallbackPool' location_strategy: - $ref: '#/components/schemas/location_strategy' + $ref: '#/components/schemas/loadBalancingLocationStrategy' name: - $ref: '#/components/schemas/load-balancer_components-schemas-name' + $ref: '#/components/schemas/loadBalancingComponentsSchemasName' + networks: + $ref: '#/components/schemas/loadBalancingNetworks' pop_pools: - $ref: '#/components/schemas/pop_pools' + $ref: '#/components/schemas/loadBalancingPopPools' proxied: - $ref: '#/components/schemas/schemas-proxied' + $ref: '#/components/schemas/loadBalancingProxied' random_steering: - $ref: '#/components/schemas/random_steering' + $ref: '#/components/schemas/loadBalancingRandomSteering' region_pools: - $ref: '#/components/schemas/region_pools' + $ref: '#/components/schemas/loadBalancingRegionPools' rules: - $ref: '#/components/schemas/load-balancer_components-schemas-rules' + $ref: '#/components/schemas/loadBalancingRules' session_affinity: - $ref: '#/components/schemas/session_affinity' + $ref: '#/components/schemas/loadBalancingSessionAffinity' session_affinity_attributes: - $ref: '#/components/schemas/session_affinity_attributes' + $ref: '#/components/schemas/loadBalancingSessionAffinityAttributes' session_affinity_ttl: - $ref: '#/components/schemas/session_affinity_ttl' + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' steering_policy: - $ref: '#/components/schemas/steering_policy' + $ref: '#/components/schemas/loadBalancingSteeringPolicy' ttl: - $ref: '#/components/schemas/schemas-ttl' + $ref: '#/components/schemas/loadBalancingTtl' required: - name - default_pools - fallback_pool - required: true + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - description: Update Load Balancer response - 4xx: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasSingleResponse + description: Update Load Balancer response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Load Balancer response failure + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + adaptive_routing: + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' + country_pools: + $ref: '#/components/schemas/loadBalancingCountryPools' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + default_pools: + $ref: '#/components/schemas/loadBalancingDefaultPools' + description: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasDescription + enabled: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasEnabled + fallback_pool: + $ref: '#/components/schemas/loadBalancingFallbackPool' + id: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasIdentifier + location_strategy: + $ref: '#/components/schemas/loadBalancingLocationStrategy' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasName + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + pop_pools: + $ref: '#/components/schemas/loadBalancingPopPools' + proxied: + $ref: '#/components/schemas/loadBalancingProxied' + random_steering: + $ref: '#/components/schemas/loadBalancingRandomSteering' + region_pools: + $ref: '#/components/schemas/loadBalancingRegionPools' + rules: + $ref: '#/components/schemas/loadBalancingRules' + session_affinity: + $ref: '#/components/schemas/loadBalancingSessionAffinity' + session_affinity_attributes: + $ref: >- + #/components/schemas/loadBalancingSessionAffinityAttributes + session_affinity_ttl: + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' + steering_policy: + $ref: '#/components/schemas/loadBalancingSteeringPolicy' + ttl: + $ref: '#/components/schemas/loadBalancingTtl' + zone_name: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasZoneName + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Load Balancer response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Update Load Balancer - tags: - - Load Balancers - '/zones/{identifier}/load_balancers': - get: - description: List configured load balancers. - operationId: load-balancers-list-load-balancers - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/load-balancer_components-schemas-response_collection' - description: List Load Balancers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/load-balancer_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Load Balancers response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: List Load Balancers + summary: Update Load Balancer tags: - Load Balancers - post: - description: Create a new load balancer. - operationId: load-balancers-create-load-balancer - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/load-balancer_components-schemas-identifier' - requestBody: - content: - application/json: - schema: + x-api-token-group: + - Load Balancers Write + x-stackql-sdk: + service: load_balancers + resource_chain: [] + method: update +components: + schemas: + loadBalancerPool: + properties: + check_regions: + $ref: '#/components/schemas/loadBalancingCheckRegions' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/loadBalancingSchemasDescription' + disabled_at: + $ref: '#/components/schemas/loadBalancingSchemasDisabledAt' + readOnly: true + enabled: + $ref: '#/components/schemas/loadBalancingEnabled' + id: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + latitude: + $ref: '#/components/schemas/loadBalancingLatitude' + load_shedding: + $ref: '#/components/schemas/loadBalancingLoadShedding' + longitude: + $ref: '#/components/schemas/loadBalancingLongitude' + minimum_origins: + $ref: '#/components/schemas/loadBalancingMinimumOrigins' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + monitor: + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + name: + $ref: '#/components/schemas/loadBalancingName' + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + notification_email: + $ref: '#/components/schemas/loadBalancingNotificationEmail' + notification_filter: + $ref: '#/components/schemas/loadBalancingNotificationFilter' + origin_steering: + $ref: '#/components/schemas/loadBalancingOriginSteering' + origins: + $ref: '#/components/schemas/loadBalancingOrigins' + type: object + enum: + - null + loadBalancingAdaptiveRouting: + description: >- + Controls features that modify the routing of requests to pools and + origins in response to dynamic conditions, such as during the interval + between active health monitoring requests. For example, zero-downtime + failover occurs immediately when an origin becomes unavailable due to + HTTP 521, 522, or 523 response codes. If there is another healthy origin + in the same pool, the request is retried once against this alternate + origin. + properties: + failover_across_pools: + default: false + description: >- + Extends zero-downtime failover of requests to healthy origins from + alternate pools, when no healthy alternate exists in the same pool, + according to the failover order defined by traffic and origin + steering. When set false (the default) zero-downtime failover will + only occur between origins within the same pool. See + `session_affinity_attributes` for control over when sessions are + broken or reassigned. + example: true + type: boolean + x-auditable: true + type: object + loadBalancingAddress: + description: >- + The IP address (IPv4 or IPv6) of the origin, or its publicly addressable + hostname. Hostnames entered here should resolve directly to the origin, + and not be a hostname proxied by Cloudflare. To set an internal/reserved + address, virtual_network_id must also be set. + example: 0.0.0.0 + type: string + x-auditable: true + loadBalancingAllowInsecure: + default: false + description: >- + Do not validate the certificate when monitor use HTTPS. This parameter + is currently only valid for HTTP and HTTPS monitors. + example: true + type: boolean + x-auditable: true + loadBalancingCheckRegions: + description: >- + A list of regions from which to run health checks. Null means every + Cloudflare data center. + example: + - WEU + - ENAM + items: + description: >- + WNAM: Western North America, ENAM: Eastern North America, WEU: Western + Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: + Southern South America, OC: Oceania, ME: Middle East, NAF: North + Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, + NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers + only). + enum: + - WNAM + - ENAM + - WEU + - EEU + - NSAM + - SSAM + - OC + - ME + - NAF + - SAF + - SAS + - SEAS + - NEAS + - ALL_REGIONS + type: string + x-auditable: true + nullable: true + type: array + loadBalancingComponentsSchemasDescription: + description: Object description. + example: Load Balancer for www.example.com + type: string + x-auditable: true + loadBalancingComponentsSchemasEnabled: + default: true + description: Whether to enable (the default) this load balancer. + example: true + type: boolean + x-auditable: true + loadBalancingComponentsSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasIdentifier + type: object + required: + - success + - errors + - messages + - result + loadBalancingComponentsSchemasName: + description: >- + The DNS hostname to associate with your Load Balancer. If this hostname + already exists as a DNS record in Cloudflare's DNS, the Load Balancer + will take precedence and the DNS record will not be used. + example: www.example.com + type: string + x-auditable: true + loadBalancingComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: A list of countries and subdivisions mapped to a region. + example: + iso_standard: >- + Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO + 3166-2 + regions: + - countries: + - country_code_a2: CA + country_name: Canada + country_subdivisions: + - subdivision_code_a2: AB + subdivision_name: Alberta + - subdivision_code_a2: BC + subdivision_name: British Columbia + - country_code_a2: HT + country_name: Haiti + - country_code_a2: MX + country_name: Mexico + - country_code_a2: US + country_name: United States + country_subdivisions: + - subdivision_code_a2: AZ + subdivision_name: Arizona + - subdivision_code_a2: CA + subdivision_name: California + - subdivision_code_a2: CO + subdivision_name: Colorado + - subdivision_code_a2: HI + subdivision_name: Hawaii + - subdivision_code_a2: MN + subdivision_name: Minnesota + - subdivision_code_a2: MO + subdivision_name: Missouri + - subdivision_code_a2: NV + subdivision_name: Nevada + - subdivision_code_a2: OR + subdivision_name: Oregon + - subdivision_code_a2: TX + subdivision_name: Texas + - subdivision_code_a2: UT + subdivision_name: Utah + - subdivision_code_a2: WA + subdivision_name: Washington + region_code: WNAM + type: object + required: + - success + - errors + - messages + - result + loadBalancingComponentsSchemasZoneName: + example: example.com + type: string + x-auditable: true + loadBalancingConsecutiveDown: + description: >- + To be marked unhealthy the monitored origin must fail this healthcheck N + consecutive times. + type: integer + x-auditable: true + loadBalancingConsecutiveUp: + description: >- + To be marked healthy the monitored origin must pass this healthcheck N + consecutive times. + type: integer + x-auditable: true + loadBalancingCountryPools: + description: >- + A mapping of country codes to a list of pool IDs (ordered by their + failover priority) for the given country. Any country not explicitly + defined will fall back to using the corresponding region_pool mapping if + it exists else to default_pools. + example: + GB: + - abd90f38ced07c2e2f4df50b1f61d4194 + US: + - de90f38ced07c2e2f4df50b1f61d4194 + - 00920f38ce07c2e2f4df50b1f61d4194 + type: object + loadBalancingDefaultPools: + description: >- + A list of pool IDs ordered by their failover priority. Pools defined + here are used by default, or when region_pools are not configured for a + given region. + example: + - 17b5962d775c646f3f9725cbc7a53df4 + - 9290f38c5d07c2e2f4df57b1f61d4196 + - 00920f38ce07c2e2f4df50b1f61d4194 + items: + description: A pool ID. + type: string + type: array + loadBalancingDescription: + default: '' + description: Object description. + example: Login page monitor + type: string + x-auditable: true + loadBalancingDisabledAt: + description: >- + This field shows up only if the origin is disabled. This field is set + with the time the origin was disabled. + format: date-time + readOnly: true + type: string + x-auditable: true + loadBalancingEnabled: + default: true + description: >- + Whether to enable (the default) or disable this pool. Disabled pools + will not receive traffic and are excluded from health checks. Disabling + a pool will cause any load balancers using it to failover to the next + pool (if any). + example: false + type: boolean + x-auditable: true + loadBalancingExpectedBody: + default: '' + description: >- + A case-insensitive sub-string to look for in the response body. If this + string is not found, the origin will be marked as unhealthy. This + parameter is only valid for HTTP and HTTPS monitors. + example: alive + type: string + x-auditable: true + loadBalancingExpectedCodes: + default: '' + description: >- + The expected HTTP response code or code range of the health check. This + parameter is only valid for HTTP and HTTPS monitors. + example: 2xx + type: string + x-auditable: true + loadBalancingFallbackPool: + description: The pool ID to use when all other pools are detected as unhealthy. + type: string + x-auditable: true + loadBalancingFilterOptions: + description: >- + Filter options for a particular resource type (pool or origin). Use null + to reset. + nullable: true + properties: + disable: + default: false + description: >- + If set true, disable notifications for this type of resource (pool + or origin). + nullable: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: optional + healthy: + description: >- + If present, send notifications only for this health status (e.g. + false for only DOWN events). Use null to reset (all events). + nullable: true + type: boolean + x-auditable: true + type: object + loadBalancingFollowRedirects: + default: false + description: >- + Follow redirects if returned by the origin. This parameter is only valid + for HTTP and HTTPS monitors. + example: true + type: boolean + x-auditable: true + loadBalancingHeader: + description: >- + The HTTP request headers to send in the health check. It is recommended + you set a Host header by default. The User-Agent header cannot be + overridden. This parameter is only valid for HTTP and HTTPS monitors. + example: + Host: + - example.com + X-App-ID: + - abc123 + type: object + loadBalancingHealthDetails: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: >- + A list of regions from which to run health checks. Null means every + Cloudflare data center. + example: + pool_id: 17b5962d775c646f3f9725cbc7a53df4 + pop_health: + Amsterdam, NL: + healthy: true + origins: + - 2001:DB8::5: + failure_reason: No failures + healthy: true + response_code: 401 + rtt: 12.1ms + properties: + pool_id: + description: Pool ID. + example: 17b5962d775c646f3f9725cbc7a53df4 + type: string + x-auditable: true + pop_health: + description: List of regions and associated health status. properties: - adaptive_routing: - $ref: '#/components/schemas/adaptive_routing' - country_pools: - $ref: '#/components/schemas/country_pools' - default_pools: - $ref: '#/components/schemas/default_pools' - description: - $ref: '#/components/schemas/load-balancer_components-schemas-description' - fallback_pool: - $ref: '#/components/schemas/fallback_pool' - location_strategy: - $ref: '#/components/schemas/location_strategy' - name: - $ref: '#/components/schemas/load-balancer_components-schemas-name' - pop_pools: - $ref: '#/components/schemas/pop_pools' - proxied: - $ref: '#/components/schemas/schemas-proxied' - random_steering: - $ref: '#/components/schemas/random_steering' - region_pools: - $ref: '#/components/schemas/region_pools' - rules: - $ref: '#/components/schemas/load-balancer_components-schemas-rules' - session_affinity: - $ref: '#/components/schemas/session_affinity' - session_affinity_attributes: - $ref: '#/components/schemas/session_affinity_attributes' - session_affinity_ttl: - $ref: '#/components/schemas/session_affinity_ttl' - steering_policy: - $ref: '#/components/schemas/steering_policy' - ttl: - $ref: '#/components/schemas/schemas-ttl' - required: - - name - - default_pools - - fallback_pool - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - description: Create Load Balancer response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/load-balancer_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Load Balancer response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Load Balancer - tags: - - Load Balancers + healthy: + description: Whether health check in region is healthy. + example: true + type: boolean + x-auditable: true + origins: + items: + $ref: '#/components/schemas/loadBalancingOriginHealth' + type: array + type: object + type: object + required: + - success + - errors + - messages + - result + loadBalancingHost: + description: >- + The 'Host' header allows to override the hostname set in the HTTP + request. Current support is 1 'Host' header override per origin. + items: + example: example.com + type: string + x-auditable: true + type: array + loadBalancingIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + type: object + required: + - success + - errors + - messages + - result + loadBalancingIdentifier: + example: f1aba936b94213e5b8dca0c0dbf1f9cc + type: string + x-auditable: true + loadBalancingInterval: + default: 60 + description: >- + The interval between each health check. Shorter intervals may improve + failover time, but will increase load on the origins as we check from + multiple locations. + type: integer + x-auditable: true + loadBalancingLatitude: + description: >- + The latitude of the data center containing the origins used in this pool + in decimal degrees. If this is set, longitude must also be set. + type: number + x-auditable: true + loadBalancingLoadBalancer: + properties: + adaptive_routing: + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' + country_pools: + $ref: '#/components/schemas/loadBalancingCountryPools' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + default_pools: + $ref: '#/components/schemas/loadBalancingDefaultPools' + description: + $ref: '#/components/schemas/loadBalancingComponentsSchemasDescription' + enabled: + $ref: '#/components/schemas/loadBalancingComponentsSchemasEnabled' + fallback_pool: + $ref: '#/components/schemas/loadBalancingFallbackPool' + id: + $ref: >- + #/components/schemas/loadBalancingLoadBalancerComponentsSchemasIdentifier + location_strategy: + $ref: '#/components/schemas/loadBalancingLocationStrategy' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/loadBalancingComponentsSchemasName' + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + pop_pools: + $ref: '#/components/schemas/loadBalancingPopPools' + proxied: + $ref: '#/components/schemas/loadBalancingProxied' + random_steering: + $ref: '#/components/schemas/loadBalancingRandomSteering' + region_pools: + $ref: '#/components/schemas/loadBalancingRegionPools' + rules: + $ref: '#/components/schemas/loadBalancingRules' + session_affinity: + $ref: '#/components/schemas/loadBalancingSessionAffinity' + session_affinity_attributes: + $ref: '#/components/schemas/loadBalancingSessionAffinityAttributes' + session_affinity_ttl: + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' + steering_policy: + $ref: '#/components/schemas/loadBalancingSteeringPolicy' + ttl: + $ref: '#/components/schemas/loadBalancingTtl' + zone_name: + $ref: '#/components/schemas/loadBalancingComponentsSchemasZoneName' + type: object + loadBalancingLoadBalancerComponentsSchemasIdentifier: + example: 699d98642c564d2e855e9661899b7252 + type: string + x-auditable: true + loadBalancingLoadBalancerComponentsSchemasResponseCollection: + required: + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingLoadBalancer' + type: array + loadBalancingLoadBalancerComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/loadBalancingLoadBalancer' + required: + - success + - errors + - messages + - result + loadBalancingLoadShedding: + description: Configures load shedding policies and percentages for the pool. + nullable: true + properties: + default_percent: + default: 0 + description: >- + The percent of traffic to shed from the pool, according to the + default policy. Applies to new sessions and traffic without session + affinity. + maximum: 100 + minimum: 0 + type: number + x-auditable: true + default_policy: + default: random + description: >- + The default policy to use when load shedding. A random policy + randomly sheds a given percent of requests. A hash policy computes a + hash over the CF-Connecting-IP address and sheds all requests + originating from a percent of IPs. + enum: + - random + - hash + type: string + x-auditable: true + session_percent: + default: 0 + description: >- + The percent of existing sessions to shed from the pool, according to + the session policy. + maximum: 100 + minimum: 0 + type: number + x-auditable: true + session_policy: + default: hash + description: >- + Only the hash policy is supported for existing sessions (to avoid + exponential decay). + enum: + - hash + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: computed_optional + loadBalancingLocationStrategy: + description: >- + Controls location-based steering for non-proxied requests. See + `steering_policy` to learn how steering is affected. + properties: + mode: + default: pop + description: >- + Determines the authoritative location when ECS is not preferred, + does not exist in the request, or its GeoIP lookup is unsuccessful. + - `"pop"`: Use the Cloudflare PoP location. - `"resolver_ip"`: Use + the DNS resolver GeoIP location. If the GeoIP lookup is + unsuccessful, use the Cloudflare PoP location. + enum: + - pop + - resolver_ip + example: resolver_ip + type: string + x-auditable: true + prefer_ecs: + default: proximity + description: >- + Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as + the authoritative location. - `"always"`: Always prefer ECS. - + `"never"`: Never prefer ECS. - `"proximity"`: Prefer ECS only when + `steering_policy="proximity"`. - `"geo"`: Prefer ECS only when + `steering_policy="geo"`. + enum: + - always + - never + - proximity + - geo + example: always + type: string + x-auditable: true + type: object + loadBalancingLongitude: + description: >- + The longitude of the data center containing the origins used in this + pool in decimal degrees. If this is set, latitude must also be set. + type: number + x-auditable: true + loadBalancingMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + loadBalancingMethod: + description: >- + The method to use for the health check. This defaults to 'GET' for + HTTP/HTTPS based checks and 'connection_established' for TCP based + health checks. + example: GET + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + loadBalancingMinimumOrigins: + default: 1 + description: >- + The minimum number of origins that must be healthy for this pool to + serve traffic. If the number of healthy origins falls below this number, + the pool will be marked unhealthy and will failover to the next + available pool. + type: integer + x-auditable: true + loadBalancingMonitor: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/loadBalancingIdentifier' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + type: object + loadBalancingMonitorEditable: + properties: + allow_insecure: + $ref: '#/components/schemas/loadBalancingAllowInsecure' + consecutive_down: + $ref: '#/components/schemas/loadBalancingConsecutiveDown' + consecutive_up: + $ref: '#/components/schemas/loadBalancingConsecutiveUp' + description: + $ref: '#/components/schemas/loadBalancingDescription' + expected_body: + $ref: '#/components/schemas/loadBalancingExpectedBody' + expected_codes: + $ref: '#/components/schemas/loadBalancingExpectedCodes' + follow_redirects: + $ref: '#/components/schemas/loadBalancingFollowRedirects' + header: + $ref: '#/components/schemas/loadBalancingHeader' + interval: + $ref: '#/components/schemas/loadBalancingInterval' + method: + $ref: '#/components/schemas/loadBalancingMethod' + path: + $ref: '#/components/schemas/loadBalancingPath' + port: + $ref: '#/components/schemas/loadBalancingPort' + probe_zone: + $ref: '#/components/schemas/loadBalancingProbeZone' + retries: + $ref: '#/components/schemas/loadBalancingRetries' + timeout: + $ref: '#/components/schemas/loadBalancingTimeout' + x-stainless-naming: + python: + method_argument: load_balancer_monitor_timeout + type: + $ref: '#/components/schemas/loadBalancingType' + type: object + loadBalancingMonitorGroup: + properties: + created_at: + description: The timestamp of when the monitor group was created + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + description: + description: A short description of the monitor group + example: Primary datacenter monitors + type: string + id: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + members: + description: List of monitors in this group + items: + $ref: '#/components/schemas/loadBalancingMonitorGroupMember' + type: array + updated_at: + description: The timestamp of when the monitor group was last updated + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + required: + - id + - description + - members + type: object + loadBalancingMonitorGroupId: + description: >- + The ID of the Monitor Group to use for checking the health of origins + within this pool. + type: string + x-auditable: true + loadBalancingMonitorGroupMember: + properties: + created_at: + description: The timestamp of when the monitor was added to the group + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + enabled: + description: Whether this monitor is enabled in the group + example: true + type: boolean + monitor_id: + $ref: '#/components/schemas/loadBalancingMonitorId' + monitoring_only: + description: >- + Whether this monitor is used for monitoring only (does not affect + pool health) + example: false + type: boolean + must_be_healthy: + description: >- + Whether this monitor must be healthy for the pool to be considered + healthy + example: true + type: boolean + updated_at: + description: The timestamp of when the monitor group member was last updated + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + required: + - monitor_id + - enabled + - monitoring_only + - must_be_healthy + type: object + loadBalancingMonitorGroupReferencesResponse: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: List of resources that reference a given monitor group. + example: + - reference_type: referrer + resource_id: 17b5962d775c646f3f9725cbc7a53df4 + resource_name: primary-dc-1 + resource_type: pool + items: + $ref: >- + #/components/schemas/loadBalancingMonitorGroupReferencesResponse_result_item + type: array + required: + - success + - errors + - messages + - result + type: object + loadBalancingMonitorGroupReferencesResponse_result_item: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + loadBalancingMonitorGroupResponseCollection: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/loadBalancingMonitorGroup' + type: array + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + required: + - success + - errors + - messages + - result + type: object + loadBalancingMonitorGroupSingleResponse: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/loadBalancingMonitorGroup' + required: + - success + - errors + - messages + - result + type: object + loadBalancingMonitorId: + description: >- + The ID of the Monitor to use for checking the health of origins within + this pool. + type: string + x-auditable: true + loadBalancingMonitorReferencesResponse: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: List of resources that reference a given monitor. + example: + - reference_type: referrer + resource_id: 17b5962d775c646f3f9725cbc7a53df4 + resource_name: primary-dc-1 + resource_type: pool + items: + $ref: >- + #/components/schemas/loadBalancingMonitorReferencesResponse_result_item + type: array + required: + - success + - errors + - messages + - result + type: object + loadBalancingMonitorReferencesResponse_result_item: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + loadBalancingMonitorResponseCollection: + required: + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingMonitor' + type: array + loadBalancingMonitorResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/loadBalancingMonitor' + required: + - success + - errors + - messages + - result + loadBalancingName: + description: >- + A short name (tag) for the pool. Only alphanumeric characters, hyphens, + and underscores are allowed. + example: primary-dc-1 + type: string + x-auditable: true + loadBalancingNetworks: + description: List of networks where Load Balancer or Pool is enabled. + items: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: array + loadBalancingNotificationEmail: + default: '' + description: >- + This field is now deprecated. It has been moved to Cloudflare's + Centralized Notification service + https://developers.cloudflare.com/fundamentals/notifications/. The email + address to send health status notifications to. This can be an + individual mailbox or a mailing list. Multiple emails can be supplied as + a comma delimited list. + example: someone@example.com,sometwo@example.com + type: string + x-auditable: true + loadBalancingNotificationFilter: + description: >- + Filter pool and origin health notifications by resource type or health + status. Use null to reset. + example: + origin: + disable: true + pool: + healthy: false + nullable: true + properties: + origin: + $ref: '#/components/schemas/loadBalancingFilterOptions' + pool: + $ref: '#/components/schemas/loadBalancingFilterOptions' + type: object + x-stainless-terraform-configurability: computed_optional + loadBalancingOrigin: + properties: + address: + $ref: '#/components/schemas/loadBalancingAddress' + disabled_at: + $ref: '#/components/schemas/loadBalancingDisabledAt' + readOnly: true + enabled: + $ref: '#/components/schemas/loadBalancingSchemasEnabled' + flatten_cname: + $ref: '#/components/schemas/loadBalancingOriginFlattenCname' + header: + $ref: '#/components/schemas/loadBalancingSchemasHeader' + name: + $ref: '#/components/schemas/loadBalancingSchemasName' + port: + $ref: '#/components/schemas/loadBalancingOriginPort' + virtual_network_id: + $ref: '#/components/schemas/loadBalancingVirtualNetworkId' + weight: + $ref: '#/components/schemas/loadBalancingWeight' + type: object + loadBalancingOriginFlattenCname: + default: true + description: >- + Whether to flatten CNAME records for this origin, resolving them to + A/AAAA records before returning to the client. When true (the default), + the director resolves CNAME addresses to their underlying A/AAAA + records. When false, the origin address is returned as a raw CNAME + record without resolution. This setting mirrors the DNS API record + flatten_cname setting. + type: boolean + loadBalancingOriginHealth: + properties: + ip: + properties: + failure_reason: + description: Failure reason. + example: No failure reasons + type: string + x-auditable: true + healthy: + description: Origin health status. + example: true + type: boolean + x-auditable: true + response_code: + description: Response code from origin health check. + example: 200 + type: number + x-auditable: true + rtt: + description: Origin RTT (Round Trip Time) response. + example: 201.5ms + type: string + x-auditable: true + type: object + type: object + loadBalancingOriginPort: + default: 0 + description: >- + The port for upstream connections. A value of 0 means the default port + for the protocol will be used. + type: integer + loadBalancingOriginSteering: + description: >- + Configures origin steering for the pool. Controls how origins are + selected for new sessions and traffic without session affinity. + nullable: true + properties: + policy: + default: random + description: >- + The type of origin steering policy to use. - `"random"`: Select an + origin randomly. - `"hash"`: Select an origin by computing a hash + over the CF-Connecting-IP address. - `"least_outstanding_requests"`: + Select an origin by taking into consideration origin weights, as + well as each origin's number of outstanding requests. Origins with + more pending requests are weighted proportionately less relative to + others. - `"least_connections"`: Select an origin by taking into + consideration origin weights, as well as each origin's number of + open connections. Origins with more open connections are weighted + proportionately less relative to others. Supported for HTTP/1 and + HTTP/2 connections. + enum: + - random + - hash + - least_outstanding_requests + - least_connections + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: computed_optional + loadBalancingOrigins: + description: >- + The list of origins within this pool. Traffic directed at this pool is + balanced across all currently healthy origins, provided the pool itself + is healthy. + items: + $ref: '#/components/schemas/loadBalancingOrigin' + type: array + x-stainless-collection-type: set + loadBalancingPatchPoolsNotificationEmail: + description: >- + The email address to send health status notifications to. This field is + now deprecated in favor of Cloudflare Notifications for Load Balancing, + so only resetting this field with an empty string `""` is accepted. + enum: + - '' + example: '' + type: string + loadBalancingPath: + description: >- + The endpoint path you want to conduct a health check against. This + parameter is only valid for HTTP and HTTPS monitors. + example: /health + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + loadBalancingPool: + properties: + check_regions: + $ref: '#/components/schemas/loadBalancingCheckRegions' + created_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/loadBalancingSchemasDescription' + disabled_at: + $ref: '#/components/schemas/loadBalancingSchemasDisabledAt' + readOnly: true + enabled: + $ref: '#/components/schemas/loadBalancingEnabled' + id: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + latitude: + $ref: '#/components/schemas/loadBalancingLatitude' + load_shedding: + $ref: '#/components/schemas/loadBalancingLoadShedding' + longitude: + $ref: '#/components/schemas/loadBalancingLongitude' + minimum_origins: + $ref: '#/components/schemas/loadBalancingMinimumOrigins' + modified_on: + $ref: '#/components/schemas/loadBalancingTimestamp' + readOnly: true + monitor: + $ref: '#/components/schemas/loadBalancingMonitorId' + monitor_group: + $ref: '#/components/schemas/loadBalancingMonitorGroupId' + name: + $ref: '#/components/schemas/loadBalancingName' + networks: + $ref: '#/components/schemas/loadBalancingNetworks' + notification_email: + $ref: '#/components/schemas/loadBalancingNotificationEmail' + notification_filter: + $ref: '#/components/schemas/loadBalancingNotificationFilter' + origin_steering: + $ref: '#/components/schemas/loadBalancingOriginSteering' + origins: + $ref: '#/components/schemas/loadBalancingOrigins' + type: object + loadBalancingPoolsReferencesResponse: + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: List of resources that reference a given pool. + example: + - reference_type: referrer + resource_id: 699d98642c564d2e855e9661899b7252 + resource_name: www.example.com + resource_type: load_balancer + - reference_type: referral + resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc + resource_name: Login page monitor + resource_type: monitor + items: + $ref: >- + #/components/schemas/loadBalancingPoolsReferencesResponse_result_item + type: array + required: + - success + - errors + - messages + - result + type: object + loadBalancingPoolsReferencesResponse_result_item: + properties: + reference_type: + enum: + - '*' + - referral + - referrer + type: string + x-auditable: true + resource_id: + type: string + x-auditable: true + resource_name: + type: string + x-auditable: true + resource_type: + type: string + x-auditable: true + type: object + loadBalancingPopPools: + description: >- + Enterprise only: A mapping of Cloudflare PoP identifiers to a list of + pool IDs (ordered by their failover priority) for the PoP (datacenter). + Any PoPs not explicitly defined will fall back to using the + corresponding country_pool, then region_pool mapping if it exists else + to default_pools. + example: + LAX: + - de90f38ced07c2e2f4df50b1f61d4194 + - 9290f38c5d07c2e2f4df57b1f61d4196 + LHR: + - abd90f38ced07c2e2f4df50b1f61d4194 + - f9138c5d07c2e2f4df57b1f61d4196 + SJC: + - 00920f38ce07c2e2f4df50b1f61d4194 + type: object + loadBalancingPort: + description: >- + The port number to connect to for the health check. Required for TCP, + UDP, and SMTP checks. HTTP and HTTPS checks should only define the port + when using a non-standard port (HTTP: default 80, HTTPS: default 443). + nullable: true + type: integer + x-auditable: true + x-stainless-terraform-configurability: optional + loadBalancingPreviewId: + example: f1aba936b94213e5b8dca0c0dbf1f9cc + type: string + loadBalancingPreviewResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + pools: + description: Monitored pool IDs mapped to their respective names. + example: + abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter + ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter + type: object + preview_id: + $ref: '#/components/schemas/loadBalancingIdentifier' + type: object + required: + - success + - errors + - messages + - result + loadBalancingPreviewResult: + description: Resulting health data from a preview operation. + example: + abwlnp5jbqn45ecgxd03erbgtxtqai0d: + healthy: true + origins: + - originone.example.com.: + failure_reason: No failures + healthy: true + response_code: 200 + rtt: 66ms + type: object + loadBalancingPreviewResultResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/loadBalancingPreviewResult' + required: + - success + - errors + - messages + - result + loadBalancingProbeZone: + default: '' + description: >- + Assign this monitor to emulate the specified zone while probing. This + parameter is only valid for HTTP and HTTPS monitors. + example: example.com + type: string + x-auditable: true + loadBalancingProxied: + default: false + description: >- + Whether the hostname should be gray clouded (false) or orange clouded + (true). + example: true + type: boolean + x-auditable: true + loadBalancingRandomSteering: + description: >- + Configures pool weights. - `steering_policy="random"`: A random pool is + selected with probability proportional to pool weights. - + `steering_policy="least_outstanding_requests"`: Use pool weights to + scale each pool's outstanding requests. - + `steering_policy="least_connections"`: Use pool weights to scale each + pool's open connections. + properties: + default_weight: + default: 1 + description: >- + The default weight for pools in the load balancer that are not + specified in the pool_weights map. + example: 0.2 + maximum: 1 + minimum: 0 + multipleOf: 0.1 + type: number + x-auditable: true + pool_weights: + description: >- + A mapping of pool IDs to custom weights. The weight is relative to + other pools in the load balancer. + example: + 9290f38c5d07c2e2f4df57b1f61d4196: 0.5 + de90f38ced07c2e2f4df50b1f61d4194: 0.3 + type: object + type: object + loadBalancingRegionCode: + description: >- + A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern + North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern + South America, SSAM: Southern South America, OC: Oceania, ME: Middle + East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: + South East Asia, NEAS: North East Asia). + enum: + - WNAM + - ENAM + - WEU + - EEU + - NSAM + - SSAM + - OC + - ME + - NAF + - SAF + - SAS + - SEAS + - NEAS + example: WNAM + type: string + loadBalancingRegionComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + - result + loadBalancingRegionPools: + description: >- + A mapping of region codes to a list of pool IDs (ordered by their + failover priority) for the given region. Any regions not explicitly + defined will fall back to using default_pools. + example: + ENAM: + - 00920f38ce07c2e2f4df50b1f61d4194 + WNAM: + - de90f38ced07c2e2f4df50b1f61d4194 + - 9290f38c5d07c2e2f4df57b1f61d4196 + type: object + loadBalancingResourceReference: + description: A reference to a load balancer resource. + properties: + reference_type: + description: When listed as a reference, the type (direction) of the reference. + enum: + - referral + - referrer + type: string + x-auditable: true + references: + description: A list of references to (referrer) or from (referral) this resource. + example: + - reference_type: referrer + resource_id: 699d98642c564d2e855e9661899b7252 + resource_name: www.example.com + resource_type: load_balancer + - reference_type: referral + resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc + resource_name: Login page monitor + resource_type: monitor + items: + description: A reference to a load balancer resource. + type: object + type: array + resource_id: + example: 17b5962d775c646f3f9725cbc7a53df4 + type: string + resource_name: + description: The human-identifiable name of the resource. + example: primary-dc-1 + type: string + x-auditable: true + resource_type: + description: The type of the resource. + enum: + - load_balancer + - monitor + - pool + example: pool + type: string + x-auditable: true + type: object + loadBalancingResultInfo: + properties: + count: + description: Total number of results on the current page. + example: 20 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: Total number of pages available. + example: 100 + type: number + type: object + loadBalancingRetries: + default: 2 + description: >- + The number of retries to attempt in case of a timeout before marking the + origin as unhealthy. Retries are attempted immediately. + type: integer + x-auditable: true + loadBalancingRules: + description: >- + BETA Field Not General Access: A list of rules for this load balancer to + execute. + items: + description: >- + A rule object containing conditions and overrides for this load + balancer to evaluate. + properties: + condition: + description: >- + The condition expressions to evaluate. If the condition evaluates + to true, the overrides or fixed_response in this rule will be + applied. An empty condition is always true. For more details on + condition expressions, please see + https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions. + example: http.request.uri.path contains "/testing" + type: string + x-auditable: true + disabled: + default: false + description: >- + Disable this specific rule. It will no longer be evaluated by this + load balancer. + type: boolean + x-auditable: true + fixed_response: + description: >- + A collection of fields used to directly respond to the eyeball + instead of routing to a pool. If a fixed_response is supplied the + rule will be marked as terminates. + properties: + content_type: + description: The http 'Content-Type' header to include in the response. + example: application/json + maxLength: 32 + type: string + x-auditable: true + location: + description: The http 'Location' header to include in the response. + example: www.example.com + maxLength: 2048 + type: string + x-auditable: true + message_body: + description: Text to include as the http body. + example: Testing Hello + maxLength: 1024 + type: string + x-auditable: true + status_code: + description: The http status code to respond with. + type: integer + x-auditable: true + type: object + name: + description: Name of this rule. Only used for human readability. + example: route the path /testing to testing datacenter. + maxLength: 200 + type: string + x-auditable: true + overrides: + description: >- + A collection of overrides to apply to the load balancer when this + rule's condition is true. All fields are optional. + properties: + adaptive_routing: + $ref: '#/components/schemas/loadBalancingAdaptiveRouting' + country_pools: + $ref: '#/components/schemas/loadBalancingCountryPools' + default_pools: + $ref: '#/components/schemas/loadBalancingDefaultPools' + fallback_pool: + $ref: '#/components/schemas/loadBalancingFallbackPool' + location_strategy: + $ref: '#/components/schemas/loadBalancingLocationStrategy' + pop_pools: + $ref: '#/components/schemas/loadBalancingPopPools' + random_steering: + $ref: '#/components/schemas/loadBalancingRandomSteering' + region_pools: + $ref: '#/components/schemas/loadBalancingRegionPools' + session_affinity: + $ref: '#/components/schemas/loadBalancingSessionAffinity' + session_affinity_attributes: + $ref: '#/components/schemas/loadBalancingSessionAffinityAttributes' + session_affinity_ttl: + $ref: '#/components/schemas/loadBalancingSessionAffinityTtl' + steering_policy: + $ref: '#/components/schemas/loadBalancingSteeringPolicy' + ttl: + $ref: '#/components/schemas/loadBalancingTtl' + type: object + priority: + default: 0 + description: >- + The order in which rules should be executed in relation to each + other. Lower values are executed first. Values do not need to be + sequential. If no value is provided for any rule the array order + of the rules field will be used to assign a priority. + minimum: 0 + type: integer + x-auditable: true + terminates: + description: >- + If this rule's condition is true, this causes rule evaluation to + stop after processing this rule. + type: boolean + x-auditable: true + type: object + type: array + loadBalancingSchemasDescription: + default: '' + description: A human-readable description of the pool. + example: Primary data center - Provider XYZ + type: string + x-auditable: true + loadBalancingSchemasDisabledAt: + description: >- + This field shows up only if the pool is disabled. This field is set with + the time the pool was disabled at. + format: date-time + readOnly: true + type: string + x-auditable: true + loadBalancingSchemasEnabled: + default: true + description: >- + Whether to enable (the default) this origin within the pool. Disabled + origins will not receive traffic and are excluded from health checks. + The origin will only be disabled for the current pool. + example: true + type: boolean + x-auditable: true + loadBalancingSchemasHeader: + description: >- + The request header is used to pass additional information with an HTTP + request. Currently supported header is 'Host'. + properties: + Host: + $ref: '#/components/schemas/loadBalancingHost' + type: object + loadBalancingSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + type: object + required: + - success + - errors + - messages + - result + loadBalancingSchemasIdentifier: + example: 17b5962d775c646f3f9725cbc7a53df4 + type: string + x-auditable: true + loadBalancingSchemasName: + description: A human-identifiable name for the origin. + example: app-server-1 + type: string + x-auditable: true + loadBalancingSchemasPreviewId: + example: p1aba936b94213e5b8dca0c0dbf1f9cc + type: string + loadBalancingSchemasResponseCollection: + required: + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingPool' + type: array + loadBalancingSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/loadBalancingPool' + required: + - success + - errors + - messages + - result + loadBalancingSearch: + properties: + resources: + description: A list of resources matching the search query. + items: + $ref: '#/components/schemas/loadBalancingResourceReference' + type: array + type: object + loadBalancingSessionAffinity: + default: none + description: >- + Specifies the type of session affinity the load balancer should use + unless specified as `"none"`. The supported types are: - `"cookie"`: On + the first request to a proxied load balancer, a cookie is generated, + encoding information of which origin the request will be forwarded to. + Subsequent requests, by the same client to the same load balancer, will + be sent to the origin server the cookie encodes, for the duration of the + cookie and as long as the origin server remains healthy. If the cookie + has expired or the origin server is unhealthy, then a new origin server + is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` + except the initial origin selection is stable and based on the client's + ip address. - `"header"`: On the first request to a proxied load + balancer, a session key based on the configured HTTP headers (see + `session_affinity_attributes.headers`) is generated, encoding the + request headers used for storing in the load balancer session state + which origin the request will be forwarded to. Subsequent requests to + the load balancer with the same headers will be sent to the same origin + server, for the duration of the session and as long as the origin server + remains healthy. If the session has been idle for the duration of + `session_affinity_ttl` seconds or the origin server is unhealthy, then a + new origin server is calculated and used. See `headers` in + `session_affinity_attributes` for additional required configuration. + enum: + - none + - cookie + - ip_cookie + - header + example: cookie + type: string + x-auditable: true + loadBalancingSessionAffinityAttributes: + description: Configures attributes for session affinity. + properties: + drain_duration: + description: >- + Configures the drain duration in seconds. This field is only used + when session affinity is enabled on the load balancer. + example: 100 + type: number + x-auditable: true + headers: + description: >- + Configures the names of HTTP headers to base session affinity on + when header `session_affinity` is enabled. At least one HTTP header + name must be provided. To specify the exact cookies to be used, + include an item in the following format: + `"cookie:,"` (example) where + everything after the colon is a comma-separated list of cookie + names. Providing only `"cookie"` will result in all cookies being + used. The default max number of HTTP header names that can be + provided depends on your plan: 5 for Enterprise, 1 for all other + plans. + items: + description: An HTTP header name. + maxLength: 100 + minLength: 1 + type: string + x-auditable: true + type: array + uniqueItems: true + require_all_headers: + default: false + description: >- + When header `session_affinity` is enabled, this option can be used + to specify how HTTP headers on load balancing requests will be used. + The supported values are: - `"true"`: Load balancing requests must + contain *all* of the HTTP headers specified by the `headers` session + affinity attribute, otherwise sessions aren't created. - `"false"`: + Load balancing requests must contain *at least one* of the HTTP + headers specified by the `headers` session affinity attribute, + otherwise sessions aren't created. + type: boolean + x-auditable: true + samesite: + default: Auto + description: >- + Configures the SameSite attribute on session affinity cookie. Value + "Auto" will be translated to "Lax" or "None" depending if Always Use + HTTPS is enabled. Note: when using value "None", the secure + attribute can not be set to "Never". + enum: + - Auto + - Lax + - None + - Strict + example: Auto + type: string + x-auditable: true + secure: + default: Auto + description: >- + Configures the Secure attribute on session affinity cookie. Value + "Always" indicates the Secure attribute will be set in the + Set-Cookie header, "Never" indicates the Secure attribute will not + be set, and "Auto" will set the Secure attribute depending if Always + Use HTTPS is enabled. + enum: + - Auto + - Always + - Never + example: Auto + type: string + x-auditable: true + zero_downtime_failover: + default: none + description: >- + Configures the zero-downtime failover between origins within a pool + when session affinity is enabled. This feature is currently + incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The + supported values are: - `"none"`: No failover takes place for + sessions pinned to the origin (default). - `"temporary"`: Traffic + will be sent to another other healthy origin until the originally + pinned origin is available; note that this can potentially result in + heavy origin flapping. - `"sticky"`: The session affinity cookie is + updated and subsequent requests are sent to the new origin. Note: + Zero-downtime failover with sticky sessions is currently not + supported for session affinity by header. + enum: + - none + - temporary + - sticky + example: sticky + type: string + x-auditable: true + type: object + loadBalancingSessionAffinityTtl: + description: >- + Time, in seconds, until a client's session expires after being created. + Once the expiry time has been reached, subsequent requests may get sent + to a different origin server. The accepted ranges per `session_affinity` + policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 + hours will be used unless explicitly set. The accepted range of values + is between [1800, 604800]. - `"header"`: The current default of 1800 + seconds will be used unless explicitly set. The accepted range of values + is between [30, 3600]. Note: With session affinity by header, sessions + only expire after they haven't been used for the number of seconds + specified. + example: 1800 + type: number + x-auditable: true + loadBalancingSteeringPolicy: + default: '' + description: >- + Steering Policy for this load balancer. - `"off"`: Use `default_pools`. + - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For + non-proxied requests, the country for `country_pools` is determined by + `location_strategy`. - `"random"`: Select a pool randomly. - + `"dynamic_latency"`: Use round trip time to select the closest pool in + default_pools (requires pool health checks). - `"proximity"`: Use the + pools' latitude and longitude to select the closest pool using the + Cloudflare PoP location for proxied requests or the location determined + by `location_strategy` for non-proxied requests. - + `"least_outstanding_requests"`: Select a pool by taking into + consideration `random_steering` weights, as well as each pool's number + of outstanding requests. Pools with more pending requests are weighted + proportionately less relative to others. - `"least_connections"`: Select + a pool by taking into consideration `random_steering` weights, as well + as each pool's number of open connections. Pools with more open + connections are weighted proportionately less relative to others. + Supported for HTTP/1 and HTTP/2 connections. - `""`: Will map to `"geo"` + if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`. + enum: + - 'off' + - geo + - random + - dynamic_latency + - proximity + - least_outstanding_requests + - least_connections + - '' + example: dynamic_latency + type: string + x-auditable: true + loadBalancingSubdivisionCodeA2: + description: Two-letter subdivision code followed in ISO 3166-2. + example: CA + type: string + x-auditable: true + loadBalancingTimeout: + default: 5 + description: The timeout (in seconds) before marking the health check as failed. + type: integer + x-auditable: true + loadBalancingTimestamp: + example: '2014-01-01T05:20:00.12345Z' + readOnly: true + type: string + x-auditable: true + loadBalancingTtl: + description: >- + Time to live (TTL) of the DNS entry for the IP address returned by this + load balancer. This only applies to gray-clouded (unproxied) load + balancers. + example: 30 + type: number + x-auditable: true + loadBalancingType: + default: http + description: >- + The protocol to use for the health check. Currently supported protocols + are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. + enum: + - http + - https + - tcp + - udp_icmp + - icmp_ping + - smtp + example: https + type: string + x-auditable: true + loadBalancingVirtualNetworkId: + description: >- + The virtual network subnet ID the origin belongs in. Virtual network + must also belong to the account. + example: a5624d4e-044a-4ff0-b3e1-e2465353d4b4 + type: string + loadBalancingWeight: + default: 1 + description: >- + The weight of this origin relative to other origins in the pool. Based + on the configured weight the total traffic is distributed among origins + within the pool. - + `origin_steering.policy="least_outstanding_requests"`: Use weight to + scale the origin's outstanding requests. - + `origin_steering.policy="least_connections"`: Use weight to scale the + origin's open connections. + example: 0.6 + maximum: 1 + minimum: 0 + multipleOf: 0.01 + type: number + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef025497b7e63379c31929636b5186e45c: + properties: + pools: + description: Monitored pool IDs mapped to their respective names. + example: + abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter + ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter + type: object + preview_id: + $ref: '#/components/schemas/loadBalancingIdentifier' + type: object + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + monitor_groups: + id: cloudflare.load_balancers.monitor_groups + name: monitor_groups + title: Monitor Groups + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitor_groups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitor_groups/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitor_groups~1{monitor_group_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitor_groups~1{monitor_group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitor_groups~1{monitor_group_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitor_groups~1{monitor_group_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/monitor_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/monitor_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/monitor_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/monitor_groups/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/monitor_groups/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/monitor_groups/methods/update' + monitor_groups_references: + id: cloudflare.load_balancers.monitor_groups_references + name: monitor_groups_references + title: Monitor Groups References + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitor_groups~1{monitor_group_id}~1references/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/monitor_groups_references/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + monitors: + id: cloudflare.load_balancers.monitors + name: monitors + title: Monitors + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1load_balancers~1monitors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1load_balancers~1monitors/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitors~1{monitor_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitors~1{monitor_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitors~1{monitor_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitors~1{monitor_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_user: + operation: + $ref: '#/paths/~1user~1load_balancers~1monitors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + load_balancer_monitors_create_monitor: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1monitors/post' + response: + mediaType: application/json + openAPIDocKey: '200' + load_balancer_monitors_delete_monitor: + operation: + $ref: '#/paths/~1user~1load_balancers~1monitors~1{monitor_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_user: + operation: + $ref: '#/paths/~1user~1load_balancers~1monitors~1{monitor_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + load_balancer_monitors_patch_monitor: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1monitors~1{monitor_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + load_balancer_monitors_update_monitor: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1monitors~1{monitor_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/monitors/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/monitors/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/monitors/methods/get_by_user' + - $ref: '#/components/x-stackQL-resources/monitors/methods/list_by_user' + insert: + - $ref: '#/components/x-stackQL-resources/monitors/methods/create' + - $ref: >- + #/components/x-stackQL-resources/monitors/methods/load_balancer_monitors_create_monitor + update: + - $ref: '#/components/x-stackQL-resources/monitors/methods/edit' + - $ref: >- + #/components/x-stackQL-resources/monitors/methods/load_balancer_monitors_patch_monitor + delete: + - $ref: '#/components/x-stackQL-resources/monitors/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/monitors/methods/load_balancer_monitors_delete_monitor + replace: + - $ref: '#/components/x-stackQL-resources/monitors/methods/update' + - $ref: >- + #/components/x-stackQL-resources/monitors/methods/load_balancer_monitors_update_monitor + previews: + id: cloudflare.load_balancers.previews + name: previews + title: Previews + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitors~1{monitor_id}~1preview/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1preview~1{preview_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/previews/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/previews/methods/create' + update: [] + delete: [] + replace: [] + monitors_references: + id: cloudflare.load_balancers.monitors_references + name: monitors_references + title: Monitors References + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1monitors~1{monitor_id}~1references/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_user: + operation: + $ref: >- + #/paths/~1user~1load_balancers~1monitors~1{monitor_id}~1references/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/monitors_references/methods/list_by_account + - $ref: >- + #/components/x-stackQL-resources/monitors_references/methods/list_by_user + insert: [] + update: [] + delete: [] + replace: [] + pools: + id: cloudflare.load_balancers.pools + name: pools + title: Pools + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1load_balancers~1pools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + account_load_balancer_pools_patch_pools: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1load_balancers~1pools/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1load_balancers~1pools/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1pools~1{pool_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1pools~1{pool_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1pools~1{pool_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1pools~1{pool_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_user: + operation: + $ref: '#/paths/~1user~1load_balancers~1pools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + load_balancer_pools_patch_pools: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1pools/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + load_balancer_pools_create_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1pools/post' + response: + mediaType: application/json + openAPIDocKey: '200' + load_balancer_pools_delete_pool: + operation: + $ref: '#/paths/~1user~1load_balancers~1pools~1{pool_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_user: + operation: + $ref: '#/paths/~1user~1load_balancers~1pools~1{pool_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + load_balancer_pools_patch_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1pools~1{pool_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + load_balancer_pools_update_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1pools~1{pool_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pools/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/pools/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/pools/methods/get_by_user' + - $ref: '#/components/x-stackQL-resources/pools/methods/list_by_user' + insert: + - $ref: '#/components/x-stackQL-resources/pools/methods/create' + - $ref: >- + #/components/x-stackQL-resources/pools/methods/load_balancer_pools_create_pool + update: + - $ref: '#/components/x-stackQL-resources/pools/methods/edit' + - $ref: >- + #/components/x-stackQL-resources/pools/methods/account_load_balancer_pools_patch_pools + - $ref: >- + #/components/x-stackQL-resources/pools/methods/load_balancer_pools_patch_pool + - $ref: >- + #/components/x-stackQL-resources/pools/methods/load_balancer_pools_patch_pools + delete: + - $ref: '#/components/x-stackQL-resources/pools/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/pools/methods/load_balancer_pools_delete_pool + replace: + - $ref: '#/components/x-stackQL-resources/pools/methods/update' + - $ref: >- + #/components/x-stackQL-resources/pools/methods/load_balancer_pools_update_pool + health: + id: cloudflare.load_balancers.health + name: health + title: Health + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1pools~1{pool_id}~1health/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1pools~1{pool_id}~1preview/post + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_user: + operation: + $ref: '#/paths/~1user~1load_balancers~1pools~1{pool_id}~1health/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/health/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/health/methods/list_by_user' + insert: + - $ref: '#/components/x-stackQL-resources/health/methods/create' + update: [] + delete: [] + replace: [] + pools_references: + id: cloudflare.load_balancers.pools_references + name: pools_references + title: Pools References + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1pools~1{pool_id}~1references/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_user: + operation: + $ref: '#/paths/~1user~1load_balancers~1pools~1{pool_id}~1references/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pools_references/methods/list_by_account + - $ref: >- + #/components/x-stackQL-resources/pools_references/methods/list_by_user + insert: [] + update: [] + delete: [] + replace: [] + regions: + id: cloudflare.load_balancers.regions + name: regions + title: Regions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1load_balancers~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1load_balancers~1regions~1{region_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/regions/methods/get' + - $ref: '#/components/x-stackQL-resources/regions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + searches: + id: cloudflare.load_balancers.searches + name: searches + title: Searches + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1load_balancers~1search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.resources + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/searches/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + preview: + id: cloudflare.load_balancers.preview + name: preview + title: Preview + methods: + load_balancer_monitors_preview_monitor: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1user~1load_balancers~1monitors~1{monitor_id}~1preview/post + response: + mediaType: application/json + openAPIDocKey: '200' + load_balancer_pools_preview_pool: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1load_balancers~1pools~1{pool_id}~1preview/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1user~1load_balancers~1preview~1{preview_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/preview/methods/get' + insert: + - $ref: >- + #/components/x-stackQL-resources/preview/methods/load_balancer_monitors_preview_monitor + - $ref: >- + #/components/x-stackQL-resources/preview/methods/load_balancer_pools_preview_pool + update: [] + delete: [] + replace: [] + load_balancers: + id: cloudflare.load_balancers.load_balancers + name: load_balancers + title: Load Balancers + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1load_balancers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1load_balancers/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1load_balancers~1{load_balancer_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1load_balancers~1{load_balancer_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1load_balancers~1{load_balancer_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1load_balancers~1{load_balancer_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/get' + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/logpush.yaml b/providers/src/cloudflare/v00.00.00000/services/logpush.yaml new file mode 100644 index 00000000..a1bb11f7 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/logpush.yaml @@ -0,0 +1,2680 @@ +openapi: 3.0.3 +info: + title: logpush API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/logpush/edge/jobs: + get: + description: Lists Instant Logs jobs for a zone. + operationId: get-zones-zone_id-logpush-edge-jobs + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushInstantLogsJobResponseCollection' + description: List Instant Logs jobs response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/logpushInstantLogsJob' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: List Instant Logs jobs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Instant Logs jobs + tags: + - Instant Logs jobs for a zone + x-api-token-group: + - Logs Read + x-cfPermissionsRequired: + enum: + - '#logs:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - edge + method: get + post: + description: Creates a new Instant Logs job for a zone. + operationId: post-zones-zone_id-logpush-edge-jobs + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + fields: + $ref: '#/components/schemas/logpushFields' + filter: + $ref: '#/components/schemas/logpushSchemasFilter' + sample: + $ref: '#/components/schemas/logpushSample' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushInstantLogsJobResponseSingle' + description: Create Instant Logs job response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + nullable: true + properties: + destination_conf: + $ref: '#/components/schemas/logpushSchemasDestinationConf' + fields: + $ref: '#/components/schemas/logpushFields' + filter: + $ref: '#/components/schemas/logpushSchemasFilter' + sample: + $ref: '#/components/schemas/logpushSample' + session_id: + $ref: '#/components/schemas/logpushSessionId' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Instant Logs job response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Instant Logs job + tags: + - Instant Logs jobs for a zone + x-api-token-group: + - Logs Read + x-cfPermissionsRequired: + enum: + - '#logs:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - edge + method: create + /accounts/{account_id}/logpush/datasets/{dataset_id}/fields: + get: + description: >- + Lists all fields available for a dataset. The response result is. an + object with key-value pairs, where keys are field names, and values are + descriptions. + parameters: + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushFieldResponseCollection' + description: List fields response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: List fields response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List fields + tags: [] + x-api-token-group: + - Logs Read + x-cfPermissionsRequired: + enum: + - '#logs:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - datasets + - fields + method: get + operationId: get_accounts_account_id_logpush_datasets_dataset_id_fields + /zones/{zone_id}/logpush/datasets/{dataset_id}/fields: + get: + description: >- + Lists all fields available for a dataset. The response result is. an + object with key-value pairs, where keys are field names, and values are + descriptions. + parameters: + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushFieldResponseCollection' + description: List fields response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: List fields response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List fields + tags: [] + x-api-token-group: + - Logs Read + x-cfPermissionsRequired: + enum: + - '#logs:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - datasets + - fields + method: get + operationId: get_zones_zone_id_logpush_datasets_dataset_id_fields + /accounts/{account_id}/logpush/datasets/{dataset_id}/jobs: + get: + description: Lists Logpush jobs for an account or zone for a dataset. + parameters: + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseCollection' + description: List Logpush jobs for a dataset response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: List Logpush jobs for a dataset response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Logpush jobs for a dataset + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - datasets + - jobs + method: get + operationId: get_accounts_account_id_logpush_datasets_dataset_id_jobs + /zones/{zone_id}/logpush/datasets/{dataset_id}/jobs: + get: + description: Lists Logpush jobs for an account or zone for a dataset. + parameters: + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseCollection' + description: List Logpush jobs for a dataset response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: List Logpush jobs for a dataset response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Logpush jobs for a dataset + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - datasets + - jobs + method: get + operationId: get_zones_zone_id_logpush_datasets_dataset_id_jobs + /accounts/{account_id}/logpush/jobs: + get: + description: Lists Logpush jobs for an account or zone. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseCollection' + description: List Logpush jobs response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: List Logpush jobs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Logpush jobs + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: list + operationId: get_accounts_account_id_logpush_jobs + post: + description: Creates a new Logpush job for an account or zone. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + dataset: + $ref: '#/components/schemas/logpushDataset' + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + enabled: + $ref: '#/components/schemas/logpushEnabled' + filter: + $ref: '#/components/schemas/logpushFilter' + frequency: + $ref: '#/components/schemas/logpushFrequency' + kind: + $ref: '#/components/schemas/logpushKind' + logpull_options: + $ref: '#/components/schemas/logpushLogpullOptions' + max_upload_bytes: + $ref: '#/components/schemas/logpushMaxUploadBytes' + max_upload_interval_seconds: + $ref: '#/components/schemas/logpushMaxUploadIntervalSeconds' + max_upload_records: + $ref: '#/components/schemas/logpushMaxUploadRecords' + name: + $ref: '#/components/schemas/logpushName' + output_options: + $ref: '#/components/schemas/logpushOutputOptions' + ownership_challenge: + $ref: '#/components/schemas/logpushOwnershipChallenge' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseSingle' + description: Create Logpush job response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Create Logpush job response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Logpush job + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: create + operationId: post_accounts_account_id_logpush_jobs + /zones/{zone_id}/logpush/jobs: + get: + description: Lists Logpush jobs for an account or zone. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseCollection' + description: List Logpush jobs response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: List Logpush jobs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Logpush jobs + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: list + operationId: get_zones_zone_id_logpush_jobs + post: + description: Creates a new Logpush job for an account or zone. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + dataset: + $ref: '#/components/schemas/logpushDataset' + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + enabled: + $ref: '#/components/schemas/logpushEnabled' + filter: + $ref: '#/components/schemas/logpushFilter' + frequency: + $ref: '#/components/schemas/logpushFrequency' + kind: + $ref: '#/components/schemas/logpushKind' + logpull_options: + $ref: '#/components/schemas/logpushLogpullOptions' + max_upload_bytes: + $ref: '#/components/schemas/logpushMaxUploadBytes' + max_upload_interval_seconds: + $ref: '#/components/schemas/logpushMaxUploadIntervalSeconds' + max_upload_records: + $ref: '#/components/schemas/logpushMaxUploadRecords' + name: + $ref: '#/components/schemas/logpushName' + output_options: + $ref: '#/components/schemas/logpushOutputOptions' + ownership_challenge: + $ref: '#/components/schemas/logpushOwnershipChallenge' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseSingle' + description: Create Logpush job response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Create Logpush job response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Logpush job + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: create + operationId: post_zones_zone_id_logpush_jobs + /accounts/{account_id}/logpush/jobs/{job_id}: + get: + description: Gets the details of a Logpush job. + parameters: + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseSingle' + description: Get Logpush job details response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Get Logpush job details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Logpush job details + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: get + operationId: get_accounts_account_id_logpush_jobs_job_id + put: + description: Updates a Logpush job. + parameters: + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + enabled: + $ref: '#/components/schemas/logpushEnabled' + filter: + $ref: '#/components/schemas/logpushFilter' + frequency: + $ref: '#/components/schemas/logpushFrequency' + kind: + $ref: '#/components/schemas/logpushKind' + logpull_options: + $ref: '#/components/schemas/logpushLogpullOptions' + max_upload_bytes: + $ref: '#/components/schemas/logpushMaxUploadBytes' + max_upload_interval_seconds: + $ref: '#/components/schemas/logpushMaxUploadIntervalSeconds' + max_upload_records: + $ref: '#/components/schemas/logpushMaxUploadRecords' + name: + $ref: '#/components/schemas/logpushName' + output_options: + $ref: '#/components/schemas/logpushOutputOptions' + ownership_challenge: + $ref: '#/components/schemas/logpushOwnershipChallenge' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseSingle' + description: Update Logpush job response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Update Logpush job response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Logpush job + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: update + operationId: put_accounts_account_id_logpush_jobs_job_id + delete: + description: Deletes a Logpush job. + parameters: + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/logpushId' + type: object + required: + - success + - errors + - messages + type: object + description: Delete Logpush job response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Delete Logpush job response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Logpush job + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: delete + operationId: delete_accounts_account_id_logpush_jobs_job_id + /zones/{zone_id}/logpush/jobs/{job_id}: + get: + description: Gets the details of a Logpush job. + parameters: + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseSingle' + description: Get Logpush job details response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Get Logpush job details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Logpush job details + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: get + operationId: get_zones_zone_id_logpush_jobs_job_id + put: + description: Updates a Logpush job. + parameters: + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + enabled: + $ref: '#/components/schemas/logpushEnabled' + filter: + $ref: '#/components/schemas/logpushFilter' + frequency: + $ref: '#/components/schemas/logpushFrequency' + kind: + $ref: '#/components/schemas/logpushKind' + logpull_options: + $ref: '#/components/schemas/logpushLogpullOptions' + max_upload_bytes: + $ref: '#/components/schemas/logpushMaxUploadBytes' + max_upload_interval_seconds: + $ref: '#/components/schemas/logpushMaxUploadIntervalSeconds' + max_upload_records: + $ref: '#/components/schemas/logpushMaxUploadRecords' + name: + $ref: '#/components/schemas/logpushName' + output_options: + $ref: '#/components/schemas/logpushOutputOptions' + ownership_challenge: + $ref: '#/components/schemas/logpushOwnershipChallenge' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushLogpushJobResponseSingle' + description: Update Logpush job response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Update Logpush job response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Logpush job + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: update + operationId: put_zones_zone_id_logpush_jobs_job_id + delete: + description: Deletes a Logpush job. + parameters: + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/logpushId' + type: object + required: + - success + - errors + - messages + type: object + description: Delete Logpush job response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Delete Logpush job response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Logpush job + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - jobs + method: delete + operationId: delete_zones_zone_id_logpush_jobs_job_id + /accounts/{account_id}/logpush/ownership: + post: + description: Gets a new ownership challenge sent to your destination. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushGetOwnershipResponse' + description: Get ownership challenge response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Get ownership challenge response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get ownership challenge + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - ownership + method: create + operationId: post_accounts_account_id_logpush_ownership + /zones/{zone_id}/logpush/ownership: + post: + description: Gets a new ownership challenge sent to your destination. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushGetOwnershipResponse' + description: Get ownership challenge response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Get ownership challenge response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get ownership challenge + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - ownership + method: create + operationId: post_zones_zone_id_logpush_ownership + /accounts/{account_id}/logpush/ownership/validate: + post: + description: Validates ownership challenge of the destination. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + ownership_challenge: + $ref: '#/components/schemas/logpushOwnershipChallenge' + required: + - destination_conf + - ownership_challenge + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushValidateOwnershipResponse' + description: Validate ownership challenge response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Validate ownership challenge response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate ownership challenge + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - ownership + method: validate + operationId: post_accounts_account_id_logpush_ownership_validate + /zones/{zone_id}/logpush/ownership/validate: + post: + description: Validates ownership challenge of the destination. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + ownership_challenge: + $ref: '#/components/schemas/logpushOwnershipChallenge' + required: + - destination_conf + - ownership_challenge + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushValidateOwnershipResponse' + description: Validate ownership challenge response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Validate ownership challenge response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate ownership challenge + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - ownership + method: validate + operationId: post_zones_zone_id_logpush_ownership_validate + /accounts/{account_id}/logpush/validate/destination: + post: + description: Validates destination. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushValidateResponse' + description: Validate destination response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Validate destination response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate destination + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - validate + method: destination + operationId: post_accounts_account_id_logpush_validate_destination + /zones/{zone_id}/logpush/validate/destination: + post: + description: Validates destination. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushValidateResponse' + description: Validate destination response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Validate destination response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate destination + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - validate + method: destination + operationId: post_zones_zone_id_logpush_validate_destination + /accounts/{account_id}/logpush/validate/destination/exists: + post: + description: Checks if there is an existing job with a destination. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushDestinationExistsResponse' + description: Check destination exists response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Check destination exists response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Check destination exists + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - validate + method: destination_exists + operationId: post_accounts_account_id_logpush_validate_destination_exists + /zones/{zone_id}/logpush/validate/destination/exists: + post: + description: Checks if there is an existing job with a destination. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + required: + - destination_conf + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushDestinationExistsResponse' + description: Check destination exists response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Check destination exists response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Check destination exists + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - validate + method: destination_exists + operationId: post_zones_zone_id_logpush_validate_destination_exists + /accounts/{account_id}/logpush/validate/origin: + post: + description: Validates logpull origin with logpull_options. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + logpull_options: + $ref: '#/components/schemas/logpushLogpullOptions' + required: + - logpull_options + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushValidateResponse' + description: Validate origin response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Validate origin response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate origin + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - validate + method: origin + operationId: post_accounts_account_id_logpush_validate_origin + /zones/{zone_id}/logpush/validate/origin: + post: + description: Validates logpull origin with logpull_options. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + logpull_options: + $ref: '#/components/schemas/logpushLogpullOptions' + required: + - logpull_options + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/logpushValidateResponse' + description: Validate origin response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logpushApiResponseCommonFailure' + description: Validate origin response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate origin + tags: [] + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: logpush + resource_chain: + - validate + method: origin + operationId: post_zones_zone_id_logpush_validate_origin +components: + schemas: + logpushApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/logpushMessages' + messages: + example: [] + $ref: '#/components/schemas/logpushMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + logpushDataset: + default: http_requests + description: >- + Name of the dataset. A list of supported datasets can be found on the + [Developer + Docs](https://developers.cloudflare.com/logs/reference/log-fields/). + enum: + - access_requests + - audit_logs + - audit_logs_v2 + - biso_user_actions + - casb_findings + - device_posture_results + - dex_application_tests + - dex_device_state_events + - dlp_forensic_copies + - dns_firewall_logs + - dns_logs + - email_security_alerts + - email_security_post_delivery_events + - firewall_events + - gateway_dns + - gateway_http + - gateway_network + - http_requests + - ipsec_logs + - magic_ids_detections + - mcp_portal_logs + - nel_reports + - network_analytics_logs + - page_shield_events + - sinkhole_http_logs + - spectrum_events + - ssh_logs + - warp_config_changes + - warp_toggle_changes + - workers_trace_events + - zaraz_events + - zero_trust_network_sessions + example: http_requests + nullable: true + type: string + x-auditable: true + logpushDestinationConf: + description: >- + Uniquely identifies a resource (such as an s3 bucket) where data. will + be pushed. Additional configuration parameters supported by the + destination may be included. + example: s3://mybucket/logs?region=us-west-2 + format: uri + maxLength: 4096 + type: string + x-sensitive: true + logpushDestinationExistsResponse: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + exists: + example: false + type: boolean + x-auditable: true + type: object + required: + - success + - errors + - messages + type: object + logpushEnabled: + default: false + description: Flag that indicates if the job is enabled. + example: false + type: boolean + x-auditable: true + logpushErrorMessage: + description: >- + If not null, the job is currently failing. Failures are usually. + repetitive (example: no permissions to write to destination bucket). + Only the last failure is recorded. On successful execution of a job the + error_message and last_error are set to null. + nullable: true + type: string + x-auditable: true + logpushFields: + description: Comma-separated list of fields. + example: >- + ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID + type: string + x-auditable: true + logpushFilter: + description: >- + The filters to select the events to include and/or remove from your + logs. For more information, refer to + [Filters](https://developers.cloudflare.com/logs/reference/filters/). + example: >- + {"where":{"and":[{"key":"ClientRequestPath","operator":"contains","value":"/static"},{"key":"ClientRequestHost","operator":"eq","value":"example.com"}]}} + nullable: true + type: string + logpushFrequency: + default: high + deprecated: true + description: >- + This field is deprecated. Please use `max_upload_*` parameters instead. + . The frequency at which Cloudflare sends batches of logs to your + destination. Setting frequency to high sends your logs in larger + quantities of smaller files. Setting frequency to low sends logs in + smaller quantities of larger files. + enum: + - high + - low + example: high + nullable: true + type: string + x-auditable: true + logpushGetOwnershipResponse: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + filename: + example: logs/challenge-filename.txt + type: string + x-auditable: true + message: + example: '' + type: string + x-auditable: true + valid: + example: true + type: boolean + x-auditable: true + type: object + required: + - success + - errors + - messages + type: object + logpushId: + description: Unique id of the job. + minimum: 1 + type: integer + x-auditable: true + logpushInstantLogsJob: + nullable: true + properties: + destination_conf: + $ref: '#/components/schemas/logpushSchemasDestinationConf' + fields: + $ref: '#/components/schemas/logpushFields' + filter: + $ref: '#/components/schemas/logpushSchemasFilter' + sample: + $ref: '#/components/schemas/logpushSample' + session_id: + $ref: '#/components/schemas/logpushSessionId' + type: object + logpushInstantLogsJobResponseCollection: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/logpushInstantLogsJob' + type: array + required: + - success + - errors + - messages + type: object + logpushInstantLogsJobResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/logpushInstantLogsJob' + required: + - success + - errors + - messages + logpushKind: + default: '' + description: >- + The kind parameter (optional) is used to differentiate between Logpush + and Edge Log Delivery jobs (when supported by the dataset). + enum: + - '' + - edge + example: '' + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + logpushLastComplete: + description: >- + Records the last time for which logs have been successfully pushed. If + the last successful push was for logs range 2018-07-23T10:00:00Z to + 2018-07-23T10:01:00Z then the value of this field will be + 2018-07-23T10:01:00Z. If the job has never run or has just been enabled + and hasn't run yet then the field will be empty. + format: date-time + nullable: true + type: string + x-auditable: true + logpushLastError: + description: >- + Records the last time the job failed. If not null, the job is currently. + failing. If null, the job has either never failed or has run + successfully at least once since last failure. See also the + error_message field. + format: date-time + nullable: true + type: string + x-auditable: true + logpushLogpullOptions: + deprecated: true + description: >- + This field is deprecated. Use `output_options` instead. Configuration + string. It specifies things like requested fields and timestamp formats. + If migrating from the logpull api, copy the url (full url or just the + query string) of your call here, and logpush will keep on making this + call for you, setting start and end times appropriately. + example: fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339 + format: uri-reference + maxLength: 4096 + nullable: true + type: string + x-auditable: true + logpushLogpushFieldResponseCollection: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: >- + #/components/schemas/logpushLogpushFieldResponseCollection_result_item + type: object + required: + - success + - errors + - messages + type: object + logpushLogpushFieldResponseCollection_result_item: + nullable: true + properties: + key: + example: value + type: string + x-auditable: true + type: object + logpushLogpushJob: + nullable: true + properties: + dataset: + $ref: '#/components/schemas/logpushDataset' + destination_conf: + $ref: '#/components/schemas/logpushDestinationConf' + enabled: + $ref: '#/components/schemas/logpushEnabled' + error_message: + $ref: '#/components/schemas/logpushErrorMessage' + frequency: + $ref: '#/components/schemas/logpushFrequency' + id: + $ref: '#/components/schemas/logpushId' + kind: + $ref: '#/components/schemas/logpushKind' + last_complete: + $ref: '#/components/schemas/logpushLastComplete' + last_error: + $ref: '#/components/schemas/logpushLastError' + logpull_options: + $ref: '#/components/schemas/logpushLogpullOptions' + max_upload_bytes: + $ref: '#/components/schemas/logpushMaxUploadBytes' + max_upload_interval_seconds: + $ref: '#/components/schemas/logpushMaxUploadIntervalSeconds' + max_upload_records: + $ref: '#/components/schemas/logpushMaxUploadRecords' + name: + $ref: '#/components/schemas/logpushName' + output_options: + $ref: '#/components/schemas/logpushOutputOptions' + type: object + logpushLogpushJobResponseCollection: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/logpushLogpushJob' + type: array + required: + - success + - errors + - messages + type: object + logpushLogpushJobResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/logpushLogpushJob' + required: + - success + - errors + - messages + logpushMaxUploadBytes: + description: >- + The maximum uncompressed file size of a batch of logs. This setting + value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that + you cannot set a minimum file size; this means that log files may be + much smaller than this batch size. + example: 5000000 + nullable: true + type: integer + x-auditable: true + enum: + - 0 + logpushMaxUploadIntervalSeconds: + description: >- + The maximum interval in seconds for log batches. This setting must be + between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that + you cannot specify a minimum interval for log batches; this means that + log files may be sent in shorter intervals than this. + example: 30 + nullable: true + type: integer + x-auditable: true + enum: + - 0 + logpushMaxUploadRecords: + description: >- + The maximum number of log lines per batch. This setting must be between + 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot + specify a minimum number of log lines per batch; this means that log + files may contain many fewer lines than this. + example: 1000 + nullable: true + type: integer + x-auditable: true + enum: + - 0 + logpushMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + logpushName: + description: >- + Optional human readable job name. Not unique. Cloudflare suggests. that + you set this to a meaningful string, like the domain name, to make it + easier to identify your job. + example: example.com + maxLength: 512 + nullable: true + type: string + x-auditable: true + logpushOutputOptions: + description: >- + The structured replacement for `logpull_options`. When including this + field, the `logpull_option` field will be ignored. + nullable: true + properties: + CVE-2021-44228: + description: >- + If set to true, will cause all occurrences of `${` in the generated + files to be replaced with `x{`. + nullable: true + type: boolean + x-auditable: true + batch_prefix: + description: String to be prepended before each batch. + nullable: true + type: string + x-auditable: true + batch_suffix: + description: String to be appended after each batch. + nullable: true + type: string + x-auditable: true + field_delimiter: + description: >- + String to join fields. This field be ignored when `record_template` + is set. + nullable: true + type: string + x-auditable: true + field_names: + description: >- + List of field names to be included in the Logpush output. For the + moment, there is no option to add all fields at once, so you must + specify all the fields names you are interested in. + example: + - ClientIP + - EdgeStartTimestamp + - RayID + items: + type: string + x-auditable: true + type: array + merge_subrequests: + description: >- + If set to true, subrequests will be merged into the parent request. + Only supported for the `http_requests` dataset. + nullable: true + type: boolean + x-auditable: true + output_type: + description: >- + Specifies the output type, such as `ndjson` or `csv`. This sets + default values for the rest of the settings, depending on the chosen + output type. Some formatting rules, like string quoting, are + different between output types. + enum: + - ndjson + - csv + example: ndjson + type: string + x-auditable: true + record_delimiter: + description: String to be inserted in-between the records as separator. + nullable: true + type: string + x-auditable: true + record_prefix: + description: String to be prepended before each record. + nullable: true + type: string + x-auditable: true + record_suffix: + description: String to be appended after each record. + nullable: true + type: string + x-auditable: true + record_template: + description: >- + String to use as template for each record instead of the default + json key value mapping. All fields used in the template must be + present in `field_names` as well, otherwise they will end up as + null. Format as a Go `text/template` without any standard functions, + like conditionals, loops, sub-templates, etc. + nullable: true + type: string + x-auditable: true + sample_rate: + description: >- + Floating number to specify sampling rate. Sampling is applied on top + of filtering, and regardless of the current `sample_interval` of the + data. + format: float + maximum: 1 + minimum: 0 + nullable: true + type: number + x-auditable: true + timestamp_format: + description: >- + String to specify the format for timestamps, such as `unixnano`, + `unix`, `rfc3339`, `rfc3339ms` or `rfc3339ns`. + enum: + - unixnano + - unix + - rfc3339 + - rfc3339ms + - rfc3339ns + type: string + x-auditable: true + type: object + logpushOwnershipChallenge: + description: Ownership challenge token to prove destination ownership. + example: '00000000000000000000' + maxLength: 4096 + type: string + x-sensitive: true + logpushSample: + description: >- + The sample parameter is the sample rate of the records set by the + client: "sample": 1 is 100% of records "sample": 10 is 10% and so on. + example: 1 + type: integer + x-auditable: true + logpushSchemasDestinationConf: + description: >- + Unique WebSocket address that will receive messages from Cloudflare’s + edge. + example: >- + wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987 + format: uri + maxLength: 4096 + type: string + x-auditable: true + logpushSchemasFilter: + description: Filters to drill down into specific events. + example: >- + {"where":{"and":[{"key":"ClientCountry","operator":"neq","value":"ca"}]}} + type: string + x-auditable: true + logpushSessionId: + description: Unique session id of the job. + example: 99d471b1ca3c23cc8e30b6acec5db987 + type: string + x-auditable: true + logpushValidateOwnership: + nullable: true + properties: + valid: + example: true + type: boolean + x-auditable: true + type: object + logpushValidateOwnershipResponse: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/logpushValidateOwnership' + required: + - success + - errors + - messages + type: object + logpushValidateResponse: + properties: + errors: + $ref: '#/components/schemas/logpushMessages' + messages: + $ref: '#/components/schemas/logpushMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + message: + example: '' + type: string + x-auditable: true + valid: + example: true + type: boolean + x-auditable: true + type: object + required: + - success + - errors + - messages + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + edge: + id: cloudflare.logpush.edge + name: edge + title: Edge + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1edge~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1edge~1jobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/edge/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/edge/methods/create' + update: [] + delete: [] + replace: [] + fields: + id: cloudflare.logpush.fields + name: fields + title: Fields + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logpush~1datasets~1{dataset_id}~1fields/get + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1logpush~1datasets~1{dataset_id}~1fields/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fields/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/fields/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + datasets_jobs: + id: cloudflare.logpush.datasets_jobs + name: datasets_jobs + title: Datasets Jobs + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logpush~1datasets~1{dataset_id}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1logpush~1datasets~1{dataset_id}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/datasets_jobs/methods/list_by_account + - $ref: >- + #/components/x-stackQL-resources/datasets_jobs/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + logpush_jobs: + id: cloudflare.logpush.logpush_jobs + name: logpush_jobs + title: Logpush Jobs + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logpush~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/logpush_jobs/methods/list_by_account + - $ref: '#/components/x-stackQL-resources/logpush_jobs/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + jobs: + id: cloudflare.logpush.jobs + name: jobs + title: Jobs + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logpush~1jobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1jobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logpush~1jobs~1{job_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logpush~1jobs~1{job_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logpush~1jobs~1{job_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1jobs~1{job_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1jobs~1{job_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1jobs~1{job_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/get_by_zone' + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/jobs/methods/update_by_zone' + logpush_ownership: + id: cloudflare.logpush.logpush_ownership + name: logpush_ownership + title: Logpush Ownership + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logpush~1ownership/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1ownership/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/logpush_ownership/methods/create_by_account + - $ref: >- + #/components/x-stackQL-resources/logpush_ownership/methods/create_by_zone + update: [] + delete: [] + replace: [] + ownership_validate: + id: cloudflare.logpush.ownership_validate + name: ownership_validate + title: Ownership Validate + methods: + validate_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logpush~1ownership~1validate/post + response: + mediaType: application/json + openAPIDocKey: '200' + validate_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1ownership~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/ownership_validate/methods/validate_by_account + - $ref: >- + #/components/x-stackQL-resources/ownership_validate/methods/validate_by_zone + update: [] + delete: [] + replace: [] + validate_destination: + id: cloudflare.logpush.validate_destination + name: validate_destination + title: Validate Destination + methods: + destination_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logpush~1validate~1destination/post + response: + mediaType: application/json + openAPIDocKey: '200' + destination_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1validate~1destination/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/validate_destination/methods/destination_by_account + - $ref: >- + #/components/x-stackQL-resources/validate_destination/methods/destination_by_zone + update: [] + delete: [] + replace: [] + destination_exists: + id: cloudflare.logpush.destination_exists + name: destination_exists + title: Destination Exists + methods: + destination_exists_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logpush~1validate~1destination~1exists/post + response: + mediaType: application/json + openAPIDocKey: '200' + destination_exists_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1logpush~1validate~1destination~1exists/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/destination_exists/methods/destination_exists_by_account + - $ref: >- + #/components/x-stackQL-resources/destination_exists/methods/destination_exists_by_zone + update: [] + delete: [] + replace: [] + validate_origin: + id: cloudflare.logpush.validate_origin + name: validate_origin + title: Validate Origin + methods: + origin_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logpush~1validate~1origin/post' + response: + mediaType: application/json + openAPIDocKey: '200' + origin_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logpush~1validate~1origin/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/validate_origin/methods/origin_by_account + - $ref: >- + #/components/x-stackQL-resources/validate_origin/methods/origin_by_zone + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/logs.yaml b/providers/src/cloudflare/v00.00.00000/services/logs.yaml index 1dbee1ba..5c0dbdde 100644 --- a/providers/src/cloudflare/v00.00.00000/services/logs.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/logs.yaml @@ -1,786 +1,281 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Logpush Jobs - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - logs + title: logs API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - dataset: - description: Dataset to be pulled. - example: http_requests - maxLength: 256 - nullable: true - pattern: '^[a-zA-Z0-9_\-]*$' - type: string - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - logpush_field_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - nullable: true + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/logs/control/cmb/config: + delete: + description: Deletes CMB config. + operationId: delete-accounts-account_id-logs-control-cmb-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: properties: - key: - example: value - type: string + errors: + $ref: '#/components/schemas/logcontrolMessages' + messages: + $ref: '#/components/schemas/logcontrolMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages type: object - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + description: Delete CMB config response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/logcontrolApiResponseCommonFailure' + description: Delete CMB config response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete CMB config + tags: + - Logcontrol CMB config for an account + x-api-token-group: + - Logs Write + x-cfPermissionsRequired: + enum: + - '#logs:edit' + x-stackql-sdk: + service: logs + resource_chain: + - control + - cmb + - config + method: delete + get: + description: Gets CMB config. + operationId: get-accounts-account_id-logs-control-cmb-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - logpush_job_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - nullable: true - type: object - type: array - destination_conf: - description: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. - example: 's3://mybucket/logs?region=us-west-2' - format: uri - maxLength: 4096 - type: string - enabled: - description: Flag that indicates if the job was enabled. - example: false - type: boolean - components-schemas-frequency: - default: high - description: The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files. - enum: - - high - - low - example: high - nullable: true - type: string - logpull_options: - description: 'Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.' - example: 'fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339' - format: uri-reference - maxLength: 4096 - nullable: true - type: string - logpush_components-schemas-name: - description: 'Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.' - example: example.com - maxLength: 512 - nullable: true - pattern: '^[a-zA-Z0-9\-\.]*$' - type: string - ownership_challenge: - description: Ownership challenge token to prove destination ownership. - example: '00000000000000000000' - maxLength: 4096 - pattern: '^[a-zA-Z0-9/\+\.\-_]*$' - type: string - logpush_job_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - nullable: true - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - id: - description: Unique id of the job. - minimum: 1 - type: integer - get_ownership_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - filename: - example: logs/challenge-filename.txt - type: string - message: - example: '' - type: string - valid: - example: true - type: boolean - type: object - validate_ownership_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - valid: - example: true - type: boolean - type: object - destination_exists_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - exists: - example: false - type: boolean - type: object - validate_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - message: - example: '' - type: string - valid: - example: true - type: boolean - type: object - flag_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - flag: - example: true - type: boolean - type: object - flag: - description: The log retention flag for Logpull API. - example: true - type: boolean - ray_identifier: - description: Ray identifier. - example: 41ddf1740f67442d - maxLength: 16 - readOnly: true - type: string - logs: - anyOf: - - type: string - - type: object - example: |- - {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} - {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} - {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} - fields_response: - properties: - key: - example: value - type: string - type: object - script_name: - description: 'Name of the script, used in URLs and route configuration.' - example: this-is_my_script-01 - pattern: '^[a-z0-9_][a-z0-9-_]*$' - type: string - tail-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - properties: - expires_at: - readOnly: true - id: - readOnly: true - url: - readOnly: true - type: object - components-schemas-id: - description: Identifier for the tail. - example: 03dc9f77817b488fb26c5861ec18f791 - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_logpush_datasets_fields: - id: cloudflare.logs.zones_logpush_datasets_fields - name: zones_logpush_datasets_fields - title: Zones Logpush Datasets Fields - methods: - logpush_jobs_list_fields: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1datasets~1{dataset}~1fields/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _logpush_jobs_list_fields: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1datasets~1{dataset}~1fields/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_logpush_datasets_fields/methods/logpush_jobs_list_fields' - insert: [] - update: [] - delete: [] - zones_logpush_datasets_jobs: - id: cloudflare.logs.zones_logpush_datasets_jobs - name: zones_logpush_datasets_jobs - title: Zones Logpush Datasets Jobs - methods: - logpush_jobs_list_logpush_jobs_for_a_dataset: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1datasets~1{dataset}~1jobs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _logpush_jobs_list_logpush_jobs_for_a_dataset: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1datasets~1{dataset}~1jobs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_logpush_datasets_jobs/methods/logpush_jobs_list_logpush_jobs_for_a_dataset' - insert: [] - update: [] - delete: [] - zones_logpush_jobs: - id: cloudflare.logs.zones_logpush_jobs - name: zones_logpush_jobs - title: Zones Logpush Jobs - methods: - logpush_jobs_list_logpush_jobs: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1jobs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _logpush_jobs_list_logpush_jobs: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1jobs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - logpush_jobs_create_logpush_job: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1jobs/post' - response: - mediaType: application/json - openAPIDocKey: '200' - logpush_jobs_delete_logpush_job: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1jobs~1{job_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - logpush_jobs_get_logpush_job_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1jobs~1{job_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _logpush_jobs_get_logpush_job_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1jobs~1{job_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - logpush_jobs_update_logpush_job: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1jobs~1{job_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_logpush_jobs/methods/logpush_jobs_list_logpush_jobs' - - $ref: '#/components/x-stackQL-resources/zones_logpush_jobs/methods/logpush_jobs_get_logpush_job_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_logpush_jobs/methods/logpush_jobs_create_logpush_job' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_logpush_jobs/methods/logpush_jobs_delete_logpush_job' - zones_logpush_ownership: - id: cloudflare.logs.zones_logpush_ownership - name: zones_logpush_ownership - title: Zones Logpush Ownership - methods: - logpush_jobs_get_ownership_challenge: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1ownership/post' - response: - mediaType: application/json - openAPIDocKey: '200' - logpush_jobs_validate_ownership_challenge: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1ownership~1validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_logpush_validate_destination_exists: - id: cloudflare.logs.zones_logpush_validate_destination_exists - name: zones_logpush_validate_destination_exists - title: Zones Logpush Validate Destination Exists - methods: - logpush_jobs_check_destination_exists: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1validate~1destination~1exists/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_logpush_validate_origin: - id: cloudflare.logs.zones_logpush_validate_origin - name: zones_logpush_validate_origin - title: Zones Logpush Validate Origin - methods: - logpush_jobs_validate_origin: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logpush~1validate~1origin/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_control_retention_flag: - id: cloudflare.logs.zones_control_retention_flag - name: zones_control_retention_flag - title: Zones Control Retention Flag - methods: - received_get_log_retention_flag: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1control~1retention~1flag/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _received_get_log_retention_flag: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1control~1retention~1flag/get' - response: - mediaType: application/json - openAPIDocKey: '200' - received_update_log_retention_flag: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1control~1retention~1flag/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_control_retention_flag/methods/received_get_log_retention_flag' - insert: [] - update: [] - delete: [] - zones_rayids: - id: cloudflare.logs.zones_rayids - name: zones_rayids - title: Zones Rayids - methods: - received_get_logs_ray_i_ds: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1rayids~1{ray_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _received_get_logs_ray_i_ds: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1rayids~1{ray_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_received: - id: cloudflare.logs.zones_received - name: zones_received - title: Zones Received - methods: - received_get_logs_received: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1received/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _received_get_logs_received: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1received/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_received_fields: - id: cloudflare.logs.zones_received_fields - name: zones_received_fields - title: Zones Received Fields - methods: - received_list_fields: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1received~1fields/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _received_list_fields: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1logs~1received~1fields/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_received_fields/methods/received_list_fields' - insert: [] - update: [] - delete: [] - accounts_workers_scripts_tails: - id: cloudflare.logs.accounts_workers_scripts_tails - name: accounts_workers_scripts_tails - title: Accounts Workers Scripts Tails - methods: - worker_tail_logs_list_tails: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1tails/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_tail_logs_list_tails: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1tails/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_tail_logs_start_tail: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1tails/post' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_tail_logs_delete_tail: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1tails~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_workers_scripts_tails/methods/worker_tail_logs_list_tails' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_workers_scripts_tails/methods/worker_tail_logs_delete_tail' -paths: - '/zones/{zone_identifier}/logpush/datasets/{dataset}/fields': - get: - description: 'Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.' - operationId: logpush-jobs-list-fields - parameters: - - in: path - name: dataset - required: true - schema: - $ref: '#/components/schemas/dataset' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logpush_field_response_collection' - description: List fields response - 4xx: + $ref: '#/components/schemas/logcontrolCmbConfigResponseSingle' + description: Get CMB config response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logpush_field_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List fields response failure + $ref: '#/components/schemas/logcontrolApiResponseCommonFailure' + description: Get CMB config response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List fields + summary: Get CMB config tags: - - Logpush Jobs + - Logcontrol CMB config for an account + x-api-token-group: + - Logs Write + - Logs Read x-cfPermissionsRequired: enum: - - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logpush/datasets/{dataset}/jobs': - get: - description: Lists Logpush jobs for a zone for a dataset. - operationId: logpush-jobs-list-logpush-jobs-for-a-dataset + - '#logs:read' + - '#analytics:read' + x-stackql-sdk: + service: logs + resource_chain: + - control + - cmb + - config + method: get + post: + description: Updates CMB config. + operationId: post-accounts-account_id-logs-control-cmb-config parameters: - - in: path - name: dataset + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/dataset' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/logcontrolCmbConfig' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logpush_job_response_collection' - description: List Logpush jobs for a dataset response - 4xx: + $ref: '#/components/schemas/logcontrolCmbConfigResponseSingle' + description: Update CMB config response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logpush_job_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Logpush jobs for a dataset response failure + $ref: '#/components/schemas/logcontrolApiResponseCommonFailure' + description: Update CMB config response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List Logpush jobs for a dataset + summary: Update CMB config tags: - - Logpush Jobs + - Logcontrol CMB config for an account + x-api-token-group: + - Logs Write x-cfPermissionsRequired: enum: - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logpush/jobs': + x-stackql-sdk: + service: logs + resource_chain: + - control + - cmb + - config + method: create + /zones/{zone_id}/logs/control/retention/flag: get: - description: Lists Logpush jobs for a zone. - operationId: logpush-jobs-list-logpush-jobs + description: Gets log retention flag for Logpull API. + operationId: get-zones-zone_id-logs-control-retention-flag parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logpush_job_response_collection' - description: List Logpush jobs response - 4xx: + $ref: '#/components/schemas/logcontrolRetentionFlagResponseSingle' + description: Get log retention flag response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logpush_job_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Logpush jobs response failure + $ref: '#/components/schemas/logcontrolApiResponseCommonFailure' + description: Get log retention flag response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List Logpush jobs + summary: Get log retention flag tags: - - Logpush Jobs + - Logs Received + x-api-token-group: + - Logs Write + - Logs Read x-cfPermissionsRequired: enum: - - '#logs:edit' + - '#logs:read' + - '#analytics:read' x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: logs + resource_chain: + - control + - retention + method: get post: - description: Creates a new Logpush job for a zone. - operationId: logpush-jobs-create-logpush-job + description: Updates log retention flag for Logpull API. + operationId: post-zones-zone_id-logs-control-retention-flag parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - dataset: - $ref: '#/components/schemas/dataset' - destination_conf: - $ref: '#/components/schemas/destination_conf' - enabled: - $ref: '#/components/schemas/enabled' - frequency: - $ref: '#/components/schemas/components-schemas-frequency' - logpull_options: - $ref: '#/components/schemas/logpull_options' - name: - $ref: '#/components/schemas/logpush_components-schemas-name' - ownership_challenge: - $ref: '#/components/schemas/ownership_challenge' - required: - - destination_conf - required: true + $ref: '#/components/schemas/logcontrolRetentionFlag' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logpush_job_response_single' - description: Create Logpush job response - 4xx: + $ref: '#/components/schemas/logcontrolRetentionFlagResponseSingle' + description: Update log retention flag response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logpush_job_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Logpush job response failure + $ref: '#/components/schemas/logcontrolApiResponseCommonFailure' + description: Update log retention flag response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create Logpush job + summary: Update log retention flag tags: - - Logpush Jobs + - Logs Received + x-api-token-group: + - Logs Write x-cfPermissionsRequired: enum: - '#logs:edit' @@ -789,720 +284,1801 @@ paths: enterprise: true free: false pro: false - '/zones/{zone_identifier}/logpush/jobs/{job_identifier}': - delete: - description: Deletes a Logpush job. - operationId: logpush-jobs-delete-logpush-job + x-stackql-sdk: + service: logs + resource_chain: + - control + - retention + method: create + /zones/{zone_id}/logs/rayids/{ray_id}: + get: + description: >- + The `/rayids` api route allows lookups by specific rayid. The rayids + route will return zero, one, or more records (ray ids are not unique). + operationId: get-zones-zone_id-logs-rayids-ray_id parameters: - - in: path - name: job_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/id' + type: string - in: path - name: zone_identifier + name: ray_id + schema: + $ref: '#/components/schemas/logshareRayIdentifier' required: true + - in: query + name: fields schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + $ref: '#/components/schemas/logshareFields' + - in: query + name: timestamps + schema: + $ref: '#/components/schemas/logshareTimestamps' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - example: {} - nullable: true - type: object - description: Delete Logpush job response - 4xx: + $ref: '#/components/schemas/logshareLogsResponseJsonLines' + description: Get logs RayIDs response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - example: {} - nullable: true - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Logpush job response failure + $ref: '#/components/schemas/logshareApiResponseCommonFailure' + description: Get logs RayIDs response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Delete Logpush job + summary: Get logs RayIDs tags: - - Logpush Jobs - x-cfPermissionsRequired: - enum: - - '#logs:edit' + - Logs Received + x-api-token-group: + - Logs Write + - Logs Read x-cfPlanAvailability: business: false enterprise: true free: false pro: false + /zones/{zone_id}/logs/received: get: - description: Gets the details of a Logpush job. - operationId: logpush-jobs-get-logpush-job-details + description: >- + The `/received` api route allows customers to retrieve their edge HTTP + logs. The basic access pattern is "give me all the logs for zone Z for + minute M", where the minute M refers to the time records were received + at Cloudflare's central data center. `start` is inclusive, and `end` is + exclusive. Because of that, to get all data, at minutely cadence, + starting at 10AM, the proper values are: + `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then + `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the + overlap will be handled properly. + operationId: get-zones-zone_id-logs-received parameters: - - in: path - name: job_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/id' - - in: path - name: zone_identifier - required: true + type: string + - in: query + name: start schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + $ref: '#/components/schemas/logshareStart' + - in: query + name: end + schema: + $ref: '#/components/schemas/logshareEnd' + - in: query + name: fields + schema: + $ref: '#/components/schemas/logshareFields' + - in: query + name: sample + schema: + $ref: '#/components/schemas/logshareSample' + - in: query + name: count + schema: + $ref: '#/components/schemas/logshareCount' + - in: query + name: timestamps + schema: + $ref: '#/components/schemas/logshareTimestamps' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logpush_job_response_single' - description: Get Logpush job details response - 4xx: + $ref: '#/components/schemas/logshareLogsResponseJsonLines' + description: Get logs received response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logpush_job_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Logpush job details response failure + $ref: '#/components/schemas/logshareApiResponseCommonFailure' + description: Get logs received response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Logpush job details + summary: Get logs received tags: - - Logpush Jobs + - Logs Received + x-api-token-group: + - Logs Write + - Logs Read x-cfPermissionsRequired: enum: - - '#logs:edit' + - '#logs:read' x-cfPlanAvailability: business: false enterprise: true free: false pro: false - put: - description: Updates a Logpush job. - operationId: logpush-jobs-update-logpush-job + x-stackql-sdk: + service: logs + resource_chain: + - received + method: get + /zones/{zone_id}/logs/received/fields: + get: + description: >- + Lists all fields available. The response is json object with key-value + pairs, where keys are field names, and values are descriptions. + operationId: get-zones-zone_id-logs-received-fields parameters: - - in: path - name: job_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - destination_conf: - $ref: '#/components/schemas/destination_conf' - enabled: - $ref: '#/components/schemas/enabled' - frequency: - $ref: '#/components/schemas/components-schemas-frequency' - logpull_options: - $ref: '#/components/schemas/logpull_options' - ownership_challenge: - $ref: '#/components/schemas/ownership_challenge' - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logpush_job_response_single' - description: Update Logpush job response - 4xx: + $ref: '#/components/schemas/logshareFieldsResponse' + description: List fields response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logpush_job_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Logpush job response failure + $ref: '#/components/schemas/logshareApiResponseCommonFailure' + description: List fields response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update Logpush job + summary: List fields tags: - - Logpush Jobs - x-cfPermissionsRequired: - enum: - - '#logs:edit' + - Logs Received + x-api-token-group: + - Logs Write + - Logs Read x-cfPlanAvailability: business: false enterprise: true free: false pro: false - '/zones/{zone_identifier}/logpush/ownership': - post: - description: Gets a new ownership challenge sent to your destination. - operationId: logpush-jobs-get-ownership-challenge + x-stackql-sdk: + service: logs + resource_chain: + - received + - fields + method: get + /accounts/{account_id}/logs/explorer/datasets: + get: + description: >- + Returns all Log Explorer datasets configured for the account or zone. + Pass `include_zones=true` to also include zone-level datasets that + belong to this account or zone. List responses omit the `fields` + property; use the single-dataset endpoint to retrieve field + configuration. parameters: - - in: path - name: zone_identifier + - description: >- + Set to true to include zone-scoped datasets belonging to this + account. + in: query + name: include_zones + schema: + type: boolean + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - destination_conf: - $ref: '#/components/schemas/destination_conf' - required: - - destination_conf - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/get_ownership_response' - description: Get ownership challenge response - 4xx: + $ref: '#/components/schemas/lexDatasetSummaryListResponse' + description: The datasets the account or zone has configured. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/get_ownership_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get ownership challenge response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get ownership challenge - tags: - - Logpush Jobs - x-cfPermissionsRequired: - enum: - - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logpush/ownership/validate': + summary: List account or zone datasets + tags: [] + x-api-token-group: + - Logs Write + - Logs Read + operationId: get_accounts_account_id_logs_explorer_datasets post: - description: Validates ownership challenge of the destination. - operationId: logpush-jobs-validate-ownership-challenge - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + description: >- + Create a new Log Explorer dataset for the account or zone. Use the + `/account or zones/{account or + zone_id}/logs/explorer/datasets/available` endpoint to list dataset + types you can create along with their available fields. The `fields` + property is optional. If not specified, all available fields will be + enabled. requestBody: content: application/json: schema: - properties: - destination_conf: - $ref: '#/components/schemas/destination_conf' - ownership_challenge: - $ref: '#/components/schemas/ownership_challenge' - required: - - destination_conf - - ownership_challenge - required: true + $ref: '#/components/schemas/lexCreateDatasetRequest' responses: - '200': + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/lexDatasetDetailResponse' + description: Dataset created successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': content: application/json: schema: - $ref: '#/components/schemas/validate_ownership_response' - description: Validate ownership challenge response - 4xx: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. + '409': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/validate_ownership_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Validate ownership challenge response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: A dataset of this type already exists for this account or zone. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Validate ownership challenge - tags: - - Logpush Jobs - x-cfPermissionsRequired: - enum: - - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logpush/validate/destination/exists': - post: - description: Checks if there is an existing job with a destination. - operationId: logpush-jobs-check-destination-exists + summary: Create an account or zone dataset + tags: [] + x-api-token-group: + - Logs Write parameters: - - in: path - name: zone_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - destination_conf: - $ref: '#/components/schemas/destination_conf' - required: - - destination_conf - required: true + type: string + operationId: post_accounts_account_id_logs_explorer_datasets + /zones/{zone_id}/logs/explorer/datasets: + get: + description: >- + Returns all Log Explorer datasets configured for the account or zone. + Pass `include_zones=true` to also include zone-level datasets that + belong to this account or zone. List responses omit the `fields` + property; use the single-dataset endpoint to retrieve field + configuration. + parameters: + - description: >- + Set to true to include zone-scoped datasets belonging to this + account. + in: query + name: include_zones + schema: + type: boolean + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/destination_exists_response' - description: Check destination exists response - 4xx: + $ref: '#/components/schemas/lexDatasetSummaryListResponse' + description: The datasets the account or zone has configured. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/destination_exists_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Check destination exists response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Check destination exists - tags: - - Logpush Jobs - x-cfPermissionsRequired: - enum: - - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logpush/validate/origin': + summary: List account or zone datasets + tags: [] + x-api-token-group: + - Logs Write + - Logs Read + operationId: get_zones_zone_id_logs_explorer_datasets post: - description: Validates logpull origin with logpull_options. - operationId: logpush-jobs-validate-origin - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + description: >- + Create a new Log Explorer dataset for the account or zone. Use the + `/account or zones/{account or + zone_id}/logs/explorer/datasets/available` endpoint to list dataset + types you can create along with their available fields. The `fields` + property is optional. If not specified, all available fields will be + enabled. requestBody: content: application/json: schema: - properties: - logpull_options: - $ref: '#/components/schemas/logpull_options' - required: - - logpull_options - required: true + $ref: '#/components/schemas/lexCreateDatasetRequest' responses: - '200': + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/lexDatasetDetailResponse' + description: Dataset created successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': content: application/json: schema: - $ref: '#/components/schemas/validate_response' - description: Validate origin response - 4xx: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. + '409': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/validate_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Validate origin response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: A dataset of this type already exists for this account or zone. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Validate origin - tags: - - Logpush Jobs - x-cfPermissionsRequired: - enum: - - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logs/control/retention/flag': - get: - description: Gets log retention flag for Logpull API. - operationId: logs-received-get-log-retention-flag + summary: Create an account or zone dataset + tags: [] + x-api-token-group: + - Logs Write parameters: - - in: path - name: zone_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + operationId: post_zones_zone_id_logs_explorer_datasets + /accounts/{account_id}/logs/explorer/datasets/available: + get: + description: >- + Returns all dataset types that this account or zone can create. Each + entry includes the dataset schema and timestamp field. The schema shows + all possible fields for a dataset. However, not all fields may be + available for your account or zone. When creating or updating a dataset, + only fields available to your account or zone can be enabled. If you + request a field that is not available, you will receive an error. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flag_response' - description: Get log retention flag response - 4xx: + $ref: '#/components/schemas/lexAvailableDestinationListResponse' + description: List of dataset types available to create. + '400': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/flag_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get log retention flag response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get log retention flag - tags: - - Logs Received - x-cfPermissionsRequired: - enum: - - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Updates log retention flag for Logpull API. - operationId: logs-received-update-log-retention-flag + summary: List available account or zone datasets + tags: [] + x-api-token-group: + - Logs Write + - Logs Read parameters: - - in: path - name: zone_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - flag: - $ref: '#/components/schemas/flag' - required: - - flag - type: object - required: true + type: string + operationId: get_accounts_account_id_logs_explorer_datasets_available + /zones/{zone_id}/logs/explorer/datasets/available: + get: + description: >- + Returns all dataset types that this account or zone can create. Each + entry includes the dataset schema and timestamp field. The schema shows + all possible fields for a dataset. However, not all fields may be + available for your account or zone. When creating or updating a dataset, + only fields available to your account or zone can be enabled. If you + request a field that is not available, you will receive an error. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/flag_response' - description: Update log retention flag response - 4xx: + $ref: '#/components/schemas/lexAvailableDestinationListResponse' + description: List of dataset types available to create. + '400': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/flag_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update log retention flag response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Update log retention flag - tags: - - Logs Received - x-cfPermissionsRequired: - enum: - - '#logs:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logs/rayids/{ray_identifier}': - get: - description: 'The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).' - operationId: logs-received-get-logs-ray-i-ds + summary: List available account or zone datasets + tags: [] + x-api-token-group: + - Logs Write + - Logs Read parameters: - - in: path - name: ray_identifier - required: true - schema: - $ref: '#/components/schemas/ray_identifier' - - in: path - name: zone_identifier + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + operationId: get_zones_zone_id_logs_explorer_datasets_available + /accounts/{account_id}/logs/explorer/datasets/{dataset_id}: + get: + description: Retrieve a single Log Explorer dataset by ID for the account or zone. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logs' - description: Get logs RayIDs response - 4xx: + $ref: '#/components/schemas/lexDatasetDetailResponse' + description: Dataset details, including the fields active for ingestion. + '400': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logs' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get logs RayIDs response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get logs RayIDs - tags: - - Logs Received - x-cfPermissionsRequired: - enum: - - '#logs:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logs/received': - get: - description: 'The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare''s central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.' - operationId: logs-received-get-logs-received + summary: Get an account or zone dataset + tags: [] + x-api-token-group: + - Logs Write parameters: - - in: path - name: zone_identifier + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path required: true + description: The dataset ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + operationId: get_accounts_account_id_logs_explorer_datasets_dataset_id + put: + description: >- + Updates the enabled state and/or field configuration of an account or + zone dataset. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/lexUpdateDatasetRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/logs' - description: Get logs received response - 4xx: + $ref: '#/components/schemas/lexDatasetDetailResponse' + description: The dataset after the update. + '400': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/logs' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get logs received response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get logs received - tags: - - Logs Received - x-cfPermissionsRequired: - enum: - - '#logs:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/logs/received/fields': - get: - description: 'Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.' - operationId: logs-received-list-fields + summary: Update an account or zone dataset + tags: [] + x-api-token-group: + - Logs Write parameters: - - in: path - name: zone_identifier + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path required: true + description: The dataset ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + operationId: put_accounts_account_id_logs_explorer_datasets_dataset_id + /zones/{zone_id}/logs/explorer/datasets/{dataset_id}: + get: + description: Retrieve a single Log Explorer dataset by ID for the account or zone. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/fields_response' - description: List fields response - 4xx: + $ref: '#/components/schemas/lexDatasetDetailResponse' + description: Dataset details, including the fields active for ingestion. + '400': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/fields_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List fields response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: List fields - tags: - - Logs Received - x-cfPermissionsRequired: - enum: - - '#logs:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/workers/scripts/{script_name}/tails': - get: - description: Get list of tails currently deployed on a worker. - operationId: worker-tail-logs-list-tails + summary: Get an account or zone dataset + tags: [] + x-api-token-group: + - Logs Write parameters: - - in: path - name: script_name + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier + type: string + - name: dataset_id + in: path required: true + description: The dataset ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + operationId: get_zones_zone_id_logs_explorer_datasets_dataset_id + put: + description: >- + Updates the enabled state and/or field configuration of an account or + zone dataset. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/lexUpdateDatasetRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/tail-response' - description: List Tails response - 4xx: + $ref: '#/components/schemas/lexDatasetDetailResponse' + description: The dataset after the update. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: >- + Invalid request, unsupported dataset, or invalid field + configuration. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The caller lacks permission or entitlement to access this resource. + '404': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/tail-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Tails response failure + $ref: '#/components/schemas/lexSchemasErrorResponse' + description: The requested resource does not exist. security: - - api_email: [] - api_key: [] - api_token: [] - summary: List Tails - tags: - - Worker Tail Logs - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.read - post: - description: Starts a tail that receives logs and exception from a Worker. - operationId: worker-tail-logs-start-tail + summary: Update an account or zone dataset + tags: [] + x-api-token-group: + - Logs Write parameters: - - in: path - name: script_name + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier + type: string + - name: dataset_id + in: path required: true + description: The dataset ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + operationId: put_zones_zone_id_logs_explorer_datasets_dataset_id + /accounts/{account_id}/logs/explorer/query/sql: + post: + description: Run a SQL query against account or zone-level datasets. requestBody: content: - application/json: {} - required: true + text/plain: + schema: + description: SQL query to execute. + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/tail-response' - description: Start Tail response - 4xx: + $ref: '#/components/schemas/lexQueryResponse' + description: Query results. + '400': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/tail-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Start Tail response failure + $ref: '#/components/schemas/lexErrorResponse' + description: Invalid request or unsupported query. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexErrorResponse' + description: Missing permission to access the requested resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexErrorResponse' + description: Requested resource not found. + '507': + content: + application/json: + schema: + $ref: '#/components/schemas/lexErrorResponse' + description: Query exceeded internal memory or resource limits. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Start Tail - tags: - - Worker Tail Logs - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.read - - com.cloudflare.edge.worker.tail.create - '/accounts/{account_identifier}/workers/scripts/{script_name}/tails/{id}': - delete: - description: Deletes a tail from a Worker. - operationId: worker-tail-logs-delete-tail + summary: Run a log query + tags: [] + x-api-token-group: + - Logs Write + - Logs Read + x-auditable: false parameters: - - in: path - name: id + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/components-schemas-id' - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + operationId: post_accounts_account_id_logs_explorer_query_sql + /zones/{zone_id}/logs/explorer/query/sql: + post: + description: Run a SQL query against account or zone-level datasets. requestBody: content: - application/json: {} - required: true + text/plain: + schema: + description: SQL query to execute. + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/api-response-common' - description: Delete Tail response - 4xx: + $ref: '#/components/schemas/lexQueryResponse' + description: Query results. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/lexErrorResponse' + description: Invalid request or unsupported query. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/lexErrorResponse' + description: Missing permission to access the requested resource. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/lexErrorResponse' + description: Requested resource not found. + '507': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-common' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Tail response failure + $ref: '#/components/schemas/lexErrorResponse' + description: Query exceeded internal memory or resource limits. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Delete Tail - tags: - - Worker Tail Logs - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.read - - com.cloudflare.edge.worker.tail.create + summary: Run a log query + tags: [] + x-api-token-group: + - Logs Write + - Logs Read + x-auditable: false + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + operationId: post_zones_zone_id_logs_explorer_query_sql +components: + schemas: + lexAvailableDestination: + description: A dataset type that the account or zone can create. + properties: + dataset: + description: Dataset type name (e.g. `http_requests`). + type: string + object_type: + description: Whether this dataset type is account-scoped or zone-scoped. + enum: + - account + - zone + type: string + schema: + description: JSON Schema that describes the fields this dataset exposes. + properties: + properties: + type: object + required: + items: + type: string + type: array + type: + enum: + - object + type: string + type: object + timestamp_field: + description: The primary timestamp field name for this dataset. + type: string + required: + - dataset + - timestamp_field + - schema + - object_type + type: object + lexAvailableDestinationListResponse: + properties: + errors: + items: + $ref: '#/components/schemas/lexSchemasV4Error' + type: array + messages: + items: + type: string + type: array + result: + items: + $ref: '#/components/schemas/lexAvailableDestination' + nullable: true + type: array + success: + type: boolean + required: + - success + - errors + - messages + type: object + lexCreateDatasetRequest: + properties: + dataset: + description: Dataset type name to create (e.g. `http_requests`). + type: string + x-auditable: true + fields: + description: >- + Controls which fields the API ingests. Defaults to all available + fields when absent. + items: + $ref: '#/components/schemas/lexLogField' + type: array + required: + - dataset + type: object + lexDatasetDetailResponse: + properties: + errors: + items: + $ref: '#/components/schemas/lexSchemasV4Error' + type: array + messages: + items: + type: string + x-auditable: true + type: array + result: + $ref: '#/components/schemas/lexDatasetResponse' + success: + type: boolean + x-auditable: true + required: + - success + - errors + - messages + type: object + lexDatasetResponse: + description: >- + A Log Explorer dataset summary. List endpoints return this type and omit + field configuration; use the single-dataset endpoint to retrieve it. + properties: + created_at: + description: RFC3339 timestamp recording when the API created this dataset. + format: date-time + type: string + x-auditable: true + readOnly: true + dataset: + description: Dataset type name (e.g. `http_requests`). + type: string + x-auditable: true + dataset_id: + description: Unique dataset ID. + type: string + x-auditable: true + enabled: + description: Whether log ingest is currently active for this dataset. + type: boolean + x-auditable: true + object_id: + description: Public ID of the account or zone that owns this dataset. + type: string + x-auditable: true + object_type: + description: Whether this dataset belongs to an account or a zone. + enum: + - account + - zone + type: string + x-auditable: true + updated_at: + description: RFC3339 timestamp recording when the API last updated this dataset. + format: date-time + type: string + x-auditable: true + readOnly: true + fields: + description: The field configuration for this dataset. + items: + $ref: '#/components/schemas/lexLogField' + type: array + required: + - dataset + - object_type + - object_id + - created_at + - updated_at + - dataset_id + - enabled + type: object + lexDatasetSummary: + description: >- + A Log Explorer dataset summary. List endpoints return this type and omit + field configuration; use the single-dataset endpoint to retrieve it. + properties: + created_at: + description: RFC3339 timestamp recording when the API created this dataset. + format: date-time + type: string + x-auditable: true + readOnly: true + dataset: + description: Dataset type name (e.g. `http_requests`). + type: string + x-auditable: true + dataset_id: + description: Unique dataset ID. + type: string + x-auditable: true + enabled: + description: Whether log ingest is currently active for this dataset. + type: boolean + x-auditable: true + object_id: + description: Public ID of the account or zone that owns this dataset. + type: string + x-auditable: true + object_type: + description: Whether this dataset belongs to an account or a zone. + enum: + - account + - zone + type: string + x-auditable: true + updated_at: + description: RFC3339 timestamp recording when the API last updated this dataset. + format: date-time + type: string + x-auditable: true + readOnly: true + required: + - dataset + - object_type + - object_id + - created_at + - updated_at + - dataset_id + - enabled + type: object + lexDatasetSummaryListResponse: + properties: + errors: + items: + $ref: '#/components/schemas/lexSchemasV4Error' + type: array + messages: + items: + type: string + type: array + result: + items: + $ref: '#/components/schemas/lexDatasetSummary' + nullable: true + type: array + success: + type: boolean + required: + - success + - errors + - messages + type: object + lexErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/lexV4Error' + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - result + - success + - errors + - messages + type: object + lexLogField: + properties: + enabled: + description: Whether the API includes this field in log ingest. + type: boolean + x-auditable: true + name: + description: Field name in lowercase. + type: string + x-auditable: true + required: + - name + - enabled + type: object + lexQueryResponse: + properties: + errors: + items: + $ref: '#/components/schemas/lexV4Error' + type: array + messages: + items: + type: string + type: array + result: + items: + $ref: '#/components/schemas/lexQueryRow' + nullable: true + type: array + success: + type: boolean + required: + - success + - errors + - messages + type: object + lexQueryRow: + type: object + lexSchemasErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/lexSchemasV4Error' + type: array + messages: + items: + type: string + x-auditable: true + type: array + result: + nullable: true + type: object + x-auditable: true + success: + enum: + - false + type: boolean + x-auditable: true + required: + - result + - success + - errors + - messages + type: object + lexSchemasV4Error: + $ref: '#/components/schemas/responseInfo' + lexUpdateDatasetRequest: + properties: + enabled: + description: Whether to enable or disable log ingest for this dataset. + type: boolean + x-auditable: true + fields: + description: >- + Controls which fields the API ingests after the update. Defaults to + all available fields when absent. + items: + $ref: '#/components/schemas/lexLogField' + type: array + required: + - enabled + type: object + lexV4Error: + $ref: '#/components/schemas/responseInfo' + logcontrolAllowOutOfRegionAccess: + description: Allow out of region access + example: false + type: boolean + x-auditable: true + logcontrolApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/logcontrolMessages' + messages: + example: [] + $ref: '#/components/schemas/logcontrolMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + logcontrolCmbConfig: + nullable: true + properties: + allow_out_of_region_access: + $ref: '#/components/schemas/logcontrolAllowOutOfRegionAccess' + regions: + $ref: '#/components/schemas/logcontrolRegions' + type: object + logcontrolCmbConfigResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/logcontrolMessages' + messages: + $ref: '#/components/schemas/logcontrolMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/logcontrolCmbConfig' + required: + - success + - errors + - messages + logcontrolFlag: + description: The log retention flag for Logpull API. + example: true + type: boolean + x-auditable: true + logcontrolMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + logcontrolRegions: + description: Name of the region. + example: eu + maxLength: 256 + type: string + x-auditable: true + logcontrolRetentionFlag: + nullable: true + properties: + flag: + $ref: '#/components/schemas/logcontrolFlag' + type: object + logcontrolRetentionFlagResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/logcontrolMessages' + messages: + $ref: '#/components/schemas/logcontrolMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/logcontrolRetentionFlag' + required: + - success + - errors + - messages + logshareApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/logshareMessages' + messages: + example: [] + $ref: '#/components/schemas/logshareMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + logshareCount: + description: >- + When `?count=` is provided, the response will contain up to `count` + results. Since results are not sorted, you are likely to get different + data for repeated requests. `count` must be an integer > 0. + minimum: 1 + type: integer + x-auditable: true + logshareEnd: + description: >- + Sets the (exclusive) end of the requested time frame. This can be a unix + timestamp (in seconds or nanoseconds), or an absolute timestamp that + conforms to RFC 3339. `end` must be at least five minutes earlier than + now and must be later than `start`. Difference between `start` and `end` + must be not greater than one hour. + example: '2018-05-20T10:01:00Z' + x-auditable: true + type: string + logshareFields: + description: >- + The `/received` route by default returns a limited set of fields, and + allows customers to override the default field set by specifying + individual fields. The reasons for this are: 1. Most customers require + only a small subset of fields, but that subset varies from customer to + customer; 2. Flat schema is much easier to work with downstream + (importing into BigTable etc); 3. Performance (time to process, file + size). If `?fields=` is not specified, default field set is returned. + This default field set may change at any time. When `?fields=` is + provided, each record is returned with the specified fields. `fields` + must be specified as a comma separated list without any whitespaces, and + all fields must exist. The order in which fields are specified does not + matter, and the order of fields in the response is not specified. + example: ClientIP,RayID,EdgeStartTimestamp + type: string + x-auditable: true + logshareFieldsResponse: + properties: + key: + example: value + type: string + x-auditable: true + type: object + logshareLogsResponseJsonLines: + example: >- + {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} + + {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} + + {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} + type: string + logshareMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + logshareRayIdentifier: + description: Ray identifier. + example: 41ddf1740f67442d + maxLength: 16 + readOnly: true + type: string + x-auditable: true + logshareSample: + description: >- + When `?sample=` is provided, a sample of matching records is returned. + If `sample=0.1` then 10% of records will be returned. Sampling is + random: repeated calls will not only return different records, but + likely will also vary slightly in number of returned records. When + `?count=` is also specified, `count` is applied to the number of + returned records, not the sampled records. So, with `sample=0.05` and + `count=7`, when there is a total of 100 records available, approximately + five will be returned. When there are 1000 records, seven will be + returned. When there are 10,000 records, seven will be returned. + example: 0.1 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + logshareStart: + description: >- + Sets the (inclusive) beginning of the requested time frame. This can be + a unix timestamp (in seconds or nanoseconds), or an absolute timestamp + that conforms to RFC 3339. At this point in time, it cannot exceed a + time in the past greater than seven days. + example: '2018-05-20T10:00:00Z' + x-auditable: true + type: string + logshareTimestamps: + default: unixnano + description: >- + By default, timestamps in responses are returned as Unix nanosecond + integers. The `?timestamps=` argument can be set to change the format in + which response timestamps are returned. Possible values are: `unix`, + `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps + as integers; `rfc3339` returns timestamps as strings. + enum: + - unix + - unixnano + - rfc3339 + example: unixnano + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + config: + id: cloudflare.logs.config + name: config + title: Config + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logs~1control~1cmb~1config/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logs~1control~1cmb~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logs~1control~1cmb~1config/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/config/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/config/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/config/methods/delete' + replace: [] + retention: + id: cloudflare.logs.retention + name: retention + title: Retention + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1control~1retention~1flag/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1control~1retention~1flag/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/retention/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/retention/methods/create' + update: [] + delete: [] + replace: [] + rayids: + id: cloudflare.logs.rayids + name: rayids + title: Rayids + methods: + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1rayids~1{ray_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rayids/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + received: + id: cloudflare.logs.received + name: received + title: Received + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1received/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/received/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + fields: + id: cloudflare.logs.fields + name: fields + title: Fields + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1received~1fields/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fields/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + accounts_logs_explorer_datasets: + id: cloudflare.logs.accounts_logs_explorer_datasets + name: accounts_logs_explorer_datasets + title: Accounts Logs Explorer Datasets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logs~1explorer~1datasets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_accounts_account_id_logs_explorer_datasets: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logs~1explorer~1datasets/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logs~1explorer~1datasets~1{dataset_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + put_accounts_account_id_logs_explorer_datasets_dataset_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logs~1explorer~1datasets~1{dataset_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/accounts_logs_explorer_datasets/methods/get + - $ref: >- + #/components/x-stackQL-resources/accounts_logs_explorer_datasets/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/accounts_logs_explorer_datasets/methods/post_accounts_account_id_logs_explorer_datasets + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/accounts_logs_explorer_datasets/methods/put_accounts_account_id_logs_explorer_datasets_dataset_id + zones_logs_explorer_datasets: + id: cloudflare.logs.zones_logs_explorer_datasets + name: zones_logs_explorer_datasets + title: Zones Logs Explorer Datasets + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1explorer~1datasets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_zones_zone_id_logs_explorer_datasets: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1explorer~1datasets/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1logs~1explorer~1datasets~1{dataset_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + put_zones_zone_id_logs_explorer_datasets_dataset_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1logs~1explorer~1datasets~1{dataset_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/zones_logs_explorer_datasets/methods/get + - $ref: >- + #/components/x-stackQL-resources/zones_logs_explorer_datasets/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/zones_logs_explorer_datasets/methods/post_zones_zone_id_logs_explorer_datasets + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/zones_logs_explorer_datasets/methods/put_zones_zone_id_logs_explorer_datasets_dataset_id + accounts_logs_explorer_datasets_available: + id: cloudflare.logs.accounts_logs_explorer_datasets_available + name: accounts_logs_explorer_datasets_available + title: Accounts Logs Explorer Datasets Available + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1logs~1explorer~1datasets~1available/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/accounts_logs_explorer_datasets_available/methods/list + insert: [] + update: [] + delete: [] + replace: [] + zones_logs_explorer_datasets_available: + id: cloudflare.logs.zones_logs_explorer_datasets_available + name: zones_logs_explorer_datasets_available + title: Zones Logs Explorer Datasets Available + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1logs~1explorer~1datasets~1available/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/zones_logs_explorer_datasets_available/methods/list + insert: [] + update: [] + delete: [] + replace: [] + accounts_logs_explorer_query_sql: + id: cloudflare.logs.accounts_logs_explorer_query_sql + name: accounts_logs_explorer_query_sql + title: Accounts Logs Explorer Query Sql + methods: + create_sql: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1logs~1explorer~1query~1sql/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + zones_logs_explorer_query_sql: + id: cloudflare.logs.zones_logs_explorer_query_sql + name: zones_logs_explorer_query_sql + title: Zones Logs Explorer Query Sql + methods: + create_sql: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1logs~1explorer~1query~1sql/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/magic.yaml b/providers/src/cloudflare/v00.00.00000/services/magic.yaml deleted file mode 100644 index fd432a50..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/magic.yaml +++ /dev/null @@ -1,3431 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Magic GRE tunnels - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - magic - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - tunnels_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - gre_tunnels: - items: - $ref: '#/components/schemas/gre-tunnel' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - gre-tunnel: - properties: - cloudflare_gre_endpoint: - $ref: '#/components/schemas/cloudflare_gre_endpoint' - created_on: - $ref: '#/components/schemas/common_components-schemas-created_on' - customer_gre_endpoint: - $ref: '#/components/schemas/customer_gre_endpoint' - description: - $ref: '#/components/schemas/gre-tunnel_components-schemas-description' - health_check: - $ref: '#/components/schemas/health_check' - id: - $ref: '#/components/schemas/common_components-schemas-identifier-2' - interface_address: - $ref: '#/components/schemas/interface_address' - modified_on: - $ref: '#/components/schemas/common_components-schemas-modified_on' - mtu: - $ref: '#/components/schemas/mtu' - name: - $ref: '#/components/schemas/gre-tunnel_components-schemas-name' - ttl: - $ref: '#/components/schemas/components-schemas-ttl' - required: - - name - - customer_gre_endpoint - - cloudflare_gre_endpoint - - interface_address - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - cloudflare_gre_endpoint: - description: The IP address assigned to the Cloudflare side of the GRE tunnel. - example: 203.0.113.1 - type: string - common_components-schemas-created_on: - description: The date and time the tunnel was created. - example: '2017-06-14T00:00:00Z' - format: date-time - readOnly: true - type: string - customer_gre_endpoint: - description: The IP address assigned to the customer side of the GRE tunnel. - example: 203.0.113.1 - type: string - gre-tunnel_components-schemas-description: - description: An optional description of the GRE tunnel. - example: Tunnel for ISP X - type: string - health_check: - properties: - enabled: - default: true - description: Determines whether to run healthchecks for a tunnel. - example: true - type: boolean - target: - description: The address used to run healthchecks for a tunnel. This field defaults to `customer_gre_endpoint address`. - example: 203.0.113.1 - type: string - type: - default: reply - description: 'The type of healthcheck to run, reply or request. The default value is `reply`.' - enum: - - reply - - request - example: request - type: string - type: object - common_components-schemas-identifier-2: - description: Tunnel identifier tag. - example: c4a7362d577a6c3019a474fd6f485821 - maxLength: 32 - readOnly: true - type: string - interface_address: - description: 'A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.' - example: 192.0.2.0/31 - type: string - common_components-schemas-modified_on: - description: The date and time the tunnel was last modified. - example: '2017-06-14T05:20:00Z' - format: date-time - readOnly: true - type: string - mtu: - default: 1476 - description: Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. - type: integer - gre-tunnel_components-schemas-name: - description: 'The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel.' - example: GRE_1 - type: string - components-schemas-ttl: - default: 64 - description: Time To Live (TTL) in number of hops of the GRE tunnel. - type: integer - modified_tunnels_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_gre_tunnels: - items: - $ref: '#/components/schemas/gre-tunnel' - type: array - tunnel_deleted_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - deleted: - example: true - type: boolean - deleted_gre_tunnel: - type: object - tunnel_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - gre_tunnel: - type: object - tunnel_update_request: - allOf: - - $ref: '#/components/schemas/tunnel_add_single_request' - tunnel_modified_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_gre_tunnel: - type: object - tunnel_add_single_request: - properties: - cloudflare_gre_endpoint: - $ref: '#/components/schemas/cloudflare_gre_endpoint' - customer_gre_endpoint: - $ref: '#/components/schemas/customer_gre_endpoint' - description: - $ref: '#/components/schemas/gre-tunnel_components-schemas-description' - health_check: - $ref: '#/components/schemas/health_check' - interface_address: - $ref: '#/components/schemas/interface_address' - mtu: - $ref: '#/components/schemas/mtu' - name: - $ref: '#/components/schemas/gre-tunnel_components-schemas-name' - ttl: - $ref: '#/components/schemas/components-schemas-ttl' - required: - - name - - customer_gre_endpoint - - cloudflare_gre_endpoint - - interface_address - type: object - schemas-tunnels_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - ipsec_tunnels: - items: - $ref: '#/components/schemas/ipsec-tunnel' - type: array - ipsec-tunnel: - properties: - allow_null_cipher: - $ref: '#/components/schemas/allow_null_cipher' - cloudflare_endpoint: - $ref: '#/components/schemas/cloudflare_ipsec_endpoint' - created_on: - $ref: '#/components/schemas/common_components-schemas-created_on' - customer_endpoint: - $ref: '#/components/schemas/customer_ipsec_endpoint' - description: - $ref: '#/components/schemas/ipsec-tunnel_components-schemas-description' - id: - $ref: '#/components/schemas/common_components-schemas-identifier-2' - interface_address: - $ref: '#/components/schemas/interface_address' - modified_on: - $ref: '#/components/schemas/common_components-schemas-modified_on' - name: - $ref: '#/components/schemas/ipsec-tunnel_components-schemas-name' - psk_metadata: - $ref: '#/components/schemas/psk_metadata' - tunnel_health_check: - $ref: '#/components/schemas/tunnel_health_check' - required: - - name - - cloudflare_endpoint - - interface_address - type: object - allow_null_cipher: - description: 'When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).' - example: true - type: boolean - cloudflare_ipsec_endpoint: - description: The IP address assigned to the Cloudflare side of the IPsec tunnel. - example: 203.0.113.1 - type: string - customer_ipsec_endpoint: - description: The IP address assigned to the customer side of the IPsec tunnel. - example: 203.0.113.1 - type: string - ipsec-tunnel_components-schemas-description: - description: An optional description forthe IPsec tunnel. - example: Tunnel for ISP X - type: string - ipsec-tunnel_components-schemas-name: - description: The name of the IPsec tunnel. The name cannot share a name with other tunnels. - example: IPsec_1 - type: string - psk_metadata: - description: The PSK metadata that includes when the PSK was generated. - properties: - last_generated_on: - $ref: '#/components/schemas/common_components-schemas-modified_on' - type: object - tunnel_health_check: - properties: - enabled: - default: true - description: Determines whether to run healthchecks for a tunnel. - example: true - type: boolean - target: - description: The address used to run healthchecks for a tunnel. This field defaults to `customer_gre_endpoint address`. - example: 203.0.113.1 - type: string - type: - default: reply - description: 'The type of healthcheck to run, reply or request. The default value is `reply`.' - enum: - - reply - - request - example: request - type: string - type: object - schemas-modified_tunnels_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_ipsec_tunnels: - items: - $ref: '#/components/schemas/ipsec-tunnel' - type: array - schemas-tunnel_deleted_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - deleted: - example: true - type: boolean - deleted_ipsec_tunnel: - type: object - schemas-tunnel_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - ipsec_tunnel: - type: object - schemas-tunnel_update_request: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_add_single_request' - schemas-tunnel_modified_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_ipsec_tunnel: - type: object - schemas-tunnel_add_single_request: - properties: - cloudflare_endpoint: - $ref: '#/components/schemas/cloudflare_ipsec_endpoint' - customer_endpoint: - $ref: '#/components/schemas/customer_ipsec_endpoint' - description: - $ref: '#/components/schemas/ipsec-tunnel_components-schemas-description' - interface_address: - $ref: '#/components/schemas/interface_address' - name: - $ref: '#/components/schemas/ipsec-tunnel_components-schemas-name' - psk: - $ref: '#/components/schemas/psk' - required: - - name - - cloudflare_endpoint - - interface_address - type: object - psk: - description: A randomly generated or provided string for use in the IPsec tunnel. - example: O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy - type: string - psk_generation_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - ipsec_tunnel_id: - $ref: '#/components/schemas/common_components-schemas-identifier' - psk: - $ref: '#/components/schemas/psk' - psk_metadata: - $ref: '#/components/schemas/psk_metadata' - components-schemas-tunnels_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - interconnects: - items: - $ref: '#/components/schemas/interconnect' - type: array - interconnect: - properties: - colo_name: - $ref: '#/components/schemas/interconnect_components-schemas-name' - created_on: - $ref: '#/components/schemas/common_components-schemas-created_on' - description: - $ref: '#/components/schemas/interconnect_components-schemas-description' - gre: - $ref: '#/components/schemas/gre' - health_check: - $ref: '#/components/schemas/schemas-health_check' - id: - $ref: '#/components/schemas/common_components-schemas-identifier-2' - interface_address: - $ref: '#/components/schemas/interface_address' - modified_on: - $ref: '#/components/schemas/common_components-schemas-modified_on' - mtu: - $ref: '#/components/schemas/schemas-mtu' - name: - $ref: '#/components/schemas/interconnect_components-schemas-name' - type: object - interconnect_components-schemas-name: - description: The name of the interconnect. The name cannot share a name with other tunnels. - example: pni_ord - type: string - interconnect_components-schemas-description: - description: An optional description of the interconnect. - example: Tunnel for Interconnect to ORD - type: string - gre: - description: The configuration specific to GRE interconnects. - properties: - cloudflare_endpoint: - description: The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect. - example: 203.0.113.1 - type: string - customer_endpoint: - description: The IP address assigned to the customer side of the GRE tunnel created as part of the Interconnect. - example: 203.0.113.1 - type: string - type: object - schemas-health_check: - properties: - enabled: - default: true - description: Determines whether to run healthchecks for a tunnel. - example: true - type: boolean - target: - description: The address used to run healthchecks for a tunnel. - example: 203.0.113.1 - type: string - type: - default: reply - description: 'The type of healthcheck to run, reply or request. The default value is `reply`.' - enum: - - reply - - request - example: request - type: string - type: object - schemas-mtu: - default: 1476 - description: The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576. - type: integer - components-schemas-modified_tunnels_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_interconnects: - items: - $ref: '#/components/schemas/interconnect' - type: array - components-schemas-tunnel_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - interconnect: - type: object - components-schemas-tunnel_update_request: - properties: - description: - $ref: '#/components/schemas/interconnect_components-schemas-description' - gre: - $ref: '#/components/schemas/gre' - interface_address: - $ref: '#/components/schemas/interface_address' - mtu: - $ref: '#/components/schemas/schemas-mtu' - type: object - components-schemas-tunnel_modified_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_interconnect: - type: object - config_components-schemas-account_identifier: - example: 6f91088a406011ed95aed352566e8d4c - mnm_config: - properties: - default_sampling: - $ref: '#/components/schemas/mnm_config_default_sampling' - name: - $ref: '#/components/schemas/mnm_config_name' - router_ips: - $ref: '#/components/schemas/mnm_config_router_ips' - required: - - name - - default_sampling - - router_ips - type: object - mnm_config_default_sampling: - default: 1 - description: Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router. - minimum: 1 - type: number - mnm_config_name: - description: The account name. - example: cloudflare user's account - type: string - mnm_config_router_ips: - items: - $ref: '#/components/schemas/mnm_config_router_ip' - type: array - mnm_config_router_ip: - description: IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported. - example: 203.0.113.1/32 - type: string - rules_components-schemas-account_identifier: - example: 6f91088a406011ed95aed352566e8d4c - mnm_rules: - items: - $ref: '#/components/schemas/mnm_rule' - type: array - mnm_rule: - properties: - automatic_advertisement: - $ref: '#/components/schemas/mnm_rule_automatic_advertisement' - bandwidth_threshold: - $ref: '#/components/schemas/mnm_rule_bandwidth_threshold' - duration: - $ref: '#/components/schemas/mnm_rule_duration' - id: - $ref: '#/components/schemas/schemas-rule_identifier' - name: - $ref: '#/components/schemas/mnm_rule_name' - packet_threshold: - $ref: '#/components/schemas/mnm_rule_packet_threshold' - prefixes: - $ref: '#/components/schemas/mnm_rule_ip_prefixes' - required: - - name - - prefixes - - automatic_advertisement - - duration - type: object - mnm_rule_automatic_advertisement: - description: Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit. - example: 'false' - type: boolean - mnm_rule_bandwidth_threshold: - description: 'The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.' - example: 1000 - minimum: 1 - type: number - mnm_rule_duration: - default: 60s - description: 'The amount of time that the rule threshold must be exceeded to send an alert notification. The minimum is 60 seconds and maximum is 21600 seconds. The format is XhYmZs where X, Y, and Z durations are optional; however at least one unit must be provided.' - example: 1h2m3s - type: string - schemas-rule_identifier: - example: 2890e6fa406311ed9b5a23f70f6fb8cf - mnm_rule_name: - description: 'The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters.' - example: my_rule_1 - type: string - mnm_rule_packet_threshold: - description: 'The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.' - example: 10000 - minimum: 1 - type: number - mnm_rule_ip_prefixes: - items: - $ref: '#/components/schemas/mnm_rule_ip_prefix' - type: array - mnm_rule_ip_prefix: - description: The IP prefixes that are monitored for this rule. Must be a CIDR range like 203.0.113.0/24. Max 5000 different CIDR ranges. - example: 203.0.113.1/32 - type: string - pcaps_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - anyOf: - - $ref: '#/components/schemas/pcaps_response_simple' - - $ref: '#/components/schemas/pcaps_response_full' - type: array - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - pcaps_response_simple: - properties: - filter_v1: - $ref: '#/components/schemas/pcaps_filter_v1' - id: - $ref: '#/components/schemas/pcaps_id' - status: - $ref: '#/components/schemas/pcaps_status' - submitted: - $ref: '#/components/schemas/pcaps_submitted' - system: - $ref: '#/components/schemas/pcaps_system' - time_limit: - $ref: '#/components/schemas/pcaps_time_limit' - type: - $ref: '#/components/schemas/pcaps_type' - type: object - pcaps_response_full: - properties: - byte_limit: - $ref: '#/components/schemas/pcaps_byte_limit' - colo_name: - $ref: '#/components/schemas/pcaps_colo_name' - destination_conf: - $ref: '#/components/schemas/pcaps_destination_conf' - error_message: - $ref: '#/components/schemas/pcaps_error_message' - filter_v1: - $ref: '#/components/schemas/pcaps_filter_v1' - id: - $ref: '#/components/schemas/pcaps_id' - status: - $ref: '#/components/schemas/pcaps_status' - submitted: - $ref: '#/components/schemas/pcaps_submitted' - system: - $ref: '#/components/schemas/pcaps_system' - time_limit: - $ref: '#/components/schemas/pcaps_time_limit' - type: - $ref: '#/components/schemas/pcaps_type' - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - pcaps_filter_v1: - description: 'The packet capture filter. When this field is empty, all packets are captured.' - properties: - destination_address: - description: The destination IP address of the packet. - example: 1.2.3.4 - type: string - destination_port: - description: The destination port of the packet. - example: 80 - type: number - protocol: - description: The protocol number of the packet. - example: 6 - type: number - source_address: - description: The source IP address of the packet. - example: 1.2.3.4 - type: string - source_port: - description: The source port of the packet. - example: 123 - type: number - type: object - pcaps_id: - description: The ID for the packet capture. - example: 66802ca5668e47a2b82c2e6746e45037 - maxLength: 32 - minLength: 32 - type: string - pcaps_status: - description: The status of the packet capture request. - enum: - - unknown - - success - - pending - - running - - conversion_pending - - conversion_running - - complete - - failed - example: success - type: string - pcaps_submitted: - description: The RFC 3339 timestamp when the packet capture was created. - example: '2020-01-01T08:00:00Z' - type: string - pcaps_system: - description: The system used to collect packet captures. - enum: - - magic-transit - example: magic-transit - type: string - pcaps_time_limit: - description: The packet capture duration in seconds. - example: 300 - maximum: 300 - minimum: 1 - type: number - pcaps_type: - description: 'The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.' - enum: - - simple - - full - example: simple - type: string - pcaps_byte_limit: - description: The maximum number of bytes to capture. This field only applies to `full` packet captures. - example: 500000 - maximum: 1000000000 - minimum: 1 - type: number - pcaps_colo_name: - description: The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures. - example: ord02 - type: string - pcaps_destination_conf: - description: The full URI for the bucket. This field only applies to `full` packet captures. - example: 's3://pcaps-bucket?region=us-east-1' - type: string - pcaps_error_message: - description: An error message that describes why the packet capture failed. This field only applies to `full` packet captures. - example: No packets matched the filter in the time limit given. Please modify the filter or try again. - type: string - pcaps_request_pcap: - anyOf: - - $ref: '#/components/schemas/pcaps_request_simple' - - $ref: '#/components/schemas/pcaps_request_full' - pcaps_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - anyOf: - - $ref: '#/components/schemas/pcaps_response_simple' - - $ref: '#/components/schemas/pcaps_response_full' - pcaps_request_simple: - properties: - filter_v1: - $ref: '#/components/schemas/pcaps_filter_v1' - packet_limit: - $ref: '#/components/schemas/pcaps_packet_limit' - system: - $ref: '#/components/schemas/pcaps_system' - time_limit: - $ref: '#/components/schemas/pcaps_time_limit' - type: - $ref: '#/components/schemas/pcaps_type' - required: - - time_limit - - packet_limit - - type - - system - type: object - pcaps_request_full: - properties: - byte_limit: - $ref: '#/components/schemas/pcaps_byte_limit' - colo_name: - $ref: '#/components/schemas/pcaps_colo_name' - destination_conf: - $ref: '#/components/schemas/pcaps_destination_conf' - filter_v1: - $ref: '#/components/schemas/pcaps_filter_v1' - packet_limit: - $ref: '#/components/schemas/pcaps_packet_limit' - system: - $ref: '#/components/schemas/pcaps_system' - time_limit: - $ref: '#/components/schemas/pcaps_time_limit' - type: - $ref: '#/components/schemas/pcaps_type' - required: - - time_limit - - type - - system - - colo_name - - destination_conf - type: object - pcaps_packet_limit: - description: The limit of packets contained in a packet capture. - example: 10000 - maximum: 10000 - minimum: 1 - type: number - pcaps_ownership_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/pcaps_ownership_response' - nullable: true - type: array - pcaps_ownership_response: - properties: - destination_conf: - $ref: '#/components/schemas/pcaps_destination_conf' - filename: - $ref: '#/components/schemas/pcaps_ownership_challenge' - id: - description: The bucket ID associated with the packet captures API. - example: 9883874ecac311ec8475433579a6bf5f - maxLength: 32 - minLength: 32 - type: string - status: - description: 'The status of the ownership challenge. Can be pending, success or failed.' - enum: - - pending - - success - - failed - example: success - type: string - submitted: - description: The RFC 3339 timestamp when the bucket was added to packet captures API. - example: '2020-01-01T08:00:00Z' - type: string - validated: - description: The RFC 3339 timestamp when the bucket was validated. - example: '2020-01-01T08:00:00Z' - type: string - required: - - id - - status - - submitted - - destination_conf - - filename - type: object - pcaps_ownership_challenge: - description: The ownership challenge filename stored in the bucket. - example: ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt - type: string - pcaps_ownership_request: - properties: - destination_conf: - $ref: '#/components/schemas/pcaps_destination_conf' - required: - - destination_conf - type: object - pcaps_ownership_single_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - $ref: '#/components/schemas/pcaps_ownership_response' - pcaps_ownership_validate_request: - properties: - destination_conf: - $ref: '#/components/schemas/pcaps_destination_conf' - ownership_challenge: - $ref: '#/components/schemas/pcaps_ownership_challenge' - required: - - destination_conf - - ownership_challenge - type: object - routes_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - routes: - items: - $ref: '#/components/schemas/schemas-route' - type: array - schemas-route: - properties: - created_on: - $ref: '#/components/schemas/route_components-schemas-created_on' - description: - $ref: '#/components/schemas/route_components-schemas-description' - id: - $ref: '#/components/schemas/route_components-schemas-identifier' - modified_on: - $ref: '#/components/schemas/route_components-schemas-modified_on' - nexthop: - $ref: '#/components/schemas/nexthop' - prefix: - $ref: '#/components/schemas/prefix' - priority: - $ref: '#/components/schemas/route_components-schemas-priority' - scope: - $ref: '#/components/schemas/schemas-scope' - weight: - $ref: '#/components/schemas/schemas-weight' - required: - - prefix - - nexthop - - priority - type: object - route_components-schemas-created_on: - description: When the route was created. - example: '2017-06-14T00:00:00Z' - format: date-time - readOnly: true - type: string - route_components-schemas-description: - description: An optional human provided description of the static route. - example: New route for new prefix 203.0.113.1 - type: string - route_components-schemas-identifier: - description: Route identifier tag. - example: c4a7362d577a6c3019a474fd6f485821 - maxLength: 32 - readOnly: true - type: string - route_components-schemas-modified_on: - description: When the route was last modified. - example: '2017-06-14T05:20:00Z' - format: date-time - readOnly: true - type: string - nexthop: - description: The next-hop IP Address for the static route. - example: 203.0.113.1 - type: string - prefix: - description: IP Prefix in Classless Inter-Domain Routing format. - example: 192.0.2.0/24 - type: string - route_components-schemas-priority: - description: Priority of the static route. - type: integer - schemas-scope: - description: Used only for ECMP routes. - properties: - colo_names: - $ref: '#/components/schemas/colo_names' - colo_regions: - $ref: '#/components/schemas/colo_regions' - type: object - schemas-weight: - description: Optional weight of the ECMP scope - if provided. - type: integer - colo_names: - description: List of colo names for the ECMP scope. - items: - $ref: '#/components/schemas/schemas-colo_name' - type: array - colo_regions: - description: List of colo regions for the ECMP scope. - items: - $ref: '#/components/schemas/colo_region' - type: array - schemas-colo_name: - description: Scope colo name. - example: den01 - type: string - colo_region: - description: Scope colo region. - example: APAC - type: string - route_update_many_request: - properties: - routes: - items: - $ref: '#/components/schemas/route_update_single_request' - type: array - required: - - routes - type: object - multiple_route_modified_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_routes: - items: - $ref: '#/components/schemas/schemas-route' - type: array - route_update_single_request: - allOf: - - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - - $ref: '#/components/schemas/route_add_single_request' - route_add_single_request: - properties: - description: - $ref: '#/components/schemas/route_components-schemas-description' - nexthop: - $ref: '#/components/schemas/nexthop' - prefix: - $ref: '#/components/schemas/prefix' - priority: - $ref: '#/components/schemas/route_components-schemas-priority' - scope: - $ref: '#/components/schemas/schemas-scope' - weight: - $ref: '#/components/schemas/schemas-weight' - required: - - prefix - - nexthop - - priority - type: object - route_deleted_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - deleted: - example: true - type: boolean - deleted_route: - type: object - route_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - route: - type: object - route_update_request: - allOf: - - $ref: '#/components/schemas/route_add_single_request' - route_modified_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - modified: - example: true - type: boolean - modified_route: - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_gre_tunnels: - id: cloudflare.magic.accounts_gre_tunnels - name: accounts_gre_tunnels - title: Accounts Gre Tunnels - methods: - gre_tunnels_list_gre_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.gre_tunnels - _gre_tunnels_list_gre_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gre_tunnels_create_gre_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels/post' - response: - mediaType: application/json - openAPIDocKey: '200' - gre_tunnels_update_multiple_gre_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels/put' - response: - mediaType: application/json - openAPIDocKey: '200' - gre_tunnels_delete_gre_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels~1{tunnel_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - gre_tunnels_list_gre_tunnel_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels~1{tunnel_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.gre_tunnel - _gre_tunnels_list_gre_tunnel_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels~1{tunnel_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gre_tunnels_update_gre_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1gre_tunnels~1{tunnel_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gre_tunnels/methods/gre_tunnels_list_gre_tunnels' - - $ref: '#/components/x-stackQL-resources/accounts_gre_tunnels/methods/gre_tunnels_list_gre_tunnel_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_gre_tunnels/methods/gre_tunnels_create_gre_tunnels' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_gre_tunnels/methods/gre_tunnels_delete_gre_tunnel' - accounts_ipsec_tunnels: - id: cloudflare.magic.accounts_ipsec_tunnels - name: accounts_ipsec_tunnels - title: Accounts Ipsec Tunnels - methods: - i_psec_tunnels_list_i_psec_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.ipsec_tunnels - _i_psec_tunnels_list_i_psec_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels/get' - response: - mediaType: application/json - openAPIDocKey: '200' - i_psec_tunnels_create_i_psec_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels/post' - response: - mediaType: application/json - openAPIDocKey: '200' - i_psec_tunnels_update_multiple_i_psec_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels/put' - response: - mediaType: application/json - openAPIDocKey: '200' - i_psec_tunnels_delete_i_psec_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels~1{tunnel_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - i_psec_tunnels_list_i_psec_tunnel_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels~1{tunnel_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.ipsec_tunnel - _i_psec_tunnels_list_i_psec_tunnel_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels~1{tunnel_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - i_psec_tunnels_update_i_psec_tunnel: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels~1{tunnel_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - i_psec_tunnels_generate_pre_shared_key___psk__for_i_psec_tunnels: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1ipsec_tunnels~1{tunnel_identifier}~1psk_generate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_ipsec_tunnels/methods/i_psec_tunnels_list_i_psec_tunnels' - - $ref: '#/components/x-stackQL-resources/accounts_ipsec_tunnels/methods/i_psec_tunnels_list_i_psec_tunnel_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_ipsec_tunnels/methods/i_psec_tunnels_create_i_psec_tunnels' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_ipsec_tunnels/methods/i_psec_tunnels_delete_i_psec_tunnel' - accounts_cf_interconnects: - id: cloudflare.magic.accounts_cf_interconnects - name: accounts_cf_interconnects - title: Accounts Cf Interconnects - methods: - interconnects_list_interconnects: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1cf_interconnects/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.interconnects - _interconnects_list_interconnects: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1cf_interconnects/get' - response: - mediaType: application/json - openAPIDocKey: '200' - interconnects_update_multiple_interconnects: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1cf_interconnects/put' - response: - mediaType: application/json - openAPIDocKey: '200' - interconnects_list_interconnect_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1cf_interconnects~1{tunnel_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.interconnect - _interconnects_list_interconnect_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1cf_interconnects~1{tunnel_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - interconnects_update_interconnect: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1cf_interconnects~1{tunnel_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_cf_interconnects/methods/interconnects_list_interconnects' - - $ref: '#/components/x-stackQL-resources/accounts_cf_interconnects/methods/interconnects_list_interconnect_details' - insert: [] - update: [] - delete: [] - accounts_mnm_config: - id: cloudflare.magic.accounts_mnm_config - name: accounts_mnm_config - title: Accounts Mnm Config - methods: - network_monitoring_configuration_delete_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_configuration_list_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _network_monitoring_configuration_list_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config/get' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_configuration_update_account_configuration_fields: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_configuration_create_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config/post' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_configuration_update_an_entire_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_mnm_config/methods/network_monitoring_configuration_list_account_configuration' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_mnm_config/methods/network_monitoring_configuration_create_account_configuration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_mnm_config/methods/network_monitoring_configuration_delete_account_configuration' - accounts_mnm_config_full: - id: cloudflare.magic.accounts_mnm_config_full - name: accounts_mnm_config_full - title: Accounts Mnm Config Full - methods: - network_monitoring_configuration_list_rules_and_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config~1full/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _network_monitoring_configuration_list_rules_and_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1config~1full/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_mnm_config_full/methods/network_monitoring_configuration_list_rules_and_account_configuration' - insert: [] - update: [] - delete: [] - accounts_mnm_rules: - id: cloudflare.magic.accounts_mnm_rules - name: accounts_mnm_rules - title: Accounts Mnm Rules - methods: - network_monitoring_rules_list_rules: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _network_monitoring_rules_list_rules: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_rules_create_rules: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_rules_update_rules: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules/put' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_rules_delete_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules~1{rule_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_rules_get_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules~1{rule_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _network_monitoring_rules_get_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules~1{rule_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_rules_update_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules~1{rule_identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - network_monitoring_rules_update_advertisement_for_rule: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1mnm~1rules~1{rule_identifier}~1advertisement/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_mnm_rules/methods/network_monitoring_rules_list_rules' - - $ref: '#/components/x-stackQL-resources/accounts_mnm_rules/methods/network_monitoring_rules_get_rule' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_mnm_rules/methods/network_monitoring_rules_create_rules' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_mnm_rules/methods/network_monitoring_rules_delete_rule' - accounts_pcaps: - id: cloudflare.magic.accounts_pcaps - name: accounts_pcaps - title: Accounts Pcaps - methods: - pcap_collection_list_packet_capture_requests: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _pcap_collection_list_packet_capture_requests: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - pcap_collection_create_pcap_request: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps/post' - response: - mediaType: application/json - openAPIDocKey: '200' - pcap_collection_get_pcap_request: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _pcap_collection_get_pcap_request: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - pcap_collection_download_simple_pcap: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1{identifier}~1download/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _pcap_collection_download_simple_pcap: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1{identifier}~1download/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_pcaps/methods/pcap_collection_list_packet_capture_requests' - - $ref: '#/components/x-stackQL-resources/accounts_pcaps/methods/pcap_collection_get_pcap_request' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_pcaps/methods/pcap_collection_create_pcap_request' - update: [] - delete: [] - accounts_pcaps_ownership: - id: cloudflare.magic.accounts_pcaps_ownership - name: accounts_pcaps_ownership - title: Accounts Pcaps Ownership - methods: - pcap_collection_list_pca_ps_bucket_ownership: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1ownership/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _pcap_collection_list_pca_ps_bucket_ownership: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1ownership/get' - response: - mediaType: application/json - openAPIDocKey: '200' - pcap_collection_add_buckets_for_full_packet_captures: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1ownership/post' - response: - mediaType: application/json - openAPIDocKey: '200' - pcap_collection_delete_buckets_for_full_packet_captures: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1ownership~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - pcap_collection_validate_buckets_for_full_packet_captures: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pcaps~1ownership~1validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_pcaps_ownership/methods/pcap_collection_list_pca_ps_bucket_ownership' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_pcaps_ownership/methods/pcap_collection_delete_buckets_for_full_packet_captures' - accounts_routes: - id: cloudflare.magic.accounts_routes - name: accounts_routes - title: Accounts Routes - methods: - static_routes_list_routes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _static_routes_list_routes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - static_routes_create_routes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes/post' - response: - mediaType: application/json - openAPIDocKey: '200' - static_routes_update_many_routes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes/put' - response: - mediaType: application/json - openAPIDocKey: '200' - static_routes_delete_route: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes~1{route_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - static_routes_route_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes~1{route_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _static_routes_route_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes~1{route_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - static_routes_update_route: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1magic~1routes~1{route_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_routes/methods/static_routes_list_routes' - - $ref: '#/components/x-stackQL-resources/accounts_routes/methods/static_routes_route_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_routes/methods/static_routes_create_routes' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_routes/methods/static_routes_delete_route' -paths: - '/accounts/{account_identifier}/magic/gre_tunnels': - get: - description: Lists GRE tunnels associated with an account. - operationId: magic-gre-tunnels-list-gre-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnels_collection_response' - description: List GRE tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List GRE tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List GRE tunnels - tags: - - Magic GRE tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Creates new GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-gre-tunnels-create-gre-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - customer_gre_endpoint - - cloudflare_gre_endpoint - - interface_address - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnels_collection_response' - description: Create GRE tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create GRE tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create GRE tunnels - tags: - - Magic GRE tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-gre-tunnels-update-multiple-gre-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/modified_tunnels_collection_response' - description: Update multiple GRE tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/modified_tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update multiple GRE tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update multiple GRE tunnels - tags: - - Magic GRE tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}': - delete: - description: Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-gre-tunnels-delete-gre-tunnel - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_deleted_response' - description: Delete GRE Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_deleted_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete GRE Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete GRE Tunnel - tags: - - Magic GRE tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Lists informtion for a specific GRE tunnel. - operationId: magic-gre-tunnels-list-gre-tunnel-details - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_single_response' - description: List GRE Tunnel Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List GRE Tunnel Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List GRE Tunnel Details - tags: - - Magic GRE tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-gre-tunnels-update-gre-tunnel - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_update_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/tunnel_modified_response' - description: Update GRE Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/tunnel_modified_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update GRE Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update GRE Tunnel - tags: - - Magic GRE tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/ipsec_tunnels': - get: - description: Lists IPsec tunnels associated with an account. - operationId: magic-i-psec-tunnels-list-i-psec-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnels_collection_response' - description: List IPsec tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List IPsec tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List IPsec tunnels - tags: - - Magic IPsec tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-i-psec-tunnels-create-i-psec-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - name - - customer_ipsec_endpoint - - cloudflare_ipsec_endpoint - - interface_address - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnels_collection_response' - description: Create IPsec tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create IPsec tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create IPsec tunnels - tags: - - Magic IPsec tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-i-psec-tunnels-update-multiple-i-psec-tunnels - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-modified_tunnels_collection_response' - description: Update multiple IPsec tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-modified_tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update multiple IPsec tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update multiple IPsec tunnels - tags: - - Magic IPsec tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}': - delete: - description: Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-i-psec-tunnels-delete-i-psec-tunnel - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_deleted_response' - description: Delete IPsec Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_deleted_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete IPsec Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete IPsec Tunnel - tags: - - Magic IPsec tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Lists details for a specific IPsec tunnel. - operationId: magic-i-psec-tunnels-list-i-psec-tunnel-details - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_single_response' - description: List IPsec tunnel details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List IPsec tunnel details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List IPsec tunnel details - tags: - - Magic IPsec tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-i-psec-tunnels-update-i-psec-tunnel - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_update_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-tunnel_modified_response' - description: Update IPsec Tunnel response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-tunnel_modified_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update IPsec Tunnel response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update IPsec Tunnel - tags: - - Magic IPsec tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate': - post: - description: 'Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare''s edge and cannot be retrieved later. Note the PSK in a safe place.' - operationId: magic-i-psec-tunnels-generate-pre-shared-key-(-psk)-for-i-psec-tunnels - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/psk_generation_response' - description: Generate Pre Shared Key (PSK) for IPsec tunnels response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/psk_generation_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Generate Pre Shared Key (PSK) for IPsec tunnels response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Generate Pre Shared Key (PSK) for IPsec tunnels - tags: - - Magic IPsec tunnels - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/cf_interconnects': - get: - description: Lists interconnects associated with an account. - operationId: magic-interconnects-list-interconnects - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-tunnels_collection_response' - description: List interconnects response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List interconnects response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List interconnects - tags: - - Magic Interconnects - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-interconnects-update-multiple-interconnects - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-modified_tunnels_collection_response' - description: Update multiple interconnects response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-modified_tunnels_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update multiple interconnects response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update multiple interconnects - tags: - - Magic Interconnects - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}': - get: - description: Lists details for a specific interconnect. - operationId: magic-interconnects-list-interconnect-details - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-tunnel_single_response' - description: List interconnect Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-tunnel_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List interconnect Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List interconnect Details - tags: - - Magic Interconnects - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. - operationId: magic-interconnects-update-interconnect - parameters: - - in: path - name: tunnel_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-tunnel_update_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-tunnel_modified_response' - description: Update interconnect response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-tunnel_modified_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update interconnect response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update interconnect - tags: - - Magic Interconnects - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/mnm/config': - delete: - description: Delete an existing network monitoring configuration. - operationId: magic-network-monitoring-configuration-delete-account-configuration - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/config_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_config' - description: Delete account configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete account configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete account configuration - tags: - - Magic Network Monitoring Configuration - get: - description: Lists default sampling and router IPs for account. - operationId: magic-network-monitoring-configuration-list-account-configuration - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/config_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_config' - description: List account configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: List account configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List account configuration - tags: - - Magic Network Monitoring Configuration - patch: - description: Update fields in an existing network monitoring configuration. - operationId: magic-network-monitoring-configuration-update-account-configuration-fields - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/config_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_config' - description: Update account configuration fields response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update account configuration fields response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update account configuration fields - tags: - - Magic Network Monitoring Configuration - post: - description: Create a new network monitoring configuration. - operationId: magic-network-monitoring-configuration-create-account-configuration - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/config_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_config' - description: Create account configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create account configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create account configuration - tags: - - Magic Network Monitoring Configuration - put: - description: 'Update an existing network monitoring configuration, requires the entire configuration to be updated at once.' - operationId: magic-network-monitoring-configuration-update-an-entire-account-configuration - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/config_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_config' - description: Update an entire account configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an entire account configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update an entire account configuration - tags: - - Magic Network Monitoring Configuration - '/accounts/{account_identifier}/mnm/config/full': - get: - description: 'Lists default sampling, router IPs, and rules for account.' - operationId: magic-network-monitoring-configuration-list-rules-and-account-configuration - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/config_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_config' - description: List rules and account configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: List rules and account configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List rules and account configuration - tags: - - Magic Network Monitoring Configuration - '/accounts/{account_identifier}/mnm/rules': - get: - description: Lists network monitoring rules for account. - operationId: magic-network-monitoring-rules-list-rules - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_rules' - description: List rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_rules' - - $ref: '#/components/schemas/api-response-common-failure' - description: List rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List rules - tags: - - Magic Network Monitoring Rules - post: - description: Create network monitoring rules for account. - operationId: magic-network-monitoring-rules-create-rules - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_rules' - description: Create rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_rules' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create rules - tags: - - Magic Network Monitoring Rules - put: - description: Update network monitoring rules for account. - operationId: magic-network-monitoring-rules-update-rules - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_rules' - description: Update rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_rules' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update rules - tags: - - Magic Network Monitoring Rules - '/accounts/{account_identifier}/mnm/rules/{rule_identifier}': - delete: - description: Delete a network monitoring rule for account. - operationId: magic-network-monitoring-rules-delete-rule - parameters: - - in: path - name: rule_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-rule_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_rule' - description: Delete rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_rule' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete rule - tags: - - Magic Network Monitoring Rules - get: - description: List a single network monitoring rule for account. - operationId: magic-network-monitoring-rules-get-rule - parameters: - - in: path - name: rule_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-rule_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_rule' - description: Get rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_rule' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get rule - tags: - - Magic Network Monitoring Rules - patch: - description: Update a network monitoring rule for account. - operationId: magic-network-monitoring-rules-update-rule - parameters: - - in: path - name: rule_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-rule_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_rule' - description: Update rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_rule' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update rule - tags: - - Magic Network Monitoring Rules - '/accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement': - patch: - description: Update advertisement for rule. - operationId: magic-network-monitoring-rules-update-advertisement-for-rule - parameters: - - in: path - name: rule_identifier - required: true - schema: - $ref: '#/components/schemas/schemas-rule_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/mnm_rule_automatic_advertisement' - description: Update advertisement for rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/mnm_rule_automatic_advertisement' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update advertisement for rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update advertisement for rule - tags: - - Magic Network Monitoring Rules - '/accounts/{account_identifier}/pcaps': - get: - description: Lists all packet capture requests for an account. - operationId: magic-pcap-collection-list-packet-capture-requests - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_collection_response' - description: List packet capture requests response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pcaps_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List packet capture requests response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List packet capture requests - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Create new PCAP request for account. - operationId: magic-pcap-collection-create-pcap-request - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_request_pcap' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_single_response' - description: Create PCAP request response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pcaps_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create PCAP request response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create PCAP request - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/pcaps/ownership': - get: - description: List all buckets configured for use with PCAPs API. - operationId: magic-pcap-collection-list-pca-ps-bucket-ownership - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_ownership_collection' - description: List PCAPs Bucket Ownership response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pcaps_ownership_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List PCAPs Bucket Ownership response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List PCAPs Bucket Ownership - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Adds an AWS or GCP bucket to use with full packet captures. - operationId: magic-pcap-collection-add-buckets-for-full-packet-captures - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_ownership_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_ownership_single_response' - description: Add buckets for full packet captures response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pcaps_ownership_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add buckets for full packet captures response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add buckets for full packet captures - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/pcaps/ownership/validate': - post: - description: Validates buckets added to the packet captures API. - operationId: magic-pcap-collection-validate-buckets-for-full-packet-captures - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_ownership_validate_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_ownership_single_response' - description: Validate buckets for full packet captures response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pcaps_ownership_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Validate buckets for full packet captures response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Validate buckets for full packet captures - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/pcaps/ownership/{identifier}': - delete: - description: Deletes buckets added to the packet captures API. - operationId: magic-pcap-collection-delete-buckets-for-full-packet-captures - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: {} - description: Delete buckets for full packet captures response - 4xx: - content: - application/json: {} - description: Delete buckets for full packet captures response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete buckets for full packet captures - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/pcaps/{identifier}': - get: - description: Get information for a PCAP request by id. - operationId: magic-pcap-collection-get-pcap-request - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pcaps_single_response' - description: Get PCAP request response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pcaps_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get PCAP request response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get PCAP request - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/pcaps/{identifier}/download': - get: - description: Download PCAP information into a file. Response is a binary PCAP file. - operationId: magic-pcap-collection-download-simple-pcap - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: {} - description: Download Simple PCAP response - 4xx: - content: - application/json: {} - description: Download Simple PCAP response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Download Simple PCAP - tags: - - Magic PCAP collection - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/routes': - get: - description: List all Magic static routes. - operationId: magic-static-routes-list-routes - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/routes_collection_response' - description: List Routes response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/routes_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Routes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Routes - tags: - - Magic Static Routes - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. - operationId: magic-static-routes-create-routes - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - prefix - - nexthop - - priority - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/routes_collection_response' - description: Create Routes response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/routes_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Routes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Routes - tags: - - Magic Static Routes - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided. - operationId: magic-static-routes-update-many-routes - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/route_update_many_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/multiple_route_modified_response' - description: Update Many Routes response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/multiple_route_modified_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Many Routes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Many Routes - tags: - - Magic Static Routes - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/magic/routes/{route_identifier}': - delete: - description: Disable and remove a specific Magic static route. - operationId: magic-static-routes-delete-route - parameters: - - in: path - name: route_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_deleted_response' - description: Delete Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_deleted_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Route - tags: - - Magic Static Routes - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Get a specific Magic static route. - operationId: magic-static-routes-route-details - parameters: - - in: path - name: route_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_single_response' - description: Route Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Route Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Route Details - tags: - - Magic Static Routes - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. - operationId: magic-static-routes-update-route - parameters: - - in: path - name: route_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/route_update_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_modified_response' - description: Update Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_modified_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Route - tags: - - Magic Static Routes - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false diff --git a/providers/src/cloudflare/v00.00.00000/services/magic_cloud_networking.yaml b/providers/src/cloudflare/v00.00.00000/services/magic_cloud_networking.yaml new file mode 100644 index 00000000..6c04b338 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/magic_cloud_networking.yaml @@ -0,0 +1,4727 @@ +openapi: 3.0.3 +info: + title: magic_cloud_networking API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/magic/cloud/catalog-syncs: + get: + description: List Catalog Syncs (Closed Beta). + operationId: catalog-syncs-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnReadAccountCatalogSyncsResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Catalog Syncs + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + method: list + post: + description: Create a new Catalog Sync (Closed Beta). + operationId: catalog-syncs-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: forwarded + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnCreateCatalogSyncRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnCreateCatalogSyncResponse' + description: Created. + headers: + location: + description: The path to the newly created list. + schema: + type: string + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Catalog Sync + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + method: create + /accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies: + get: + description: List prebuilt catalog sync policies (Closed Beta). + operationId: catalog-syncs-prebuilt-policies-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Specify type of destination, omit to return all. + in: query + name: destination_type + schema: + $ref: '#/components/schemas/mcnCatalogSyncDestinationType' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnCatalogSyncsPrebuiltPoliciesResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Prebuilt Policies + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + - prebuilt_policies + method: list + /accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}: + delete: + description: Delete a Catalog Sync (Closed Beta). + operationId: catalog-syncs-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sync_id + schema: + $ref: '#/components/schemas/mcnCatalogSyncId' + required: true + - in: query + name: delete_destination + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnDeleteCatalogSyncResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Catalog Sync + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + method: delete + get: + description: Read a Catalog Sync (Closed Beta). + operationId: catalog-syncs-read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sync_id + schema: + $ref: '#/components/schemas/mcnCatalogSyncId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnReadAccountCatalogSyncResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read Catalog Sync + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + method: get + patch: + description: Update a Catalog Sync (Closed Beta). + operationId: catalog-syncs-patch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sync_id + schema: + $ref: '#/components/schemas/mcnCatalogSyncId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateCatalogSyncRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateCatalogSyncResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Catalog Sync + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + method: edit + put: + description: Update a Catalog Sync (Closed Beta). + operationId: catalog-syncs-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sync_id + schema: + $ref: '#/components/schemas/mcnCatalogSyncId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateCatalogSyncRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateCatalogSyncResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Catalog Sync + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + method: update + /accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}/refresh: + post: + description: Refresh a Catalog Sync's destination by running the sync policy against latest resource catalog (Closed Beta). + operationId: catalog-syncs-refresh + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sync_id + schema: + $ref: '#/components/schemas/mcnCatalogSyncId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnRefreshCatalogSyncResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Run Catalog Sync + tags: + - Catalog Sync + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - catalog_syncs + method: refresh + /accounts/{account_id}/magic/cloud/onramps: + get: + description: List On-ramps (Closed Beta). + operationId: onramps-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: One of ["updated_at", "id", "cloud_type", "name"]. + in: query + name: order_by + schema: + type: string + - in: query + name: desc + schema: + type: boolean + - in: query + name: status + schema: + type: boolean + - in: query + name: vpcs + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnListOnrampsResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List On-ramps + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: list + post: + description: Create a new On-ramp (Closed Beta). + operationId: onramps-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: forwarded + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnCreateOnrampRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnCreateOnrampResponse' + description: Created. + headers: + location: + description: The path to the newly created resource. + schema: + type: string + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create On-ramp + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: create + /accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space: + get: + description: Read the Magic WAN Address Space (Closed Beta). + operationId: onramps-mwan-addr-space-read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnGetMagicWanAddressSpaceResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read Magic WAN Address Space + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + - address_spaces + method: list + patch: + description: Update the Magic WAN Address Space (Closed Beta). + operationId: onramps-mwan-addr-space-patch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateMagicWanAddressSpaceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateMagicWanAddressSpaceResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Magic WAN Address Space + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + - address_spaces + method: edit + put: + description: Update the Magic WAN Address Space (Closed Beta). + operationId: onramps-mwan-addr-space-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateMagicWanAddressSpaceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateMagicWanAddressSpaceResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Magic WAN Address Space + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + - address_spaces + method: update + /accounts/{account_id}/magic/cloud/onramps/{onramp_id}: + delete: + description: Delete an On-ramp (Closed Beta). + operationId: onramps-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: onramp_id + schema: + $ref: '#/components/schemas/mcnOnrampId' + required: true + - in: query + name: destroy + schema: + type: boolean + - in: query + name: force + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnDeleteOnrampResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete On-ramp + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: delete + get: + description: Read an On-ramp (Closed Beta). + operationId: onramps-read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: onramp_id + schema: + $ref: '#/components/schemas/mcnOnrampId' + required: true + - in: query + name: status + schema: + type: boolean + - in: query + name: vpcs + schema: + type: boolean + - in: query + name: post_apply_resources + schema: + type: boolean + - in: query + name: planned_resources + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnGetOnrampResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read On-ramp + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: get + patch: + description: Update an On-ramp (Closed Beta). + operationId: onramps-patch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: onramp_id + schema: + $ref: '#/components/schemas/mcnOnrampId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateOnrampRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateOnrampResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch On-ramp + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: edit + put: + description: Update an On-ramp (Closed Beta). + operationId: onramps-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: onramp_id + schema: + $ref: '#/components/schemas/mcnOnrampId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateOnrampRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateOnrampResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update On-ramp + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: update + /accounts/{account_id}/magic/cloud/onramps/{onramp_id}/apply: + post: + description: Apply an On-ramp (Closed Beta). + operationId: onramps-apply + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: onramp_id + schema: + $ref: '#/components/schemas/mcnOnrampId' + required: true + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnGoodResponse' + description: Accepted. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Apply On-ramp + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: apply + /accounts/{account_id}/magic/cloud/onramps/{onramp_id}/export: + post: + description: Export an On-ramp to terraform ready file(s) (Closed Beta). + operationId: onramps-export + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: onramp_id + schema: + $ref: '#/components/schemas/mcnOnrampId' + required: true + responses: + '201': + content: + application/zip: + schema: + type: object + properties: + contents: + type: string + description: Exported file. + headers: + Content-Disposition: + schema: + type: string + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Export as Terraform + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: export + /accounts/{account_id}/magic/cloud/onramps/{onramp_id}/plan: + post: + description: Plan an On-ramp (Closed Beta). + operationId: onramps-plan + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: onramp_id + schema: + $ref: '#/components/schemas/mcnOnrampId' + required: true + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnGoodResponse' + description: Accepted. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Plan On-ramp + tags: + - On-ramps + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - on_ramps + method: plan + /accounts/{account_id}/magic/cloud/providers: + get: + description: List Cloud Integrations (Closed Beta). + operationId: providers-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: status + schema: + type: boolean + - description: One of ["updated_at", "id", "cloud_type", "name"]. + in: query + name: order_by + schema: + type: string + - in: query + name: desc + schema: + type: boolean + - in: query + name: cloudflare + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnReadAccountProvidersResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Cloud Integrations + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: list + post: + description: Create a new Cloud Integration (Closed Beta). + operationId: providers-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: forwarded + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnCreateProviderRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnCreateProviderResponse' + description: Created. + headers: + location: + description: The path to the newly created resource. + schema: + type: string + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Cloud Integration + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: create + /accounts/{account_id}/magic/cloud/providers/discover: + post: + description: Run discovery for all Cloud Integrations in an account (Closed Beta). + operationId: providers-discover-all + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnGoodResponse' + description: Accepted. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Run Discovery for All Integrations + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: discover_all + /accounts/{account_id}/magic/cloud/providers/{provider_id}: + delete: + description: Delete a Cloud Integration (Closed Beta). + operationId: providers-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: provider_id + schema: + $ref: '#/components/schemas/mcnProviderId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnDeleteProviderResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Cloud Integration + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: delete + get: + description: Read a Cloud Integration (Closed Beta). + operationId: providers-read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: provider_id + schema: + $ref: '#/components/schemas/mcnProviderId' + required: true + - in: query + name: status + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnReadAccountProviderResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read Cloud Integration + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: get + patch: + description: Update a Cloud Integration (Closed Beta). + operationId: providers-patch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: provider_id + schema: + $ref: '#/components/schemas/mcnProviderId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateProviderRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateProviderResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Cloud Integration + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: edit + put: + description: Update a Cloud Integration (Closed Beta). + operationId: providers-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: provider_id + schema: + $ref: '#/components/schemas/mcnProviderId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateProviderRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnUpdateProviderResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Cloud Integration + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: update + /accounts/{account_id}/magic/cloud/providers/{provider_id}/discover: + post: + description: Run discovery for a Cloud Integration (Closed Beta). + operationId: providers-discover + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: provider_id + schema: + $ref: '#/components/schemas/mcnProviderId' + required: true + - in: query + name: v2 + schema: + type: boolean + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnGoodResponse' + description: Accepted. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Conflict. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Run Discovery + tags: + - Cloud Integrations + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: discover + /accounts/{account_id}/magic/cloud/providers/{provider_id}/initial_setup: + get: + description: Get initial configuration to complete Cloud Integration setup (Closed Beta). + operationId: providers-initial-setup + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: provider_id + schema: + $ref: '#/components/schemas/mcnProviderId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnProviderInitialSetupResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Cloud Integration Setup Config + tags: + - Cloud Integrations + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - cloud_integrations + method: initial_setup + /accounts/{account_id}/magic/cloud/resources: + get: + description: List resources in the Resource Catalog (Closed Beta). + operationId: resources-catalog-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: provider_id + schema: + type: string + - in: query + name: resource_type + schema: + items: + $ref: '#/components/schemas/mcnResourceType' + type: array + explode: true + - in: query + name: resource_id + schema: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + explode: true + - in: query + name: region + schema: + type: string + - in: query + name: resource_group + schema: + type: string + - in: query + name: managed + schema: + type: boolean + - in: query + name: search + schema: + items: + type: string + type: array + explode: true + - description: One of ["id", "resource_type", "region"]. + in: query + name: order_by + schema: + type: string + - in: query + name: desc + schema: + type: boolean + - in: query + name: per_page + schema: + minimum: 1 + type: integer + - in: query + name: page + schema: + minimum: 1 + type: integer + - in: query + name: cloudflare + schema: + type: boolean + - in: query + name: v2 + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnReadAccountResourcesResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Resources + tags: + - Resources + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - resources + method: list + /accounts/{account_id}/magic/cloud/resources/export: + get: + description: Export resources in the Resource Catalog as a JSON file (Closed Beta). + operationId: resources-catalog-export + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: provider_id + schema: + type: string + - in: query + name: resource_type + schema: + items: + $ref: '#/components/schemas/mcnResourceType' + type: array + explode: true + - in: query + name: resource_id + schema: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + explode: true + - in: query + name: region + schema: + type: string + - in: query + name: resource_group + schema: + type: string + - in: query + name: search + schema: + items: + type: string + type: array + explode: true + - description: One of ["id", "resource_type", "region"]. + in: query + name: order_by + schema: + type: string + - in: query + name: desc + schema: + type: boolean + - in: query + name: v2 + schema: + type: boolean + responses: + '200': + content: + application/octet-stream: + schema: + type: object + properties: + contents: + type: string + description: Exported file. + headers: + Content-Disposition: + schema: + type: string + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Export Resources + tags: + - Resources + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - resources + method: export + /accounts/{account_id}/magic/cloud/resources/policy-preview: + post: + description: Preview Rego query result against the latest resource catalog (Closed Beta). + operationId: resources-catalog-policy-preview + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mcnResourcesCatalogPolicyPreviewRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnResourcesCatalogPolicyPreviewResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Unprocessable Entity. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Preview Rego Query + tags: + - Resources + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - resources + method: policy_preview + /accounts/{account_id}/magic/cloud/resources/{resource_id}: + get: + description: Read an resource from the Resource Catalog (Closed Beta). + operationId: resources-catalog-read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: resource_id + schema: + $ref: '#/components/schemas/mcnResourceId' + required: true + - in: query + name: v2 + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnReadAccountResourceResponse' + description: OK. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Bad Request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Invalid Credentials. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Not Found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mcnBadResponse' + description: Internal Server Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read Resource + tags: + - Resources + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-stackql-sdk: + service: magic_cloud_networking + resource_chain: + - resources + method: get +components: + schemas: + mcnAccountId: + type: string + x-auditable: true + mcnApplyProgress: + properties: + done: + type: integer + x-auditable: true + total: + type: integer + x-auditable: true + required: + - done + - total + type: object + mcnBadResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + minLength: 1 + type: array + result: + enum: + - null + nullable: true + type: object + required: + - result + - success + - errors + - messages + mcnCatalogSync: + properties: + description: + type: string + destination_id: + $ref: '#/components/schemas/mcnCatalogSyncDestinationId' + destination_type: + $ref: '#/components/schemas/mcnCatalogSyncDestinationType' + errors: + type: object + id: + $ref: '#/components/schemas/mcnCatalogSyncId' + includes_discoveries_until: + type: string + last_attempted_update_at: + type: string + last_successful_update_at: + type: string + last_user_update_at: + type: string + name: + type: string + policy: + type: string + update_mode: + $ref: '#/components/schemas/mcnCatalogSyncUpdateMode' + required: + - id + - name + - description + - policy + - destination_type + - destination_id + - destination_url + - update_mode + - last_user_update_at + type: object + mcnCatalogSyncDestinationId: + format: uuid + type: string + x-auditable: true + mcnCatalogSyncDestinationType: + enum: + - NONE + - ZERO_TRUST_LIST + type: string + x-auditable: true + mcnCatalogSyncId: + format: uuid + type: string + mcnCatalogSyncUpdateMode: + enum: + - AUTO + - MANUAL + type: string + x-auditable: true + mcnCatalogSyncsPrebuiltPoliciesResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + items: + $ref: '#/components/schemas/mcnCatalogSyncsPrebuiltPolicy' + type: array + required: + - result + - success + - errors + - messages + mcnCatalogSyncsPrebuiltPolicy: + properties: + applicable_destinations: + items: + $ref: '#/components/schemas/mcnCatalogSyncDestinationType' + type: array + policy_description: + type: string + policy_name: + type: string + policy_string: + type: string + required: + - policy_name + - policy_description + - policy_string + - applicable_destinations + type: object + mcnCidrPrefix: + description: An IP address prefix in CIDR format. + example: 192.168.0.0/16 + type: string + x-auditable: true + mcnCloudPlatformClient: + properties: + client_type: + enum: + - MAGIC_WAN_CLOUD_ONRAMP + type: string + x-auditable: true + id: + $ref: '#/components/schemas/mcnPlatformClientId' + name: + type: string + x-auditable: true + required: + - client_type + - name + - id + type: object + mcnCloudType: + enum: + - AWS + - AZURE + - GOOGLE + - CLOUDFLARE + type: string + x-auditable: true + mcnConduitRouteId: + format: uuid + type: string + x-auditable: true + mcnConduitTunnelId: + format: uuid + type: string + x-auditable: true + mcnCost: + properties: + currency: + type: string + x-auditable: true + monthly_cost: + format: double + type: number + required: + - monthly_cost + - currency + type: object + mcnCostDiff: + properties: + currency: + type: string + x-auditable: true + current_monthly_cost: + format: double + type: number + diff: + format: double + type: number + proposed_monthly_cost: + format: double + type: number + required: + - current_monthly_cost + - proposed_monthly_cost + - diff + - currency + type: object + mcnCreateCatalogSyncRequest: + properties: + description: + type: string + destination_type: + $ref: '#/components/schemas/mcnCatalogSyncDestinationType' + name: + type: string + policy: + type: string + update_mode: + $ref: '#/components/schemas/mcnCatalogSyncUpdateMode' + required: + - name + - update_mode + - destination_type + type: object + mcnCreateCatalogSyncResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnCatalogSync' + required: + - result + - success + - errors + - messages + mcnCreateOnrampRequest: + properties: + adopted_hub_id: + $ref: '#/components/schemas/mcnResourceId' + attached_hubs: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + attached_vpcs: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + cloud_asn: + description: Sets the cloud-side ASN. If unset or zero, the cloud's default ASN takes effect. + format: uint32 + type: integer + x-auditable: true + cloud_type: + $ref: '#/components/schemas/mcnOnrampCloudType' + description: + type: string + dynamic_routing: + description: Enables BGP routing. When enabling this feature, set both install_routes_in_cloud and install_routes_in_magic_wan to false. + type: boolean + x-auditable: true + hub_provider_id: + $ref: '#/components/schemas/mcnProviderId' + install_routes_in_cloud: + type: boolean + x-auditable: true + install_routes_in_magic_wan: + type: boolean + x-auditable: true + manage_hub_to_hub_attachments: + type: boolean + x-auditable: true + manage_vpc_to_hub_attachments: + type: boolean + x-auditable: true + name: + type: string + region: + type: string + x-auditable: true + type: + $ref: '#/components/schemas/mcnOnrampType' + vpc: + $ref: '#/components/schemas/mcnResourceId' + required: + - name + - type + - cloud_type + - install_routes_in_cloud + - install_routes_in_magic_wan + - dynamic_routing + type: object + mcnCreateOnrampResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnOnramp' + required: + - result + - success + - errors + - messages + mcnCreateProviderRequest: + properties: + cloud_type: + $ref: '#/components/schemas/mcnCloudType' + description: + type: string + x-auditable: true + friendly_name: + type: string + x-auditable: true + required: + - friendly_name + - cloud_type + type: object + mcnCreateProviderResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnProvider' + required: + - result + - success + - errors + - messages + mcnDeleteCatalogSyncResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnDeletedCatalogSync' + required: + - result + - success + - errors + - messages + mcnDeleteOnrampResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnDeletedOnramp' + required: + - result + - success + - errors + - messages + mcnDeleteProviderResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnDeletedProvider' + required: + - result + - success + - errors + - messages + mcnDeletedCatalogSync: + properties: + id: + $ref: '#/components/schemas/mcnCatalogSyncId' + required: + - id + type: object + mcnDeletedOnramp: + properties: + id: + $ref: '#/components/schemas/mcnOnrampId' + required: + - id + type: object + mcnDeletedProvider: + properties: + id: + $ref: '#/components/schemas/mcnProviderId' + required: + - id + type: object + mcnError: + properties: + code: + enum: + - 1001 + - 1002 + - 1003 + - 1004 + - 1005 + - 1006 + - 1007 + - 1008 + - 1009 + - 1010 + - 1011 + - 1012 + - 1013 + - 1014 + - 1015 + - 1016 + - 1017 + - 1018 + - 2001 + - 2002 + - 2003 + - 2004 + - 2005 + - 2006 + - 2007 + - 2008 + - 2009 + - 2010 + - 2011 + - 2012 + - 2013 + - 2014 + - 2015 + - 2016 + - 2017 + - 2018 + - 2019 + - 2020 + - 2021 + - 2022 + - 3001 + - 3002 + - 3003 + - 3004 + - 3005 + - 3006 + - 3007 + - 4001 + - 4002 + - 4003 + - 4004 + - 4005 + - 4006 + - 4007 + - 4008 + - 4009 + - 4010 + - 4011 + - 4012 + - 4013 + - 4014 + - 4015 + - 4016 + - 4017 + - 4018 + - 4019 + - 4020 + - 4021 + - 4022 + - 4023 + - 5001 + - 5002 + - 5003 + - 5004 + - 102000 + - 102001 + - 102002 + - 102003 + - 102004 + - 102005 + - 102006 + - 102007 + - 102008 + - 102009 + - 102010 + - 102011 + - 102012 + - 102013 + - 102014 + - 102015 + - 102016 + - 102017 + - 102018 + - 102019 + - 102020 + - 102021 + - 102022 + - 102023 + - 102024 + - 102025 + - 102026 + - 102027 + - 102028 + - 102029 + - 102030 + - 102031 + - 102032 + - 102033 + - 102034 + - 102035 + - 102036 + - 102037 + - 102038 + - 102039 + - 102040 + - 102041 + - 102042 + - 102043 + - 102044 + - 102045 + - 102046 + - 102047 + - 102048 + - 102049 + - 102050 + - 102051 + - 102052 + - 102053 + - 102054 + - 102055 + - 102056 + - 102057 + - 102058 + - 102059 + - 102060 + - 102061 + - 102062 + - 102063 + - 102064 + - 102065 + - 102066 + - 102067 + - 102068 + - 102069 + - 102070 + - 102071 + - 102072 + - 103001 + - 103002 + - 103003 + - 103004 + - 103005 + - 103006 + - 103007 + - 103008 + type: integer + x-auditable: true + documentation_url: + type: string + message: + type: string + meta: + $ref: '#/components/schemas/mcnErrorMeta' + source: + $ref: '#/components/schemas/mcnErrorSource' + required: + - code + - message + type: object + mcnErrorMeta: + properties: + l10n_key: + type: string + x-auditable: true + loggable_error: + type: string + template_data: + type: object + trace_id: + type: string + x-auditable: true + type: object + mcnErrorSource: + properties: + parameter: + type: string + x-auditable: true + parameter_value_index: + type: integer + x-auditable: true + pointer: + type: string + x-auditable: true + type: object + mcnGetMagicWanAddressSpaceResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnMagicWanAddressSpace' + required: + - result + - success + - errors + - messages + mcnGetOnrampResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnOnramp' + required: + - result + - success + - errors + - messages + mcnGoodResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + required: + - result + - success + - errors + - messages + mcnListOnrampsResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + items: + $ref: '#/components/schemas/mcnOnramp' + type: array + required: + - result + - success + - errors + - messages + mcnMagicWanAddressSpace: + properties: + prefixes: + items: + $ref: '#/components/schemas/mcnCidrPrefix' + type: array + required: + - prefixes + type: object + mcnOnramp: + properties: + attached_hubs: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + attached_vpcs: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + cloud_asn: + format: uint32 + type: integer + x-auditable: true + cloud_type: + $ref: '#/components/schemas/mcnOnrampCloudType' + description: + type: string + x-auditable: true + dynamic_routing: + type: boolean + x-auditable: true + hub: + $ref: '#/components/schemas/mcnResourceId' + id: + $ref: '#/components/schemas/mcnOnrampId' + install_routes_in_cloud: + type: boolean + x-auditable: true + install_routes_in_magic_wan: + type: boolean + x-auditable: true + last_applied_at: + type: string + x-auditable: true + last_exported_at: + type: string + x-auditable: true + last_planned_at: + type: string + x-auditable: true + manage_hub_to_hub_attachments: + type: boolean + x-auditable: true + manage_vpc_to_hub_attachments: + type: boolean + x-auditable: true + name: + type: string + x-auditable: true + planned_monthly_cost_estimate: + $ref: '#/components/schemas/mcnCostDiff' + planned_resources: + items: + $ref: '#/components/schemas/mcnResourceDiff' + type: array + planned_resources_unavailable: + type: boolean + x-auditable: true + post_apply_monthly_cost_estimate: + $ref: '#/components/schemas/mcnCost' + post_apply_resources: + type: object + post_apply_resources_unavailable: + type: boolean + x-auditable: true + region: + type: string + x-auditable: true + status: + $ref: '#/components/schemas/mcnOnrampStatus' + type: + $ref: '#/components/schemas/mcnOnrampType' + updated_at: + type: string + readOnly: true + vpc: + $ref: '#/components/schemas/mcnResourceId' + vpcs_by_id: + type: object + vpcs_by_id_unavailable: + description: The list of vpc IDs for which resource details failed to generate. + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + required: + - id + - name + - type + - cloud_type + - install_routes_in_cloud + - install_routes_in_magic_wan + - dynamic_routing + - updated_at + type: object + mcnOnrampCloudType: + enum: + - AWS + - AZURE + - GOOGLE + type: string + x-auditable: true + mcnOnrampId: + format: uuid + type: string + x-auditable: true + mcnOnrampLifecycleState: + enum: + - OnrampNeedsApply + - OnrampPendingPlan + - OnrampPlanning + - OnrampPlanFailed + - OnrampPendingApproval + - OnrampPendingApply + - OnrampApplying + - OnrampApplyFailed + - OnrampActive + - OnrampPendingDestroy + - OnrampDestroying + - OnrampDestroyFailed + type: string + x-auditable: true + mcnOnrampStatus: + properties: + apply_progress: + $ref: '#/components/schemas/mcnApplyProgress' + lifecycle_errors: + type: object + lifecycle_state: + $ref: '#/components/schemas/mcnOnrampLifecycleState' + plan_progress: + $ref: '#/components/schemas/mcnPlanProgress' + routes: + items: + $ref: '#/components/schemas/mcnConduitRouteId' + type: array + tunnels: + items: + $ref: '#/components/schemas/mcnConduitTunnelId' + type: array + required: + - lifecycle_state + - tunnels + - routes + - plan_progress + - apply_progress + type: object + mcnOnrampType: + enum: + - OnrampTypeSingle + - OnrampTypeHub + type: string + x-auditable: true + mcnPlanProgress: + properties: + done: + type: integer + x-auditable: true + total: + type: integer + x-auditable: true + required: + - done + - total + type: object + mcnPlannedAction: + enum: + - no_op + - create + - update + - replace + - destroy + type: string + x-auditable: true + mcnPlatformClientId: + format: uuid + type: string + x-auditable: true + mcnPolicyResult: + type: string + mcnProvider: + properties: + aws_arn: + type: string + x-auditable: true + azure_subscription_id: + type: string + x-auditable: true + azure_tenant_id: + type: string + x-auditable: true + cloud_type: + $ref: '#/components/schemas/mcnCloudType' + description: + type: string + friendly_name: + type: string + gcp_project_id: + type: string + x-auditable: true + gcp_service_account_email: + type: string + x-auditable: true + id: + $ref: '#/components/schemas/mcnProviderId' + last_updated: + type: string + x-auditable: true + lifecycle_state: + $ref: '#/components/schemas/mcnProviderLifecycleState' + state: + $ref: '#/components/schemas/mcnProviderDiscoveryStatus' + state_v2: + $ref: '#/components/schemas/mcnProviderDiscoveryStatus' + status: + $ref: '#/components/schemas/mcnProviderStatus' + required: + - id + - friendly_name + - cloud_type + - last_updated + - state + - state_v2 + - lifecycle_state + type: object + mcnProviderDiscoveryProgress: + properties: + done: + type: integer + x-auditable: true + total: + type: integer + x-auditable: true + unit: + type: string + x-auditable: true + required: + - unit + - done + - total + type: object + mcnProviderDiscoveryStatus: + enum: + - UNSPECIFIED + - PENDING + - DISCOVERING + - FAILED + - SUCCEEDED + type: string + x-auditable: true + mcnProviderId: + format: uuid + type: string + x-auditable: true + mcnProviderInitialSetupResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + type: object + properties: + aws_trust_policy: + type: string + item_type: + type: string + x-auditable: true + azure_consent_url: + type: string + integration_identity_tag: + type: string + x-auditable: true + tag_cli_command: + type: string + required: + - item_type + required: + - result + - success + - errors + - messages + mcnProviderLifecycleState: + enum: + - ACTIVE + - PENDING_SETUP + - RETIRED + type: string + x-auditable: true + mcnProviderStatus: + properties: + credentials_good_since: + type: string + x-auditable: true + credentials_missing_since: + type: string + x-auditable: true + credentials_rejected_since: + type: string + x-auditable: true + discovery_message: + type: string + x-auditable: true + discovery_message_v2: + type: string + x-auditable: true + discovery_progress: + $ref: '#/components/schemas/mcnProviderDiscoveryProgress' + discovery_progress_v2: + $ref: '#/components/schemas/mcnProviderDiscoveryProgress' + in_use_by: + items: + $ref: '#/components/schemas/mcnCloudPlatformClient' + type: array + last_discovery_completed_at: + type: string + x-auditable: true + last_discovery_completed_at_v2: + type: string + x-auditable: true + last_discovery_started_at: + type: string + x-auditable: true + last_discovery_started_at_v2: + type: string + x-auditable: true + last_discovery_status: + $ref: '#/components/schemas/mcnProviderDiscoveryStatus' + last_discovery_status_v2: + $ref: '#/components/schemas/mcnProviderDiscoveryStatus' + last_updated: + type: string + x-auditable: true + regions: + items: + type: string + x-auditable: true + type: array + required: + - last_discovery_status + - last_discovery_status_v2 + - regions + - discovery_status + - discovery_status_v2 + - discovery_progress + - discovery_progress_v2 + type: object + mcnReadAccountCatalogSyncResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnCatalogSync' + required: + - result + - success + - errors + - messages + mcnReadAccountCatalogSyncsResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + items: + $ref: '#/components/schemas/mcnCatalogSync' + type: array + required: + - result + - success + - errors + - messages + mcnReadAccountProviderResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnProvider' + required: + - result + - success + - errors + - messages + mcnReadAccountProvidersResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + items: + $ref: '#/components/schemas/mcnProvider' + type: array + required: + - result + - success + - errors + - messages + mcnReadAccountResourceResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnResourceDetails' + required: + - result + - success + - errors + - messages + mcnReadAccountResourcesResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + result_info: + $ref: '#/components/schemas/mcnResultInfo' + success: + type: boolean + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + items: + $ref: '#/components/schemas/mcnResourceDetails' + type: array + required: + - result + - success + - errors + - messages + mcnRefreshCatalogSyncResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnPolicyResult' + required: + - result + - success + - errors + - messages + mcnResourceDetails: + properties: + account_id: + $ref: '#/components/schemas/mcnAccountId' + cloud_type: + $ref: '#/components/schemas/mcnCloudType' + config: + type: object + deployment_provider: + $ref: '#/components/schemas/mcnProviderId' + id: + $ref: '#/components/schemas/mcnResourceId' + managed: + type: boolean + x-auditable: true + managed_by: + items: + $ref: '#/components/schemas/mcnCloudPlatformClient' + type: array + monthly_cost_estimate: + $ref: '#/components/schemas/mcnCost' + name: + type: string + native_id: + type: string + observations: + type: object + provider_ids: + items: + $ref: '#/components/schemas/mcnProviderId' + type: array + provider_names_by_id: + type: object + region: + type: string + x-auditable: true + resource_group: + type: string + x-auditable: true + resource_type: + $ref: '#/components/schemas/mcnResourceType' + sections: + items: + $ref: '#/components/schemas/mcnResourceDetailsSection' + type: array + state: + type: object + tags: + type: object + updated_at: + type: string + readOnly: true + url: + type: string + required: + - id + - native_id + - name + - account_id + - cloud_type + - resource_type + - managed + - provider_ids + - provider_names_by_id + - region + - resource_group + - tags + - updated_at + - url + - config + - state + - observations + - deployment_provider + - sections + - monthly_cost_estimate + type: object + mcnResourceDetailsSection: + properties: + help_text: + type: string + hidden_items: + items: + $ref: '#/components/schemas/mcnResourceDetailsSectionItem' + type: array + name: + type: string + visible_items: + items: + $ref: '#/components/schemas/mcnResourceDetailsSectionItem' + type: array + required: + - name + - visible_items + - hidden_items + type: object + mcnResourceDetailsSectionItem: + properties: + helpText: + type: string + name: + type: string + value: + type: object + properties: + item_type: + type: string + string: + type: string + yaml: + type: string + yaml_diff: + $ref: '#/components/schemas/mcnYamlDiff' + resource_preview: + $ref: '#/components/schemas/mcnResourcePreview' + list: + items: + type: object + properties: + item_type: + type: string + string: + type: string + resource_preview: + $ref: '#/components/schemas/mcnResourcePreview' + required: + - item_type + type: array + x-stainless-naming: + python: + property_name: rule_list + required: + - item_type + type: object + mcnResourceDiff: + properties: + diff: + $ref: '#/components/schemas/mcnYamlDiff' + keys_require_replace: + items: + type: string + type: array + monthly_cost_estimate_diff: + $ref: '#/components/schemas/mcnCostDiff' + planned_action: + $ref: '#/components/schemas/mcnPlannedAction' + resource: + $ref: '#/components/schemas/mcnResourcePreview' + required: + - resource + - diff + - planned_action + - keys_require_replace + - monthly_cost_estimate_diff + type: object + mcnResourceId: + format: uuid + type: string + x-auditable: true + mcnResourcePreview: + properties: + cloud_type: + $ref: '#/components/schemas/mcnCloudType' + detail: + type: string + id: + $ref: '#/components/schemas/mcnResourceId' + name: + type: string + resource_type: + $ref: '#/components/schemas/mcnResourceType' + title: + type: string + required: + - id + - cloud_type + - resource_type + - name + - title + - detail + type: object + mcnResourceType: + enum: + - aws_customer_gateway + - aws_egress_only_internet_gateway + - aws_internet_gateway + - aws_instance + - aws_network_interface + - aws_route + - aws_route_table + - aws_route_table_association + - aws_subnet + - aws_vpc + - aws_vpc_ipv4_cidr_block_association + - aws_vpn_connection + - aws_vpn_connection_route + - aws_vpn_gateway + - aws_security_group + - aws_vpc_security_group_ingress_rule + - aws_vpc_security_group_egress_rule + - aws_ec2_managed_prefix_list + - aws_ec2_transit_gateway + - aws_ec2_transit_gateway_prefix_list_reference + - aws_ec2_transit_gateway_vpc_attachment + - azurerm_application_security_group + - azurerm_lb + - azurerm_lb_backend_address_pool + - azurerm_lb_nat_pool + - azurerm_lb_nat_rule + - azurerm_lb_rule + - azurerm_local_network_gateway + - azurerm_network_interface + - azurerm_network_interface_application_security_group_association + - azurerm_network_interface_backend_address_pool_association + - azurerm_network_interface_security_group_association + - azurerm_network_security_group + - azurerm_public_ip + - azurerm_route + - azurerm_route_table + - azurerm_subnet + - azurerm_subnet_route_table_association + - azurerm_virtual_machine + - azurerm_virtual_network_gateway_connection + - azurerm_virtual_network + - azurerm_virtual_network_gateway + - google_compute_network + - google_compute_subnetwork + - google_compute_vpn_gateway + - google_compute_vpn_tunnel + - google_compute_route + - google_compute_address + - google_compute_global_address + - google_compute_router + - google_compute_interconnect_attachment + - google_compute_ha_vpn_gateway + - google_compute_forwarding_rule + - google_compute_network_firewall_policy + - google_compute_network_firewall_policy_rule + - cloudflare_static_route + - cloudflare_ipsec_tunnel + type: string + x-auditable: true + mcnResourcesCatalogPolicyPreview: + type: string + mcnResourcesCatalogPolicyPreviewRequest: + properties: + policy: + type: string + required: + - policy + type: object + mcnResourcesCatalogPolicyPreviewResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnResourcesCatalogPolicyPreview' + required: + - result + - success + - errors + - messages + mcnResultInfo: + properties: + count: + description: The number of items in the current result set. + example: 1 + type: integer + page: + description: The current page (starts from zero). + example: 1 + type: integer + per_page: + description: The maximum number of items per page. + example: 20 + type: integer + total_count: + description: The total number of items in the entire result set. + example: 2000 + type: integer + total_pages: + description: The number of total pages in the entire result set. + example: 200 + type: integer + required: + - page + - per_page + - count + - total_count + type: object + mcnUpdateCatalogSyncRequest: + properties: + description: + type: string + name: + type: string + policy: + type: string + update_mode: + $ref: '#/components/schemas/mcnCatalogSyncUpdateMode' + type: object + mcnUpdateCatalogSyncResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnCatalogSync' + required: + - result + - success + - errors + - messages + mcnUpdateMagicWanAddressSpaceRequest: + properties: + prefixes: + items: + $ref: '#/components/schemas/mcnCidrPrefix' + type: array + required: + - prefixes + type: object + mcnUpdateMagicWanAddressSpaceResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnMagicWanAddressSpace' + required: + - result + - success + - errors + - messages + mcnUpdateOnrampRequest: + properties: + attached_hubs: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + attached_vpcs: + items: + $ref: '#/components/schemas/mcnResourceId' + type: array + description: + type: string + install_routes_in_cloud: + type: boolean + x-auditable: true + install_routes_in_magic_wan: + type: boolean + x-auditable: true + manage_hub_to_hub_attachments: + type: boolean + manage_vpc_to_hub_attachments: + type: boolean + name: + type: string + vpc: + $ref: '#/components/schemas/mcnResourceId' + type: object + mcnUpdateOnrampResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnOnramp' + required: + - result + - success + - errors + - messages + mcnUpdateProviderRequest: + properties: + aws_arn: + type: string + x-auditable: true + azure_subscription_id: + type: string + x-auditable: true + azure_tenant_id: + type: string + x-auditable: true + description: + type: string + x-auditable: true + friendly_name: + type: string + x-auditable: true + gcp_project_id: + type: string + x-auditable: true + gcp_service_account_email: + type: string + x-auditable: true + type: object + mcnUpdateProviderResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mcnError' + type: array + success: + type: boolean + x-auditable: true + errors: + items: + $ref: '#/components/schemas/mcnError' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mcnProvider' + required: + - result + - success + - errors + - messages + mcnYamlDiff: + properties: + diff: + type: string + left_description: + type: string + left_yaml: + type: string + right_description: + type: string + right_yaml: + type: string + required: + - left_yaml + - left_description + - right_yaml + - right_description + - diff + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + catalog_syncs: + id: cloudflare.magic_cloud_networking.catalog_syncs + name: catalog_syncs + title: Catalog Syncs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs~1{sync_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs~1{sync_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs~1{sync_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs~1{sync_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + refresh: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs~1{sync_id}~1refresh/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/catalog_syncs/methods/get' + - $ref: '#/components/x-stackQL-resources/catalog_syncs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/catalog_syncs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/catalog_syncs/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/catalog_syncs/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/catalog_syncs/methods/update' + prebuilt_policies: + id: cloudflare.magic_cloud_networking.prebuilt_policies + name: prebuilt_policies + title: Prebuilt Policies + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1catalog-syncs~1prebuilt-policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/prebuilt_policies/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + on_ramps: + id: cloudflare.magic_cloud_networking.on_ramps + name: on_ramps + title: On Ramps + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1{onramp_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1{onramp_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1{onramp_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1{onramp_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/on_ramps/methods/get' + - $ref: '#/components/x-stackQL-resources/on_ramps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/on_ramps/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/on_ramps/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/on_ramps/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/on_ramps/methods/update' + address_spaces: + id: cloudflare.magic_cloud_networking.address_spaces + name: address_spaces + title: Address Spaces + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1magic_wan_address_space/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1magic_wan_address_space/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1magic_wan_address_space/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/address_spaces/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/address_spaces/methods/edit' + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/address_spaces/methods/update' + magic: + id: cloudflare.magic_cloud_networking.magic + name: magic + title: Magic + methods: + apply: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1{onramp_id}~1apply/post' + response: + mediaType: application/json + openAPIDocKey: '202' + export: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1{onramp_id}~1export/post' + response: + mediaType: application/zip + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + plan: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1onramps~1{onramp_id}~1plan/post' + response: + mediaType: application/json + openAPIDocKey: '202' + discover: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers~1discover/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + cloud_providers: + id: cloudflare.magic_cloud_networking.cloud_providers + name: cloud_providers + title: Cloud Providers + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_providers/methods/list_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/cloud_providers/methods/create' + update: [] + delete: [] + replace: [] + cloud_integrations: + id: cloudflare.magic_cloud_networking.cloud_integrations + name: cloud_integrations + title: Cloud Integrations + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers~1{provider_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers~1{provider_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers~1{provider_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers~1{provider_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + discover: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers~1{provider_id}~1discover/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_integrations/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/cloud_integrations/methods/discover' + update: + - $ref: '#/components/x-stackQL-resources/cloud_integrations/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_integrations/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/cloud_integrations/methods/update' + providers_initial_setup: + id: cloudflare.magic_cloud_networking.providers_initial_setup + name: providers_initial_setup + title: Providers Initial Setup + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1providers~1{provider_id}~1initial_setup/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/providers_initial_setup/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + cloud_resources: + id: cloudflare.magic_cloud_networking.cloud_resources + name: cloud_resources + title: Cloud Resources + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1resources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_resources/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + resources: + id: cloudflare.magic_cloud_networking.resources + name: resources + title: Resources + methods: + export: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1resources~1export/get' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + policy_preview: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1resources~1policy-preview/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cloud~1resources~1{resource_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resources/methods/get' + - $ref: '#/components/x-stackQL-resources/resources/methods/export' + insert: + - $ref: '#/components/x-stackQL-resources/resources/methods/policy_preview' + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/magic_network_monitoring.yaml b/providers/src/cloudflare/v00.00.00000/services/magic_network_monitoring.yaml new file mode 100644 index 00000000..c2cb95e6 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/magic_network_monitoring.yaml @@ -0,0 +1,1659 @@ +openapi: 3.0.3 +info: + title: magic_network_monitoring API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/mnm/config: + delete: + description: Delete an existing network monitoring configuration. + operationId: magic-network-monitoring-configuration-delete-account-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigSingleResponse' + description: Delete account configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef621ca3f6ea9a96427c902b0d14279ff8 + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete account configuration response failure + security: + - api_email: [] + api_key: [] + summary: Delete account configuration + tags: + - Magic Network Monitoring Configuration + x-api-token-group: + - Magic Network Monitoring Admin + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - configs + method: delete + get: + description: Lists default sampling, router IPs and warp devices for account. + operationId: magic-network-monitoring-configuration-list-account-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigSingleResponse' + description: List account configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef621ca3f6ea9a96427c902b0d14279ff8 + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List account configuration response failure + security: + - api_email: [] + api_key: [] + summary: List account configuration + tags: + - Magic Network Monitoring Configuration + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + - Magic Network Monitoring Config Read + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - configs + method: get + patch: + description: Update fields in an existing network monitoring configuration. + operationId: >- + magic-network-monitoring-configuration-update-account-configuration-fields + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + default_sampling: + $ref: >- + #/components/schemas/magicVisibilityMnmMnmConfigDefaultSampling + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigName' + router_ips: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigRouterIps' + warp_devices: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigWarpDevices' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigSingleResponse' + description: Update account configuration fields response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef621ca3f6ea9a96427c902b0d14279ff8 + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update account configuration fields response failure + security: + - api_email: [] + api_key: [] + summary: Update account configuration fields + tags: + - Magic Network Monitoring Configuration + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - configs + method: edit + post: + description: Create a new network monitoring configuration. + operationId: magic-network-monitoring-configuration-create-account-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + default_sampling: + $ref: >- + #/components/schemas/magicVisibilityMnmMnmConfigDefaultSampling + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigName' + router_ips: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigRouterIps' + warp_devices: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigWarpDevices' + required: + - name + - default_sampling + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigSingleResponse' + description: Create account configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef621ca3f6ea9a96427c902b0d14279ff8 + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create account configuration response failure + security: + - api_email: [] + api_key: [] + summary: Create account configuration + tags: + - Magic Network Monitoring Configuration + x-api-token-group: + - Magic Network Monitoring Admin + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - configs + method: create + put: + description: >- + Update an existing network monitoring configuration, requires the entire + configuration to be updated at once. + operationId: >- + magic-network-monitoring-configuration-update-an-entire-account-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + default_sampling: + $ref: >- + #/components/schemas/magicVisibilityMnmMnmConfigDefaultSampling + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigName' + router_ips: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigRouterIps' + warp_devices: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigWarpDevices' + required: + - name + - default_sampling + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigSingleResponse' + description: Update an entire account configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef621ca3f6ea9a96427c902b0d14279ff8 + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update an entire account configuration response failure + security: + - api_email: [] + api_key: [] + summary: Update an entire account configuration + tags: + - Magic Network Monitoring Configuration + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - configs + method: update + /accounts/{account_id}/mnm/config/full: + get: + description: Lists default sampling, router IPs, warp devices, and rules for account. + operationId: >- + magic-network-monitoring-configuration-list-rules-and-account-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigSingleResponse' + description: List rules and account configuration response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef621ca3f6ea9a96427c902b0d14279ff8 + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List rules and account configuration response failure + security: + - api_email: [] + api_key: [] + summary: List rules and account configuration + tags: + - Magic Network Monitoring Configuration + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + - Magic Network Monitoring Config Read + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - configs + - full + method: get + /accounts/{account_id}/mnm/rules: + get: + description: Lists network monitoring rules for account. + operationId: magic-network-monitoring-rules-list-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/magicVisibilityMnmMnmRulesCollectionResponse + description: List rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + items: + $ref: '#/components/schemas/magicVisibilityMnmMnmRule' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/magicVisibilityMnmResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List rules response failure + security: + - api_email: [] + api_key: [] + summary: List rules + tags: + - Magic Network Monitoring Rules + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + - Magic Network Monitoring Config Read + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - rules + method: list + post: + description: >- + Create network monitoring rules for account. Currently only supports + creating a single rule per API request. + operationId: magic-network-monitoring-rules-create-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleCreate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulesSingleResponse' + description: Create rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef99ba74ba6027c3c87ca03d4e81cfc16d + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create rules response failure + security: + - api_email: [] + api_key: [] + summary: Create rules + tags: + - Magic Network Monitoring Rules + x-api-token-group: + - Magic Network Monitoring Admin + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - rules + method: create + put: + description: Update network monitoring rules for account. + operationId: magic-network-monitoring-rules-update-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleCreate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulesSingleResponse' + description: Update rules response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef99ba74ba6027c3c87ca03d4e81cfc16d + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update rules response failure + security: + - api_email: [] + api_key: [] + summary: Update rules + tags: + - Magic Network Monitoring Rules + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - rules + method: update + /accounts/{account_id}/mnm/rules/{rule_id}: + delete: + description: Delete a network monitoring rule for account. + operationId: magic-network-monitoring-rules-delete-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulesSingleResponse' + description: Delete rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef99ba74ba6027c3c87ca03d4e81cfc16d + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete rule response failure + security: + - api_email: [] + api_key: [] + summary: Delete rule + tags: + - Magic Network Monitoring Rules + x-api-token-group: + - Magic Network Monitoring Admin + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - rules + method: delete + get: + description: List a single network monitoring rule for account. + operationId: magic-network-monitoring-rules-get-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulesSingleResponse' + description: Get rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef99ba74ba6027c3c87ca03d4e81cfc16d + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get rule response failure + security: + - api_email: [] + api_key: [] + summary: Get rule + tags: + - Magic Network Monitoring Rules + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + - Magic Network Monitoring Config Read + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - rules + method: get + patch: + description: Update a network monitoring rule for account. + operationId: magic-network-monitoring-rules-update-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleCreate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulesSingleResponse' + description: Update rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef99ba74ba6027c3c87ca03d4e81cfc16d + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update rule response failure + security: + - api_email: [] + api_key: [] + summary: Update rule + tags: + - Magic Network Monitoring Rules + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - rules + method: edit + /accounts/{account_id}/mnm/rules/{rule_id}/advertisement: + patch: + description: Update advertisement for rule. + operationId: magic-network-monitoring-rules-update-advertisement-for-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/magicVisibilityMnmMnmRuleAdvertisementSingleResponse + description: Update advertisement for rule response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + nullable: true + properties: + automatic_advertisement: + $ref: >- + #/components/schemas/magicVisibilityMnmMnmRuleAutomaticAdvertisement + required: + - automatic_advertisement + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update advertisement for rule response failure + security: + - api_email: [] + api_key: [] + summary: Update advertisement for rule + tags: + - Magic Network Monitoring Rules + x-api-token-group: + - Magic Network Monitoring Admin + - Magic Network Monitoring Config Write + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - rules + - advertisements + method: edit + /accounts/{account_id}/mnm/vpc-flows/token: + post: + description: Generate authentication token for VPC flow logs export. + operationId: magic-network-monitoring-vpc-flows-generate-authentication-token + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/magicVisibilityMnmMnmVpcFlowsSingleResponse + description: Generate authentication token for VPC flow logs export response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + description: >- + Authentication token to be used for VPC Flows export + authentication. + type: string + x-sensitive: true + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Generate authentication token for VPC flow logs export failure. + security: + - api_email: [] + api_key: [] + summary: Generate authentication token for VPC flow logs export. + tags: + - Magic Network Monitoring VPC Flow logs + x-api-token-group: + - Magic Network Monitoring Admin + x-stackql-sdk: + service: magic_network_monitoring + resource_chain: + - vpc_flows + - tokens + method: create +components: + schemas: + magicVisibilityMnmMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + magicVisibilityMnmMnmConfig: + properties: + default_sampling: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigDefaultSampling' + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigName' + router_ips: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigRouterIps' + warp_devices: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigWarpDevices' + required: + - name + - default_sampling + - router_ips + - warp_devices + type: object + magicVisibilityMnmMnmConfigDefaultSampling: + default: 1 + description: >- + Fallback sampling rate of flow messages being sent in packets per + second. This should match the packet sampling rate configured on the + router. + minimum: 1 + type: number + x-auditable: true + magicVisibilityMnmMnmConfigName: + description: The account name. + example: cloudflare user's account + type: string + x-auditable: true + magicVisibilityMnmMnmConfigRouterIp: + description: >- + IPv4 CIDR of the router sourcing flow data. Only /32 addresses are + currently supported. + example: 203.0.113.1 + type: string + x-auditable: true + magicVisibilityMnmMnmConfigRouterIps: + items: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigRouterIp' + type: array + magicVisibilityMnmMnmConfigSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfig' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicVisibilityMnmMnmConfigWarpDevice: + description: Object representing a warp device with an ID and name. + properties: + id: + description: Unique identifier for the warp device. + example: 5360368d-b351-4791-abe1-93550dabd351 + type: string + x-auditable: true + name: + description: Name of the warp device. + example: My warp device + type: string + x-auditable: true + router_ip: + description: >- + IPv4 CIDR of the router sourcing flow data associated with this warp + device. Only /32 addresses are currently supported. + example: 203.0.113.1 + type: string + x-auditable: true + required: + - id + - name + - router_ip + type: object + magicVisibilityMnmMnmConfigWarpDevices: + items: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigWarpDevice' + type: array + magicVisibilityMnmMnmRule: + nullable: true + properties: + automatic_advertisement: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleAutomaticAdvertisement' + bandwidth_threshold: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleBandwidthThreshold' + duration: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleDuration' + id: + $ref: '#/components/schemas/magicVisibilityMnmRuleIdentifier' + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleName' + packet_threshold: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulePacketThreshold' + prefix_match: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulePrefixMatch' + prefixes: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleIpPrefixes' + type: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleType' + zscore_sensitivity: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleZscoreSensitivity' + zscore_target: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleZscoreTarget' + required: + - id + - name + - prefixes + - automatic_advertisement + - type + type: object + magicVisibilityMnmMnmRuleAdvertisableResponse: + nullable: true + properties: + automatic_advertisement: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleAutomaticAdvertisement' + required: + - automatic_advertisement + type: object + magicVisibilityMnmMnmRuleAdvertisementSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleAdvertisableResponse' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicVisibilityMnmMnmRuleAutomaticAdvertisement: + description: >- + Toggle on if you would like Cloudflare to automatically advertise the IP + Prefixes within the rule via Magic Transit when the rule is triggered. + Only available for users of Magic Transit. + nullable: true + type: boolean + x-auditable: true + magicVisibilityMnmMnmRuleBandwidthThreshold: + description: >- + The number of bits per second for the rule. When this value is exceeded + for the set duration, an alert notification is sent. Minimum of 1 and no + maximum. + example: 1000 + minimum: 1 + type: number + x-auditable: true + magicVisibilityMnmMnmRuleCreate: + nullable: true + properties: + automatic_advertisement: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleAutomaticAdvertisement' + bandwidth_threshold: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleBandwidthThreshold' + duration: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleDuration' + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleName' + packet_threshold: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulePacketThreshold' + prefix_match: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulePrefixMatch' + prefixes: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleIpPrefixes' + type: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleType' + zscore_sensitivity: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleZscoreSensitivity' + zscore_target: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleZscoreTarget' + required: + - name + - prefixes + - automatic_advertisement + - type + type: object + magicVisibilityMnmMnmRuleDuration: + default: 1m + description: >- + The amount of time that the rule threshold must be exceeded to send an + alert notification. The final value must be equivalent to one of the + following 8 values ["1m","5m","10m","15m","20m","30m","45m","60m"]. + enum: + - 1m + - 5m + - 10m + - 15m + - 20m + - 30m + - 45m + - 60m + type: string + x-auditable: true + magicVisibilityMnmMnmRuleIpPrefix: + description: >- + The IP prefixes that are monitored for this rule. Must be a CIDR range + like 203.0.113.0/24. Max 5000 different CIDR ranges. + example: 203.0.113.1/32 + type: string + x-auditable: true + magicVisibilityMnmMnmRuleIpPrefixes: + items: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleIpPrefix' + type: array + magicVisibilityMnmMnmRuleName: + description: >- + The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, + underscore (_), dash (-), period (.), and tilde (~). You can’t have a + space in the rule name. Max 256 characters. + example: my_rule_1 + type: string + x-auditable: true + magicVisibilityMnmMnmRulePacketThreshold: + description: >- + The number of packets per second for the rule. When this value is + exceeded for the set duration, an alert notification is sent. Minimum of + 1 and no maximum. + example: 10000 + minimum: 1 + type: number + x-auditable: true + magicVisibilityMnmMnmRulePrefixMatch: + description: >- + Prefix match type to be applied for a prefix auto advertisement when + using an advanced_ddos rule. + enum: + - exact + - subnet + - supernet + example: exact + nullable: true + type: string + x-auditable: true + magicVisibilityMnmMnmRuleType: + description: MNM rule type. + enum: + - threshold + - zscore + - advanced_ddos + example: zscore + type: string + x-auditable: true + magicVisibilityMnmMnmRuleZscoreSensitivity: + description: Level of sensitivity set for zscore rules. + enum: + - low + - medium + - high + example: high + nullable: true + type: string + x-auditable: true + magicVisibilityMnmMnmRuleZscoreTarget: + description: Target of the zscore rule analysis. + enum: + - bits + - packets + example: bits + nullable: true + type: string + x-auditable: true + magicVisibilityMnmMnmRulesCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + items: + $ref: '#/components/schemas/magicVisibilityMnmMnmRule' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/magicVisibilityMnmResultInfo' + required: + - success + - errors + - messages + - result + magicVisibilityMnmMnmRulesSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: '#/components/schemas/magicVisibilityMnmMnmRule' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicVisibilityMnmMnmVpcFlowsSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + messages: + $ref: '#/components/schemas/magicVisibilityMnmMessages' + result: + $ref: '#/components/schemas/magicVisibilityMnmMnmVpcFlowsToken' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicVisibilityMnmMnmVpcFlowsToken: + description: Authentication token to be used for VPC Flows export authentication. + example: JWE/JWT auth token + type: string + x-sensitive: true + magicVisibilityMnmResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + magicVisibilityMnmRuleIdentifier: + description: The id of the rule. Must be unique. + example: 2890e6fa406311ed9b5a23f70f6fb8cf + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef621ca3f6ea9a96427c902b0d14279ff8: + properties: + default_sampling: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigDefaultSampling' + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigName' + router_ips: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigRouterIps' + warp_devices: + $ref: '#/components/schemas/magicVisibilityMnmMnmConfigWarpDevices' + required: + - name + - default_sampling + - router_ips + - warp_devices + type: object + enum: + - null + unnamedSchemaRef99ba74ba6027c3c87ca03d4e81cfc16d: + nullable: true + properties: + automatic_advertisement: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleAutomaticAdvertisement' + bandwidth_threshold: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleBandwidthThreshold' + duration: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleDuration' + id: + $ref: '#/components/schemas/magicVisibilityMnmRuleIdentifier' + name: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleName' + packet_threshold: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulePacketThreshold' + prefix_match: + $ref: '#/components/schemas/magicVisibilityMnmMnmRulePrefixMatch' + prefixes: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleIpPrefixes' + type: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleType' + zscore_sensitivity: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleZscoreSensitivity' + zscore_target: + $ref: '#/components/schemas/magicVisibilityMnmMnmRuleZscoreTarget' + required: + - id + - name + - prefixes + - automatic_advertisement + - type + type: object + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + configs: + id: cloudflare.magic_network_monitoring.configs + name: configs + title: Configs + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1config/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1config/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1config/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1config/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/configs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/configs/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/configs/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/configs/methods/update' + fulls: + id: cloudflare.magic_network_monitoring.fulls + name: fulls + title: Fulls + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1config~1full/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fulls/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + rules: + id: cloudflare.magic_network_monitoring.rules + name: rules + title: Rules + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1rules/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1rules~1{rule_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update_advertisement: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1mnm~1rules~1{rule_id}~1advertisement/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get' + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/rules/methods/update' + mnm: + id: cloudflare.magic_network_monitoring.mnm + name: mnm + title: Mnm + methods: + create_token: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mnm~1vpc-flows~1token/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/magic_transit.yaml b/providers/src/cloudflare/v00.00.00000/services/magic_transit.yaml new file mode 100644 index 00000000..dc3b08e0 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/magic_transit.yaml @@ -0,0 +1,11523 @@ +openapi: 3.0.3 +info: + title: magic_transit API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules: + delete: + description: Delete all DNS Protection rules for an account. + operationId: deleteDnsProtectionRulesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete all DNS Protection rules response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all DNS Protection rules. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + get: + description: List all DNS Protection rules for an account. + operationId: listDnsProtectionRulesForAccount + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The page number for pagination. Defaults to 1. + explode: false + in: query + name: page + schema: + format: int64 + type: integer + x-auditable: true + - description: The number of items per page. Must be between 10 and 1000. Defaults to 25. + explode: false + in: query + name: per_page + schema: + format: int64 + type: integer + x-auditable: true + - description: The field to order by. Defaults to 'prefix'. + explode: false + in: query + name: order + schema: + type: string + x-auditable: true + - description: The direction of ordering (ASC or DESC). Defaults to 'ASC'. + explode: false + in: query + name: direction + schema: + type: string + x-auditable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosDnsProtectionRuleListResponse' + description: List all DNS Protection rules response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: List all DNS Protection rules failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all DNS Protection rules. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + post: + description: Create a DNS Protection rule for an account. + operationId: createDnsProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosNewDnsProtectionRule' + description: The new DNS Protection rule to add. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosDnsProtectionRuleResponse' + description: Create DNS Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Create DNS Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create DNS Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + /accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules/{rule_id}: + delete: + description: Delete a DNS Protection rule specified by the given UUID. + operationId: deleteDnsProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommon' + description: Delete DNS Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Delete DNS Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete DNS Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + get: + description: Get a DNS Protection rule specified by the given UUID. + operationId: getDnsProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosDnsProtectionRuleResponse' + description: Get DNS Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Get DNS Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + - DDoS Protection Read + patch: + description: Update a DNS Protection rule specified by the given UUID. + operationId: updateDnsProtectionRule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dosDnsProtectionRuleUpdate' + description: The updates to apply to the DNS Protection rule. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/dosDnsProtectionRuleResponse' + description: Update DNS Protection rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dosApiResponseCommonFailure' + description: Update DNS Protection rule failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update DNS Protection rule. + tags: + - dos-flowtrackd-api_other + x-api-token-group: + - DDoS Protection Write + /accounts/{account_id}/magic/apps: + get: + description: Lists Apps associated with an account. + operationId: magic-account-apps-list-apps + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppsCollectionResponse' + description: List Apps response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: List Apps response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Apps + tags: + - Magic Account Apps + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - apps + method: list + post: + description: Creates a new App for an account + operationId: magic-account-apps-add-app + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppAddSingleRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppSingleResponse' + description: Create Account App response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Create Account App response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new App + tags: + - Magic Account Apps + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - apps + method: create + /accounts/{account_id}/magic/apps/{account_app_id}: + delete: + description: Deletes specific Account App. + operationId: magic-account-apps-delete-app + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: account_app_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppSingleResponse' + description: Delete App response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Delete App response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Account App + tags: + - Magic Account Apps + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - apps + method: delete + patch: + description: Updates an Account App + operationId: magic-account-apps-patch-app + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: account_app_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppSingleResponse' + description: Update App response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update App response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an App + tags: + - Magic Account Apps + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - apps + method: edit + put: + description: Updates an Account App + operationId: magic-account-apps-update-app + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: account_app_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppSingleResponse' + description: Update App response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update App response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an App + tags: + - Magic Account Apps + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - apps + method: update + /accounts/{account_id}/magic/cf_interconnects: + get: + description: Lists interconnects associated with an account. + operationId: magic-interconnects-list-interconnects + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicComponentsSchemasTunnelsCollectionResponse' + description: List interconnects response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + interconnects: + items: + $ref: '#/components/schemas/magicInterconnect' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List interconnects response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List interconnects + tags: + - Magic Interconnects + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - cf_interconnects + method: list + put: + description: Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-interconnects-update-multiple-interconnects + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicComponentsSchemasModifiedTunnelsCollectionResponse' + description: Update multiple interconnects response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_interconnects: + items: + $ref: '#/components/schemas/magicInterconnect' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update multiple interconnects response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update multiple interconnects + tags: + - Magic Interconnects + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - cf_interconnects + method: bulk_update + /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}: + get: + description: Lists details for a specific interconnect. + operationId: magic-interconnects-list-interconnect-details + parameters: + - in: path + name: cf_interconnect_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicComponentsSchemasTunnelSingleResponse' + description: List interconnect Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + interconnect: + $ref: '#/components/schemas/magicInterconnect' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List interconnect Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List interconnect Details + tags: + - Magic Interconnects + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - cf_interconnects + method: get + put: + description: Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-interconnects-update-interconnect + parameters: + - in: path + name: cf_interconnect_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicInterconnectTunnelUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicComponentsSchemasTunnelModifiedResponse' + description: Update interconnect response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_interconnect: + $ref: '#/components/schemas/magicInterconnect' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update interconnect response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update interconnect + tags: + - Magic Interconnects + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - cf_interconnects + method: update + /accounts/{account_id}/magic/connectors: + get: + operationId: mconn-connector-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Filter connectors by device type. + in: query + name: device_type + schema: + enum: + - MANAGED + - LICENSED + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorListResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Forbidden + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Connectors + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + method: list + post: + operationId: mconn-connector-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorCreateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorCreateResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Not Found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Conflict + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add a connector to your account + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + method: create + /accounts/{account_id}/magic/connectors/{connector_id}: + delete: + operationId: mconn-connector-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + $ref: '#/components/schemas/mconnUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorDeleteResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Not Found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Remove a connector from your account + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + method: delete + get: + operationId: mconn-connector-fetch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + $ref: '#/components/schemas/mconnUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorFetchResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Not Found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch Connector + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + method: get + patch: + operationId: mconn-connector-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + $ref: '#/components/schemas/mconnUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorUpdateResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Not Found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Connector to update specific properties or Re-provision License Key + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + method: edit + put: + operationId: mconn-connector-replace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + $ref: '#/components/schemas/mconnUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerConnectorUpdateResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Not Found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnBadResponse' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Replace Connector or Re-provision License Key + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + method: update + /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events: + get: + operationId: mconn-connector-telemetry-events-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + type: string + required: true + - in: query + name: from + schema: + type: number + - in: query + name: to + schema: + type: number + - in: query + name: limit + schema: + type: number + - in: query + name: cursor + schema: + type: string + - description: Filter by event kind + in: query + name: k + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerEventsGetSuccess' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Forbidden + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Too Many Requests + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Events + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + - events + method: list + /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/latest: + get: + operationId: mconn-connector-telemetry-events-listLatest + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerEventsGetLatestSuccess' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Not Found + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Too Many Requests + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get latest Events + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + - events + - latest + method: list + /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/{event_t}.{event_n}: + get: + operationId: mconn-connector-telemetry-events-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + type: string + required: true + - in: path + name: event_t + schema: + type: number + required: true + - in: path + name: event_n + schema: + type: number + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerEventGetSuccess' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Not Found + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Too Many Requests + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Event + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + - events + method: get + /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots: + get: + operationId: mconn-connector-telemetry-snapshots-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + type: string + required: true + - in: query + name: from + schema: + type: number + - in: query + name: to + schema: + type: number + - in: query + name: limit + schema: + type: number + - in: query + name: cursor + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerSnapshotsGetSuccess' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Forbidden + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Too Many Requests + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Snapshots + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + - snapshots + method: list + /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/latest: + get: + operationId: mconn-connector-telemetry-snapshots-listLatest + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerSnapshotsGetLatestSuccess' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Not Found + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Too Many Requests + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get latest Snapshots + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + - snapshots + - latest + method: list + /accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/{snapshot_t}: + get: + operationId: mconn-connector-telemetry-snapshots-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: connector_id + schema: + type: string + required: true + - in: path + name: snapshot_t + schema: + type: number + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnCustomerSnapshotGetSuccess' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Not Found + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Too Many Requests + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/mconnEnvelope' + description: Internal Server Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Snapshot + tags: + - Magic Connectors + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - connectors + - snapshots + method: get + /accounts/{account_id}/magic/gre_tunnels: + get: + description: Lists GRE tunnels associated with an account. + operationId: magic-gre-tunnels-list-gre-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicTunnelsCollectionResponse' + description: List GRE tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + gre_tunnels: + items: + $ref: '#/components/schemas/magicGreTunnel' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List GRE tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List GRE tunnels + tags: + - Magic GRE tunnels + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - gre_tunnels + method: list + post: + description: Creates a new GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-gre-tunnels-create-gre-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicCreateGreTunnelRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicCreateGreTunnelResponse' + description: Create GRE tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + gre_tunnels: + items: + $ref: '#/components/schemas/magicGreTunnel' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create GRE tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a GRE tunnel + tags: + - Magic GRE tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - gre_tunnels + method: create + put: + description: Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-gre-tunnels-update-multiple-gre-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicModifiedTunnelsCollectionResponse' + description: Update multiple GRE tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_gre_tunnels: + items: + $ref: '#/components/schemas/magicGreTunnel' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update multiple GRE tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update multiple GRE tunnels + tags: + - Magic GRE tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - gre_tunnels + method: bulk_update + /accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}: + delete: + description: Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-gre-tunnels-delete-gre-tunnel + parameters: + - in: path + name: gre_tunnel_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicTunnelDeletedResponse' + description: Delete GRE Tunnel response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + type: boolean + deleted_gre_tunnel: + $ref: '#/components/schemas/magicGreTunnel' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete GRE Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete GRE Tunnel + tags: + - Magic GRE tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - gre_tunnels + method: delete + get: + description: Lists informtion for a specific GRE tunnel. + operationId: magic-gre-tunnels-list-gre-tunnel-details + parameters: + - in: path + name: gre_tunnel_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicTunnelSingleResponse' + description: List GRE Tunnel Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + gre_tunnel: + $ref: '#/components/schemas/magicGreTunnel' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List GRE Tunnel Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List GRE Tunnel Details + tags: + - Magic GRE tunnels + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - gre_tunnels + method: get + put: + description: Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-gre-tunnels-update-gre-tunnel + parameters: + - in: path + name: gre_tunnel_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicGreTunnelUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicTunnelModifiedResponse' + description: Update GRE Tunnel response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_gre_tunnel: + $ref: '#/components/schemas/magicGreTunnel' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update GRE Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update GRE Tunnel + tags: + - Magic GRE tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - gre_tunnels + method: update + /accounts/{account_id}/magic/ipsec_tunnels: + get: + description: Lists IPsec tunnels associated with an account. + operationId: magic-ipsec-tunnels-list-ipsec-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSchemasTunnelsCollectionResponse' + description: List IPsec tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + ipsec_tunnels: + items: + $ref: '#/components/schemas/magicIpsecTunnel' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List IPsec tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List IPsec tunnels + tags: + - Magic IPsec tunnels + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - ipsec_tunnels + method: list + post: + description: Creates a new IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-ipsec-tunnels-create-ipsec-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicIpsecTunnelAddRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSchemasCreateIpsecTunnelResponse' + description: Create IPsec tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + allow_null_cipher: + $ref: '#/components/schemas/magicAllowNullCipher' + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + bgp: + $ref: '#/components/schemas/magicBgpConfig' + bgp_status: + $ref: '#/components/schemas/magicBgpStatusWithState' + cloudflare_endpoint: + $ref: '#/components/schemas/magicCloudflareIpsecEndpoint' + created_on: + $ref: '#/components/schemas/magicSchemasCreatedOn' + readOnly: true + custom_remote_identities: + $ref: '#/components/schemas/magicCustomRemoteIdentities' + customer_endpoint: + $ref: '#/components/schemas/magicCustomerIpsecEndpoint' + description: + $ref: '#/components/schemas/magicComponentsSchemasDescription' + health_check: + $ref: '#/components/schemas/magicTunnelHealthCheck' + id: + $ref: '#/components/schemas/magicSchemasIdentifier' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + modified_on: + $ref: '#/components/schemas/magicSchemasModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/magicIpsecTunnelName' + psk_metadata: + $ref: '#/components/schemas/magicPskMetadata' + replay_protection: + $ref: '#/components/schemas/magicReplayProtection' + required: + - id + - name + - cloudflare_endpoint + - interface_address + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create IPsec tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an IPsec tunnel + tags: + - Magic IPsec tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - ipsec_tunnels + method: create + put: + description: Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-ipsec-tunnels-update-multiple-ipsec-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSchemasModifiedTunnelsCollectionResponse' + description: Update multiple IPsec tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_ipsec_tunnels: + items: + $ref: '#/components/schemas/magicIpsecTunnel' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update multiple IPsec tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update multiple IPsec tunnels + tags: + - Magic IPsec tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - ipsec_tunnels + method: bulk_update + /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}: + delete: + description: Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-ipsec-tunnels-delete-ipsec-tunnel + parameters: + - in: path + name: ipsec_tunnel_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSchemasTunnelDeletedResponse' + description: Delete IPsec Tunnel response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + type: boolean + deleted_ipsec_tunnel: + $ref: '#/components/schemas/magicIpsecTunnel' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete IPsec Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete IPsec Tunnel + tags: + - Magic IPsec tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - ipsec_tunnels + method: delete + get: + description: Lists details for a specific IPsec tunnel. + operationId: magic-ipsec-tunnels-list-ipsec-tunnel-details + parameters: + - in: path + name: ipsec_tunnel_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSchemasTunnelSingleResponse' + description: List IPsec tunnel details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + ipsec_tunnel: + $ref: '#/components/schemas/magicIpsecTunnel' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List IPsec tunnel details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List IPsec tunnel details + tags: + - Magic IPsec tunnels + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - ipsec_tunnels + method: get + put: + description: Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. + operationId: magic-ipsec-tunnels-update-ipsec-tunnel + parameters: + - in: path + name: ipsec_tunnel_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicIpsecTunnelAddSingleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSchemasTunnelModifiedResponse' + description: Update IPsec Tunnel response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_ipsec_tunnel: + $ref: '#/components/schemas/magicIpsecTunnel' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update IPsec Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update IPsec Tunnel + tags: + - Magic IPsec tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - ipsec_tunnels + method: update + /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}/psk_generate: + post: + description: Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place. + operationId: magic-ipsec-tunnels-generate-pre-shared-key-(-psk)-for-ipsec-tunnels + parameters: + - in: path + name: ipsec_tunnel_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicPskGenerationResponse' + description: Generate Pre Shared Key (PSK) for IPsec tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + ipsec_tunnel_id: + $ref: '#/components/schemas/magicIdentifier' + psk: + $ref: '#/components/schemas/magicPsk' + psk_metadata: + $ref: '#/components/schemas/magicPskMetadata' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Generate Pre Shared Key (PSK) for IPsec tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Generate Pre Shared Key (PSK) for IPsec tunnels + tags: + - Magic IPsec tunnels + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - ipsec_tunnels + method: psk_generate + /accounts/{account_id}/magic/routes: + delete: + description: Delete multiple Magic static routes. + operationId: magic-static-routes-delete-many-routes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicMultipleRouteDeleteResponse' + description: Delete Many Routes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + type: boolean + deleted_routes: + items: + $ref: '#/components/schemas/magicRoute' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Many Routes response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Many Routes + tags: + - Magic Static Routes + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - routes + method: empty + get: + description: List all Magic static routes. + operationId: magic-static-routes-list-routes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicRoutesCollectionResponse' + description: List Routes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + routes: + items: + $ref: '#/components/schemas/magicRoute' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Routes response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Routes + tags: + - Magic Static Routes + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - routes + method: list + post: + description: Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. + operationId: magic-static-routes-create-routes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicCreateRouteRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicCreateRouteResponse' + description: Create Routes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + routes: + items: + $ref: '#/components/schemas/magicRoute' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Routes response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Route + tags: + - Magic Static Routes + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - routes + method: create + put: + description: Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided. + operationId: magic-static-routes-update-many-routes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicRouteUpdateManyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicMultipleRouteModifiedResponse' + description: Update Many Routes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_routes: + items: + $ref: '#/components/schemas/magicRoute' + type: array + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Many Routes response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Many Routes + tags: + - Magic Static Routes + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - routes + method: bulk_update + /accounts/{account_id}/magic/routes/{route_id}: + delete: + description: Disable and remove a specific Magic static route. + operationId: magic-static-routes-delete-route + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicRouteDeletedResponse' + description: Delete Route response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + type: boolean + deleted_route: + $ref: '#/components/schemas/magicRoute' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Route + tags: + - Magic Static Routes + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - routes + method: delete + get: + description: Get a specific Magic static route. + operationId: magic-static-routes-route-details + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicRouteSingleResponse' + description: Route Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + route: + $ref: '#/components/schemas/magicRoute' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Route Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Route Details + tags: + - Magic Static Routes + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - routes + method: get + put: + description: Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. + operationId: magic-static-routes-update-route + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicRouteUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicRouteModifiedResponse' + description: Update Route response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + type: boolean + modified_route: + $ref: '#/components/schemas/magicRoute' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Route + tags: + - Magic Static Routes + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - routes + method: update + /accounts/{account_id}/magic/sites: + get: + description: Lists Sites associated with an account. Use connectorid query param to return sites where connectorid matches either site.ConnectorID or site.SecondaryConnectorID. + operationId: magic-sites-list-sites + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: connectorid + schema: + $ref: '#/components/schemas/magicIdentifier' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSitesCollectionResponse' + description: List Sites response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: List Sites response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Sites + tags: + - Magic Sites + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + method: list + post: + description: Creates a new Site + operationId: magic-sites-create-site + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicSitesAddSingleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSiteSingleResponse' + description: Create Site response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Create Site response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Site + tags: + - Magic Sites + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + method: create + /accounts/{account_id}/magic/sites/{site_id}: + delete: + description: Remove a specific Site. + operationId: magic-sites-delete-site + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSiteDeletedResponse' + description: Delete Site response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Delete Site response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Site + tags: + - Magic Sites + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + method: delete + get: + description: Get a specific Site. + operationId: magic-sites-site-details + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If true, the health check target in the response body will be presented using the new object format. Defaults to false. + in: header + name: x-magic-new-hc-target + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSiteSingleResponse' + description: Site Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Site Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Site Details + tags: + - Magic Sites + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + method: get + patch: + description: Patch a specific Site. + operationId: magic-sites-patch-site + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicSiteUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSiteModifiedResponse' + description: Patch Site response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Patch Site response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Site + tags: + - Magic Sites + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + method: edit + put: + description: Update a specific Site. + operationId: magic-sites-update-site + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicSiteUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicSiteModifiedResponse' + description: Update Site response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update Site response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Site + tags: + - Magic Sites + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + method: update + /accounts/{account_id}/magic/sites/{site_id}/acls: + get: + description: Lists Site ACLs associated with an account. + operationId: magic-site-acls-list-acls + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclsCollectionResponse' + description: List Site ACLs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: List Site ACLs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Site ACLs + tags: + - Magic Site ACLs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - acls + method: list + post: + description: Creates a new Site ACL. + operationId: magic-site-acls-create-acl + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclsAddSingleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclSingleResponse' + description: Create Site ACL response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Create Site ACL response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Site ACL + tags: + - Magic Site ACLs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - acls + method: create + /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}: + delete: + description: Remove a specific Site ACL. + operationId: magic-site-acls-delete-acl + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: acl_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclDeletedResponse' + description: Delete Site ACL response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Delete Site ACL response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Site ACL + tags: + - Magic Site ACLs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - acls + method: delete + get: + description: Get a specific Site ACL. + operationId: magic-site-acls-acl-details + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: acl_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclSingleResponse' + description: Site ACL Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Site ACL Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Site ACL Details + tags: + - Magic Site ACLs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - acls + method: get + patch: + description: Patch a specific Site ACL. + operationId: magic-site-acls-patch-acl + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: acl_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclModifiedResponse' + description: Patch Site ACL response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Patch Site ACL response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Site ACL + tags: + - Magic Site ACLs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - acls + method: edit + put: + description: Update a specific Site ACL. + operationId: magic-site-acls-update-acl + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: acl_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAclModifiedResponse' + description: Update Site ACL response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update Site ACL response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Site ACL + tags: + - Magic Site ACLs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - acls + method: update + /accounts/{account_id}/magic/sites/{site_id}/app_configs: + get: + description: Lists App Configs associated with a site. + operationId: magic-site-app-configs-list-app-configs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigsCollectionResponse' + description: List App Configs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: List App Configs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List App Configs + tags: + - Magic Site App Configs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + post: + description: Creates a new App Config for a site + operationId: magic-site-app-configs-add-app-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigAddSingleRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigSingleResponse' + description: Create Site App Config response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Create Site App Config response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new App Config + tags: + - Magic Site App Configs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}: + delete: + description: Deletes specific App Config associated with a site. + operationId: magic-site-app-configs-delete-app-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - in: path + name: app_config_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigSingleResponse' + description: Delete App Config response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Delete App Config response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete App Config + tags: + - Magic Site App Configs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + patch: + description: Updates an App Config for a site + operationId: magic-site-app-configs-patch-app-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - in: path + name: app_config_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigSingleResponse' + description: Update Site App Config response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update Site App Config response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an App Config + tags: + - Magic Site App Configs + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + put: + description: Updates an App Config for a site + operationId: magic-site-app-configs-update-app-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - in: path + name: app_config_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicAppConfigSingleResponse' + description: Update Site App Config response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update Site App Config response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an App Config + tags: + - Magic Site App Configs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/magic/sites/{site_id}/lans: + get: + description: Lists Site LANs associated with an account. + operationId: magic-site-lans-list-lans + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicLansCollectionResponse' + description: List Site LANs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: List Site LANs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Site LANs + tags: + - Magic Site LANs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - lans + method: create + post: + description: Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address. + operationId: magic-site-lans-create-lan + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicLansAddSingleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicLansCollectionResponse' + description: Create Site LAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Create Site LAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Site LAN + tags: + - Magic Site LANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}: + delete: + description: Remove a specific Site LAN. + operationId: magic-site-lans-delete-lan + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: lan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicLanDeletedResponse' + description: Delete Site LAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Delete Site LAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Site LAN + tags: + - Magic Site LANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - lans + method: delete + get: + description: Get a specific Site LAN. + operationId: magic-site-lans-lan-details + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: lan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicLanSingleResponse' + description: Site LAN Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Site LAN Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Site LAN Details + tags: + - Magic Site LANs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - lans + method: get + patch: + description: Patch a specific Site LAN. + operationId: magic-site-lans-patch-lan + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: lan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicLanUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicLanModifiedResponse' + description: Patch Site LAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Patch Site LAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Site LAN + tags: + - Magic Site LANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - lans + method: edit + put: + description: Update a specific Site LAN. + operationId: magic-site-lans-update-lan + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: lan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicLanUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicLanModifiedResponse' + description: Update Site LAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update Site LAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Site LAN + tags: + - Magic Site LANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - lans + method: update + /accounts/{account_id}/magic/sites/{site_id}/netflow_config: + delete: + description: Remove NetFlow configuration for a site. + operationId: magic-site-netflow-config-delete-netflow-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigSingleResponse' + description: Delete NetFlow Configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Delete NetFlow Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete NetFlow Configuration + tags: + - Magic Site NetFlow Config + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + get: + description: Get NetFlow configuration for a site. + operationId: magic-site-netflow-config-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigSingleResponse' + description: Get NetFlow Configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Get NetFlow Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: NetFlow Configuration Details + tags: + - Magic Site NetFlow Config + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + patch: + description: Updates NetFlow configuration for a site. + operationId: magic-site-netflow-config-patch-netflow-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigSingleResponse' + description: Update NetFlow Configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update NetFlow Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update NetFlow Configuration + tags: + - Magic Site NetFlow Config + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + post: + description: Creates a NetFlow configuration for a site. + operationId: magic-site-netflow-config-create-netflow-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigSingleResponse' + description: Create NetFlow Configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Create NetFlow Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create NetFlow Configuration + tags: + - Magic Site NetFlow Config + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + put: + description: Updates NetFlow configuration for a site (partial update). + operationId: magic-site-netflow-config-update-netflow-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicNetflowConfigSingleResponse' + description: Update NetFlow Configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update NetFlow Configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update NetFlow Configuration + tags: + - Magic Site NetFlow Config + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/magic/sites/{site_id}/wans: + get: + description: Lists Site WANs associated with an account. + operationId: magic-site-wans-list-wans + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicWansCollectionResponse' + description: List Site WANs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: List Site WANs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Site WANs + tags: + - Magic Site WANs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - wans + method: create + post: + description: Creates a new Site WAN. + operationId: magic-site-wans-create-wan + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicWansAddSingleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicWansCollectionResponse' + description: Create Site WAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Create Site WAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Site WAN + tags: + - Magic Site WANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}: + delete: + description: Remove a specific Site WAN. + operationId: magic-site-wans-delete-wan + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: wan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicWanDeletedResponse' + description: Delete Site WAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Delete Site WAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Site WAN + tags: + - Magic Site WANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - wans + method: delete + get: + description: Get a specific Site WAN. + operationId: magic-site-wans-wan-details + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: wan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicWanSingleResponse' + description: Site WAN Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Site WAN Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Site WAN Details + tags: + - Magic Site WANs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - wans + method: get + patch: + description: Patch a specific Site WAN. + operationId: magic-site-wans-patch-wan + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: wan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicWanUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicWanModifiedResponse' + description: Patch Site WAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Patch Site WAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Site WAN + tags: + - Magic Site WANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - wans + method: edit + put: + description: Update a specific Site WAN. + operationId: magic-site-wans-update-wan + parameters: + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: wan_id + schema: + $ref: '#/components/schemas/magicIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicWanUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicWanModifiedResponse' + description: Update Site WAN response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/magicApiResponseCommonFailure' + description: Update Site WAN response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Site WAN + tags: + - Magic Site WANs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-cfPermissionsRequired: + enum: + - '#organization:edit' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - sites + - wans + method: update + /accounts/{account_id}/pcaps: + get: + description: Lists all packet capture requests for an account. + operationId: magic-pcap-collection-list-packet-capture-requests + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsCollectionResponse' + description: List packet capture requests response. + default: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + items: + type: object + properties: + filter_v1: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsFilterV1' + id: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsId' + offset_time: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOffsetTime' + status: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStatus' + submitted: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSubmitted' + system: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSystem' + time_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsTimeLimitSampled' + type: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsType' + byte_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsByteLimit' + colo_name: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsColoName' + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + error_message: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsErrorMessage' + packets_captured: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsPacketsCaptured' + stop_requested: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStopRequested' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/magicVisibilityPcapsResultInfo' + required: + - errors + - messages + - result + - success + description: List packet capture requests response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List packet capture requests + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + - Magic Firewall Packet Captures - Read PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + method: list + post: + description: Create new PCAP request for account. + operationId: magic-pcap-collection-create-pcap-request + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsRequestPcap' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSingleResponse' + description: Create PCAP request response. + default: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + type: object + properties: + filter_v1: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsFilterV1' + id: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsId' + offset_time: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOffsetTime' + status: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStatus' + submitted: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSubmitted' + system: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSystem' + time_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsTimeLimitSampled' + type: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsType' + byte_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsByteLimit' + colo_name: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsColoName' + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + error_message: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsErrorMessage' + packets_captured: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsPacketsCaptured' + stop_requested: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStopRequested' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - errors + - messages + - result + - success + description: Create PCAP request response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create PCAP request + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + method: create + /accounts/{account_id}/pcaps/ownership: + get: + description: List all buckets configured for use with PCAPs API. + operationId: magic-pcap-collection-list-pca-ps-bucket-ownership + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipCollection' + description: List PCAPs Bucket Ownership response. + default: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + items: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipResponse' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/magicVisibilityPcapsResultInfo' + required: + - errors + - messages + - result + - success + description: List PCAPs Bucket Ownership response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List PCAPs Bucket Ownership + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + - Magic Firewall Packet Captures - Read PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + - ownership + method: get + post: + description: Adds an AWS or GCP bucket to use with full packet captures. + operationId: magic-pcap-collection-add-buckets-for-full-packet-captures + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipSingleResponse' + description: Add buckets for full packet captures response. + default: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - errors + - messages + - result + - success + description: Add buckets for full packet captures response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add buckets for full packet captures + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + - ownership + method: create + /accounts/{account_id}/pcaps/ownership/validate: + post: + description: Validates buckets added to the packet captures API. + operationId: magic-pcap-collection-validate-buckets-for-full-packet-captures + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipValidateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipSingleResponse' + description: Validate buckets for full packet captures response. + default: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - errors + - messages + - result + - success + description: Validate buckets for full packet captures response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate buckets for full packet captures + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + - ownership + method: validate + /accounts/{account_id}/pcaps/ownership/{ownership_id}: + delete: + description: Deletes buckets added to the packet captures API. + operationId: magic-pcap-collection-delete-buckets-for-full-packet-captures + parameters: + - in: path + name: ownership_id + schema: + $ref: '#/components/schemas/magicVisibilityPcapsIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '204': + description: Delete buckets for full packet captures response. + default: + content: + application/json: {} + description: Delete buckets for full packet captures response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete buckets for full packet captures + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + - ownership + method: delete + /accounts/{account_id}/pcaps/{pcap_id}: + get: + description: Get information for a PCAP request by id. + operationId: magic-pcap-collection-get-pcap-request + parameters: + - in: path + name: pcap_id + schema: + $ref: '#/components/schemas/magicVisibilityPcapsIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSingleResponse' + description: Get PCAP request response. + default: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + type: object + properties: + filter_v1: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsFilterV1' + id: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsId' + offset_time: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOffsetTime' + status: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStatus' + submitted: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSubmitted' + system: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSystem' + time_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsTimeLimitSampled' + type: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsType' + byte_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsByteLimit' + colo_name: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsColoName' + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + error_message: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsErrorMessage' + packets_captured: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsPacketsCaptured' + stop_requested: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStopRequested' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - errors + - messages + - result + - success + description: Get PCAP request response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get PCAP request + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + - Magic Firewall Packet Captures - Read PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + method: get + /accounts/{account_id}/pcaps/{pcap_id}/download: + get: + description: Download PCAP information into a file. Response is a binary PCAP file. + operationId: magic-pcap-collection-download-simple-pcap + parameters: + - in: path + name: pcap_id + schema: + $ref: '#/components/schemas/magicVisibilityPcapsIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/vnd.tcpdump.pcap: + schema: + type: object + properties: + contents: + type: string + description: Download Simple PCAP response. + default: + content: + application/json: {} + description: Download Simple PCAP response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Download Simple PCAP + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + - Magic Firewall Packet Captures - Read PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + - download + method: get + /accounts/{account_id}/pcaps/{pcap_id}/stop: + put: + description: Stop full PCAP. + operationId: magic-pcap-collection-stop-full-pcap + parameters: + - in: path + name: pcap_id + schema: + $ref: '#/components/schemas/magicVisibilityPcapsIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '204': + description: Stop full PCAP response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/magicVisibilityPcapsApiResponseCommonFailure' + description: Stop full PCAP response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Stop full PCAP + tags: + - Magic PCAP collection + x-api-token-group: + - Magic Firewall Packet Captures - Write PCAPs API + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: magic_transit + resource_chain: + - pcaps + method: stop +components: + schemas: + dosApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + dosApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/dosMessages' + messages: + example: [] + $ref: '#/components/schemas/dosMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + dosDnsProtectionRule: + properties: + burst_sensitivity: + description: The burst sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + created_on: + description: The creation timestamp of the DNS Protection rule. + format: date-time + type: string + x-auditable: true + readOnly: true + id: + description: The unique ID of the DNS Protection rule. + type: string + x-auditable: true + mode: + description: The mode for DNS Protection. Must be one of 'enabled', 'disabled', 'monitoring'. + type: string + x-auditable: true + modified_on: + description: The last modification timestamp of the DNS Protection rule. + format: date-time + type: string + x-auditable: true + readOnly: true + name: + description: The name of the DNS Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'. + type: string + x-auditable: true + profile_sensitivity: + description: The profile sensitivity. Recommended setting is 'low'. Must be one of 'low', 'medium', 'high', or 'very_high'. + type: string + x-auditable: true + rate_sensitivity: + description: The rate sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + scope: + description: The scope for the DNS Protection rule. Must be one of 'global', 'region', or 'datacenter'. + type: string + x-auditable: true + required: + - id + - scope + - name + - mode + - profile_sensitivity + - rate_sensitivity + - burst_sensitivity + - created_on + - modified_on + type: object + dosDnsProtectionRuleListResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/dosDnsProtectionRule' + type: array + required: + - success + - errors + - messages + dosDnsProtectionRuleResponse: + properties: + errors: + $ref: '#/components/schemas/dosMessages' + messages: + $ref: '#/components/schemas/dosMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/dosDnsProtectionRule' + required: + - success + - errors + - messages + type: object + dosDnsProtectionRuleUpdate: + properties: + burst_sensitivity: + description: The new burst sensitivity. Optional. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + mode: + description: The new mode for DNS Protection. Optional. Must be one of 'enabled', 'disabled', 'monitoring'. + type: string + x-auditable: true + profile_sensitivity: + description: The new profile sensitivity. Optional. Recommended setting is 'low'. Must be one of 'low', 'medium', 'high', or 'very_high'. + type: string + x-auditable: true + rate_sensitivity: + description: The new rate sensitivity. Optional. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + type: object + dosMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dosNewDnsProtectionRule: + properties: + burst_sensitivity: + description: The burst sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + mode: + description: The mode for DNS Protection. Must be one of 'enabled', 'disabled', 'monitoring'. + type: string + x-auditable: true + name: + description: The name of the DNS Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'. + type: string + x-auditable: true + profile_sensitivity: + description: The profile sensitivity. Recommended setting is 'low'. Must be one of 'low', 'medium', 'high', or 'very_high'. + type: string + x-auditable: true + rate_sensitivity: + description: The rate sensitivity. Must be one of 'low', 'medium', 'high'. + type: string + x-auditable: true + scope: + description: The scope for the DNS Protection rule. Must be one of 'global', 'region', or 'datacenter'. + type: string + x-auditable: true + required: + - scope + - name + - mode + - profile_sensitivity + - rate_sensitivity + - burst_sensitivity + type: object + magicAccountApp: + description: Custom app defined for an account. + properties: + account_app_id: + $ref: '#/components/schemas/magicAccountAppId' + hostnames: + $ref: '#/components/schemas/magicAppHostnames' + ip_subnets: + $ref: '#/components/schemas/magicAppSubnets' + name: + $ref: '#/components/schemas/magicAppName' + source_subnets: + $ref: '#/components/schemas/magicAppSourceSubnets' + type: + $ref: '#/components/schemas/magicAppType' + required: + - account_app_id + title: Account App + type: object + magicAccountAppId: + description: Magic account app ID. + example: ac60d3d0435248289d446cedd870bcf4 + type: string + magicAcl: + description: Bidirectional ACL policy for network traffic within a site. + properties: + description: + description: Description for the ACL. + example: Allows local traffic between PIN pads and cash register. + type: string + forward_locally: + $ref: '#/components/schemas/magicForwardLocally' + id: + $ref: '#/components/schemas/magicIdentifier' + lan_1: + $ref: '#/components/schemas/magicLanAclConfiguration' + lan_2: + $ref: '#/components/schemas/magicLanAclConfiguration' + name: + description: The name of the ACL. + example: PIN Pad - Cash Register + type: string + protocols: + items: + $ref: '#/components/schemas/unnamedSchemaRef87fa9e5fe9f6b8d607be1df57340d916' + type: array + unidirectional: + $ref: '#/components/schemas/magicUnidirectional' + type: object + magicAclDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicAcl' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicAclModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicAcl' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicAclPortRange: + description: A valid port range value. + example: 8080-9000 + type: string + magicAclSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicAcl' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicAclSubnet: + type: string + description: A valid IPv4 address. + example: 192.0.2.1 + magicAclUpdateRequest: + properties: + description: + description: Description for the ACL. + example: Allows local traffic between PIN pads and cash register. + type: string + forward_locally: + $ref: '#/components/schemas/magicForwardLocally' + lan_1: + $ref: '#/components/schemas/magicLanAclConfiguration' + lan_2: + $ref: '#/components/schemas/magicLanAclConfiguration' + name: + description: The name of the ACL. + example: PIN Pad - Cash Register + type: string + protocols: + items: + $ref: '#/components/schemas/unnamedSchemaRef87fa9e5fe9f6b8d607be1df57340d916' + type: array + unidirectional: + $ref: '#/components/schemas/magicUnidirectional' + type: object + magicAclsAddSingleRequest: + description: Bidirectional ACL policy for local network traffic within a site. + properties: + description: + description: Description for the ACL. + example: Allows local traffic between PIN pads and cash register. + type: string + forward_locally: + $ref: '#/components/schemas/magicForwardLocally' + lan_1: + $ref: '#/components/schemas/magicLanAclConfiguration' + lan_2: + $ref: '#/components/schemas/magicLanAclConfiguration' + name: + description: The name of the ACL. + example: PIN Pad - Cash Register + type: string + protocols: + items: + $ref: '#/components/schemas/unnamedSchemaRef87fa9e5fe9f6b8d607be1df57340d916' + type: array + unidirectional: + $ref: '#/components/schemas/magicUnidirectional' + required: + - name + - lan_1 + - lan_2 + type: object + magicAclsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + items: + $ref: '#/components/schemas/magicAcl' + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicAllowNullCipher: + description: When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2). + example: true + type: boolean + magicApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/magicMessages' + messages: + example: [] + $ref: '#/components/schemas/magicMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicApp: + description: Collection of Hostnames and/or IP Subnets to associate with traffic decisions. + type: object + title: Account App + properties: + account_app_id: + $ref: '#/components/schemas/magicAccountAppId' + hostnames: + $ref: '#/components/schemas/magicAppHostnames' + ip_subnets: + $ref: '#/components/schemas/magicAppSubnets' + name: + $ref: '#/components/schemas/magicAppName' + source_subnets: + $ref: '#/components/schemas/magicAppSourceSubnets' + type: + $ref: '#/components/schemas/magicAppType' + managed_app_id: + $ref: '#/components/schemas/magicManagedAppId' + required: [] + magicAppAddSingleRequest: + properties: + hostnames: + $ref: '#/components/schemas/magicAppHostnames' + ip_subnets: + $ref: '#/components/schemas/magicAppSubnets' + name: + $ref: '#/components/schemas/magicAppName' + source_subnets: + $ref: '#/components/schemas/magicAppSourceSubnets' + type: + $ref: '#/components/schemas/magicAppType' + required: [] + type: object + title: Hostnames + magicAppBreakout: + description: Whether to breakout traffic to the app's endpoints directly. Null preserves default behavior. + example: true + type: boolean + magicAppBreakoutPreferredWans: + description: WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true). + items: + $ref: '#/components/schemas/magicIdentifier' + type: array + magicAppConfig: + description: Traffic decision configuration for an app. + type: object + properties: + breakout: + $ref: '#/components/schemas/magicAppBreakout' + id: + $ref: '#/components/schemas/magicIdentifier' + preferred_wans: + $ref: '#/components/schemas/magicAppBreakoutPreferredWans' + priority: + $ref: '#/components/schemas/magicAppPriority' + site_id: + $ref: '#/components/schemas/magicIdentifier' + account_app_id: + $ref: '#/components/schemas/magicAccountAppId' + managed_app_id: + $ref: '#/components/schemas/magicManagedAppId' + required: [] + title: Account App + magicAppConfigAddSingleRequest: + type: object + properties: + breakout: + $ref: '#/components/schemas/magicAppBreakout' + preferred_wans: + $ref: '#/components/schemas/magicAppBreakoutPreferredWans' + priority: + $ref: '#/components/schemas/magicAppPriority' + account_app_id: + $ref: '#/components/schemas/magicAccountAppId' + managed_app_id: + $ref: '#/components/schemas/magicManagedAppId' + title: Account App + required: [] + magicAppConfigSingleResponse: + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/magicAppConfig' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicAppConfigUpdateRequest: + properties: + account_app_id: + $ref: '#/components/schemas/magicAccountAppId' + breakout: + $ref: '#/components/schemas/magicAppBreakout' + managed_app_id: + $ref: '#/components/schemas/magicManagedAppId' + preferred_wans: + $ref: '#/components/schemas/magicAppBreakoutPreferredWans' + priority: + $ref: '#/components/schemas/magicAppPriority' + type: object + magicAppConfigsCollectionResponse: + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + nullable: true + type: array + items: + $ref: '#/components/schemas/magicAppConfig' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicAppHostnames: + description: FQDNs to associate with traffic decisions. + items: + example: auth.cloudflare.com + type: string + type: array + magicAppName: + description: Display name for the app. + example: Cloudflare Dashboard + type: string + magicAppPriority: + description: Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported) + maximum: 1 + minimum: 0 + type: integer + magicAppSingleResponse: + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/magicAccountApp' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicAppSourceSubnets: + description: IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported) + items: + $ref: '#/components/schemas/magicCidr' + example: 1.1.1.1/32 + type: array + magicAppSubnets: + description: IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported) + items: + $ref: '#/components/schemas/magicCidr' + example: 1.1.1.1/32 + type: array + magicAppType: + description: Category of the app. + example: Development + type: string + magicAppUpdateRequest: + properties: + hostnames: + $ref: '#/components/schemas/magicAppHostnames' + ip_subnets: + $ref: '#/components/schemas/magicAppSubnets' + name: + $ref: '#/components/schemas/magicAppName' + source_subnets: + $ref: '#/components/schemas/magicAppSourceSubnets' + type: + $ref: '#/components/schemas/magicAppType' + type: object + title: Update App Name + required: [] + magicAppsCollectionResponse: + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + items: + $ref: '#/components/schemas/magicApp' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicAutomaticReturnRouting: + default: false + description: True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the `coupler_integration` account flag to be enabled; requests setting this to `true` without that flag will be rejected. + example: true + type: boolean + x-auditable: true + magicBgpConfig: + properties: + customer_asn: + description: ASN used on the customer end of the BGP session + format: int32 + minimum: 0 + type: integer + extra_prefixes: + description: Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. + items: + format: cidr + type: string + type: array + md5_key: + description: 'MD5 key to use for session authentication. Note that *this is not a security measure*. MD5 is not a valid security mechanism, and the key is not treated as a secret value. This is *only* supported for preventing misconfiguration, not for defending against malicious attacks. The MD5 key, if set, must be of non-zero length and consist only of the following types of character: * ASCII alphanumerics: `[a-zA-Z0-9]` * Special characters in the set `''!@#$%^&*()+[]{}<>/.,;:_-~`= \|` In other words, MD5 keys may contain any printable ASCII character aside from newline (0x0A), quotation mark (`"`), vertical tab (0x0B), carriage return (0x0D), tab (0x09), form feed (0x0C), and the question mark (`?`). Requests specifying an MD5 key with one or more of these disallowed characters will be rejected.' + type: string + required: + - customer_asn + type: object + magicBgpStatusWithState: + properties: + bgp_state: + type: string + cf_speaker_ip: + format: ipv4 + type: string + cf_speaker_port: + maximum: 65535 + minimum: 1 + type: integer + customer_speaker_ip: + format: ipv4 + type: string + customer_speaker_port: + maximum: 65535 + minimum: 1 + type: integer + state: + enum: + - BGP_DOWN + - BGP_UP + - BGP_ESTABLISHING + type: string + tcp_established: + type: boolean + updated_at: + format: date-time + type: string + readOnly: true + required: + - state + - tcp_established + - updated_at + type: object + magicBondId: + example: 2 + type: integer + magicCidr: + description: A valid CIDR notation representing an IP range. + example: 192.0.2.0/24 + type: string + magicCloudflareGreEndpoint: + description: The IP address assigned to the Cloudflare side of the GRE tunnel. + example: 203.0.113.1 + type: string + x-auditable: true + magicCloudflareIpsecEndpoint: + description: The IP address assigned to the Cloudflare side of the IPsec tunnel. + example: 203.0.113.1 + type: string + magicColoName: + description: Scope colo name. + example: den01 + type: string + x-auditable: true + magicColoNames: + description: List of colo names for the ECMP scope. + items: + $ref: '#/components/schemas/magicColoName' + type: array + magicColoRegion: + description: Scope colo region. + example: APAC + type: string + x-auditable: true + magicColoRegions: + description: List of colo regions for the ECMP scope. + items: + $ref: '#/components/schemas/magicColoRegion' + type: array + x-auditable: true + magicComponentsSchemasDescription: + description: An optional description forthe IPsec tunnel. + example: Tunnel for ISP X + type: string + magicComponentsSchemasModifiedTunnelsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_interconnects: + items: + $ref: '#/components/schemas/magicInterconnect' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicComponentsSchemasName: + description: The name of the interconnect. The name cannot share a name with other tunnels. + example: pni_ord + type: string + magicComponentsSchemasTunnelModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_interconnect: + $ref: '#/components/schemas/magicInterconnect' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicComponentsSchemasTunnelSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + interconnect: + $ref: '#/components/schemas/magicInterconnect' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicComponentsSchemasTunnelsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + interconnects: + items: + $ref: '#/components/schemas/magicInterconnect' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicConnectorId: + description: Magic Connector identifier tag. + example: ac60d3d0435248289d446cedd870bcf4 + type: string + x-auditable: true + magicCreateGreTunnelRequest: + properties: + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + bgp: + $ref: '#/components/schemas/magicBgpConfig' + cloudflare_gre_endpoint: + $ref: '#/components/schemas/magicCloudflareGreEndpoint' + customer_gre_endpoint: + $ref: '#/components/schemas/magicCustomerGreEndpoint' + description: + $ref: '#/components/schemas/magicSchemasDescription' + health_check: + $ref: '#/components/schemas/magicTunnelHealthCheck' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + mtu: + $ref: '#/components/schemas/magicMtu' + name: + $ref: '#/components/schemas/magicGreTunnelName' + ttl: + $ref: '#/components/schemas/magicTtl' + required: + - name + - customer_gre_endpoint + - cloudflare_gre_endpoint + - interface_address + type: object + magicCreateGreTunnelResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicGreTunnel' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicCreateRouteRequest: + properties: + description: + $ref: '#/components/schemas/magicDescription' + nexthop: + $ref: '#/components/schemas/magicNexthop' + prefix: + $ref: '#/components/schemas/magicPrefix' + priority: + $ref: '#/components/schemas/magicPriority' + scope: + $ref: '#/components/schemas/magicScope' + weight: + $ref: '#/components/schemas/magicWeight' + required: + - prefix + - nexthop + - priority + type: object + magicCreateRouteResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicRoute' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicCreatedOn: + description: When the route was created. + example: '2017-06-14T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + magicCustomRemoteIdentities: + properties: + fqdn_id: + description: A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The generated IKE IDs can still be used even if this custom value is specified. Must be of the form `..custom.ipsec.cloudflare.com`. This custom ID does not need to be unique. Two IPsec tunnels may have the same custom fqdn_id. However, if another IPsec tunnel has the same value then the two tunnels cannot have the same cloudflare_endpoint. + type: string + type: object + magicCustomerGreEndpoint: + description: The IP address assigned to the customer side of the GRE tunnel. + example: 203.0.113.1 + type: string + x-auditable: true + magicCustomerIpsecEndpoint: + description: The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work. + example: 203.0.113.1 + type: string + magicDescription: + description: An optional human provided description of the static route. + example: New route for new prefix 203.0.113.1 + type: string + x-auditable: true + magicDhcpOption: + description: A custom DHCP option to include in DHCP responses. + example: + code: 66 + type: ip + value: 10.20.30.40 + properties: + code: + description: DHCP option number (1-254). Options 0 and 255 are reserved by RFC 2132. Options 3, 6, and 51 are not allowed because they conflict with connector-managed configuration. + maximum: 254 + minimum: 1 + type: integer + type: + description: 'The type of the option value. text: a string (max 255 bytes). hex: colon-separated hex bytes (e.g. "01:04:aa:bb:cc", max 255 bytes). ip: an IPv4 address (e.g. "10.20.30.40"). byte: an unsigned integer 0-255 (1 byte). short: an unsigned integer 0-65535 (2 bytes). integer: an unsigned integer 0-4294967295 (4 bytes).' + enum: + - text + - hex + - ip + - byte + - short + - integer + type: string + value: + description: The option value, interpreted according to the type field. + type: string + required: + - code + - type + - value + type: object + magicForwardLocally: + description: The desired forwarding action for this ACL policy. If set to "false", the policy will forward traffic to Cloudflare. If set to "true", the policy will forward traffic locally on the Magic Connector. If not included in request, will default to false. + type: boolean + magicGre: + description: The configuration specific to GRE interconnects. + properties: + cloudflare_endpoint: + description: The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect. + example: 203.0.113.1 + type: string + type: object + magicGreTunnel: + properties: + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + bgp: + $ref: '#/components/schemas/magicBgpConfig' + bgp_status: + $ref: '#/components/schemas/magicBgpStatusWithState' + cloudflare_gre_endpoint: + $ref: '#/components/schemas/magicCloudflareGreEndpoint' + created_on: + $ref: '#/components/schemas/magicSchemasCreatedOn' + readOnly: true + customer_gre_endpoint: + $ref: '#/components/schemas/magicCustomerGreEndpoint' + description: + $ref: '#/components/schemas/magicSchemasDescription' + health_check: + $ref: '#/components/schemas/magicTunnelHealthCheck' + id: + $ref: '#/components/schemas/magicSchemasIdentifier' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + modified_on: + $ref: '#/components/schemas/magicSchemasModifiedOn' + readOnly: true + mtu: + $ref: '#/components/schemas/magicMtu' + name: + $ref: '#/components/schemas/magicGreTunnelName' + ttl: + $ref: '#/components/schemas/magicTtl' + required: + - id + - name + - customer_gre_endpoint + - cloudflare_gre_endpoint + - interface_address + type: object + magicGreTunnelAddSingleRequest: + properties: + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + cloudflare_gre_endpoint: + $ref: '#/components/schemas/magicCloudflareGreEndpoint' + customer_gre_endpoint: + $ref: '#/components/schemas/magicCustomerGreEndpoint' + description: + $ref: '#/components/schemas/magicSchemasDescription' + health_check: + $ref: '#/components/schemas/magicTunnelHealthCheck' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + mtu: + $ref: '#/components/schemas/magicMtu' + name: + $ref: '#/components/schemas/magicGreTunnelName' + ttl: + $ref: '#/components/schemas/magicTtl' + required: + - name + - customer_gre_endpoint + - cloudflare_gre_endpoint + - interface_address + type: object + magicGreTunnelName: + description: The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel. + example: GRE_1 + type: string + x-auditable: true + magicGreTunnelUpdateRequest: + $ref: '#/components/schemas/magicGreTunnelAddSingleRequest' + magicHealthCheckBase: + properties: + enabled: + default: true + description: Determines whether to run healthchecks for a tunnel. + example: true + type: boolean + x-auditable: true + rate: + $ref: '#/components/schemas/unnamedSchemaRefEebdc868ce7f7ae92e23438caa84e7b5' + target: + description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false. + type: object + properties: + effective: + description: The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests. + example: 203.0.113.1 + readOnly: true + type: string + x-auditable: true + saved: + description: The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. + example: 203.0.113.1 + type: string + x-auditable: true + type: + $ref: '#/components/schemas/magicHealthCheckType' + type: object + magicHealthCheckType: + default: reply + description: The type of healthcheck to run, reply or request. The default value is `reply`. + enum: + - reply + - request + example: request + type: string + x-auditable: true + magicIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + magicInterconnect: + properties: + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + colo_name: + $ref: '#/components/schemas/magicComponentsSchemasName' + created_on: + $ref: '#/components/schemas/magicSchemasCreatedOn' + readOnly: true + description: + $ref: '#/components/schemas/magicInterconnectComponentsSchemasDescription' + gre: + $ref: '#/components/schemas/magicGre' + health_check: + $ref: '#/components/schemas/magicInterconnectHealthCheck' + id: + $ref: '#/components/schemas/magicSchemasIdentifier' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + modified_on: + $ref: '#/components/schemas/magicSchemasModifiedOn' + readOnly: true + mtu: + $ref: '#/components/schemas/magicSchemasMtu' + name: + $ref: '#/components/schemas/magicComponentsSchemasName' + virtual_port_reservation_id: + $ref: '#/components/schemas/magicSchemasIdentifier' + description: An identifier that correlates this interconnect with the corresponding V2 CNI interconnect resource. + readOnly: true + type: object + magicInterconnectComponentsSchemasDescription: + description: An optional description of the interconnect. + example: Tunnel for Interconnect to ORD + type: string + magicInterconnectHealthCheck: + $ref: '#/components/schemas/magicHealthCheckBase' + magicInterconnectTunnelUpdateRequest: + properties: + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + description: + $ref: '#/components/schemas/magicInterconnectComponentsSchemasDescription' + gre: + $ref: '#/components/schemas/magicGre' + health_check: + $ref: '#/components/schemas/magicInterconnectHealthCheck' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + mtu: + $ref: '#/components/schemas/magicSchemasMtu' + name: + $ref: '#/components/schemas/magicComponentsSchemasName' + type: object + magicInterfaceAddress: + description: "A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0\u201310.255.255.255, 172.16.0.0\u2013172.31.255.255, 192.168.0.0\u2013192.168.255.255." + example: 192.0.2.0/31 + type: string + x-auditable: true + magicInterfaceAddress6: + description: A 127 bit IPV6 prefix from within the virtual_subnet6 prefix space with the address being the first IP of the subnet and not same as the address of virtual_subnet6. Eg if virtual_subnet6 is 2606:54c1:7:0:a9fe:12d2::/127 , interface_address6 could be 2606:54c1:7:0:a9fe:12d2:1:200/127 + example: 2606:54c1:7:0:a9fe:12d2:1:200/127 + type: string + x-auditable: true + magicIpAddress: + description: A valid IPv4 address. + example: 192.0.2.1 + type: string + magicIpsecTunnel: + properties: + allow_null_cipher: + $ref: '#/components/schemas/magicAllowNullCipher' + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + bgp: + $ref: '#/components/schemas/magicBgpConfig' + bgp_status: + $ref: '#/components/schemas/magicBgpStatusWithState' + cloudflare_endpoint: + $ref: '#/components/schemas/magicCloudflareIpsecEndpoint' + created_on: + $ref: '#/components/schemas/magicSchemasCreatedOn' + readOnly: true + custom_remote_identities: + $ref: '#/components/schemas/magicCustomRemoteIdentities' + customer_endpoint: + $ref: '#/components/schemas/magicCustomerIpsecEndpoint' + description: + $ref: '#/components/schemas/magicComponentsSchemasDescription' + health_check: + $ref: '#/components/schemas/magicTunnelHealthCheck' + id: + $ref: '#/components/schemas/magicSchemasIdentifier' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + modified_on: + $ref: '#/components/schemas/magicSchemasModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/magicIpsecTunnelName' + psk_metadata: + $ref: '#/components/schemas/magicPskMetadata' + replay_protection: + $ref: '#/components/schemas/magicReplayProtection' + required: + - id + - name + - cloudflare_endpoint + - interface_address + type: object + magicIpsecTunnelAddRequest: + $ref: '#/components/schemas/magicIpsecTunnelAddSingleRequest' + magicIpsecTunnelAddSingleRequest: + properties: + automatic_return_routing: + $ref: '#/components/schemas/magicAutomaticReturnRouting' + bgp: + $ref: '#/components/schemas/magicBgpConfig' + cloudflare_endpoint: + $ref: '#/components/schemas/magicCloudflareIpsecEndpoint' + custom_remote_identities: + $ref: '#/components/schemas/magicCustomRemoteIdentities' + customer_endpoint: + $ref: '#/components/schemas/magicCustomerIpsecEndpoint' + description: + $ref: '#/components/schemas/magicComponentsSchemasDescription' + health_check: + $ref: '#/components/schemas/magicTunnelHealthCheck' + interface_address: + $ref: '#/components/schemas/magicInterfaceAddress' + interface_address6: + $ref: '#/components/schemas/magicInterfaceAddress6' + name: + $ref: '#/components/schemas/magicIpsecTunnelName' + psk: + $ref: '#/components/schemas/magicPsk' + replay_protection: + $ref: '#/components/schemas/magicReplayProtection' + required: + - name + - cloudflare_endpoint + - interface_address + type: object + magicIpsecTunnelName: + description: The name of the IPsec tunnel. The name cannot share a name with other tunnels. + example: IPsec_1 + type: string + magicLan: + properties: + bond_id: + $ref: '#/components/schemas/magicBondId' + ha_link: + description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link. + type: boolean + id: + $ref: '#/components/schemas/magicIdentifier' + is_breakout: + description: mark true to use this LAN for source-based breakout traffic + type: boolean + is_prioritized: + description: mark true to use this LAN for source-based prioritized traffic + type: boolean + name: + type: string + nat: + $ref: '#/components/schemas/magicNat' + physport: + $ref: '#/components/schemas/magicPort' + routed_subnets: + items: + $ref: '#/components/schemas/magicRoutedSubnet' + type: array + site_id: + $ref: '#/components/schemas/magicIdentifier' + static_addressing: + $ref: '#/components/schemas/magicLanStaticAddressing' + vlan_tag: + $ref: '#/components/schemas/magicVlanTag' + type: object + magicLanAclConfiguration: + properties: + lan_id: + description: The identifier for the LAN you want to create an ACL policy with. + type: string + lan_name: + description: The name of the LAN based on the provided lan_id. + type: string + port_ranges: + description: Array of port ranges on the provided LAN that will be included in the ACL. If no ports or port rangess are provided, communication on any port on this LAN is allowed. + items: + $ref: '#/components/schemas/magicAclPortRange' + type: array + ports: + description: Array of ports on the provided LAN that will be included in the ACL. If no ports or port ranges are provided, communication on any port on this LAN is allowed. + items: + $ref: '#/components/schemas/magicPort' + type: array + subnets: + description: Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed. + items: + $ref: '#/components/schemas/magicAclSubnet' + type: array + required: + - lan_id + type: object + magicLanDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicLan' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicLanDhcpRelay: + properties: + server_addresses: + description: List of DHCP server IPs. + items: + $ref: '#/components/schemas/magicIpAddress' + type: array + type: object + magicLanDhcpServer: + properties: + dhcp_options: + description: Optional list of custom DHCP options to include in DHCP responses. Only valid when DHCP server is enabled. + items: + $ref: '#/components/schemas/magicDhcpOption' + type: array + dhcp_pool_end: + $ref: '#/components/schemas/magicIpAddress' + dhcp_pool_start: + $ref: '#/components/schemas/magicIpAddress' + dns_server: + $ref: '#/components/schemas/magicIpAddress' + dns_servers: + items: + $ref: '#/components/schemas/magicIpAddress' + type: array + reservations: + description: Mapping of MAC addresses to IP addresses + example: + 00:11:22:33:44:55: 192.0.2.100 + AA:BB:CC:DD:EE:FF: 192.168.1.101 + type: object + type: object + magicLanModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicLan' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicLanSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicLan' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicLanStaticAddressing: + description: If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address. + properties: + address: + $ref: '#/components/schemas/magicCidr' + dhcp_relay: + $ref: '#/components/schemas/magicLanDhcpRelay' + dhcp_server: + $ref: '#/components/schemas/magicLanDhcpServer' + secondary_address: + $ref: '#/components/schemas/magicCidr' + virtual_address: + $ref: '#/components/schemas/magicCidr' + required: + - address + type: object + magicLanUpdateRequest: + properties: + bond_id: + $ref: '#/components/schemas/magicBondId' + is_breakout: + description: mark true to use this LAN for source-based breakout traffic + type: boolean + is_prioritized: + description: mark true to use this LAN for source-based prioritized traffic + type: boolean + name: + type: string + nat: + $ref: '#/components/schemas/magicNat' + physport: + $ref: '#/components/schemas/magicPort' + routed_subnets: + items: + $ref: '#/components/schemas/magicRoutedSubnet' + type: array + static_addressing: + $ref: '#/components/schemas/magicLanStaticAddressing' + vlan_tag: + $ref: '#/components/schemas/magicVlanTag' + type: object + magicLansAddSingleRequest: + properties: + bond_id: + $ref: '#/components/schemas/magicBondId' + ha_link: + description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link. + type: boolean + is_breakout: + description: mark true to use this LAN for source-based breakout traffic + type: boolean + is_prioritized: + description: mark true to use this LAN for source-based prioritized traffic + type: boolean + name: + type: string + nat: + $ref: '#/components/schemas/magicNat' + physport: + $ref: '#/components/schemas/magicPort' + routed_subnets: + items: + $ref: '#/components/schemas/magicRoutedSubnet' + type: array + static_addressing: + $ref: '#/components/schemas/magicLanStaticAddressing' + vlan_tag: + $ref: '#/components/schemas/magicVlanTag' + type: object + magicLansCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + items: + $ref: '#/components/schemas/magicLan' + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicManagedAppId: + description: Managed app ID. + example: cloudflare + type: string + magicMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + magicModifiedOn: + description: When the route was last modified. + example: '2017-06-14T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + magicModifiedTunnelsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_gre_tunnels: + items: + $ref: '#/components/schemas/magicGreTunnel' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicMtu: + default: 1476 + description: Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. + type: integer + x-auditable: true + magicMultipleRouteDeleteResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + example: true + type: boolean + deleted_routes: + items: + $ref: '#/components/schemas/magicRoute' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicMultipleRouteModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_routes: + items: + $ref: '#/components/schemas/magicRoute' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicNat: + properties: + static_prefix: + $ref: '#/components/schemas/magicCidr' + type: object + magicNetflowConfig: + description: NetFlow configuration for a site. + properties: + active_timeout: + description: Timeout in seconds for active flows (defaults to 30). + example: 30 + maximum: 5400 + minimum: 1 + type: integer + collector_ip: + description: IPv4 address of the NetFlow collector. + example: 162.159.65.1 + type: string + collector_port: + description: UDP port of the NetFlow collector (defaults to 2055). + example: 2055 + maximum: 65535 + minimum: 1 + type: integer + inactive_timeout: + description: Timeout in seconds for inactive flows (defaults to 15). + example: 15 + maximum: 5400 + minimum: 1 + type: integer + sampling_rate: + description: Sampling rate for NetFlow records (1 = every packet, 1000 = 1 in 1000 packets). Defaults to 1. + example: 100 + maximum: 10000 + minimum: 1 + type: integer + required: + - collector_ip + type: object + magicNetflowConfigRequest: + properties: + active_timeout: + description: Timeout in seconds for active flows. + example: 30 + maximum: 5400 + minimum: 1 + type: integer + collector_ip: + description: IPv4 address of the NetFlow collector. + example: 162.159.65.1 + type: string + collector_port: + description: UDP port of the NetFlow collector. + example: 2055 + maximum: 65535 + minimum: 1 + type: integer + inactive_timeout: + description: Timeout in seconds for inactive flows. + example: 15 + maximum: 5400 + minimum: 1 + type: integer + sampling_rate: + description: Sampling rate for NetFlow records (1 = every packet). + example: 100 + maximum: 10000 + minimum: 1 + type: integer + type: object + magicNetflowConfigSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicNetflowConfig' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicNexthop: + description: The next-hop IP Address for the static route. + example: 203.0.113.1 + type: string + x-auditable: true + magicPort: + example: 1 + type: integer + magicPrefix: + description: IP Prefix in Classless Inter-Domain Routing format. + example: 192.0.2.0/24 + type: string + x-auditable: true + magicPriority: + description: Priority of the static route. + type: integer + x-auditable: true + magicPsk: + description: A randomly generated or provided string for use in the IPsec tunnel. + example: O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy + type: string + x-sensitive: true + magicPskGenerationResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + ipsec_tunnel_id: + $ref: '#/components/schemas/magicIdentifier' + psk: + $ref: '#/components/schemas/magicPsk' + psk_metadata: + $ref: '#/components/schemas/magicPskMetadata' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicPskMetadata: + description: The PSK metadata that includes when the PSK was generated. + properties: + last_generated_on: + $ref: '#/components/schemas/magicSchemasModifiedOn' + type: object + magicReplayProtection: + default: false + description: If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction. + example: false + type: boolean + magicRoute: + properties: + created_on: + $ref: '#/components/schemas/magicCreatedOn' + readOnly: true + description: + $ref: '#/components/schemas/magicDescription' + id: + $ref: '#/components/schemas/magicIdentifier' + modified_on: + $ref: '#/components/schemas/magicModifiedOn' + readOnly: true + nexthop: + $ref: '#/components/schemas/magicNexthop' + prefix: + $ref: '#/components/schemas/magicPrefix' + priority: + $ref: '#/components/schemas/magicPriority' + scope: + $ref: '#/components/schemas/magicScope' + weight: + $ref: '#/components/schemas/magicWeight' + required: + - id + - prefix + - nexthop + - priority + type: object + magicRouteAddSingleRequest: + properties: + description: + $ref: '#/components/schemas/magicDescription' + nexthop: + $ref: '#/components/schemas/magicNexthop' + prefix: + $ref: '#/components/schemas/magicPrefix' + priority: + $ref: '#/components/schemas/magicPriority' + scope: + $ref: '#/components/schemas/magicScope' + weight: + $ref: '#/components/schemas/magicWeight' + required: + - prefix + - nexthop + - priority + type: object + magicRouteDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + example: true + type: boolean + deleted_route: + $ref: '#/components/schemas/magicRoute' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicRouteModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_route: + $ref: '#/components/schemas/magicRoute' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicRouteSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + route: + $ref: '#/components/schemas/magicRoute' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicRouteUpdateManyRequest: + properties: + routes: + items: + $ref: '#/components/schemas/magicRouteUpdateSingleRequest' + type: array + required: + - routes + type: object + magicRouteUpdateRequest: + $ref: '#/components/schemas/magicRouteAddSingleRequest' + magicRouteUpdateSingleRequest: + properties: + id: + $ref: '#/components/schemas/magicIdentifier' + description: + $ref: '#/components/schemas/magicDescription' + nexthop: + $ref: '#/components/schemas/magicNexthop' + prefix: + $ref: '#/components/schemas/magicPrefix' + priority: + $ref: '#/components/schemas/magicPriority' + scope: + $ref: '#/components/schemas/magicScope' + weight: + $ref: '#/components/schemas/magicWeight' + required: + - id + - prefix + - nexthop + - priority + type: object + magicRoutedSubnet: + properties: + nat: + $ref: '#/components/schemas/magicNat' + next_hop: + $ref: '#/components/schemas/magicIpAddress' + prefix: + $ref: '#/components/schemas/magicCidr' + required: + - prefix + - next_hop + type: object + magicRoutesCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + routes: + items: + $ref: '#/components/schemas/magicRoute' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSchemasCreateIpsecTunnelResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicIpsecTunnel' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSchemasCreatedOn: + description: The date and time the tunnel was created. + example: '2017-06-14T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + magicSchemasDescription: + description: An optional description of the GRE tunnel. + example: Tunnel for ISP X + type: string + x-auditable: true + magicSchemasIdentifier: + description: Identifier + example: c4a7362d577a6c3019a474fd6f485821 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + magicSchemasModifiedOn: + description: The date and time the tunnel was last modified. + example: '2017-06-14T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + magicSchemasModifiedTunnelsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_ipsec_tunnels: + items: + $ref: '#/components/schemas/magicIpsecTunnel' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSchemasMtu: + default: 1476 + description: The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576. + type: integer + magicSchemasTunnelDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + example: true + type: boolean + deleted_ipsec_tunnel: + $ref: '#/components/schemas/magicIpsecTunnel' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSchemasTunnelModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_ipsec_tunnel: + $ref: '#/components/schemas/magicIpsecTunnel' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSchemasTunnelSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + ipsec_tunnel: + $ref: '#/components/schemas/magicIpsecTunnel' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSchemasTunnelsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + ipsec_tunnels: + items: + $ref: '#/components/schemas/magicIpsecTunnel' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicScope: + description: Used only for ECMP routes. + properties: + colo_names: + $ref: '#/components/schemas/magicColoNames' + colo_regions: + $ref: '#/components/schemas/magicColoRegions' + type: object + magicSecondaryConnectorId: + description: Magic Connector identifier tag. Used when high availability mode is on. + example: 8d67040d3835dbcf46ce29da440dc482 + type: string + x-auditable: true + magicSite: + properties: + connector_id: + $ref: '#/components/schemas/magicConnectorId' + description: + type: string + ha_mode: + description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode. + example: true + type: boolean + id: + $ref: '#/components/schemas/magicIdentifier' + location: + $ref: '#/components/schemas/magicSiteLocation' + name: + $ref: '#/components/schemas/magicSiteName' + secondary_connector_id: + $ref: '#/components/schemas/magicSecondaryConnectorId' + type: object + magicSiteDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicSite' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSiteLocation: + description: Location of site in latitude and longitude. + properties: + lat: + description: Latitude + example: '37.6192' + type: string + x-auditable: true + lon: + description: Longitude + example: '122.3816' + type: string + x-auditable: true + type: object + magicSiteModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicSite' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSiteName: + description: The name of the site. + example: site_1 + type: string + x-auditable: true + magicSiteSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicSite' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicSiteUpdateRequest: + properties: + connector_id: + $ref: '#/components/schemas/magicConnectorId' + description: + type: string + location: + $ref: '#/components/schemas/magicSiteLocation' + name: + $ref: '#/components/schemas/magicSiteName' + secondary_connector_id: + $ref: '#/components/schemas/magicSecondaryConnectorId' + type: object + magicSitesAddSingleRequest: + properties: + connector_id: + $ref: '#/components/schemas/magicConnectorId' + description: + type: string + ha_mode: + description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode. + example: true + type: boolean + location: + $ref: '#/components/schemas/magicSiteLocation' + name: + $ref: '#/components/schemas/magicSiteName' + secondary_connector_id: + $ref: '#/components/schemas/magicSecondaryConnectorId' + required: + - name + type: object + magicSitesCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + items: + $ref: '#/components/schemas/magicSite' + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicTtl: + default: 64 + description: Time To Live (TTL) in number of hops of the GRE tunnel. + type: integer + x-auditable: true + magicTunnelDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + deleted: + example: true + type: boolean + deleted_gre_tunnel: + $ref: '#/components/schemas/magicGreTunnel' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicTunnelHealthCheck: + properties: + enabled: + default: true + description: Determines whether to run healthchecks for a tunnel. + example: true + type: boolean + x-auditable: true + rate: + $ref: '#/components/schemas/unnamedSchemaRefEebdc868ce7f7ae92e23438caa84e7b5' + target: + description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false. + type: object + properties: + effective: + description: The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests. + example: 203.0.113.1 + readOnly: true + type: string + x-auditable: true + saved: + description: The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. + example: 203.0.113.1 + type: string + x-auditable: true + type: + $ref: '#/components/schemas/magicHealthCheckType' + direction: + default: unidirectional + description: The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel. + enum: + - unidirectional + - bidirectional + example: bidirectional + type: string + type: object + magicTunnelModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + modified: + example: true + type: boolean + modified_gre_tunnel: + $ref: '#/components/schemas/magicGreTunnel' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicTunnelSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + gre_tunnel: + $ref: '#/components/schemas/magicGreTunnel' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicTunnelsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + properties: + gre_tunnels: + items: + $ref: '#/components/schemas/magicGreTunnel' + type: array + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicUnidirectional: + description: The desired traffic direction for this ACL policy. If set to "false", the policy will allow bidirectional traffic. If set to "true", the policy will only allow traffic in one direction. If not included in request, will default to false. + type: boolean + magicVisibilityPcapsApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + example: [] + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicVisibilityPcapsIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + magicVisibilityPcapsMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + magicVisibilityPcapsPcapsByteLimit: + description: The maximum number of bytes to capture. This field only applies to `full` packet captures. + example: 500000 + maximum: 1000000000 + minimum: 1 + type: number + x-auditable: true + magicVisibilityPcapsPcapsCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + items: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsCollectionResponse_result_item' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/magicVisibilityPcapsResultInfo' + required: + - success + - errors + - messages + - result + magicVisibilityPcapsPcapsCollectionResponse_result_item: + type: object + properties: + filter_v1: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsFilterV1' + id: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsId' + offset_time: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOffsetTime' + status: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStatus' + submitted: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSubmitted' + system: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSystem' + time_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsTimeLimitSampled' + type: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsType' + byte_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsByteLimit' + colo_name: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsColoName' + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + error_message: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsErrorMessage' + packets_captured: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsPacketsCaptured' + stop_requested: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStopRequested' + magicVisibilityPcapsPcapsColoName: + description: The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures. + example: ord02 + type: string + x-auditable: true + magicVisibilityPcapsPcapsDestinationConf: + description: The full URI for the bucket. This field only applies to `full` packet captures. + example: s3://pcaps-bucket?region=us-east-1 + type: string + magicVisibilityPcapsPcapsErrorMessage: + description: An error message that describes why the packet capture failed. This field only applies to `full` packet captures. + example: No packets matched the filter in the time limit given. Please modify the filter or try again. + type: string + magicVisibilityPcapsPcapsFilterV1: + description: The packet capture filter. When this field is empty, all packets are captured. + properties: + destination_address: + description: The destination IP address of the packet. + example: 1.2.3.4 + type: string + x-auditable: true + destination_port: + description: The destination port of the packet. + example: 80 + type: number + x-auditable: true + protocol: + description: The protocol number of the packet. + example: 6 + type: number + x-auditable: true + source_address: + description: The source IP address of the packet. + example: 1.2.3.4 + type: string + x-auditable: true + source_port: + description: The source port of the packet. + example: 123 + type: number + x-auditable: true + type: object + magicVisibilityPcapsPcapsId: + description: The ID for the packet capture. + example: 66802ca5668e47a2b82c2e6746e45037 + maxLength: 32 + minLength: 32 + type: string + x-auditable: true + magicVisibilityPcapsPcapsOffsetTime: + description: The RFC 3339 offset timestamp from which to query backwards for packets. Must be within the last 24h. When this field is empty, defaults to time of request. + example: '2020-01-01T08:00:00Z' + format: date-time + type: string + x-auditable: true + magicVisibilityPcapsPcapsOwnershipChallenge: + description: The ownership challenge filename stored in the bucket. + example: ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt + type: string + magicVisibilityPcapsPcapsOwnershipCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + items: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipResponse' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/magicVisibilityPcapsResultInfo' + required: + - success + - errors + - messages + - result + magicVisibilityPcapsPcapsOwnershipRequest: + properties: + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + required: + - destination_conf + type: object + magicVisibilityPcapsPcapsOwnershipResponse: + properties: + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + filename: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipChallenge' + id: + description: The bucket ID associated with the packet captures API. + example: 9883874ecac311ec8475433579a6bf5f + maxLength: 32 + minLength: 32 + type: string + status: + description: The status of the ownership challenge. Can be pending, success or failed. + enum: + - pending + - success + - failed + example: success + type: string + submitted: + description: The RFC 3339 timestamp when the bucket was added to packet captures API. + example: '2020-01-01T08:00:00Z' + type: string + validated: + description: The RFC 3339 timestamp when the bucket was validated. + example: '2020-01-01T08:00:00Z' + type: string + required: + - id + - status + - submitted + - destination_conf + - filename + type: object + magicVisibilityPcapsPcapsOwnershipSingleResponse: + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipResponse' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + magicVisibilityPcapsPcapsOwnershipValidateRequest: + properties: + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + ownership_challenge: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOwnershipChallenge' + required: + - destination_conf + - ownership_challenge + type: object + magicVisibilityPcapsPcapsPacketLimit: + description: The limit of packets contained in a packet capture. + example: 10000 + maximum: 10000 + minimum: 1 + type: number + x-auditable: true + magicVisibilityPcapsPcapsPacketsCaptured: + description: The number of packets captured. + type: integer + magicVisibilityPcapsPcapsRequestPcap: + type: object + properties: + filter_v1: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsFilterV1' + offset_time: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOffsetTime' + packet_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsPacketLimit' + system: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSystem' + time_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsTimeLimitSampled' + type: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsType' + byte_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsByteLimit' + colo_name: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsColoName' + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + required: + - system + - time_limit + - type + magicVisibilityPcapsPcapsSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + messages: + $ref: '#/components/schemas/magicVisibilityPcapsMessages' + result: + type: object + properties: + filter_v1: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsFilterV1' + id: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsId' + offset_time: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsOffsetTime' + status: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStatus' + submitted: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSubmitted' + system: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsSystem' + time_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsTimeLimitSampled' + type: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsType' + byte_limit: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsByteLimit' + colo_name: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsColoName' + destination_conf: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsDestinationConf' + error_message: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsErrorMessage' + packets_captured: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsPacketsCaptured' + stop_requested: + $ref: '#/components/schemas/magicVisibilityPcapsPcapsStopRequested' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicVisibilityPcapsPcapsStatus: + description: The status of the packet capture request. + enum: + - unknown + - success + - pending + - running + - conversion_pending + - conversion_running + - complete + - failed + example: success + type: string + magicVisibilityPcapsPcapsStopRequested: + description: The RFC 3339 timestamp when stopping the packet capture was requested. This field only applies to `full` packet captures. + format: date-time + type: string + magicVisibilityPcapsPcapsSubmitted: + description: The RFC 3339 timestamp when the packet capture was created. + example: '2020-01-01T08:00:00Z' + type: string + magicVisibilityPcapsPcapsSystem: + description: The system used to collect packet captures. + enum: + - magic-transit + example: magic-transit + type: string + x-auditable: true + magicVisibilityPcapsPcapsTimeLimitSampled: + description: The packet capture duration in seconds. + example: 300 + maximum: 300 + minimum: 1 + type: number + x-auditable: true + magicVisibilityPcapsPcapsType: + description: The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets. + enum: + - simple + - full + example: simple + type: string + x-auditable: true + magicVisibilityPcapsResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + magicVlanTag: + description: VLAN ID. Use zero for untagged. + example: 42 + type: integer + x-auditable: true + magicWan: + properties: + health_check_rate: + default: mid + description: Magic WAN health check rate for tunnels created on this link. The default value is `mid`. + enum: + - low + - mid + - high + example: low + type: string + id: + $ref: '#/components/schemas/magicIdentifier' + name: + type: string + physport: + $ref: '#/components/schemas/magicPort' + priority: + description: Priority of WAN for traffic loadbalancing. + type: integer + site_id: + $ref: '#/components/schemas/magicIdentifier' + static_addressing: + $ref: '#/components/schemas/magicWanStaticAddressing' + vlan_tag: + $ref: '#/components/schemas/magicVlanTag' + type: object + magicWanDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicWan' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicWanModifiedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicWan' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicWanSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + $ref: '#/components/schemas/magicWan' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicWanStaticAddressing: + description: (optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode. + properties: + address: + $ref: '#/components/schemas/magicCidr' + gateway_address: + $ref: '#/components/schemas/magicIpAddress' + secondary_address: + $ref: '#/components/schemas/magicCidr' + required: + - address + - gateway_address + type: object + magicWanUpdateRequest: + properties: + name: + type: string + physport: + $ref: '#/components/schemas/magicPort' + priority: + type: integer + static_addressing: + $ref: '#/components/schemas/magicWanStaticAddressing' + vlan_tag: + $ref: '#/components/schemas/magicVlanTag' + type: object + magicWansAddSingleRequest: + properties: + name: + type: string + physport: + $ref: '#/components/schemas/magicPort' + priority: + type: integer + static_addressing: + $ref: '#/components/schemas/magicWanStaticAddressing' + vlan_tag: + $ref: '#/components/schemas/magicVlanTag' + required: + - physport + type: object + magicWansCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/magicMessages' + messages: + $ref: '#/components/schemas/magicMessages' + result: + items: + $ref: '#/components/schemas/magicWan' + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + magicWeight: + description: Optional weight of the ECMP scope - if provided. + type: integer + x-auditable: true + mconnBadResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + minLength: 1 + type: array + result: + $ref: '#/components/schemas/mconnNone' + required: + - result + - success + - errors + - messages + mconnCodedMessage: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + mconnCustomerConnector: + properties: + activated: + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + device: + $ref: '#/components/schemas/mconnCustomerDevice' + id: + $ref: '#/components/schemas/mconnUuid' + interrupt_window_days_of_week: + description: Allowed days of the week for upgrades. Default is all days. + items: + $ref: '#/components/schemas/mconnDayOfWeek' + type: array + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_duration_hours: + maximum: 24 + minimum: 1 + type: number + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_embargo_dates: + description: List of dates (YYYY-MM-DD) when upgrades are blocked. + items: + $ref: '#/components/schemas/mconnEmbargoDate' + maxItems: 100 + type: array + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_hour_of_day: + type: number + x-auditable: true + x-stainless-terraform-configurability: computed_optional + last_heartbeat: + type: string + x-auditable: true + last_seen_version: + type: string + x-auditable: true + last_updated: + type: string + x-auditable: true + license_key: + type: string + x-stainless-terraform-configurability: computed_optional + notes: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + timezone: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + required: + - id + - notes + - activated + - last_updated + - timezone + - interrupt_window_hour_of_day + - interrupt_window_duration_hours + - interrupt_window_days_of_week + - interrupt_window_embargo_dates + type: object + mconnCustomerConnectorCreateRequest: + type: object + properties: + device: + $ref: '#/components/schemas/mconnCustomerDeviceOptions' + activated: + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_days_of_week: + description: Allowed days of the week for upgrades. Default is all days. + items: + $ref: '#/components/schemas/mconnDayOfWeek' + type: array + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_duration_hours: + maximum: 24 + minimum: 1 + type: number + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_embargo_dates: + description: List of dates (YYYY-MM-DD) when upgrades are blocked. + items: + $ref: '#/components/schemas/mconnEmbargoDate' + maxItems: 100 + type: array + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_hour_of_day: + type: number + x-auditable: true + x-stainless-terraform-configurability: computed_optional + notes: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + timezone: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + required: + - device + mconnCustomerConnectorCreateResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mconnCustomerConnector' + required: + - result + - success + - errors + - messages + mconnCustomerConnectorDeleteResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mconnCustomerConnector' + required: + - result + - success + - errors + - messages + mconnCustomerConnectorFetchResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mconnCustomerConnector' + required: + - result + - success + - errors + - messages + mconnCustomerConnectorListResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + maxLength: 0 + type: array + result: + items: + $ref: '#/components/schemas/mconnCustomerConnector' + type: array + required: + - result + - success + - errors + - messages + mconnCustomerConnectorUpdateRequest: + type: object + properties: + activated: + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_days_of_week: + description: Allowed days of the week for upgrades. Default is all days. + items: + $ref: '#/components/schemas/mconnDayOfWeek' + type: array + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_duration_hours: + maximum: 24 + minimum: 1 + type: number + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_embargo_dates: + description: List of dates (YYYY-MM-DD) when upgrades are blocked. + items: + $ref: '#/components/schemas/mconnEmbargoDate' + maxItems: 100 + type: array + x-auditable: true + x-stainless-terraform-configurability: computed_optional + interrupt_window_hour_of_day: + type: number + x-auditable: true + x-stainless-terraform-configurability: computed_optional + notes: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + timezone: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + provision_license: + description: When true, regenerate license key for the connector. + type: boolean + x-go-type: maybe.Maybe[bool] + x-go-type-import: + path: go.cfdata.org/mconn/api/maybe + x-go-type-skip-optional-pointer: true + mconnCustomerConnectorUpdateResponse: + type: object + properties: + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + maxLength: 0 + type: array + result: + $ref: '#/components/schemas/mconnCustomerConnector' + required: + - result + - success + - errors + - messages + mconnCustomerDevice: + properties: + id: + $ref: '#/components/schemas/mconnUuid' + serial_number: + type: string + x-auditable: true + type: + enum: + - MANAGED + - LICENSED + type: string + x-auditable: true + required: + - id + type: object + mconnCustomerDeviceOptions: + description: Exactly one of id, serial_number, or provision_license must be provided. + maxProperties: 1 + minProperties: 1 + properties: + id: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + provision_license: + description: When true, create and provision a new licence key for the connector. + type: boolean + serial_number: + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + mconnCustomerEventGetSuccess: + type: object + properties: + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/mconnRecordedEvent' + required: + - success + - result + mconnCustomerEventsGetLatestResult: + properties: + count: + type: number + items: + items: + $ref: '#/components/schemas/mconnRecordedEvent' + type: array + required: + - items + - count + type: object + mconnCustomerEventsGetLatestSuccess: + type: object + properties: + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/mconnCustomerEventsGetLatestResult' + required: + - success + - result + mconnCustomerEventsGetResult: + properties: + count: + type: number + cursor: + type: string + items: + items: + $ref: '#/components/schemas/mconnEventMetadata' + type: array + required: + - items + - count + type: object + mconnCustomerEventsGetSuccess: + type: object + properties: + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/mconnCustomerEventsGetResult' + required: + - success + - result + mconnCustomerSnapshotGetSuccess: + type: object + properties: + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/mconnSnapshot' + required: + - success + - result + mconnCustomerSnapshotsGetLatestResult: + properties: + count: + type: number + items: + items: + $ref: '#/components/schemas/mconnSnapshot' + type: array + required: + - items + - count + type: object + mconnCustomerSnapshotsGetLatestSuccess: + type: object + properties: + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/mconnCustomerSnapshotsGetLatestResult' + required: + - success + - result + mconnCustomerSnapshotsGetResult: + properties: + count: + type: number + cursor: + type: string + items: + items: + $ref: '#/components/schemas/mconnSnapshotMetadata' + type: array + required: + - items + - count + type: object + mconnCustomerSnapshotsGetSuccess: + type: object + properties: + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/mconnCustomerSnapshotsGetResult' + required: + - success + - result + mconnDayOfWeek: + enum: + - Sunday + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + type: string + mconnEmbargoDate: + type: string + mconnEnvelope: + properties: + errors: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + messages: + items: + $ref: '#/components/schemas/mconnCodedMessage' + type: array + success: + type: boolean + required: + - success + type: object + mconnEvent: + type: object + properties: + k: + description: Initialized process + enum: + - Init + type: string + url: + description: Location of upgrade bundle + type: string + required: + - k + mconnEventMetadata: + properties: + a: + description: Time the Event was collected (seconds since the Unix epoch) + type: number + k: + description: Kind + type: string + 'n': + description: Sequence number, used to order events with the same timestamp + type: number + t: + description: Time the Event was recorded (seconds since the Unix epoch) + type: number + required: + - a + - t + - 'n' + - k + type: object + mconnNone: + nullable: true + type: object + mconnRecordedEvent: + description: Recorded Event + properties: + e: + $ref: '#/components/schemas/mconnEvent' + 'n': + description: Sequence number, used to order events with the same timestamp + type: number + t: + description: Time the Event was recorded (seconds since the Unix epoch) + type: number + v: + description: Version + type: string + required: + - t + - 'n' + - e + type: object + mconnSnapshot: + description: Snapshot + properties: + bonds: + items: + $ref: '#/components/schemas/mconnSnapshotBond' + type: array + count_reclaim_failures: + description: Count of failures to reclaim space + type: number + count_reclaimed_paths: + description: Count of reclaimed paths + type: number + count_record_failed: + description: Count of failed snapshot recordings + type: number + count_transmit_failures: + description: Count of failed snapshot transmissions + type: number + cpu_count: + description: Count of processors/cores + type: number + cpu_pressure_10s: + description: Percentage of time over a 10 second window that tasks were stalled + type: number + cpu_pressure_300s: + description: Percentage of time over a 5 minute window that tasks were stalled + type: number + cpu_pressure_60s: + description: Percentage of time over a 1 minute window that tasks were stalled + type: number + cpu_pressure_total_us: + description: Total stall time (microseconds) + type: number + cpu_time_guest_ms: + description: Time spent running a virtual CPU or guest OS (milliseconds) + type: number + cpu_time_guest_nice_ms: + description: Time spent running a niced guest (milliseconds) + type: number + cpu_time_idle_ms: + description: Time spent in idle state (milliseconds) + type: number + cpu_time_iowait_ms: + description: Time spent wait for I/O to complete (milliseconds) + type: number + cpu_time_irq_ms: + description: Time spent servicing interrupts (milliseconds) + type: number + cpu_time_nice_ms: + description: Time spent in low-priority user mode (milliseconds) + type: number + cpu_time_softirq_ms: + description: Time spent servicing softirqs (milliseconds) + type: number + cpu_time_steal_ms: + description: Time stolen (milliseconds) + type: number + cpu_time_system_ms: + description: Time spent in system mode (milliseconds) + type: number + cpu_time_user_ms: + description: Time spent in user mode (milliseconds) + type: number + delta: + description: Number of network operations applied during state transition + type: number + dhcp_leases: + items: + $ref: '#/components/schemas/mconnSnapshotDhcpLease' + type: array + disks: + items: + $ref: '#/components/schemas/mconnSnapshotDisk' + type: array + epsilon: + description: Simulated number of network operations applied during state transition + type: number + ha_state: + description: Name of high availability state + type: string + ha_value: + description: Numeric value associated with high availability state (0 = disabled, 1 = active, 2 = standby, 3 = stopped, 4 = fault) + type: number + interfaces: + items: + $ref: '#/components/schemas/mconnSnapshotInterface' + type: array + io_pressure_full_10s: + description: Percentage of time over a 10 second window that all tasks were stalled + type: number + io_pressure_full_300s: + description: Percentage of time over a 5 minute window that all tasks were stalled + type: number + io_pressure_full_60s: + description: Percentage of time over a 1 minute window that all tasks were stalled + type: number + io_pressure_full_total_us: + description: Total stall time (microseconds) + type: number + io_pressure_some_10s: + description: Percentage of time over a 10 second window that some tasks were stalled + type: number + io_pressure_some_300s: + description: Percentage of time over a 3 minute window that some tasks were stalled + type: number + io_pressure_some_60s: + description: Percentage of time over a 1 minute window that some tasks were stalled + type: number + io_pressure_some_total_us: + description: Total stall time (microseconds) + type: number + kernel_btime: + description: Boot time (seconds since Unix epoch) + type: number + kernel_ctxt: + description: Number of context switches that the system underwent + type: number + kernel_processes: + description: Number of forks since boot + type: number + kernel_processes_blocked: + description: Number of processes blocked waiting for I/O + type: number + kernel_processes_running: + description: Number of processes in runnable state + type: number + load_average_15m: + description: The fifteen-minute load average + type: number + load_average_1m: + description: The one-minute load average + type: number + load_average_5m: + description: The five-minute load average + type: number + load_average_cur: + description: Number of currently runnable kernel scheduling entities + type: number + load_average_max: + description: Number of kernel scheduling entities that currently exist on the system + type: number + memory_active_bytes: + description: Memory that has been used more recently + type: number + memory_anon_hugepages_bytes: + description: Non-file backed huge pages mapped into user-space page tables + type: number + memory_anon_pages_bytes: + description: Non-file backed pages mapped into user-space page tables + type: number + memory_available_bytes: + description: Estimate of how much memory is available for starting new applications + type: number + memory_bounce_bytes: + description: Memory used for block device bounce buffers + type: number + memory_buffers_bytes: + description: Relatively temporary storage for raw disk blocks + type: number + memory_cached_bytes: + description: In-memory cache for files read from the disk + type: number + memory_cma_free_bytes: + description: Free CMA (Contiguous Memory Allocator) pages + type: number + memory_cma_total_bytes: + description: Total CMA (Contiguous Memory Allocator) pages + type: number + memory_commit_limit_bytes: + description: Total amount of memory currently available to be allocated on the system + type: number + memory_committed_as_bytes: + description: Amount of memory presently allocated on the system + type: number + memory_dirty_bytes: + description: Memory which is waiting to get written back to the disk + type: number + memory_free_bytes: + description: The sum of LowFree and HighFree + type: number + memory_high_free_bytes: + description: Amount of free highmem + type: number + memory_high_total_bytes: + description: Total amount of highmem + type: number + memory_hugepages_free: + description: The number of huge pages in the pool that are not yet allocated + type: number + memory_hugepages_rsvd: + description: Number of huge pages for which a commitment has been made, but no allocation has yet been made + type: number + memory_hugepages_surp: + description: Number of huge pages in the pool above the threshold + type: number + memory_hugepages_total: + description: The size of the pool of huge pages + type: number + memory_hugepagesize_bytes: + description: The size of huge pages + type: number + memory_inactive_bytes: + description: Memory which has been less recently used + type: number + memory_k_reclaimable_bytes: + description: Kernel allocations that the kernel will attempt to reclaim under memory pressure + type: number + memory_kernel_stack_bytes: + description: Amount of memory allocated to kernel stacks + type: number + memory_low_free_bytes: + description: Amount of free lowmem + type: number + memory_low_total_bytes: + description: Total amount of lowmem + type: number + memory_mapped_bytes: + description: Files which have been mapped into memory + type: number + memory_page_tables_bytes: + description: Amount of memory dedicated to the lowest level of page tables + type: number + memory_per_cpu_bytes: + description: Memory allocated to the per-cpu alloctor used to back per-cpu allocations + type: number + memory_pressure_full_10s: + description: Percentage of time over a 10 second window that all tasks were stalled + type: number + memory_pressure_full_300s: + description: Percentage of time over a 5 minute window that all tasks were stalled + type: number + memory_pressure_full_60s: + description: Percentage of time over a 1 minute window that all tasks were stalled + type: number + memory_pressure_full_total_us: + description: Total stall time (microseconds) + type: number + memory_pressure_some_10s: + description: Percentage of time over a 10 second window that some tasks were stalled + type: number + memory_pressure_some_300s: + description: Percentage of time over a 5 minute window that some tasks were stalled + type: number + memory_pressure_some_60s: + description: Percentage of time over a 1 minute window that some tasks were stalled + type: number + memory_pressure_some_total_us: + description: Total stall time (microseconds) + type: number + memory_s_reclaimable_bytes: + description: Part of slab that can be reclaimed on memory pressure + type: number + memory_s_unreclaim_bytes: + description: Part of slab that cannot be reclaimed on memory pressure + type: number + memory_secondary_page_tables_bytes: + description: Amount of memory dedicated to the lowest level of page tables + type: number + memory_shmem_bytes: + description: Amount of memory consumed by tmpfs + type: number + memory_shmem_hugepages_bytes: + description: Memory used by shmem and tmpfs, allocated with huge pages + type: number + memory_shmem_pmd_mapped_bytes: + description: Shared memory mapped into user space with huge pages + type: number + memory_slab_bytes: + description: In-kernel data structures cache + type: number + memory_swap_cached_bytes: + description: Memory swapped out and back in while still in swap file + type: number + memory_swap_free_bytes: + description: Amount of swap space that is currently unused + type: number + memory_swap_total_bytes: + description: Total amount of swap space available + type: number + memory_total_bytes: + description: Total usable RAM + type: number + memory_vmalloc_chunk_bytes: + description: Largest contiguous block of vmalloc area which is free + type: number + memory_vmalloc_total_bytes: + description: Total size of vmalloc memory area + type: number + memory_vmalloc_used_bytes: + description: Amount of vmalloc area which is used + type: number + memory_writeback_bytes: + description: Memory which is actively being written back to the disk + type: number + memory_writeback_tmp_bytes: + description: Memory used by FUSE for temporary writeback buffers + type: number + memory_z_swap_bytes: + description: Memory consumed by the zswap backend, compressed + type: number + memory_z_swapped_bytes: + description: Amount of anonymous memory stored in zswap, uncompressed + type: number + mounts: + items: + $ref: '#/components/schemas/mconnSnapshotMount' + type: array + netdevs: + items: + $ref: '#/components/schemas/mconnSnapshotNetdev' + type: array + platform: + description: Platform identifier + type: string + snmp_icmp_in_addr_mask_reps: + description: Number of ICMP Address Mask Reply messages received + type: number + snmp_icmp_in_addr_masks: + description: Number of ICMP Address Mask Request messages received + type: number + snmp_icmp_in_csum_errors: + description: Number of ICMP messages received with bad checksums + type: number + snmp_icmp_in_dest_unreachs: + description: Number of ICMP Destination Unreachable messages received + type: number + snmp_icmp_in_echo_reps: + description: Number of ICMP Echo Reply messages received + type: number + snmp_icmp_in_echos: + description: Number of ICMP Echo (request) messages received + type: number + snmp_icmp_in_errors: + description: Number of ICMP messages received with ICMP-specific errors + type: number + snmp_icmp_in_msgs: + description: Number of ICMP messages received + type: number + snmp_icmp_in_parm_probs: + description: Number of ICMP Parameter Problem messages received + type: number + snmp_icmp_in_redirects: + description: Number of ICMP Redirect messages received + type: number + snmp_icmp_in_src_quenchs: + description: Number of ICMP Source Quench messages received + type: number + snmp_icmp_in_time_excds: + description: Number of ICMP Time Exceeded messages received + type: number + snmp_icmp_in_timestamp_reps: + description: Number of ICMP Address Mask Request messages received + type: number + snmp_icmp_in_timestamps: + description: Number of ICMP Timestamp (request) messages received + type: number + snmp_icmp_out_addr_mask_reps: + description: Number of ICMP Address Mask Reply messages sent + type: number + snmp_icmp_out_addr_masks: + description: Number of ICMP Address Mask Request messages sent + type: number + snmp_icmp_out_dest_unreachs: + description: Number of ICMP Destination Unreachable messages sent + type: number + snmp_icmp_out_echo_reps: + description: Number of ICMP Echo Reply messages sent + type: number + snmp_icmp_out_echos: + description: Number of ICMP Echo (request) messages sent + type: number + snmp_icmp_out_errors: + description: Number of ICMP messages which this entity did not send due to ICMP-specific errors + type: number + snmp_icmp_out_msgs: + description: Number of ICMP messages attempted to send + type: number + snmp_icmp_out_parm_probs: + description: Number of ICMP Parameter Problem messages sent + type: number + snmp_icmp_out_redirects: + description: Number of ICMP Redirect messages sent + type: number + snmp_icmp_out_src_quenchs: + description: Number of ICMP Source Quench messages sent + type: number + snmp_icmp_out_time_excds: + description: Number of ICMP Time Exceeded messages sent + type: number + snmp_icmp_out_timestamp_reps: + description: Number of ICMP Timestamp Reply messages sent + type: number + snmp_icmp_out_timestamps: + description: Number of ICMP Timestamp (request) messages sent + type: number + snmp_ip_default_ttl: + description: Default value of the Time-To-Live field of the IP header + type: number + snmp_ip_forw_datagrams: + description: Number of datagrams forwarded to their final destination + type: number + snmp_ip_forwarding_enabled: + description: Set when acting as an IP gateway + type: boolean + snmp_ip_frag_creates: + description: Number of datagrams generated by fragmentation + type: number + snmp_ip_frag_fails: + description: Number of datagrams discarded because fragmentation failed + type: number + snmp_ip_frag_oks: + description: Number of datagrams successfully fragmented + type: number + snmp_ip_in_addr_errors: + description: Number of input datagrams discarded due to errors in the IP address + type: number + snmp_ip_in_delivers: + description: Number of input datagrams successfully delivered to IP user-protocols + type: number + snmp_ip_in_discards: + description: Number of input datagrams otherwise discarded + type: number + snmp_ip_in_hdr_errors: + description: Number of input datagrams discarded due to errors in the IP header + type: number + snmp_ip_in_receives: + description: Number of input datagrams received from interfaces + type: number + snmp_ip_in_unknown_protos: + description: Number of input datagrams discarded due unknown or unsupported protocol + type: number + snmp_ip_out_discards: + description: Number of output datagrams otherwise discarded + type: number + snmp_ip_out_no_routes: + description: Number of output datagrams discarded because no route matched + type: number + snmp_ip_out_requests: + description: Number of datagrams supplied for transmission + type: number + snmp_ip_reasm_fails: + description: Number of failures detected by the reassembly algorithm + type: number + snmp_ip_reasm_oks: + description: Number of datagrams successfully reassembled + type: number + snmp_ip_reasm_reqds: + description: Number of fragments received which needed to be reassembled + type: number + snmp_ip_reasm_timeout: + description: Number of seconds fragments are held while awaiting reassembly + type: number + snmp_tcp_active_opens: + description: Number of times TCP transitions to SYN-SENT from CLOSED + type: number + snmp_tcp_attempt_fails: + description: Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus transitions to LISTEN from SYN-RCVD + type: number + snmp_tcp_curr_estab: + description: Number of TCP connections in ESTABLISHED or CLOSE-WAIT + type: number + snmp_tcp_estab_resets: + description: Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAIT + type: number + snmp_tcp_in_csum_errors: + description: Number of TCP segments received with checksum errors + type: number + snmp_tcp_in_errs: + description: Number of TCP segments received in error + type: number + snmp_tcp_in_segs: + description: Number of TCP segments received + type: number + snmp_tcp_max_conn: + description: Limit on the total number of TCP connections + type: number + snmp_tcp_out_rsts: + description: Number of TCP segments sent with RST flag + type: number + snmp_tcp_out_segs: + description: Number of TCP segments sent + type: number + snmp_tcp_passive_opens: + description: Number of times TCP transitions to SYN-RCVD from LISTEN + type: number + snmp_tcp_retrans_segs: + description: Number of TCP segments retransmitted + type: number + snmp_tcp_rto_max: + description: Maximum value permitted by a TCP implementation for the retransmission timeout (milliseconds) + type: number + snmp_tcp_rto_min: + description: Minimum value permitted by a TCP implementation for the retransmission timeout (milliseconds) + type: number + snmp_udp_in_datagrams: + description: Number of UDP datagrams delivered to UDP applications + type: number + snmp_udp_in_errors: + description: Number of UDP datagrams failed to be delivered for reasons other than lack of application at the destination port + type: number + snmp_udp_no_ports: + description: Number of UDP datagrams received for which there was not application at the destination port + type: number + snmp_udp_out_datagrams: + description: Number of UDP datagrams sent + type: number + system_boot_time_s: + description: Boottime of the system (seconds since the Unix epoch) + type: number + t: + description: Time the Snapshot was recorded (seconds since the Unix epoch) + type: number + thermals: + items: + $ref: '#/components/schemas/mconnSnapshotThermal' + type: array + tunnels: + items: + $ref: '#/components/schemas/mconnSnapshotTunnel' + type: array + uptime_idle_ms: + description: Sum of how much time each core has spent idle + type: number + uptime_total_ms: + description: Uptime of the system, including time spent in suspend + type: number + v: + description: Version + type: string + required: + - t + - v + - count_reclaim_failures + - count_reclaimed_paths + - count_record_failed + - count_transmit_failures + type: object + mconnSnapshotBond: + description: Snapshot Bond + properties: + name: + description: Name of the network interface + type: string + status: + description: Current status of the network interface + type: string + required: + - name + - status + type: object + mconnSnapshotDhcpLease: + description: Snapshot DHCP lease + properties: + client_id: + description: Client ID of the device the IP Address was leased to + type: string + expiry_time: + description: Expiry time of the DHCP lease (seconds since the Unix epoch) + type: number + hostname: + description: Hostname of the device the IP Address was leased to + type: string + interface_name: + description: Name of the network interface + type: string + ip_address: + description: IP Address that was leased + type: string + mac_address: + description: MAC Address of the device the IP Address was leased to + type: string + required: + - interface_name + - expiry_time + - mac_address + - ip_address + - hostname + - client_id + type: object + mconnSnapshotDisk: + description: Snapshot Disk + properties: + discards: + description: Discards completed successfully + type: number + discards_merged: + description: Discards merged + type: number + flushes: + description: Flushes completed successfully + type: number + in_progress: + description: I/Os currently in progress + type: number + major: + description: Device major number + type: number + merged: + description: Reads merged + type: number + minor: + description: Device minor number + type: number + name: + description: Device name + type: string + reads: + description: Reads completed successfully + type: number + sectors_discarded: + description: Sectors discarded + type: number + sectors_read: + description: Sectors read successfully + type: number + sectors_written: + description: Sectors written successfully + type: number + time_discarding_ms: + description: Time spent discarding (milliseconds) + type: number + time_flushing_ms: + description: Time spent flushing (milliseconds) + type: number + time_in_progress_ms: + description: Time spent doing I/Os (milliseconds) + type: number + time_reading_ms: + description: Time spent reading (milliseconds) + type: number + time_writing_ms: + description: Time spent writing (milliseconds) + type: number + weighted_time_in_progress_ms: + description: Weighted time spent doing I/Os (milliseconds) + type: number + writes: + description: Writes completed + type: number + writes_merged: + description: Writes merged + type: number + required: + - in_progress + - major + - merged + - minor + - name + - reads + - sectors_read + - sectors_written + - time_in_progress_ms + - time_reading_ms + - time_writing_ms + - weighted_time_in_progress_ms + - writes + - writes_merged + type: object + mconnSnapshotInterface: + description: Snapshot Interface + properties: + ip_addresses: + items: + $ref: '#/components/schemas/mconnSnapshotInterfaceAddress' + type: array + name: + description: Name of the network interface + type: string + operstate: + description: UP/DOWN state of the network interface + type: string + speed: + description: Speed of the network interface (bits per second) + type: number + required: + - name + - operstate + type: object + mconnSnapshotInterfaceAddress: + description: Snapshot Interface Address + properties: + interface_name: + description: Name of the network interface + type: string + ip_address: + description: IP address of the network interface + type: string + required: + - interface_name + - ip_address + type: object + mconnSnapshotMetadata: + properties: + a: + description: Time the Snapshot was collected (seconds since the Unix epoch) + type: number + t: + description: Time the Snapshot was recorded (seconds since the Unix epoch) + type: number + required: + - a + - t + type: object + mconnSnapshotMount: + description: Snapshot Mount + properties: + available_bytes: + description: Available disk size (bytes) + type: number + available_inodes: + description: Available inodes on filesystem + type: number + file_system: + description: File system on disk (EXT4, NTFS, etc.) + type: string + is_read_only: + description: Determines whether the disk is read-only + type: boolean + is_removable: + description: Determines whether the disk is removable + type: boolean + kind: + description: Kind of disk (HDD, SSD, etc.) + type: string + mount_point: + description: Path where disk is mounted + type: string + name: + description: Name of the disk mount + type: string + total_bytes: + description: Total disk size (bytes) + type: number + total_inodes: + description: Total inodes on filesystem + type: number + required: + - name + - kind + - file_system + - mount_point + type: object + mconnSnapshotNetdev: + description: Snapshot Netdev + properties: + name: + description: Name of the network device + type: string + recv_bytes: + description: Total bytes received + type: number + recv_compressed: + description: Compressed packets received + type: number + recv_drop: + description: Packets dropped + type: number + recv_errs: + description: Bad packets received + type: number + recv_fifo: + description: FIFO overruns + type: number + recv_frame: + description: Frame alignment errors + type: number + recv_multicast: + description: Multicast packets received + type: number + recv_packets: + description: Total packets received + type: number + sent_bytes: + description: Total bytes transmitted + type: number + sent_carrier: + description: Number of packets not sent due to carrier errors + type: number + sent_colls: + description: Number of collisions + type: number + sent_compressed: + description: Number of compressed packets transmitted + type: number + sent_drop: + description: Number of packets dropped during transmission + type: number + sent_errs: + description: Number of transmission errors + type: number + sent_fifo: + description: FIFO overruns + type: number + sent_packets: + description: Total packets transmitted + type: number + required: + - name + - recv_bytes + - recv_packets + - recv_errs + - recv_drop + - recv_fifo + - recv_frame + - recv_compressed + - recv_multicast + - sent_bytes + - sent_packets + - sent_errs + - sent_drop + - sent_fifo + - sent_colls + - sent_carrier + - sent_compressed + type: object + mconnSnapshotThermal: + description: Snapshot Thermal + properties: + critical_celcius: + description: Critical failure temperature of the component (degrees Celsius) + type: number + current_celcius: + description: Current temperature of the component (degrees Celsius) + type: number + label: + description: Sensor identifier for the component + type: string + max_celcius: + description: Maximum temperature of the component (degrees Celsius) + type: number + required: + - label + type: object + mconnSnapshotTunnel: + description: Snapshot Tunnels + properties: + health_state: + description: Name of tunnel health state (unknown, healthy, degraded, down) + type: string + health_value: + description: Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 = degraded, 3 = down) + type: number + interface_name: + description: The tunnel interface name (i.e. xfrm1, xfrm3.99, etc.) + type: string + probed_mtu: + description: MTU as measured between the two ends of the tunnel + type: number + recent_healthy_pings: + description: Number of recent healthy pings for this tunnel + type: number + recent_unhealthy_pings: + description: Number of recent unhealthy pings for this tunnel + type: number + tunnel_id: + description: Tunnel identifier + type: string + required: + - tunnel_id + - interface_name + - health_state + - health_value + type: object + mconnUuid: + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef87fa9e5fe9f6b8d607be1df57340d916: + description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed. + enum: + - tcp + - udp + - icmp + type: string + unnamedSchemaRefEebdc868ce7f7ae92e23438caa84e7b5: + default: mid + description: How frequent the health check is run. The default value is `mid`. + enum: + - low + - mid + - high + example: low + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + rules: + id: cloudflare.magic_transit.rules + name: rules + title: Rules + methods: + delete_dns_protection_rules_for_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1advanced_dns_protection~1configs~1dns_protection~1rules/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1advanced_dns_protection~1configs~1dns_protection~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_dns_protection_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1advanced_dns_protection~1configs~1dns_protection~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_dns_protection_rule: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1advanced_dns_protection~1configs~1dns_protection~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1advanced_dns_protection~1configs~1dns_protection~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_dns_protection_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1advanced_dns_protection~1configs~1dns_protection~1rules~1{rule_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get' + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_dns_protection_rule' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/update_dns_protection_rule' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_dns_protection_rule' + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_dns_protection_rules_for_account' + replace: [] + apps: + id: cloudflare.magic_transit.apps + name: apps + title: Apps + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1apps/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1apps~1{account_app_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1apps~1{account_app_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1apps~1{account_app_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/apps/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/apps/methods/update' + cf_interconnects: + id: cloudflare.magic_transit.cf_interconnects + name: cf_interconnects + title: Cf Interconnects + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cf_interconnects/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.interconnects + bulk_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cf_interconnects/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cf_interconnects~1{cf_interconnect_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1cf_interconnects~1{cf_interconnect_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cf_interconnects/methods/get' + - $ref: '#/components/x-stackQL-resources/cf_interconnects/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/cf_interconnects/methods/update' + - $ref: '#/components/x-stackQL-resources/cf_interconnects/methods/bulk_update' + connectors: + id: cloudflare.magic_transit.connectors + name: connectors + title: Connectors + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connectors/methods/get' + - $ref: '#/components/x-stackQL-resources/connectors/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/connectors/methods/update' + events: + id: cloudflare.magic_transit.events + name: events + title: Events + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}~1telemetry~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.items + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}~1telemetry~1events~1{event_t}.{event_n}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events/methods/get' + - $ref: '#/components/x-stackQL-resources/events/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + events_latest: + id: cloudflare.magic_transit.events_latest + name: events_latest + title: Events Latest + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}~1telemetry~1events~1latest/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events_latest/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + snapshots: + id: cloudflare.magic_transit.snapshots + name: snapshots + title: Snapshots + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}~1telemetry~1snapshots/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.items + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}~1telemetry~1snapshots~1{snapshot_t}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + snapshots_latest: + id: cloudflare.magic_transit.snapshots_latest + name: snapshots_latest + title: Snapshots Latest + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1connectors~1{connector_id}~1telemetry~1snapshots~1latest/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/snapshots_latest/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + gre_tunnels: + id: cloudflare.magic_transit.gre_tunnels + name: gre_tunnels + title: Gre Tunnels + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1gre_tunnels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.gre_tunnels + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1gre_tunnels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1gre_tunnels/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1gre_tunnels~1{gre_tunnel_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1gre_tunnels~1{gre_tunnel_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1gre_tunnels~1{gre_tunnel_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gre_tunnels/methods/get' + - $ref: '#/components/x-stackQL-resources/gre_tunnels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/gre_tunnels/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/gre_tunnels/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/gre_tunnels/methods/update' + - $ref: '#/components/x-stackQL-resources/gre_tunnels/methods/bulk_update' + ipsec_tunnels: + id: cloudflare.magic_transit.ipsec_tunnels + name: ipsec_tunnels + title: Ipsec Tunnels + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1ipsec_tunnels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.ipsec_tunnels + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1ipsec_tunnels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1ipsec_tunnels/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1ipsec_tunnels~1{ipsec_tunnel_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1ipsec_tunnels~1{ipsec_tunnel_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1ipsec_tunnels~1{ipsec_tunnel_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + psk_generate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1ipsec_tunnels~1{ipsec_tunnel_id}~1psk_generate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ipsec_tunnels/methods/get' + - $ref: '#/components/x-stackQL-resources/ipsec_tunnels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ipsec_tunnels/methods/psk_generate' + - $ref: '#/components/x-stackQL-resources/ipsec_tunnels/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/ipsec_tunnels/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/ipsec_tunnels/methods/update' + - $ref: '#/components/x-stackQL-resources/ipsec_tunnels/methods/bulk_update' + routes: + id: cloudflare.magic_transit.routes + name: routes + title: Routes + methods: + empty: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1routes/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1routes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.routes + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1routes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1routes/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1routes~1{route_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1routes~1{route_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1routes~1{route_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes/methods/get' + - $ref: '#/components/x-stackQL-resources/routes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete' + - $ref: '#/components/x-stackQL-resources/routes/methods/empty' + replace: + - $ref: '#/components/x-stackQL-resources/routes/methods/update' + - $ref: '#/components/x-stackQL-resources/routes/methods/bulk_update' + sites: + id: cloudflare.magic_transit.sites + name: sites + title: Sites + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sites/methods/get' + - $ref: '#/components/x-stackQL-resources/sites/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/sites/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/sites/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/sites/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/sites/methods/update' + acls: + id: cloudflare.magic_transit.acls + name: acls + title: Acls + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1acls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1acls/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1acls~1{acl_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1acls~1{acl_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1acls~1{acl_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1acls~1{acl_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acls/methods/get' + - $ref: '#/components/x-stackQL-resources/acls/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/acls/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/acls/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/acls/methods/update' + app_configs: + id: cloudflare.magic_transit.app_configs + name: app_configs + title: App Configs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1app_configs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + magic_site_app_configs_add_app_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1app_configs/post' + response: + mediaType: application/json + openAPIDocKey: '201' + magic_site_app_configs_delete_app_config: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1app_configs~1{app_config_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + magic_site_app_configs_patch_app_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1app_configs~1{app_config_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + magic_site_app_configs_update_app_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1app_configs~1{app_config_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/app_configs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/app_configs/methods/magic_site_app_configs_add_app_config' + update: + - $ref: '#/components/x-stackQL-resources/app_configs/methods/magic_site_app_configs_patch_app_config' + delete: + - $ref: '#/components/x-stackQL-resources/app_configs/methods/magic_site_app_configs_delete_app_config' + replace: + - $ref: '#/components/x-stackQL-resources/app_configs/methods/magic_site_app_configs_update_app_config' + lans: + id: cloudflare.magic_transit.lans + name: lans + title: Lans + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1lans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + magic_site_lans_create_lan: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1lans/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1lans~1{lan_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1lans~1{lan_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1lans~1{lan_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1lans~1{lan_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/lans/methods/get' + - $ref: '#/components/x-stackQL-resources/lans/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/lans/methods/magic_site_lans_create_lan' + update: + - $ref: '#/components/x-stackQL-resources/lans/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/lans/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/lans/methods/update' + netflow_config: + id: cloudflare.magic_transit.netflow_config + name: netflow_config + title: Netflow Config + methods: + magic_site_netflow_config_delete_netflow_config: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1netflow_config/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1netflow_config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + magic_site_netflow_config_patch_netflow_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1netflow_config/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + magic_site_netflow_config_create_netflow_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1netflow_config/post' + response: + mediaType: application/json + openAPIDocKey: '201' + magic_site_netflow_config_update_netflow_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1netflow_config/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/netflow_config/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/netflow_config/methods/magic_site_netflow_config_create_netflow_config' + update: + - $ref: '#/components/x-stackQL-resources/netflow_config/methods/magic_site_netflow_config_patch_netflow_config' + delete: + - $ref: '#/components/x-stackQL-resources/netflow_config/methods/magic_site_netflow_config_delete_netflow_config' + replace: + - $ref: '#/components/x-stackQL-resources/netflow_config/methods/magic_site_netflow_config_update_netflow_config' + wans: + id: cloudflare.magic_transit.wans + name: wans + title: Wans + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1wans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + magic_site_wans_create_wan: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1wans/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1wans~1{wan_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1wans~1{wan_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1wans~1{wan_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1magic~1sites~1{site_id}~1wans~1{wan_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/wans/methods/get' + - $ref: '#/components/x-stackQL-resources/wans/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/wans/methods/magic_site_wans_create_wan' + update: + - $ref: '#/components/x-stackQL-resources/wans/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/wans/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/wans/methods/update' + pcaps: + id: cloudflare.magic_transit.pcaps + name: pcaps + title: Pcaps + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_ownership: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps~1ownership/post' + response: + mediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps~1{pcap_id}~1stop/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pcaps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pcaps/methods/create' + update: [] + delete: [] + replace: [] + ownership: + id: cloudflare.magic_transit.ownership + name: ownership + title: Ownership + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps~1ownership/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + validate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps~1ownership~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps~1ownership~1{ownership_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ownership/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/ownership/methods/delete' + replace: [] + accounts_pcaps: + id: cloudflare.magic_transit.accounts_pcaps + name: accounts_pcaps + title: Accounts Pcaps + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps~1{pcap_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts_pcaps/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + pcaps_download: + id: cloudflare.magic_transit.pcaps_download + name: pcaps_download + title: Pcaps Download + methods: + download: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pcaps~1{pcap_id}~1download/get' + response: + mediaType: application/vnd.tcpdump.pcap + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pcaps_download/methods/download' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/managed_transforms.yaml b/providers/src/cloudflare/v00.00.00000/services/managed_transforms.yaml new file mode 100644 index 00000000..65507f04 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/managed_transforms.yaml @@ -0,0 +1,598 @@ +openapi: 3.0.3 +info: + title: managed_transforms API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/managed_headers: + delete: + description: Disables all Managed Transforms. + operationId: deleteManagedTransforms + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '204': + description: An empty response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Managed Transforms + tags: + - Managed Transforms + x-api-token-group: + - Response Compression Write + - Config Settings Write + - Dynamic URL Redirects Write + - Cache Settings Write + - Custom Errors Write + - Origin Write + - Managed headers Write + - Zone Transform Rules Write + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - HTTP DDoS Managed Ruleset Write + - Sanitize Write + - Transform Rules Write + - Select Configuration Write + - Bot Management Write + - Zone WAF Write + - Account WAF Write + - Account Rulesets Write + - Logs Write + - Logs Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: managed_transforms + resource_chain: [] + method: delete + get: + description: Fetches a list of all Managed Transforms. + operationId: listManagedTransforms + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + $ref: '#/components/schemas/rulesetsManagedTransforms' + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A Managed Transforms response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Managed Transforms + tags: + - Managed Transforms + x-api-token-group: + - Response Compression Write + - Response Compression Read + - Config Settings Write + - Config Settings Read + - Dynamic URL Redirects Write + - Dynamic URL Redirects Read + - Cache Settings Write + - Cache Settings Read + - Custom Errors Write + - Custom Errors Read + - Origin Write + - Origin Read + - Managed headers Write + - Managed headers Read + - Zone Transform Rules Write + - Zone Transform Rules Read + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - HTTP DDoS Managed Ruleset Write + - HTTP DDoS Managed Ruleset Read + - Sanitize Write + - Sanitize Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Bot Management Write + - Bot Management Read + - Zone WAF Write + - Zone WAF Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read + - Logs Write + - Logs Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: managed_transforms + resource_chain: [] + method: list + patch: + description: Updates the status of one or more Managed Transforms. + operationId: updateManagedTransforms + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/rulesetsManagedTransforms' + responses: + '200': + content: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + $ref: '#/components/schemas/rulesetsManagedTransforms' + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A Managed Transforms response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Managed Transforms + tags: + - Managed Transforms + x-api-token-group: + - Response Compression Write + - Config Settings Write + - Dynamic URL Redirects Write + - Cache Settings Write + - Custom Errors Write + - Origin Write + - Managed headers Write + - Zone Transform Rules Write + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - HTTP DDoS Managed Ruleset Write + - Sanitize Write + - Transform Rules Write + - Select Configuration Write + - Bot Management Write + - Zone WAF Write + - Account WAF Write + - Account Rulesets Write + - Logs Write + - Logs Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: managed_transforms + resource_chain: [] + method: edit +components: + schemas: + rulesetsErrors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + rulesetsManagedTransformId: + description: The human-readable identifier of the Managed Transform. + minLength: 1 + title: Transform ID + type: string + rulesetsManagedTransforms: + description: A Managed Transforms object. + properties: + managed_request_headers: + description: The list of Managed Request Transforms. + items: + description: A Managed Transform object. + properties: + conflicts_with: + description: >- + The Managed Transforms that this Managed Transform conflicts + with. + items: + type: string + title: Transform ID + description: The human-readable identifier of the Managed Transform. + example: add_true_client_ip_headers + minItems: 1 + readOnly: true + title: Conflicts With + type: array + uniqueItems: true + x-stainless-skip: + - terraform + enabled: + description: Whether the Managed Transform is enabled. + example: true + title: Enabled + type: boolean + has_conflict: + description: >- + Whether the Managed Transform conflicts with the + currently-enabled Managed Transforms. + example: false + readOnly: true + title: Has Conflict + type: boolean + x-stainless-skip: + - terraform + id: + $ref: '#/components/schemas/rulesetsManagedTransformId' + example: add_bot_protection_headers + required: + - id + - enabled + - has_conflict + title: Managed Transform + type: object + title: Managed Request Transforms + type: array + uniqueItems: true + managed_response_headers: + description: The list of Managed Response Transforms. + items: + description: A Managed Transform object. + properties: + conflicts_with: + description: >- + The Managed Transforms that this Managed Transform conflicts + with. + items: + type: string + title: Transform ID + description: The human-readable identifier of the Managed Transform. + example: add_true_client_ip_headers + minItems: 1 + readOnly: true + title: Conflicts With + type: array + uniqueItems: true + x-stainless-skip: + - terraform + enabled: + description: Whether the Managed Transform is enabled. + example: true + title: Enabled + type: boolean + has_conflict: + description: >- + Whether the Managed Transform conflicts with the + currently-enabled Managed Transforms. + example: false + readOnly: true + title: Has Conflict + type: boolean + x-stainless-skip: + - terraform + id: + $ref: '#/components/schemas/rulesetsManagedTransformId' + example: add_security_headers + required: + - id + - enabled + - has_conflict + title: Managed Transform + type: object + title: Managed Response Transforms + type: array + uniqueItems: true + required: + - managed_request_headers + - managed_response_headers + title: Managed Transforms + type: object + rulesetsMessage: + description: A message. + properties: + code: + description: A unique code for this message. + example: 10000 + title: Code + type: integer + message: + description: A text description of this message. + example: something bad happened + minLength: 1 + title: Description + type: string + source: + description: The source of this message. + properties: + pointer: + description: A JSON pointer to the field that is the source of the message. + example: /rules/0/action + minLength: 1 + title: Pointer + type: string + required: + - pointer + title: Source + type: object + required: + - message + title: Message + type: object + rulesetsMessages: + description: A list of warning messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Messages + type: array + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + managed_headers: + id: cloudflare.managed_transforms.managed_headers + name: managed_headers + title: Managed Headers + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1managed_headers/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1managed_headers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1managed_headers/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/managed_headers/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/managed_headers/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/managed_headers/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/memberships.yaml b/providers/src/cloudflare/v00.00.00000/services/memberships.yaml new file mode 100644 index 00000000..1c91ee61 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/memberships.yaml @@ -0,0 +1,1245 @@ +openapi: 3.0.3 +info: + title: memberships API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /memberships: + get: + description: List memberships of accounts the user can access. + operationId: user'-s-account-memberships-list-memberships + parameters: + - in: query + name: account.name + schema: + $ref: '#/components/schemas/iamPropertiesName' + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of memberships per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Field to order memberships by. + enum: + - id + - account.name + - status + type: string + - in: query + name: direction + schema: + description: Direction to order memberships. + enum: + - asc + - desc + type: string + - in: query + name: name + schema: + $ref: '#/components/schemas/iamPropertiesName' + - in: query + name: status + schema: + description: Status of this membership. + enum: + - accepted + - pending + - rejected + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: memberships_with_roles + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamMembership' + type: array + required: + - errors + - messages + - success + description: List Memberships response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Memberships response failure + security: + - api_email: [] + api_key: [] + summary: List Memberships + tags: + - User's Account Memberships + x-api-token-group: + - Memberships Write + - Memberships Read + x-stackql-sdk: + service: memberships + resource_chain: [] + method: list + /memberships/{membership_id}: + delete: + description: Remove the associated member from an account. + operationId: user'-s-account-memberships-delete-membership + parameters: + - name: membership_id + in: path + required: true + description: The membership ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + $ref: >- + #/components/schemas/iamMembershipComponentsSchemasIdentifier + type: object + required: + - success + - errors + - messages + description: Delete Membership response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Delete Membership response failure + security: + - api_email: [] + api_key: [] + summary: Delete Membership + tags: + - User's Account Memberships + x-api-token-group: + - Memberships Write + x-stackql-sdk: + service: memberships + resource_chain: [] + method: delete + get: + description: Get a specific membership. + operationId: user'-s-account-memberships-membership-details + parameters: + - name: membership_id + in: path + required: true + description: The membership ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleMembershipResponseWithPolicies' + description: Membership Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Membership Details response failure + security: + - api_email: [] + api_key: [] + summary: Membership Details + tags: + - User's Account Memberships + x-api-token-group: + - Memberships Write + - Memberships Read + x-stackql-sdk: + service: memberships + resource_chain: [] + method: get + put: + description: Accept or reject this account invitation. + operationId: user'-s-account-memberships-update-membership + parameters: + - name: membership_id + in: path + required: true + description: The membership ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + status: + description: Whether to accept or reject this account invitation. + enum: + - accepted + - rejected + type: string + required: + - status + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleMembershipResponseWithPolicies' + description: Update Membership response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update Membership response failure + security: + - api_email: [] + api_key: [] + summary: Update Membership + tags: + - User's Account Memberships + x-api-token-group: + - Memberships Write + x-stackql-sdk: + service: memberships + resource_chain: [] + method: update + /organizations/{organization_id}/members: + get: + description: >- + List memberships for an Organization. (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Members_list + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + - description: Filter the list of memberships by membership status. + in: query + name: status + schema: + items: + enum: + - active + - canceled + type: string + type: array + explode: true + - description: Filter the list of memberships for a specific email. + explode: false + in: query + name: user.email + schema: + type: string + - description: >- + Filter the list of memberships for a specific email that contains a + substring. + explode: false + in: query + name: user.email.contains + schema: + type: string + - description: >- + Filter the list of memberships for a specific email that starts with + a substring. + explode: false + in: query + name: user.email.startsWith + schema: + type: string + - description: >- + Filter the list of memberships for a specific email that ends with a + substring. + explode: false + in: query + name: user.email.endsWith + schema: + type: string + - description: >- + An opaque token returned from the last list response that when + provided will retrieve the next page. Parameters used to filter the + retrieved list must remain in subsequent requests with a page token. + explode: false + in: query + name: page_token + schema: + type: string + - description: The amount of items to return. Defaults to 10. + explode: false + in: query + name: page_size + schema: + maximum: 1000 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiMember' + type: array + result_info: + $ref: '#/components/schemas/organizationsApiPageTokenResultInfo' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + - result_info + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: List organization members + tags: + - OrganizationMembers + post: + description: >- + Create a membership that grants access to a specific Organization. + (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Members_create + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiCreateMemberRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiMember' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Create organization member + tags: + - OrganizationMembers + /organizations/{organization_id}/members/{member_id}: + delete: + description: >- + Delete a membership to a particular Organization. (Currently in Closed + Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Members_delete + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + - name: member_id + in: path + required: true + description: The account member ID. + schema: + type: string + responses: + '204': + description: >- + There is no content to send for this request, but the headers may be + useful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Delete organization member + tags: + - OrganizationMembers + get: + description: >- + Retrieve a single membership from an Organization. (Currently in Closed + Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Members_retrieve + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + - name: member_id + in: path + required: true + description: The account member ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiMember' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Get organization member + tags: + - OrganizationMembers +components: + schemas: + iamAccess: + description: Allow or deny operations against the resources. + enum: + - allow + - deny + example: allow + type: string + x-auditable: true + iamAccount: + properties: + created_on: + description: Timestamp for the creation of the account + example: '2014-03-01T12:21:02.0000Z' + format: date-time + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + managed_by: + description: Parent container details + properties: + parent_org_id: + description: ID of the parent Organization, if one exists + example: 4536bcfad5faccb111b47003c79917fa + maxLength: 32 + readOnly: true + type: string + x-auditable: true + parent_org_name: + description: Name of the parent Organization, if one exists + example: Demo Parent Organization + readOnly: true + type: string + x-auditable: true + type: object + name: + description: Account name + example: Demo Account + maxLength: 100 + type: string + x-auditable: true + settings: + description: Account settings + properties: + abuse_contact_email: + description: Sets an abuse contact email to notify for abuse reports. + type: string + x-auditable: true + enforce_twofactor: + default: false + description: >- + Indicates whether membership in this account requires that + Two-Factor Authentication is enabled + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + type: + $ref: '#/components/schemas/iamAccountType' + required: + - id + - name + - type + type: object + iamAccountType: + enum: + - standard + - enterprise + type: string + iamApiAccessEnabled: + description: >- + Enterprise only. Indicates whether or not API access is enabled + specifically for this user on a given account. + example: true + nullable: true + type: boolean + x-auditable: true + iamApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/iamSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/iamSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + iamCommonComponentsSchemasIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + minLength: 32 + type: string + x-auditable: true + iamGrants: + example: + read: true + write: false + properties: + read: + example: true + type: boolean + x-auditable: true + write: + example: true + type: boolean + x-auditable: true + type: object + iamListMemberPolicy: + properties: + access: + $ref: '#/components/schemas/iamAccess' + id: + $ref: '#/components/schemas/iamPolicyIdentifier' + permission_groups: + $ref: '#/components/schemas/iamPermissionGroups' + resource_groups: + $ref: '#/components/schemas/iamResourceGroups' + title: list_member_policy + type: object + iamMembership: + properties: + account: + $ref: '#/components/schemas/iamSchemasAccount' + api_access_enabled: + $ref: '#/components/schemas/iamApiAccessEnabled' + id: + $ref: '#/components/schemas/iamMembershipComponentsSchemasIdentifier' + permissions: + description: All access permissions for the user at the account. + readOnly: true + $ref: '#/components/schemas/iamPermissions' + roles: + $ref: '#/components/schemas/iamRoleNames' + status: + $ref: '#/components/schemas/iamSchemasStatus' + type: object + iamMembershipComponentsSchemasIdentifier: + description: Membership identifier tag. + example: 4536bcfad5faccb111b47003c79917fa + maxLength: 32 + readOnly: true + type: string + x-auditable: true + iamMembershipWithPolicies: + properties: + account: + $ref: '#/components/schemas/iamSchemasAccount' + api_access_enabled: + $ref: '#/components/schemas/iamApiAccessEnabled' + id: + $ref: '#/components/schemas/iamMembershipComponentsSchemasIdentifier' + permissions: + description: All access permissions for the user at the account. + readOnly: true + $ref: '#/components/schemas/iamPermissions' + policies: + description: Access policy for the membership + items: + $ref: '#/components/schemas/iamListMemberPolicy' + type: array + roles: + $ref: '#/components/schemas/iamRoleNames' + status: + $ref: '#/components/schemas/iamSchemasStatus' + type: object + iamPermissionGroup: + description: >- + A named group of permissions that map to a group of operations against + resources. + properties: + id: + description: Identifier of the permission group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + type: string + x-auditable: true + meta: + description: Attributes associated to the permission group. + example: + label: load_balancer_admin + scopes: com.cloudflare.api.account + properties: + key: + type: string + x-auditable: true + value: + type: string + x-auditable: true + type: object + name: + description: Name of the permission group. + example: Load Balancer + readOnly: true + type: string + x-auditable: true + required: + - id + type: object + iamPermissionGroups: + description: A set of permission groups that are specified to the policy. + example: + - id: c8fed203ed3043cba015a93ad1616f1f + meta: + label: load_balancer_admin + scopes: com.cloudflare.api.account + name: Zone Read + - id: 82e64a83756745bbbb1c9c2701bf816b + meta: + label: fbm_user + scopes: com.cloudflare.api.account + name: Magic Network Monitoring + items: + $ref: '#/components/schemas/iamPermissionGroup' + type: array + iamPermissions: + example: + analytics: + read: true + write: false + zones: + read: true + write: true + properties: + analytics: + $ref: '#/components/schemas/iamGrants' + billing: + $ref: '#/components/schemas/iamGrants' + cache_purge: + $ref: '#/components/schemas/iamGrants' + dns: + $ref: '#/components/schemas/iamGrants' + dns_records: + $ref: '#/components/schemas/iamGrants' + lb: + $ref: '#/components/schemas/iamGrants' + logs: + $ref: '#/components/schemas/iamGrants' + organization: + $ref: '#/components/schemas/iamGrants' + ssl: + $ref: '#/components/schemas/iamGrants' + waf: + $ref: '#/components/schemas/iamGrants' + zone_settings: + $ref: '#/components/schemas/iamGrants' + zones: + $ref: '#/components/schemas/iamGrants' + type: object + iamPolicyIdentifier: + description: Policy identifier. + example: f267e341f3dd4697bd3b9f71dd96247f + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-always-send: true + iamPropertiesName: + description: Account name + example: Demo Account + maxLength: 100 + type: string + x-auditable: true + iamResourceGroup: + description: A group of scoped resources. + properties: + id: + description: Identifier of the resource group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + readOnly: true + type: string + x-auditable: true + meta: + description: Attributes associated to the resource group. + example: + editable: 'false' + properties: + key: + type: string + value: + type: string + type: object + name: + description: Name of the resource group. + example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4 + readOnly: true + type: string + x-auditable: true + scope: + description: The scope associated to the resource group + items: + $ref: '#/components/schemas/iamScope' + type: array + required: + - id + - scope + type: object + iamResourceGroups: + description: A list of resource groups that the policy applies to. + items: + $ref: '#/components/schemas/iamResourceGroup' + type: array + iamResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + iamRoleNames: + description: List of role names the membership has for this account. + items: + example: Account Administrator + maxLength: 120 + type: string + x-auditable: true + readOnly: true + type: array + iamSchemasAccount: + readOnly: true + $ref: '#/components/schemas/iamAccount' + iamSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + iamSchemasStatus: + description: Status of this membership. + enum: + - accepted + - pending + - rejected + example: accepted + type: string + x-auditable: true + iamScope: + description: >- + A scope is a combination of scope objects which provides additional + context. + properties: + key: + $ref: '#/components/schemas/iamScopeKey' + objects: + description: A list of scope objects for additional context. + items: + $ref: '#/components/schemas/iamScopeObject' + type: array + required: + - key + - objects + type: object + iamScopeKey: + description: >- + This is a combination of pre-defined resource name and identifier (like + Account ID etc.) + example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4 + readOnly: true + x-auditable: true + type: string + iamScopeObject: + description: >- + A scope object represents any resource that can have actions applied + against invite. + properties: + key: + $ref: '#/components/schemas/iamScopeObjectKey' + required: + - key + type: object + iamScopeObjectKey: + description: >- + This is a combination of pre-defined resource name and identifier (like + Zone ID etc.) + example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5 + readOnly: true + x-auditable: true + type: string + iamSingleMembershipResponseWithPolicies: + title: response_with_policies + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamMembershipWithPolicies' + required: + - success + - errors + - messages + organizationsApiCreateMemberRequest: + properties: + member: + $ref: '#/components/schemas/organizationsApiCreateSingleMember' + required: + - member + type: object + organizationsApiCreateSingleMember: + properties: + status: + enum: + - active + - canceled + type: string + user: + properties: + email: + type: string + required: + - email + type: object + required: + - user + type: object + organizationsApiMember: + properties: + create_time: + format: date-time + type: string + id: + $ref: '#/components/schemas/organizationsApiMemberID' + meta: + type: object + status: + enum: + - active + - canceled + type: string + update_time: + format: date-time + type: string + user: + $ref: '#/components/schemas/organizationsApiMemberSubjectUser' + required: + - id + - status + - user + - meta + - create_time + - update_time + type: object + organizationsApiMemberID: + description: Organization Member ID + example: a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8 + type: string + organizationsApiMemberSubjectUser: + properties: + email: + type: string + id: + type: string + name: + type: string + two_factor_authentication_enabled: + type: boolean + required: + - id + - email + - name + - two_factor_authentication_enabled + type: object + organizationsApiPageTokenResultInfo: + properties: + next_page_token: + description: >- + Use this opaque token in the next request to retrieve the next page. + Parameters used to filter the retrieved list must remain in + subsequent requests with a page token. + type: string + total_size: + description: >- + Counts the total amount of items in a list with the applied filters. + The API omits next_page_token to indicate no more items in a + particular list. + type: integer + type: object + organizationsApiV4ErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + type: object + success: + enum: + - false + type: boolean + required: + - success + - errors + - messages + type: object + organizationsApiV4Message: + $ref: '#/components/schemas/responseInfo' + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + memberships: + id: cloudflare.memberships.memberships + name: memberships + title: Memberships + methods: + list: + operation: + $ref: '#/paths/~1memberships/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: '#/paths/~1memberships~1{membership_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1memberships~1{membership_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1memberships~1{membership_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/memberships/methods/get' + - $ref: '#/components/x-stackQL-resources/memberships/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/memberships/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/memberships/methods/update' + members: + id: cloudflare.memberships.members + name: members + title: Members + methods: + list: + operation: + $ref: '#/paths/~1organizations~1{organization_id}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + members_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1organizations~1{organization_id}~1members/post' + response: + mediaType: application/json + openAPIDocKey: '200' + members_delete: + operation: + $ref: >- + #/paths/~1organizations~1{organization_id}~1members~1{member_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + get: + operation: + $ref: >- + #/paths/~1organizations~1{organization_id}~1members~1{member_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/members/methods/get' + - $ref: '#/components/x-stackQL-resources/members/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/members/methods/members_create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/members/methods/members_delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/mtls_certificates.yaml b/providers/src/cloudflare/v00.00.00000/services/mtls_certificates.yaml new file mode 100644 index 00000000..f6ee8d30 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/mtls_certificates.yaml @@ -0,0 +1,1041 @@ +openapi: 3.0.3 +info: + title: mtls_certificates API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/mtls_certificates: + get: + description: >- + Lists all mTLS certificates uploaded to your account, such as Bring Your + Own CA (BYO-CA) for mTLS. To list certificates issued by the Cloudflare + managed CA, use the [List Client Certificates + endpoint](/api/resources/client_certificates/methods/list/). + operationId: m-tls-certificate-management-list-m-tls-certificates + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Filters results by certificate type. Multiple types can be + comma-separated. + explode: false + in: query + name: type + schema: + items: + enum: + - custom + - gateway_managed + - access_managed + type: string + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasCertificateResponseCollection + description: List mTLS certificates response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: Total pages available of results + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateObject + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List mTLS certificates response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List mTLS certificates + tags: + - mTLS Certificate Management + x-api-token-group: + - 'Account: SSL and Certificates Read' + - 'Account: SSL and Certificates Write' + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: mtls_certificates + resource_chain: [] + method: list + post: + description: >- + Upload a certificate that you want to use with mTLS-enabled Cloudflare + services, such as Bring Your Own CA (BYO-CA) for mTLS. To create + certificates issued by the Cloudflare managed CA, use the [Create Client + Certificate + endpoint](/api/resources/client_certificates/methods/create/). + operationId: m-tls-certificate-management-upload-m-tls-certificate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ca: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCa' + certificates: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificates + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasName' + private_key: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasPrivateKey + required: + - certificates + - ca + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateResponseSinglePost + description: Upload mTLS certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + ca: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCa' + certificates: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificates + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasIssuer + name: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasName + serial_number: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasSerialNumber + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasType + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUpdatedAt + readOnly: true + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUploadedOn + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Upload mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload mTLS certificate + tags: + - mTLS Certificate Management + x-api-token-group: + - 'Account: SSL and Certificates Write' + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: mtls_certificates + resource_chain: [] + method: create + /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}: + delete: + description: >- + Deletes the mTLS certificate unless the certificate is in use by one or + more Cloudflare services. + operationId: m-tls-certificate-management-delete-m-tls-certificate + parameters: + - in: path + name: mtls_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasCertificateResponseSingle + description: Delete mTLS certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + ca: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCa' + certificates: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificates + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasIssuer + name: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasName + serial_number: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasSerialNumber + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasType + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUploadedOn + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete mTLS certificate + tags: + - mTLS Certificate Management + x-api-token-group: + - 'Account: SSL and Certificates Write' + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: mtls_certificates + resource_chain: [] + method: delete + get: + description: >- + Fetches a single mTLS certificate uploaded to your account. To get a + certificate issued by the Cloudflare managed CA, use the [Client + Certificate Details + endpoint](/api/resources/client_certificates/methods/get/). + operationId: m-tls-certificate-management-get-m-tls-certificate + parameters: + - in: path + name: mtls_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasCertificateResponseSingle + description: Get mTLS certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + properties: + ca: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCa' + certificates: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificates + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + issuer: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasIssuer + name: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasName + serial_number: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasSerialNumber + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasType + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUploadedOn + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get mTLS certificate + tags: + - mTLS Certificate Management + x-api-token-group: + - 'Account: SSL and Certificates Read' + - 'Account: SSL and Certificates Write' + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: mtls_certificates + resource_chain: [] + method: get + /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations: + get: + description: >- + Lists all active associations between the certificate and Cloudflare + services. + operationId: m-tls-certificate-management-list-m-tls-certificate-associations + parameters: + - in: path + name: mtls_certificate_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesAssociationResponseCollection + description: List mTLS certificate associations response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesAssociationObject + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List mTLS certificate associations response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List mTLS certificate associations + tags: + - mTLS Certificate Management + x-api-token-group: + - 'Account: SSL and Certificates Read' + - 'Account: SSL and Certificates Write' + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: mtls_certificates + resource_chain: + - associations + method: get +components: + schemas: + tlsCertificatesAndHostnamesAssociationObject: + properties: + service: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesService' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasStatus + type: object + tlsCertificatesAndHostnamesAssociationResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesAssociationObject' + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCa: + description: Indicates whether the certificate is a CA or leaf certificate. + example: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesCertificateObjectPost: + properties: + ca: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCa' + certificates: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasCertificates' + expires_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasIssuer' + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasName' + serial_number: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasSerialNumber' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasType + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUpdatedAt + readOnly: true + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUploadedOn + type: object + tlsCertificatesAndHostnamesCertificateResponseSinglePost: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateObjectPost + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesComponentsSchemasCertificateObject: + properties: + ca: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCa' + certificates: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasCertificates' + expires_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasExpiresOn' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasIssuer' + name: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasName' + serial_number: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasSerialNumber' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasType + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUploadedOn + type: object + tlsCertificatesAndHostnamesComponentsSchemasPrivateKey: + description: >- + The private key for the certificate. This field is only needed for + specific use cases such as using a custom certificate with Zero Trust's + block page. + example: |- + -----BEGIN PRIVATE KEY----- + MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEXDkcICRU3XBv + 9hiiPnBWIjgTQyowmVFxDr11mONgZB/cMYjE/OvQjvnpwNcOaSK16MOpAjNbELKR + x2lZiVJaLRDCccqCxXwP/CrdRChcqGzo7mbNksMlcidrErb0LlEBKLFC2QjRmRKq + B+YOs4TD8WsZu2S667A2fZmjRlaqOxFi1h62ee0P+TLU628UC/nl41JifSt5Evt7 + hMDHakemdwZblNYr2p6T3NQjdhjYXTtP4UmOGJBhJ7i7Kicg3d3CIgdTMbggSeGW + qjndr4ldVnD96FN3cVT5uDFsn2CJXTFgdeBWoUnMS4VnUZzPWGf4vSBXC8qV7Ls+ + w46yT7T1AgMBAAECggEAQZnp/oqCeNPOR6l5S2L+1tfx0gWjZ78hJVteUpZ0iHSK + 7F6kKeOxyOird7vUXV0kmo+cJq+0hp0Ke4eam640FCpwKfYoSQ4/R3vgujGWJnai + hCN5tv5sMet0XeJPuz5qE7ALoKCvwI6aXLHs20aAeZIDTQJ9QbGSGnJVzOWn+JDT + idIgZpN57RpXfSAwnJPTQK/PN8i5z108hsaDOdEgGmxYZ7kYqMqzX20KXmth58LD + fPixs5JGtS60iiKC/wOcGzkB2/AdTSojR76oEU77cANP/3zO25NG//whUdYlW0t0 + d7PgXxIeJe+xgYnamDQJx3qonVyt4H77ha0ObRAj9QKBgQDicZr+VTwFMnELP3a+ + FXGnjehRiuS1i7MXGKxNweCD+dFlML0FplSQS8Ro2n+d8lu8BBXGx0qm6VXu8Rhn + 7TAUL6q+PCgfarzxfIhacb/TZCqfieIHsMlVBfhV5HCXnk+kis0tuC/PRArcWTwD + HJUJXkBhvkUsNswvQzavDPI7KwKBgQDd/WgLkj7A3X5fgIHZH/GbDSBiXwzKb+rF + 4ZCT2XFgG/OAW7vapfcX/w+v+5lBLyrocmOAS3PGGAhM5T3HLnUCQfnK4qgps1Lq + ibkc9Tmnsn60LanUjuUMsYv/zSw70tozbzhJ0pioEpWfRxRZBztO2Rr8Ntm7h6Fk + 701EXGNAXwKBgQCD1xsjy2J3sCerIdcz0u5qXLAPkeuZW+34m4/ucdwTWwc0gEz9 + lhsULFj9p4G351zLuiEnq+7mAWLcDJlmIO3mQt6JhiLiL9Y0T4pgBmxmWqKKYtAs + JB0EmMY+1BNN44mBRqMxZFTJu1cLdhT/xstrOeoIPqytknYNanfTMZlzIwKBgHrL + Xe5oq0XMP8dcMneEcAUwsaU4pr6kQd3L9EmUkl5zl7J9C+DaxWAEuwzBw/iGutlx + zRB+rD/7szu14wJ29EqXbDGKRzMp+se5/yfBjm7xEZ1hVPw7PwBShfqt57X/4Ktq + 7lwHnmH6RcGhc+P7WBc5iO/S94YAdIp8xOT3pf9JAoGAE0QkqJUY+5Mgr+fBO0VN + V72ZoPveGpW+De59uhKAOnu1zljQCUtk59m6+DXfm0tNYKtawa5n8iN71Zh+s62x + XSt3pYi1Y5CCCmv8Y4BhwIcPwXKk3zEvLgSHVTpC0bayA9aSO4bbZgVXa5w+Z0w/ + vvfp9DWo1IS3EnQRrz6WMYA= + -----END PRIVATE KEY----- + type: string + x-sensitive: true + tlsCertificatesAndHostnamesComponentsSchemasType: + description: >- + The type of the certificate, indicating how it was created and who + manages it. + enum: + - custom + - gateway_managed + - access_managed + example: custom + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasCertificateResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 50 + type: number + total_count: + description: Total results available without any search parameters. + example: 1 + type: number + total_pages: + description: Total pages available of results + example: 1 + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateObject + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasCertificateResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateObject + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasStatus: + description: Certificate deployment status for the given service. + example: pending_deployment + type: string + x-auditable: true + tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUpdatedAt: + description: This is the time the certificate was updated. + example: '2022-11-22T17:32:30.467938Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesMtlsManagementComponentsSchemasUploadedOn: + description: This is the time the certificate was uploaded. + example: '2022-11-22T17:32:30.467938Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasCertificates: + description: The uploaded root CA certificate. + example: |- + -----BEGIN CERTIFICATE----- + MIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQEL + BQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNV + BAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIx + NjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgM + DVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4 + YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwg + JFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kC + M1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZ + CNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9 + K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1Mx + uCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcL + ypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7 + z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQE + AwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7 + NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ711 + 1Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTi + i7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG + +iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomo + ShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4 + JhqeoTewsxndhDDE + -----END CERTIFICATE----- + type: string + tlsCertificatesAndHostnamesSchemasExpiresOn: + description: When the certificate expires. + example: '2122-10-29T16:59:47Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasIssuer: + description: The certificate authority that issued the certificate. + example: O=Example Inc.,L=California,ST=San Francisco,C=US + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasName: + description: >- + Optional unique name for the certificate. Only used for human + readability. + example: example_ca_cert + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasSerialNumber: + description: The certificate serial number. + example: '235217144297995885180570755458463043449861756659' + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesService: + description: The service using the certificate. + example: gateway + type: string + x-auditable: true + tlsCertificatesAndHostnamesSignature: + description: The type of hash used for the certificate. + example: SHA256WithRSA + readOnly: true + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + mtls_certificates: + id: cloudflare.mtls_certificates.mtls_certificates + name: mtls_certificates + title: Mtls Certificates + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mtls_certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1mtls_certificates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1mtls_certificates~1{mtls_certificate_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1mtls_certificates~1{mtls_certificate_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/mtls_certificates/methods/get' + - $ref: '#/components/x-stackQL-resources/mtls_certificates/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/mtls_certificates/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/mtls_certificates/methods/delete' + replace: [] + associations: + id: cloudflare.mtls_certificates.associations + name: associations + title: Associations + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1mtls_certificates~1{mtls_certificate_id}~1associations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/associations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/network_interconnects.yaml b/providers/src/cloudflare/v00.00.00000/services/network_interconnects.yaml new file mode 100644 index 00000000..e0df22c5 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/network_interconnects.yaml @@ -0,0 +1,1258 @@ +openapi: 3.0.3 +info: + title: network_interconnects API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/cni/cnis: + get: + operationId: list_cnis + parameters: + - description: If specified, only show CNIs associated with the specified slot + in: query + name: slot + schema: + nullable: true + type: string + - description: If specified, only show cnis associated with the specified tunnel id + in: query + name: tunnel_id + schema: + nullable: true + type: string + - in: query + name: cursor + schema: + format: int32 + nullable: true + type: integer + - in: query + name: limit + schema: + minimum: 0 + nullable: true + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscCniList' + description: List of matching CNI objects + '400': + description: Bad request + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List existing CNI objects + tags: + - CNIs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - cnis + method: list + post: + operationId: create_cni + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/nscCniCreate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscCni' + description: CNI was successfully created + '400': + description: Bad request + '409': + description: Name Conflict + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new CNI object + tags: + - CNIs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - cnis + method: create + /accounts/{account_id}/cni/cnis/{cni}: + delete: + operationId: delete_cni + parameters: + - description: CNI ID to retrieve information about + in: path + name: cni + schema: + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + description: CNI has been successfully deleted + '400': + description: Bad request + '404': + description: CNI not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a specified CNI object + tags: + - CNIs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - cnis + method: delete + get: + operationId: get_cni + parameters: + - description: CNI ID to retrieve information about + in: path + name: cni + schema: + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscCni' + description: CNI's associated data + '400': + description: Bad request + '404': + description: CNI not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get information about a CNI object + tags: + - CNIs + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - cnis + method: get + put: + operationId: update_cni + parameters: + - description: CNI ID to retrieve information about + in: path + name: cni + schema: + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/nscCni' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscCni' + description: CNI has been successfully modified + '400': + description: Bad request + '404': + description: CNI not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Modify stored information about a CNI object + tags: + - CNIs + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - cnis + method: update + /accounts/{account_id}/cni/interconnects: + get: + operationId: list_interconnects + parameters: + - description: If specified, only show interconnects located at the given site + in: query + name: site + schema: + nullable: true + type: string + - description: If specified, only show interconnects of the given type + in: query + name: type + schema: + nullable: true + type: string + - in: query + name: cursor + schema: + format: int32 + nullable: true + type: integer + - in: query + name: limit + schema: + minimum: 0 + nullable: true + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscInterconnectList' + description: List of matching interconnect objects + '400': + description: Bad request + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List existing interconnects + tags: + - Interconnects + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - interconnects + method: list + post: + operationId: create_interconnect + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/nscInterconnectCreate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscInterconnect' + description: Information about the new interconnect + '400': + description: Bad request + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new interconnect + tags: + - Interconnects + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - interconnects + method: create + /accounts/{account_id}/cni/interconnects/{icon}: + delete: + operationId: delete_interconnect + parameters: + - description: Interconnect name to retrieve information about + in: path + name: icon + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + description: Successfully deleted interconnect + '400': + description: Bad request + '404': + description: Interconnect not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an interconnect object + tags: + - Interconnects + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - interconnects + method: delete + get: + operationId: get_interconnect + parameters: + - description: Interconnect name to retrieve information about + in: path + name: icon + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscInterconnect' + description: Information about the specified interconnect + '400': + description: Bad request + '404': + description: Interconnect not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get information about an interconnect object + tags: + - Interconnects + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - interconnects + method: get + /accounts/{account_id}/cni/interconnects/{icon}/loa: + get: + operationId: get_interconnect_loa + parameters: + - description: Interconnect name to retrieve information about + in: path + name: icon + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + description: Generated LOA in PDF format + '400': + description: Bad request + '404': + description: Interconnect not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Generate the Letter of Authorization (LOA) for a given interconnect + tags: + - Interconnects + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - interconnects + method: loa + /accounts/{account_id}/cni/interconnects/{icon}/status: + get: + operationId: get_interconnect_status + parameters: + - description: Interconnect name to retrieve information about + in: path + name: icon + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscStatusInfo' + description: Current interconnect status + '400': + description: Bad request + '404': + description: Interconnect not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the current status of an interconnect object + tags: + - Interconnects + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - interconnects + method: status + /accounts/{account_id}/cni/settings: + get: + operationId: get_settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscSettings' + description: The active account settings values + '400': + description: Bad request + '404': + description: Account not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the current settings for the active account + tags: + - Settings + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - settings + method: get + put: + operationId: update_settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/nscSettingsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscSettings' + description: The active account settings values + '400': + description: Bad request + '404': + description: Account not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update the current settings for the active account + tags: + - Settings + x-api-token-group: + - Magic WAN Write + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - settings + method: update + /accounts/{account_id}/cni/slots: + get: + operationId: list_slots + parameters: + - description: >- + If specified, only show slots with the given text in their address + field + in: query + name: address_contains + schema: + nullable: true + type: string + - description: If specified, only show slots located at the given site + in: query + name: site + schema: + nullable: true + type: string + - description: If specified, only show slots that support the given speed + in: query + name: speed + schema: + nullable: true + type: string + - description: >- + If specified, only show slots with a specific occupied/unoccupied + state + in: query + name: occupied + schema: + nullable: true + type: boolean + - in: query + name: cursor + schema: + format: int32 + nullable: true + type: integer + - in: query + name: limit + schema: + minimum: 0 + nullable: true + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscSlotList' + description: List of matching slots + '400': + description: Bad request + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve a list of all slots matching the specified parameters + tags: + - Slots + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - slots + method: list + /accounts/{account_id}/cni/slots/{slot}: + get: + operationId: get_slot + parameters: + - in: path + name: slot + schema: + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/nscSlotInfo' + description: Information about the specified slot + '400': + description: Bad request + '404': + description: Slot not found + '500': + description: Internal server error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get information about the specified slot + tags: + - Slots + x-api-token-group: + - Magic WAN Write + - Magic WAN Read + - Magic Transit Read + - Magic Transit Write + x-stackql-sdk: + service: network_interconnects + resource_chain: + - slots + method: get +components: + schemas: + nscAccountTag: + description: Customer account tag + type: string + nscApiBandwidth: + description: Bandwidth structure as visible through the customer-facing API. + enum: + - 50M + - 100M + - 200M + - 300M + - 400M + - 500M + - 1G + - 2G + - 5G + - 10G + - 20G + - 50G + type: string + nscBgpControl: + properties: + customer_asn: + description: ASN used on the customer end of the BGP session + format: int32 + minimum: 0 + type: integer + extra_prefixes: + description: >- + Extra set of static prefixes to advertise to the customer's end of + the session + items: + format: A.B.C.D/N + type: string + type: array + md5_key: + description: >- + MD5 key to use for session authentication. Note that *this is not a + security measure*. MD5 is not a valid security mechanism, and the + key is not treated as a secret value. This is *only* supported for + preventing misconfiguration, not for defending against malicious + attacks. The MD5 key, if set, must be of non-zero length and consist + only of the following types of character: * ASCII alphanumerics: + `[a-zA-Z0-9]` * Special characters in the set + `'!@#$%^&*()+[]{}<>/.,;:_-~`= \|` In other words, MD5 keys may + contain any printable ASCII character aside from newline (0x0A), + quotation mark (`"`), vertical tab (0x0B), carriage return (0x0D), + tab (0x09), form feed (0x0C), and the question mark (`?`). Requests + specifying an MD5 key with one or more of these disallowed + characters will be rejected. + nullable: true + type: string + required: + - customer_asn + - extra_prefixes + type: object + nscCloudflareSite: + description: A Cloudflare site name. + type: string + nscCni: + properties: + account: + $ref: '#/components/schemas/nscAccountTag' + bgp: + $ref: '#/components/schemas/nscBgpControl' + cust_ip: + description: >- + Customer end of the point-to-point link This should always be inside + the same prefix as `p2p_ip`. + example: 192.168.3.4/31 + format: A.B.C.D/N + type: string + id: + format: uuid + type: string + interconnect: + description: Interconnect identifier hosting this CNI + type: string + magic: + $ref: '#/components/schemas/nscMagicSettings' + p2p_ip: + description: Cloudflare end of the point-to-point link + example: 192.168.3.4/31 + format: A.B.C.D/N + type: string + required: + - id + - interconnect + - account + - p2p_ip + - cust_ip + - magic + type: object + nscCniCreate: + properties: + account: + $ref: '#/components/schemas/nscAccountTag' + bgp: + $ref: '#/components/schemas/nscBgpControl' + interconnect: + type: string + magic: + $ref: '#/components/schemas/nscMagicSettings' + required: + - interconnect + - account + - magic + type: object + nscCniList: + properties: + items: + items: + $ref: '#/components/schemas/nscCni' + type: array + next: + format: int32 + nullable: true + type: integer + required: + - items + type: object + nscFacilityInfo: + properties: + address: + items: + type: string + type: array + name: + type: string + required: + - name + - address + type: object + nscInterconnect: + type: object + title: Physical + properties: + account: + type: string + name: + type: string + owner: + type: string + type: + type: string + facility: + $ref: '#/components/schemas/nscFacilityInfo' + site: + $ref: '#/components/schemas/nscCloudflareSite' + slot_id: + format: uuid + type: string + speed: + type: string + region: + type: string + required: + - account + - name + - type + nscInterconnectCreate: + type: object + title: Physical + properties: + account: + type: string + type: + type: string + slot_id: + format: uuid + type: string + speed: + nullable: true + type: string + bandwidth: + $ref: '#/components/schemas/nscApiBandwidth' + pairing_key: + description: Pairing key provided by GCP + type: string + required: + - account + - type + nscInterconnectList: + properties: + items: + items: + $ref: '#/components/schemas/nscInterconnect' + type: array + next: + format: int32 + nullable: true + type: integer + required: + - items + type: object + nscMagicSettings: + properties: + conduit_name: + type: string + description: + type: string + mtu: + format: int32 + minimum: 0 + type: integer + required: + - conduit_name + - description + - mtu + type: object + nscSettings: + properties: + default_asn: + format: int32 + minimum: 0 + type: integer + required: + - default_asn + type: object + nscSettingsRequest: + properties: + default_asn: + format: int32 + minimum: 0 + nullable: true + type: integer + type: object + nscSlotInfo: + properties: + account: + $ref: '#/components/schemas/nscAccountTag' + facility: + $ref: '#/components/schemas/nscFacilityInfo' + id: + description: Slot ID + format: uuid + type: string + occupied: + description: Whether the slot is occupied or not + type: boolean + site: + type: string + speed: + type: string + required: + - id + - occupied + - site + - speed + - facility + type: object + nscSlotList: + properties: + items: + items: + $ref: '#/components/schemas/nscSlotInfo' + type: array + next: + format: int32 + nullable: true + type: integer + required: + - items + type: object + nscStatusInfo: + type: object + properties: + state: + enum: + - Pending + type: string + reason: + description: Diagnostic information, if available + nullable: true + type: string + required: + - state + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + cnis: + id: cloudflare.network_interconnects.cnis + name: cnis + title: Cnis + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1cnis/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1cnis/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1cnis~1{cni}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1cnis~1{cni}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1cnis~1{cni}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cnis/methods/get' + - $ref: '#/components/x-stackQL-resources/cnis/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cnis/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/cnis/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/cnis/methods/update' + interconnects: + id: cloudflare.network_interconnects.interconnects + name: interconnects + title: Interconnects + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1interconnects/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1interconnects/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cni~1interconnects~1{icon}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1interconnects~1{icon}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/interconnects/methods/get' + - $ref: '#/components/x-stackQL-resources/interconnects/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/interconnects/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/interconnects/methods/delete' + replace: [] + loas: + id: cloudflare.network_interconnects.loas + name: loas + title: Loas + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cni~1interconnects~1{icon}~1loa/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/loas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + interconnects_status: + id: cloudflare.network_interconnects.interconnects_status + name: interconnects_status + title: Interconnects Status + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1cni~1interconnects~1{icon}~1status/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/interconnects_status/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + settings: + id: cloudflare.network_interconnects.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/update' + slots: + id: cloudflare.network_interconnects.slots + name: slots + title: Slots + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1slots/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cni~1slots~1{slot}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/slots/methods/get' + - $ref: '#/components/x-stackQL-resources/slots/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/notifications.yaml b/providers/src/cloudflare/v00.00.00000/services/notifications.yaml deleted file mode 100644 index 34069916..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/notifications.yaml +++ /dev/null @@ -1,1305 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Notification Alert Types - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - notifications - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - alert-types_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - additionalProperties: - items: - $ref: '#/components/schemas/alert-types' - type: array - example: - Origin Monitoring: - - description: High levels of 5xx HTTP errors at your origin. - display_name: Origin Error Rate Alert - filter_options: - - ComparisonOperator: '==' - Key: zones - Optional: false - - ComparisonOperator: '>=' - Key: slo - Optional: true - type: http_alert_origin_error - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - alert-types: - properties: - description: - $ref: '#/components/schemas/alert-types_components-schemas-description' - display_name: - $ref: '#/components/schemas/display_name' - filter_options: - $ref: '#/components/schemas/schemas-filter_options' - type: - $ref: '#/components/schemas/alert-types_components-schemas-type' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - alert-types_components-schemas-description: - description: Describes the alert type. - example: High levels of 5xx HTTP errors at your origin - type: string - display_name: - description: Alert type name. - example: Origin Error Rate Alert - type: string - schemas-filter_options: - description: 'Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.' - example: - - ComparisonOperator: '==' - Key: zones - Optional: false - - ComparisonOperator: '>=' - Key: slo - Optional: true - items: {} - type: array - alert-types_components-schemas-type: - description: Use this value when creating and updating a notification policy. - example: http_alert_origin_error - type: string - history_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - example: - - alert_body: SSL certificate has expired - alert_type: universal_ssl_event_type - description: 'Universal Certificate validation status, issuance, renewal, and expiration notices.' - id: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - mechanism: test@example.com - mechanism_type: email - name: SSL Notification Event Policy - sent: '2021-10-08T17:52:17.571336Z' - items: - $ref: '#/components/schemas/history' - type: array - result_info: - example: - count: 1 - page: 1 - per_page: 20 - type: object - history: - properties: - alert_body: - $ref: '#/components/schemas/alert_body' - alert_type: - $ref: '#/components/schemas/schemas-alert_type' - description: - $ref: '#/components/schemas/history_components-schemas-description' - id: - $ref: '#/components/schemas/uuid' - mechanism: - $ref: '#/components/schemas/mechanism' - mechanism_type: - $ref: '#/components/schemas/mechanism_type' - name: - $ref: '#/components/schemas/history_components-schemas-name' - sent: - $ref: '#/components/schemas/sent' - type: object - alert_body: - description: Message body included in the notification sent. - example: SSL certificate has expired - type: string - schemas-alert_type: - description: Type of notification that has been dispatched. - example: universal_ssl_event_type - type: string - history_components-schemas-description: - description: Description of the notification policy (if present). - example: 'Universal Certificate validation status, issuance, renewal, and expiration notices' - type: string - uuid: - description: UUID - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true - type: string - mechanism: - description: The mechanism to which the notification has been dispatched. - example: test@example.com - type: string - mechanism_type: - description: The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured. - enum: - - email - - pagerduty - - webhook - example: email - type: string - history_components-schemas-name: - description: Name of the policy. - example: SSL Notification Event Policy - type: string - sent: - description: Timestamp of when the notification was dispatched in ISO 8601 format. - example: '2021-10-08T17:52:17.571336Z' - format: date-time - type: string - eligibility_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - additionalProperties: - items: - $ref: '#/components/schemas/eligibility' - type: array - example: - email: - eligible: true - ready: true - type: email - type: object - eligibility: - properties: - eligible: - $ref: '#/components/schemas/eligible' - ready: - $ref: '#/components/schemas/ready' - type: - $ref: '#/components/schemas/eligibility_components-schemas-type' - type: object - eligible: - description: Determines whether or not the account is eligible for the delivery mechanism. - example: true - type: boolean - ready: - description: 'Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications.' - example: true - type: boolean - eligibility_components-schemas-type: - description: Determines type of delivery mechanism. - enum: - - email - - pagerduty - - webhook - example: email - type: string - pagerduty_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/pagerduty' - type: array - pagerduty: - properties: - id: - $ref: '#/components/schemas/uuid' - name: - $ref: '#/components/schemas/pagerduty_components-schemas-name' - type: object - pagerduty_components-schemas-name: - description: The name of the pagerduty service. - example: My PagerDuty Service - type: string - policies_components-schemas-response_collection-2: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-policies' - type: array - components-schemas-policies: - properties: - alert_type: - $ref: '#/components/schemas/alert_type' - created: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/policies_components-schemas-description' - enabled: - $ref: '#/components/schemas/policies_components-schemas-enabled' - filters: - $ref: '#/components/schemas/components-schemas-filters' - id: - $ref: '#/components/schemas/uuid' - mechanisms: - $ref: '#/components/schemas/mechanisms' - modified: - $ref: '#/components/schemas/timestamp' - name: - $ref: '#/components/schemas/policies_components-schemas-name-2' - type: object - alert_type: - description: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. - example: universal_ssl_event_type - type: string - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - policies_components-schemas-description: - description: Optional description for the Notification policy. - example: Something describing the policy. - type: string - policies_components-schemas-enabled: - default: true - description: Whether or not the Notification policy is enabled. - example: true - type: boolean - components-schemas-filters: - additionalProperties: - description: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details. - items: {} - type: array - example: - slo: - - '99.9' - type: object - mechanisms: - additionalProperties: - items: - properties: - id: - $ref: '#/components/schemas/uuid' - type: object - type: array - description: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address. - example: - email: - - id: test@example.com - pagerduty: - - id: e8133a15-00a4-4d69-aec1-32f70c51f6e5 - webhooks: - - id: 14cc1190-5d2b-4b98-a696-c424cb2ad05f - type: object - policies_components-schemas-name-2: - description: Name of the policy. - example: SSL Notification Event Policy - type: string - policies_components-schemas-id_response-2: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/uuid' - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - policies_components-schemas-single_response-2: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/components-schemas-policies' - webhooks_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/webhooks' - type: array - webhooks: - properties: - created_at: - $ref: '#/components/schemas/webhooks_components-schemas-created_at' - id: - $ref: '#/components/schemas/uuid' - last_failure: - $ref: '#/components/schemas/last_failure' - last_success: - $ref: '#/components/schemas/last_success' - name: - $ref: '#/components/schemas/webhooks_components-schemas-name' - secret: - $ref: '#/components/schemas/schemas-secret' - type: - $ref: '#/components/schemas/webhooks_components-schemas-type' - url: - $ref: '#/components/schemas/components-schemas-url' - type: object - webhooks_components-schemas-created_at: - description: Timestamp of when the webhook destination was created. - example: '2020-10-26T18:25:04.532316Z' - format: date-time - readOnly: true - type: string - last_failure: - description: Timestamp of the last time an attempt to dispatch a notification to this webhook failed. - example: '2020-10-26T18:25:04.532316Z' - format: date-time - readOnly: true - type: string - last_success: - description: Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook. - example: '2020-10-26T18:25:04.532316Z' - format: date-time - readOnly: true - type: string - webhooks_components-schemas-name: - description: The name of the webhook destination. This will be included in the request body when you receive a webhook notification. - example: Slack Webhook - type: string - schemas-secret: - description: Optional secret that will be passed in the `cf-webhook-auth` header when dispatching a webhook notification. Secrets are not returned in any API response body. - type: string - webhooks_components-schemas-type: - description: Type of webhook endpoint. - enum: - - slack - - generic - - gchat - example: slack - type: string - components-schemas-url: - description: The POST endpoint to call when dispatching a notification. - example: 'https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd' - type: string - webhooks_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/uuid' - type: object - webhooks_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/webhooks' - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_alerting_available_alerts: - id: cloudflare.notifications.accounts_alerting_available_alerts - name: accounts_alerting_available_alerts - title: Accounts Alerting Available Alerts - methods: - notification_alert_types_get_alert_types: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1available_alerts/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _notification_alert_types_get_alert_types: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1available_alerts/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_available_alerts/methods/notification_alert_types_get_alert_types' - insert: [] - update: [] - delete: [] - accounts_alerting_history: - id: cloudflare.notifications.accounts_alerting_history - name: accounts_alerting_history - title: Accounts Alerting History - methods: - notification_history_list_history: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1history/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _notification_history_list_history: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1history/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_history/methods/notification_history_list_history' - insert: [] - update: [] - delete: [] - accounts_alerting_destinations_eligible: - id: cloudflare.notifications.accounts_alerting_destinations_eligible - name: accounts_alerting_destinations_eligible - title: Accounts Alerting Destinations Eligible - methods: - notification_mechanism_eligibility_get_delivery_mechanism_eligibility: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1eligible/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _notification_mechanism_eligibility_get_delivery_mechanism_eligibility: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1eligible/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_destinations_eligible/methods/notification_mechanism_eligibility_get_delivery_mechanism_eligibility' - insert: [] - update: [] - delete: [] - accounts_alerting_destinations_pagerduty: - id: cloudflare.notifications.accounts_alerting_destinations_pagerduty - name: accounts_alerting_destinations_pagerduty - title: Accounts Alerting Destinations Pagerduty - methods: - notification_destinations_with_pager_duty_list_pager_duty_services: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1pagerduty/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _notification_destinations_with_pager_duty_list_pager_duty_services: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1pagerduty/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_destinations_pagerduty/methods/notification_destinations_with_pager_duty_list_pager_duty_services' - insert: [] - update: [] - delete: [] - accounts_alerting_policies: - id: cloudflare.notifications.accounts_alerting_policies - name: accounts_alerting_policies - title: Accounts Alerting Policies - methods: - notification_policies_list_notification_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _notification_policies_list_notification_policies: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_policies_create_a_notification_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1policies/post' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_policies_delete_a_notification_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1policies~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_policies_get_a_notification_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1policies~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _notification_policies_get_a_notification_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1policies~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_policies_update_a_notification_policy: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1policies~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_policies/methods/notification_policies_list_notification_policies' - - $ref: '#/components/x-stackQL-resources/accounts_alerting_policies/methods/notification_policies_get_a_notification_policy' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_policies/methods/notification_policies_create_a_notification_policy' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_policies/methods/notification_policies_delete_a_notification_policy' - accounts_alerting_destinations_webhooks: - id: cloudflare.notifications.accounts_alerting_destinations_webhooks - name: accounts_alerting_destinations_webhooks - title: Accounts Alerting Destinations Webhooks - methods: - notification_webhooks_list_webhooks: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1webhooks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _notification_webhooks_list_webhooks: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1webhooks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_webhooks_create_a_webhook: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1webhooks/post' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_webhooks_delete_a_webhook: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1webhooks~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_webhooks_get_a_webhook: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1webhooks~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _notification_webhooks_get_a_webhook: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1webhooks~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - notification_webhooks_update_a_webhook: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1alerting~1v3~1destinations~1webhooks~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_destinations_webhooks/methods/notification_webhooks_list_webhooks' - - $ref: '#/components/x-stackQL-resources/accounts_alerting_destinations_webhooks/methods/notification_webhooks_get_a_webhook' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_destinations_webhooks/methods/notification_webhooks_create_a_webhook' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_alerting_destinations_webhooks/methods/notification_webhooks_delete_a_webhook' -paths: - '/accounts/{identifier}/alerting/v3/available_alerts': - get: - description: Gets a list of all alert types for which an account is eligible. - operationId: notification-alert-types-get-alert-types - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/alert-types_components-schemas-response_collection' - description: Get Alert Types response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/alert-types_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Alert Types response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Alert Types - tags: - - Notification Alert Types - '/accounts/{identifier}/alerting/v3/history': - get: - description: 'Gets a list of history records for notifications sent to an account. The records are displayed for last `x` number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).' - operationId: notification-history-list-history - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/history_components-schemas-response_collection' - description: List History response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/history_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List History response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List History - tags: - - Notification History - '/accounts/{identifier}/alerting/v3/destinations/eligible': - get: - description: Get a list of all delivery mechanism types for which an account is eligible. - operationId: notification-mechanism-eligibility-get-delivery-mechanism-eligibility - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/eligibility_components-schemas-response_collection' - description: Get delivery mechanism eligibility response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/eligibility_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get delivery mechanism eligibility response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get delivery mechanism eligibility - tags: - - Notification Mechanism Eligibility - '/accounts/{identifier}/alerting/v3/destinations/pagerduty': - get: - description: Get a list of all configured PagerDuty services. - operationId: notification-destinations-with-pager-duty-list-pager-duty-services - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pagerduty_components-schemas-response_collection' - description: List PagerDuty services response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pagerduty_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List PagerDuty services response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List PagerDuty services - tags: - - Notification destinations with PagerDuty - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/accounts/{identifier}/alerting/v3/policies': - get: - description: Get a list of all Notification policies. - operationId: notification-policies-list-notification-policies - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-response_collection-2' - description: List Notification policies response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-response_collection-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Notification policies response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Notification policies - tags: - - Notification policies - post: - description: Creates a new Notification policy. - operationId: notification-policies-create-a-notification-policy - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - alert_type: - $ref: '#/components/schemas/alert_type' - description: - $ref: '#/components/schemas/policies_components-schemas-description' - enabled: - $ref: '#/components/schemas/policies_components-schemas-enabled' - filters: - $ref: '#/components/schemas/components-schemas-filters' - mechanisms: - $ref: '#/components/schemas/mechanisms' - name: - $ref: '#/components/schemas/policies_components-schemas-name-2' - required: - - name - - alert_type - - enabled - - mechanisms - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-id_response-2' - description: Create a Notification policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-id_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a Notification policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a Notification policy - tags: - - Notification policies - '/accounts/{identifier}/alerting/v3/policies/{uuid}': - delete: - description: Delete a Notification policy. - operationId: notification-policies-delete-a-notification-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Delete a Notification policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a Notification policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a Notification policy - tags: - - Notification policies - get: - description: Get details for a single policy. - operationId: notification-policies-get-a-notification-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-single_response-2' - description: Get a Notification policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-single_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Notification policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Notification policy - tags: - - Notification policies - put: - description: Update a Notification policy. - operationId: notification-policies-update-a-notification-policy - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - alert_type: - $ref: '#/components/schemas/alert_type' - description: - $ref: '#/components/schemas/policies_components-schemas-description' - enabled: - $ref: '#/components/schemas/policies_components-schemas-enabled' - filters: - $ref: '#/components/schemas/components-schemas-filters' - mechanisms: - $ref: '#/components/schemas/mechanisms' - name: - $ref: '#/components/schemas/policies_components-schemas-name-2' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/policies_components-schemas-id_response-2' - description: Update a Notification policy response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/policies_components-schemas-id_response-2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a Notification policy response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a Notification policy - tags: - - Notification policies - '/accounts/{identifier}/alerting/v3/destinations/webhooks': - get: - description: Gets a list of all configured webhook destinations. - operationId: notification-webhooks-list-webhooks - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/webhooks_components-schemas-response_collection' - description: List webhooks response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/webhooks_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List webhooks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List webhooks - tags: - - Notification webhooks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - post: - description: Creates a new webhook destination. - operationId: notification-webhooks-create-a-webhook - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/webhooks_components-schemas-name' - secret: - $ref: '#/components/schemas/schemas-secret' - url: - $ref: '#/components/schemas/components-schemas-url' - required: - - name - - url - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/webhooks_components-schemas-id_response' - description: Create a webhook response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/webhooks_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a webhook response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a webhook - tags: - - Notification webhooks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/accounts/{identifier}/alerting/v3/destinations/webhooks/{uuid}': - delete: - description: Delete a configured webhook destination. - operationId: notification-webhooks-delete-a-webhook - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-collection' - description: Delete a webhook response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a webhook response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a webhook - tags: - - Notification webhooks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - get: - description: Get details for a single webhooks destination. - operationId: notification-webhooks-get-a-webhook - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/webhooks_components-schemas-single_response' - description: Get a webhook response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/webhooks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a webhook response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a webhook - tags: - - Notification webhooks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - put: - description: Update a webhook destination. - operationId: notification-webhooks-update-a-webhook - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/webhooks_components-schemas-name' - secret: - $ref: '#/components/schemas/schemas-secret' - url: - $ref: '#/components/schemas/components-schemas-url' - required: - - name - - url - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/webhooks_components-schemas-id_response' - description: Update a webhook response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/webhooks_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a webhook response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a webhook - tags: - - Notification webhooks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true diff --git a/providers/src/cloudflare/v00.00.00000/services/organization.yaml b/providers/src/cloudflare/v00.00.00000/services/organization.yaml deleted file mode 100644 index 23e5a51f..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/organization.yaml +++ /dev/null @@ -1,1256 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Organization Invites - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - organization - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - collection_invite_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/invite' - type: array - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - invite: - allOf: - - $ref: '#/components/schemas/organization_invite' - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - organization_invite: - allOf: - - $ref: '#/components/schemas/base' - - properties: - organization_is_enforcing_twofactor: - default: false - description: Current status of two-factor enforcement on the organization. - example: true - type: boolean - status: - description: Current status of the invitation. - enum: - - pending - - accepted - - rejected - - canceled - - left - - expired - example: accepted - type: string - base: - properties: - expires_on: - $ref: '#/components/schemas/schemas-expires_on' - id: - $ref: '#/components/schemas/invite_components-schemas-identifier' - invited_by: - $ref: '#/components/schemas/invited_by' - invited_member_email: - $ref: '#/components/schemas/invited_member_email' - invited_member_id: - description: ID of the user to add to the organization. - example: 5a7805061c76ada191ed06f989cc3dac - maxLength: 32 - nullable: true - readOnly: true - type: string - invited_on: - $ref: '#/components/schemas/invited_on' - organization_id: - description: ID of the organization the user will be added to. - example: 5a7805061c76ada191ed06f989cc3dac - maxLength: 32 - readOnly: true - type: string - organization_name: - description: Organization name. - example: 'Cloudflare, Inc.' - maxLength: 100 - readOnly: true - type: string - roles: - description: Roles to be assigned to this user. - items: - $ref: '#/components/schemas/schemas-role' - type: array - required: - - invited_member_id - - organization_id - type: object - schemas-expires_on: - description: When the invite is no longer active. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - invite_components-schemas-identifier: - description: Invite identifier tag. - example: 4f5f0c14a2a41d5063dd301b2f829f04 - maxLength: 32 - readOnly: true - type: string - invited_by: - description: The email address of the user who created the invite. - example: user@example.com - maxLength: 90 - type: string - invited_member_email: - description: Email address of the user to add to the organization. - example: user@example.com - maxLength: 90 - type: string - invited_on: - description: When the invite was sent. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - schemas-role: - properties: - description: - $ref: '#/components/schemas/description' - id: - $ref: '#/components/schemas/role_components-schemas-identifier' - name: - $ref: '#/components/schemas/components-schemas-name' - permissions: - $ref: '#/components/schemas/schemas-permissions' - required: - - id - - name - - description - - permissions - type: object - description: - description: Description of role's permissions. - example: Administrative access to the entire Organization - readOnly: true - type: string - role_components-schemas-identifier: - description: Role identifier tag. - example: 3536bcfad5faccb999b47003c79917fb - maxLength: 32 - readOnly: true - type: string - components-schemas-name: - description: Role Name. - example: Organization Admin - maxLength: 120 - readOnly: true - type: string - schemas-permissions: - description: Access permissions for this User. - items: - example: '#zones:read' - maxLength: 160 - type: string - readOnly: true - type: array - single_invite_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - organization_components-schemas-identifier: - description: Organization identifier tag. - example: 01a7362d577a6c3019a474fd6f485823 - maxLength: 32 - readOnly: true - type: string - collection_member_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-member' - type: array - type: object - components-schemas-member: - properties: - email: - $ref: '#/components/schemas/email' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/member_components-schemas-name' - roles: - description: Roles assigned to this Member. - items: - $ref: '#/components/schemas/schemas-role' - type: array - status: - description: A member's status in the organization. - enum: - - accepted - - invited - example: accepted - required: - - id - - name - - email - - status - - roles - type: object - email: - description: The contact email address of the user. - example: user@example.com - maxLength: 90 - type: string - member_components-schemas-name: - description: Member Name. - example: John Smith - maxLength: 100 - nullable: true - type: string - single_member_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - collection_role_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-role' - type: array - type: object - single_role_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - single_organization_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - organization: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/schemas-name' - permissions: - $ref: '#/components/schemas/schemas-permissions' - roles: - description: List of roles that a user has within an organization. - items: - example: All Privileges - Super Administrator - maxLength: 120 - type: string - readOnly: true - type: array - status: - $ref: '#/components/schemas/components-schemas-status' - type: object - schemas-name: - description: Organization name. - example: 'Cloudflare, Inc.' - maxLength: 100 - type: string - components-schemas-status: - description: Whether the user is a member of the organization or has an inivitation pending. - enum: - - member - - invited - example: member - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - organizations_invites: - id: cloudflare.organization.organizations_invites - name: organizations_invites - title: Organizations Invites - methods: - invites_list_invitations: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1invites/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _invites_list_invitations: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1invites/get' - response: - mediaType: application/json - openAPIDocKey: '200' - invites_create_invitation: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1invites/post' - response: - mediaType: application/json - openAPIDocKey: '200' - invites_cancel_invitation: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1invites~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - invites_invitation_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1invites~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _invites_invitation_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1invites~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - invites_edit_invitation_roles: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1invites~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/organizations_invites/methods/invites_list_invitations' - - $ref: '#/components/x-stackQL-resources/organizations_invites/methods/invites_invitation_details' - insert: - - $ref: '#/components/x-stackQL-resources/organizations_invites/methods/invites_create_invitation' - update: [] - delete: [] - organizations_members: - id: cloudflare.organization.organizations_members - name: organizations_members - title: Organizations Members - methods: - members_list_members: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1members/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _members_list_members: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1members/get' - response: - mediaType: application/json - openAPIDocKey: '200' - members_remove_member: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1members~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - members_member_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1members~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _members_member_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1members~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - members_edit_member_roles: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1members~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/organizations_members/methods/members_list_members' - - $ref: '#/components/x-stackQL-resources/organizations_members/methods/members_member_details' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/organizations_members/methods/members_remove_member' - organizations_roles: - id: cloudflare.organization.organizations_roles - name: organizations_roles - title: Organizations Roles - methods: - roles_list_roles: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1roles/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _roles_list_roles: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1roles/get' - response: - mediaType: application/json - openAPIDocKey: '200' - roles_role_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1roles~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _roles_role_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1roles~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/organizations_roles/methods/roles_list_roles' - - $ref: '#/components/x-stackQL-resources/organizations_roles/methods/roles_role_details' - insert: [] - update: [] - delete: [] - organizations: - id: cloudflare.organization.organizations - name: organizations - title: Organizations - methods: - __deprecated__organization_details: - operation: - $ref: '#/paths/~1organizations~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - ___deprecated__organization_details: - operation: - $ref: '#/paths/~1organizations~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - __deprecated__edit_organization: - operation: - $ref: '#/paths/~1organizations~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] -paths: - '/organizations/{organization_identifier}/invites': - get: - deprecated: true - description: List all invitations associated with an organization. - operationId: organization-invites-list-invitations - parameters: - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/collection_invite_response' - description: List Invitations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/collection_invite_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Invitations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Invitations - tags: - - Organization Invites - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - deprecated: true - description: Invite a User to become a Member of an Organization. - operationId: organization-invites-create-invitation - parameters: - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - auto_accept: - default: false - description: 'When present and set to true, allows for the invited user to be automatically accepted to the organization. No invitation is sent.' - example: true - type: boolean - invited_member_email: - $ref: '#/components/schemas/invited_member_email' - roles: - description: Array of Roles associated with the invited user. - example: - - id: 5a7805061c76ada191ed06f989cc3dac - - id: 9a7806061c88ada191ed06f989cc3dac - items: - properties: - description: - $ref: '#/components/schemas/description' - id: - $ref: '#/components/schemas/role_components-schemas-identifier' - name: - $ref: '#/components/schemas/components-schemas-name' - permissions: - $ref: '#/components/schemas/schemas-permissions' - required: - - id - type: object - type: array - required: - - invited_member_email - - roles - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_invite_response' - description: Create Invitation response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_invite_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Invitation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Invitation - tags: - - Organization Invites - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/invites/{identifier}': - delete: - deprecated: true - description: Cancel an existing invitation. - operationId: organization-invites-cancel-invitation - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/invite_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - properties: - id: - $ref: '#/components/schemas/invite_components-schemas-identifier' - type: object - description: Cancel Invitation response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - id: - $ref: '#/components/schemas/invite_components-schemas-identifier' - - $ref: '#/components/schemas/api-response-common-failure' - description: Cancel Invitation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Cancel Invitation - tags: - - Organization Invites - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - deprecated: true - description: Get the details of an invitation. - operationId: organization-invites-invitation-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/invite_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_invite_response' - description: Invitation Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_invite_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Invitation Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Invitation Details - tags: - - Organization Invites - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - deprecated: true - description: Change the Roles of a Pending Invite. - operationId: organization-invites-edit-invitation-roles - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/invite_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - roles: - description: Array of Roles associated with the invited user. - items: - $ref: '#/components/schemas/role_components-schemas-identifier' - type: array - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_invite_response' - description: Edit Invitation Roles response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_invite_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Invitation Roles response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit Invitation Roles - tags: - - Organization Invites - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/members': - get: - deprecated: true - description: List all members of a organization. - operationId: organization-members-list-members - parameters: - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/organization_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/collection_member_response' - description: List Members response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/collection_member_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Members response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Members - tags: - - Organization Members - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/members/{identifier}': - delete: - deprecated: true - description: Remove a member from an organization. - operationId: organization-members-remove-member - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/organization_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: object - description: Remove Member response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - - $ref: '#/components/schemas/api-response-common-failure' - description: Remove Member response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Remove Member - tags: - - Organization Members - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - deprecated: true - description: Get information about a specific member of an organization. - operationId: organization-members-member-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/organization_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_member_response' - description: Member Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_member_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Member Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Member Details - tags: - - Organization Members - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - deprecated: true - description: Change the Roles of an Organization's Member. - operationId: organization-members-edit-member-roles - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/organization_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - roles: - description: Array of Roles associated with this Member. - items: - $ref: '#/components/schemas/role_components-schemas-identifier' - type: array - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_member_response' - description: Edit Member Roles response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_member_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Member Roles response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit Member Roles - tags: - - Organization Members - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/roles': - get: - deprecated: true - description: Get all available roles for an organization. - operationId: organization-roles-list-roles - parameters: - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/organization_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/collection_role_response' - description: List Roles response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/collection_role_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Roles response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Roles - tags: - - Organization Roles - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/roles/{identifier}': - get: - deprecated: true - description: Get information about a specific role for an organization. - operationId: organization-roles-role-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/role_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/organization_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_role_response' - description: Role Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_role_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Role Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Role Details - tags: - - Organization Roles - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/organizations/{identifier}': - get: - deprecated: true - description: Get information about a specific organization that you are a member of. - operationId: organizations-(-deprecated)-organization-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_organization_response' - description: Organization Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_organization_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Organization Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Organization Details - tags: - - Organizations (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/organization/x-cfDeprecations/org_deprecation' - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - deprecated: true - description: Update an existing Organization. - operationId: organizations-(-deprecated)-edit-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/schemas-name' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_organization_response' - description: Edit Organization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_organization_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit Organization - tags: - - Organizations (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/organization/x-cfDeprecations/org_deprecation' - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false diff --git a/providers/src/cloudflare/v00.00.00000/services/organizations.yaml b/providers/src/cloudflare/v00.00.00000/services/organizations.yaml new file mode 100644 index 00000000..7f6f6013 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/organizations.yaml @@ -0,0 +1,2343 @@ +openapi: 3.0.3 +info: + title: organizations API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/organizations: + get: + description: >- + Retrieve a list of the organizations that "contain" this account or are + managing it. The returned list will be in order from "root" to "leaf", + where the "leaf" will be the organization that _immediately_ contains + the specified account. + operationId: Accounts_listAccountOrganizations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiOrganization' + type: array + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: List account organizations + tags: + - Accounts + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + /organizations: + get: + description: >- + Retrieve a list of organizations a particular user has access to. + (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organization_listOrganizations + parameters: + - description: >- + Only return organizations with the specified IDs (ex. + id=foo&id=bar). Send multiple elements by repeating the query value. + explode: false + in: query + name: id + schema: + items: + $ref: '#/components/schemas/organizationsApiOrganizationID' + type: array + - description: >- + (case-sensitive) Filter the list of organizations to where the name + is equal to a particular string. + explode: false + in: query + name: name + schema: + type: string + - description: >- + (case-insensitive) Filter the list of organizations to where the + name starts with a particular string. + explode: false + in: query + name: name.startsWith + schema: + type: string + - description: >- + (case-insensitive) Filter the list of organizations to where the + name ends with a particular string. + explode: false + in: query + name: name.endsWith + schema: + type: string + - description: >- + (case-insensitive) Filter the list of organizations to where the + name contains a particular string. + explode: false + in: query + name: name.contains + schema: + type: string + - description: >- + Filter the list of organizations to the ones that contain this + particular account. + explode: false + in: query + name: containing.account + schema: + type: string + - description: >- + Filter the list of organizations to the ones that contain this + particular user. IMPORTANT: Just because an organization "contains" + a user is not a representation of any authorization or privilege to + manage any resources therein. An organization "containing" a user + simply means the user is managed by that organization. + explode: false + in: query + name: containing.user + schema: + type: string + - description: >- + Filter the list of organizations to the ones that contain this + particular organization. + explode: false + in: query + name: containing.organization + schema: + type: string + - description: >- + Filter the list of organizations to the ones that are a + sub-organization of the specified organization. "null" is a valid + value to provide for this parameter. It means "where an organization + has no parent (i.e. it is a 'root' organization)." + explode: false + in: query + name: parent.id + schema: + type: string + title: Organization ID + enum: + - 'null' + - description: >- + An opaque token returned from the last list response that when + provided will retrieve the next page. Parameters used to filter the + retrieved list must remain in subsequent requests with a page token. + explode: false + in: query + name: page_token + schema: + type: string + - description: The amount of items to return. Defaults to 10. + explode: false + in: query + name: page_size + schema: + maximum: 1000 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiOrganization' + type: array + result_info: + $ref: '#/components/schemas/organizationsApiPageTokenResultInfo' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + - result_info + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: List organizations the user has access to + tags: + - Organizations + x-api-token-group: + - User Details Write + - User Details Read + x-stackql-sdk: + service: organizations + resource_chain: [] + method: list + post: + description: >- + Create a new organization for a user. (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organizations_createUserOrganization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiOrganization' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiOrganization' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Create organization + tags: + - Organizations + x-api-token-group: + - User Details Write + x-stackql-sdk: + service: organizations + resource_chain: [] + method: create + /organizations/{organization_id}: + delete: + description: >- + Delete an organization. The organization MUST be empty before deleting. + It must not contain any sub-organizations, accounts, members or users. + (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organizations_delete + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: >- + #/components/schemas/organizationsApiDeleteOrganizationResponse + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Delete organization. + tags: + - Organizations + x-stackql-sdk: + service: organizations + resource_chain: [] + method: delete + get: + description: >- + Retrieve the details of a certain organization. (Currently in Closed + Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organizations_retrieve + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiOrganization' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Get organization + tags: + - Organizations + x-stackql-sdk: + service: organizations + resource_chain: [] + method: get + put: + description: >- + Modify organization. (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organizations_modify + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiOrganization' + description: >- + The new details of the organization. Only accepts updates to "name" + currently. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiOrganization' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Modify organization. + tags: + - Organizations + x-stackql-sdk: + service: organizations + resource_chain: [] + method: update + /organizations/{organization_id}/accounts: + get: + description: >- + Retrieve a list of accounts that belong to a specific organization. + (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organizations_getAccounts + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + - deprecated: true + description: >- + (case-insensitive) Filter the list of accounts to where the + account_pubname is equal to a particular string. + explode: false + in: query + name: account_pubname + schema: + type: string + - deprecated: true + description: >- + (case-insensitive) Filter the list of accounts to where the + account_pubname starts with a particular string. + explode: false + in: query + name: account_pubname.startsWith + schema: + type: string + - deprecated: true + description: >- + (case-insensitive) Filter the list of accounts to where the + account_pubname ends with a particular string. + explode: false + in: query + name: account_pubname.endsWith + schema: + type: string + - deprecated: true + description: >- + (case-insensitive) Filter the list of accounts to where the + account_pubname contains a particular string. + explode: false + in: query + name: account_pubname.contains + schema: + type: string + - description: >- + (case-insensitive) Filter the list of accounts to where the name is + equal to a particular string. + explode: false + in: query + name: name + schema: + type: string + - description: >- + (case-insensitive) Filter the list of accounts to where the name + starts with a particular string. + explode: false + in: query + name: name.startsWith + schema: + type: string + - description: >- + (case-insensitive) Filter the list of accounts to where the name + ends with a particular string. + explode: false + in: query + name: name.endsWith + schema: + type: string + - description: >- + (case-insensitive) Filter the list of accounts to where the name + contains a particular string. + explode: false + in: query + name: name.contains + schema: + type: string + - description: >- + Field to order results by. Currently supported values: + `account_name`. When not specified, results are ordered by internal + account ID. + explode: false + in: query + name: order_by + schema: + enum: + - account_name + type: string + - description: >- + Sort direction for the order_by field. Valid values: `asc`, `desc`. + Defaults to `asc` when order_by is specified. + explode: false + in: query + name: direction + schema: + enum: + - asc + - desc + type: string + - description: >- + An opaque token returned from the last list response that when + provided will retrieve the next page. Parameters used to filter the + retrieved list must remain in subsequent requests with a page token. + explode: false + in: query + name: page_token + schema: + type: string + - description: The amount of items to return. Defaults to 10. + explode: false + in: query + name: page_size + schema: + maximum: 1000 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiAccount' + type: array + result_info: + $ref: '#/components/schemas/organizationsApiPageTokenResultInfo' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + - result_info + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Get organization accounts + tags: + - Organizations + /organizations/{organization_id}/logs/audit: + get: + description: Gets a list of audit logs for an organization. + operationId: audit-logs-v2-get-organization-audit-logs + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + - in: query + name: action_result + schema: + description: Filters by whether the action was successful or not. + items: + enum: + - success + - failure + type: string + type: array + explode: true + - in: query + name: action_type + schema: + description: Filters by the action type. + items: + enum: + - create + - delete + - view + - update + type: string + type: array + explode: true + - in: query + name: actor_context + schema: + description: Filters by the actor context. + items: + enum: + - api_key + - api_token + - dash + - oauth + - origin_ca_key + type: string + type: array + explode: true + - in: query + name: actor_email + schema: + description: Filters by the actor's email address. + items: + format: email + type: string + type: array + explode: true + - in: query + name: actor_id + schema: + description: Filters by the actor's user ID. + items: + type: string + type: array + explode: true + - in: query + name: actor_ip_address + schema: + description: The IP address where the action was initiated. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_id + schema: + description: >- + Filters by the API token ID when the actor context is an api_token + or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_name + schema: + description: >- + Filters by the API token name when the actor context is an + api_token or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_type + schema: + description: Filters by the actor type. + items: + enum: + - cloudflare_admin + - system + - user + type: string + type: array + explode: true + - in: query + name: id + schema: + description: Finds a specific log by its ID. + items: + type: string + type: array + explode: true + - in: query + name: raw_cf_ray_id + schema: + description: Filters by the response CF Ray ID. + items: + type: string + type: array + explode: true + - in: query + name: raw_method + schema: + description: The HTTP method for the API call. + items: + type: string + type: array + explode: true + - in: query + name: raw_status_code + schema: + description: The response status code that was returned. + items: + type: integer + type: array + explode: true + - in: query + name: raw_uri + schema: + description: Filters by the request URI. + items: + type: string + type: array + explode: true + - in: query + name: resource_id + schema: + description: Filters by the resource ID. + items: + type: string + type: array + explode: true + - in: query + name: resource_product + schema: + description: >- + Filters audit logs by the Cloudflare product associated with the + changed resource. + items: + type: string + type: array + explode: true + - in: query + name: resource_type + schema: + description: >- + Filters audit logs based on the unique type of resource changed by + the action. + items: + type: string + type: array + explode: true + - in: query + name: resource_scope + schema: + description: >- + Filters by the resource scope, specifying whether the resource is + associated with an organization. + items: + enum: + - organizations + type: string + type: array + explode: true + - in: query + name: action_result.not + schema: + description: >- + Filters out audit logs by whether the action was successful or + not. + items: + enum: + - success + - failure + type: string + type: array + explode: true + - in: query + name: action_type.not + schema: + description: Filters out audit logs by the action type. + items: + enum: + - create + - delete + - view + - update + type: string + type: array + explode: true + - in: query + name: actor_context.not + schema: + description: Filters out audit logs by the actor context. + items: + enum: + - api_key + - api_token + - dash + - oauth + - origin_ca_key + type: string + type: array + explode: true + - in: query + name: actor_email.not + schema: + description: Filters out audit logs by the actor's email address. + items: + format: email + type: string + type: array + explode: true + - in: query + name: actor_id.not + schema: + description: Filters out audit logs by the actor's user ID. + items: + type: string + type: array + explode: true + - in: query + name: actor_ip_address.not + schema: + description: Filters out audit logs IP address where the action was initiated. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_id.not + schema: + description: >- + Filters out audit logs by the API token ID when the actor context + is an api_token or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_token_name.not + schema: + description: >- + Filters out audit logs by the API token name when the actor + context is an api_token or oauth. + items: + type: string + type: array + explode: true + - in: query + name: actor_type.not + schema: + description: Filters out audit logs by the actor type. + items: + enum: + - cloudflare_admin + - system + - user + type: string + type: array + explode: true + - in: query + name: id.not + schema: + description: Filters out audit logs by their IDs. + items: + type: string + type: array + explode: true + - in: query + name: raw_cf_ray_id.not + schema: + description: Filters out audit logs by the response CF Ray ID. + items: + type: string + type: array + explode: true + - in: query + name: raw_method.not + schema: + description: Filters out audit logs by the HTTP method for the API call. + items: + type: string + type: array + explode: true + - in: query + name: raw_status_code.not + schema: + description: >- + Filters out audit logs by the response status code that was + returned. + items: + type: integer + type: array + explode: true + - in: query + name: raw_uri.not + schema: + description: Filters out audit logs by the request URI. + items: + type: string + type: array + explode: true + - in: query + name: resource_id.not + schema: + description: Filters out audit logs by the resource ID. + items: + type: string + type: array + explode: true + - in: query + name: resource_product.not + schema: + description: >- + Filters out audit logs by the Cloudflare product associated with + the changed resource. + items: + type: string + type: array + explode: true + - in: query + name: resource_type.not + schema: + description: >- + Filters out audit logs based on the unique type of resource + changed by the action. + items: + type: string + type: array + explode: true + - in: query + name: resource_scope.not + schema: + description: >- + Filters out audit logs by the resource scope, specifying whether + the resource is associated with an organization. + items: + enum: + - organizations + type: string + type: array + explode: true + - description: >- + Limits the returned results to logs newer than the specified date. + This can be a date string 2019-04-30 (interpreted in UTC) or an + absolute timestamp that conforms to RFC3339. + in: query + name: since + schema: + format: date + type: string + - description: >- + Limits the returned results to logs older than the specified date. + This can be a date string 2019-04-30 (interpreted in UTC) or an + absolute timestamp that conforms to RFC3339. + in: query + name: before + schema: + format: date + type: string + - in: query + name: direction + schema: + default: desc + description: Sets sorting order. + enum: + - desc + - asc + type: string + - in: query + name: limit + schema: + default: 100 + description: >- + The number limits the objects to return. The cursor attribute may + be used to iterate over the next batch of objects if there are + more than the limit. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: cursor + schema: + description: >- + The cursor is an opaque token used to paginate through large sets + of records. It indicates the position from which to continue when + requesting the next set of records. A valid cursor value can be + obtained from the cursor object in the result_info structure of a + previous response. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaAuditLogsV2OrgResponseCollection' + description: Get organization audit logs successful response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/aaaSchemasApiResponseCommonFailure' + description: Get organization audit logs failed response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get organization audit logs (Version 2, Beta release) + tags: + - Audit Logs + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: organizations + resource_chain: + - logs + - audit + method: list + /organizations/{organization_id}/members:batchCreate: + post: + description: >- + Batch create multiple memberships that grant access to a specific + Organization. + operationId: Members_batchCreate + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiBatchCreateMembersRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiMember' + type: array + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Batch create organization members + tags: + - OrganizationMembers + /organizations/{organization_id}/profile: + get: + description: >- + Get an organizations profile if it exists. (Currently in Closed Beta - + see https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organizations_getProfile + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiProfileResponse' + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Get organization profile + tags: + - Organizations + x-stackql-sdk: + service: organizations + resource_chain: + - organization_profile + method: get + put: + description: >- + Modify organization profile. (Currently in Closed Beta - see + https://developers.cloudflare.com/fundamentals/organizations/) + operationId: Organizations_modifyProfile + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiProfile' + responses: + '204': + description: >- + There is no content to send for this request, but the headers may be + useful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Modify organization profile. + tags: + - Organizations + x-stackql-sdk: + service: organizations + resource_chain: + - organization_profile + method: update + /organizations/{organization_id}/shares: + get: + description: Lists all organization shares. + operationId: organization-shares-list + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + - description: Filter shares by status. + in: query + name: status + schema: + $ref: '#/components/schemas/resourceSharingShareStatus' + - description: Filter shares by kind. + in: query + name: kind + schema: + $ref: '#/components/schemas/resourceSharingShareKind' + - description: Filter shares by target_type. + in: query + name: target_type + schema: + $ref: '#/components/schemas/resourceSharingShareTargetType' + - description: Filter share resources by resource_types. + in: query + name: resource_types + schema: + items: + $ref: '#/components/schemas/resourceSharingResourceType' + type: array + explode: true + - description: Order shares by values in the given field. + in: query + name: order + schema: + default: created + enum: + - name + - created + type: string + - description: Direction to sort objects. + in: query + name: direction + schema: + default: asc + enum: + - asc + - desc + type: string + - description: Page number. + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page. + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingShareResponseCollection' + description: List organization shares response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List organization shares response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List organization shares response failure. + security: + - api_email: [] + api_key: [] + summary: List organization shares + tags: + - Resource Sharing + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false +components: + schemas: + aaaAuditLogAction: + description: Provides information about the action performed. + properties: + description: + description: A short description of the action performed. + example: Add Member + type: string + result: + description: The result of the action, indicating success or failure. + example: success + type: string + time: + description: A timestamp indicating when the action was logged. + example: '2024-04-26T17:31:07Z' + format: date-time + type: string + type: + description: A short string that describes the action that was performed. + example: create + type: string + type: object + aaaAuditLogRaw: + description: Provides raw information about the request and response. + properties: + cf_ray_id: + description: The Cloudflare Ray ID for the request. + example: 8e9b1c60ef9e1c9a + type: string + method: + description: The HTTP method of the request. + example: POST + type: string + status_code: + description: The HTTP response status code returned by the API. + example: 200 + type: integer + uri: + description: The URI of the request. + example: /accounts/4bb334f7c94c4a29a045f03944f072e5/members + type: string + user_agent: + description: The client's user agent string sent with the request. + example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Safari/605.1.15 + type: string + type: object + aaaAuditLogsV2Org: + properties: + action: + $ref: '#/components/schemas/aaaAuditLogAction' + actor: + description: Provides details about the actor who performed the action. + properties: + context: + enum: + - api_key + - api_token + - dash + - oauth + - origin_ca_key + example: dash + type: string + email: + description: The email of the actor who performed the action. + example: alice@example.com + format: email + type: string + id: + description: >- + The ID of the actor who performed the action. If a user + performed the action, this will be their User ID. + example: f6b5de0326bb5182b8a4840ee01ec774 + type: string + ip_address: + description: The IP address of the request that performed the action. + example: 198.41.129.166 + type: string + token_id: + description: >- + The API token ID when the actor context is an api_token or + oauth. + type: string + token_name: + description: >- + The API token name when the actor context is an api_token or + oauth. + type: string + type: + description: The type of actor. + enum: + - cloudflare_admin + - system + - user + example: user + type: string + type: object + id: + $ref: '#/components/schemas/aaaSchemasIdentifier' + organization: + description: Contains organization related information. + properties: + id: + description: A unique identifier for the organization. + example: 019c4f65e7607d8c9f6f6b58aa3aff50 + type: string + type: object + raw: + $ref: '#/components/schemas/aaaAuditLogRaw' + resource: + description: Provides details about the affected resource. + properties: + id: + description: The unique identifier for the affected resource. + type: string + product: + description: The Cloudflare product associated with the resource. + example: organizations + type: string + request: + type: object + response: + type: object + scope: + description: The scope of the resource. + type: object + type: + description: The type of the resource. + type: string + type: object + type: object + aaaAuditLogsV2OrgResponseCollection: + properties: + errors: + $ref: '#/components/schemas/aaaSchemasMessages' + result_info: + $ref: '#/components/schemas/aaaResultInfo' + success: + description: Indicates whether the API call was successful + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/aaaAuditLogsV2Org' + type: array + type: object + aaaResultInfo: + description: >- + Provides information about the result of the request, including count + and cursor. + properties: + count: + description: The number of records returned in the response. + example: '1' + type: string + cursor: + description: The cursor token used for pagination. + example: >- + ASqdKd7dKgxh-aZ8bm0mZos1BtW4BdEqifCzNkEeGRzi_5SN_-362Y8sF-C1TRn60_6rd3z2dIajf9EAPyQ_NmIeAMkacmaJPXipqvP7PLU4t72wyqBeJfjmjdE= + type: string + type: object + aaaSchemasApiResponseCommonFailure: + properties: + errors: + description: A list of error messages. + items: + properties: + message: + description: A text description of this message. + example: No route for the URI + type: string + required: + - message + type: object + uniqueItems: true + type: array + messages: + example: [] + items: + properties: + message: + type: string + type: object + uniqueItems: true + type: array + success: + description: Indicates whether the API call was failed + enum: + - false + example: false + type: boolean + required: + - success + - errors + type: object + aaaSchemasIdentifier: + description: A unique identifier for the audit log entry. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + aaaSchemasMessages: + example: [] + items: + properties: + message: + type: string + required: + - message + type: object + uniqueItems: true + type: array + organizationsApiAccount: + properties: + created_on: + format: date-time + type: string + readOnly: true + id: + type: string + name: + nullable: true + type: string + settings: + properties: + abuse_contact_email: + nullable: true + type: string + access_approval_expiry: + format: date-time + nullable: true + type: string + api_access_enabled: + nullable: true + type: boolean + default_nameservers: + deprecated: true + description: >- + Use [DNS + Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) + instead. Deprecated. + nullable: true + type: string + enforce_twofactor: + nullable: true + type: boolean + use_account_custom_ns_by_default: + deprecated: true + description: >- + Use [DNS + Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) + instead. Deprecated. + nullable: true + type: boolean + required: + - enforce_twofactor + - api_access_enabled + - access_approval_expiry + - abuse_contact_email + - use_account_custom_ns_by_default + - default_nameservers + type: object + type: + enum: + - standard + - enterprise + type: string + required: + - id + - name + - type + - settings + - created_on + type: object + organizationsApiBatchCreateMembersRequest: + properties: + members: + items: + $ref: '#/components/schemas/organizationsApiCreateSingleMember' + maxItems: 10 + type: array + required: + - members + type: object + organizationsApiCreateSingleMember: + properties: + status: + enum: + - active + - canceled + type: string + user: + properties: + email: + type: string + required: + - email + type: object + required: + - user + type: object + organizationsApiDeleteOrganizationResponse: + properties: + id: + type: string + required: + - id + type: object + organizationsApiMember: + properties: + create_time: + format: date-time + type: string + id: + $ref: '#/components/schemas/organizationsApiMemberID' + meta: + type: object + status: + enum: + - active + - canceled + type: string + update_time: + format: date-time + type: string + user: + $ref: '#/components/schemas/organizationsApiMemberSubjectUser' + required: + - id + - status + - user + - meta + - create_time + - update_time + type: object + organizationsApiMemberID: + description: Organization Member ID + example: a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8 + type: string + organizationsApiMemberSubjectUser: + properties: + email: + type: string + id: + type: string + name: + type: string + two_factor_authentication_enabled: + type: boolean + required: + - id + - email + - name + - two_factor_authentication_enabled + type: object + organizationsApiOrganization: + description: References an Organization in the Cloudflare data model. + properties: + create_time: + format: date-time + readOnly: true + type: string + id: + readOnly: true + $ref: '#/components/schemas/organizationsApiOrganizationID' + meta: + properties: + flags: + $ref: '#/components/schemas/organizationsApiOrganizationFlags' + managed_by: + type: string + readOnly: true + type: object + name: + type: string + parent: + properties: + id: + $ref: '#/components/schemas/organizationsApiOrganizationID' + name: + readOnly: true + type: string + required: + - id + - name + type: object + profile: + $ref: '#/components/schemas/organizationsApiProfile' + required: + - id + - name + - create_time + - meta + type: object + organizationsApiOrganizationFlags: + description: Enable features for Organizations. + properties: + account_creation: + type: string + account_deletion: + type: string + account_migration: + type: string + account_mobility: + type: string + sub_org_creation: + type: string + required: + - account_creation + - account_deletion + - account_migration + - account_mobility + - sub_org_creation + type: object + organizationsApiOrganizationID: + example: a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8 + title: Organization ID + type: string + organizationsApiPageTokenResultInfo: + properties: + next_page_token: + description: >- + Use this opaque token in the next request to retrieve the next page. + Parameters used to filter the retrieved list must remain in + subsequent requests with a page token. + type: string + total_size: + description: >- + Counts the total amount of items in a list with the applied filters. + The API omits next_page_token to indicate no more items in a + particular list. + type: integer + type: object + organizationsApiProfile: + properties: + business_address: + type: string + business_email: + type: string + business_name: + type: string + business_phone: + type: string + external_metadata: + type: string + required: + - business_name + - business_email + - business_phone + - business_address + - external_metadata + type: object + organizationsApiProfileResponse: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiProfile' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + organizationsApiV4ErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + type: object + success: + enum: + - false + type: boolean + required: + - success + - errors + - messages + type: object + organizationsApiV4Message: + $ref: '#/components/schemas/responseInfo' + resourceSharingAccountId: + description: Account identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingAccountName: + description: The display name of an account. + example: Account A + type: string + x-auditable: true + resourceSharingApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/resourceSharingV4errors' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + example: false + type: boolean + x-auditable: true + required: + - success + - errors + - result + type: object + resourceSharingCreated: + description: When the share was created. + example: '2023-09-21T18:56:32.624632Z' + format: date-time + type: string + x-auditable: true + resourceSharingModified: + description: When the share was modified. + example: '2023-09-21T18:56:32.624632Z' + format: date-time + type: string + x-auditable: true + resourceSharingOrganizationId: + description: Organization identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingResourceId: + description: Share Resource identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingResourceMeta: + description: Resource Metadata. + type: object + resourceSharingResourceResourceId: + description: Share Resource identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingResourceStatus: + description: Resource Status. + enum: + - active + - deleting + - deleted + type: string + x-auditable: true + resourceSharingResourceType: + description: Resource Type. + enum: + - custom-ruleset + - gateway-policy + - gateway-destination-ip + - gateway-block-page-settings + - gateway-extended-email-matching + type: string + x-auditable: true + resourceSharingResourceVersion: + description: Resource Version. + type: integer + x-auditable: true + resourceSharingResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: Total number of pages using the given per page. + example: 50 + type: number + type: object + resourceSharingShareId: + description: Share identifier tag. + example: 3fd85f74b32742f1bff64a85009dda07 + maxLength: 32 + type: string + x-auditable: true + resourceSharingShareKind: + enum: + - sent + - received + type: string + x-auditable: true + resourceSharingShareName: + description: The name of the share. + example: My Shared WAF Managed Rule + type: string + x-auditable: true + resourceSharingShareObject: + properties: + account_id: + $ref: '#/components/schemas/resourceSharingAccountId' + account_name: + $ref: '#/components/schemas/resourceSharingAccountName' + associated_recipient_count: + description: >- + The number of recipients in the 'associated' state. This field is + only included when requested via the 'include_recipient_counts' + parameter. + example: 10 + type: integer + associating_recipient_count: + description: >- + The number of recipients in the 'associating' state. This field is + only included when requested via the 'include_recipient_counts' + parameter. + example: 1 + type: integer + created: + $ref: '#/components/schemas/resourceSharingCreated' + disassociated_recipient_count: + description: >- + The number of recipients in the 'disassociated' state. This field is + only included when requested via the 'include_recipient_counts' + parameter. + example: 0 + type: integer + disassociating_recipient_count: + description: >- + The number of recipients in the 'disassociating' state. This field + is only included when requested via the 'include_recipient_counts' + parameter. + example: 0 + type: integer + id: + $ref: '#/components/schemas/resourceSharingShareId' + kind: + $ref: '#/components/schemas/resourceSharingShareKind' + modified: + $ref: '#/components/schemas/resourceSharingModified' + name: + $ref: '#/components/schemas/resourceSharingShareName' + organization_id: + $ref: '#/components/schemas/resourceSharingOrganizationId' + resources: + description: >- + A list of resources that are part of the share. This field is only + included when requested via the 'include_resources' parameter. + items: + $ref: '#/components/schemas/resourceSharingShareResourceObject' + type: array + status: + $ref: '#/components/schemas/resourceSharingShareStatus' + target_type: + $ref: '#/components/schemas/resourceSharingShareTargetType' + required: + - id + - name + - account_id + - account_name + - organization_id + - created + - modified + - status + - target_type + type: object + resourceSharingShareResourceObject: + properties: + created: + $ref: '#/components/schemas/resourceSharingCreated' + id: + $ref: '#/components/schemas/resourceSharingResourceId' + meta: + $ref: '#/components/schemas/resourceSharingResourceMeta' + modified: + $ref: '#/components/schemas/resourceSharingModified' + resource_account_id: + $ref: '#/components/schemas/resourceSharingAccountId' + resource_id: + $ref: '#/components/schemas/resourceSharingResourceResourceId' + resource_type: + $ref: '#/components/schemas/resourceSharingResourceType' + resource_version: + $ref: '#/components/schemas/resourceSharingResourceVersion' + status: + $ref: '#/components/schemas/resourceSharingResourceStatus' + required: + - id + - resource_id + - resource_type + - resource_account_id + - meta + - status + - created + - modified + - resource_version + type: object + resourceSharingShareResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/resourceSharingV4errors' + result: + items: + $ref: '#/components/schemas/resourceSharingShareObject' + nullable: true + type: array + success: + description: Whether the API call was successful. + example: true + type: boolean + result_info: + $ref: '#/components/schemas/resourceSharingResultInfo' + required: + - success + - errors + resourceSharingShareStatus: + enum: + - active + - deleting + - deleted + type: string + x-auditable: true + resourceSharingShareTargetType: + enum: + - account + - organization + type: string + x-auditable: true + resourceSharingV4error: + $ref: '#/components/schemas/responseInfo' + resourceSharingV4errors: + example: [] + items: + $ref: '#/components/schemas/resourceSharingV4error' + type: array + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + organizations: + id: cloudflare.organizations.organizations + name: organizations + title: Organizations + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_organization: + operation: + $ref: '#/paths/~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1organizations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1organizations~1{organization_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1organizations~1{organization_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1organizations~1{organization_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_members_batch_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1organizations~1{organization_id}~1members:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/list_by_account + - $ref: '#/components/x-stackQL-resources/organizations/methods/get' + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/list_by_organization + insert: + - $ref: '#/components/x-stackQL-resources/organizations/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/organizations/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/organizations/methods/update' + accounts: + id: cloudflare.organizations.accounts + name: accounts + title: Accounts + methods: + list: + operation: + $ref: '#/paths/~1organizations~1{organization_id}~1accounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + audit: + id: cloudflare.organizations.audit + name: audit + title: Audit + methods: + list: + operation: + $ref: '#/paths/~1organizations~1{organization_id}~1logs~1audit/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + organization_profile: + id: cloudflare.organizations.organization_profile + name: organization_profile + title: Organization Profile + methods: + list: + operation: + $ref: '#/paths/~1organizations~1{organization_id}~1profile/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1organizations~1{organization_id}~1profile/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/organization_profile/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/organization_profile/methods/update + shares: + id: cloudflare.organizations.shares + name: shares + title: Shares + methods: + list: + operation: + $ref: '#/paths/~1organizations~1{organization_id}~1shares/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/shares/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/origin_ca_certificates.yaml b/providers/src/cloudflare/v00.00.00000/services/origin_ca_certificates.yaml new file mode 100644 index 00000000..86fb3921 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/origin_ca_certificates.yaml @@ -0,0 +1,718 @@ +openapi: 3.0.3 +info: + title: origin_ca_certificates API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /certificates: + get: + description: >- + List all existing Origin CA certificates for a given zone. You can use + an Origin CA Key as your User Service Key or an API token when calling + this endpoint ([see above](#requests)). + operationId: origin-ca-list-certificates + parameters: + - in: query + name: zone_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of records per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: limit + schema: + description: Limit to the number of records returned. + type: integer + - in: query + name: offset + schema: + description: Offset the results + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateResponseCollection + description: List Certificates response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificates + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Certificates response failure + security: + - user_service_key: [] + - api_token: [] + summary: List Certificates + tags: + - Origin CA + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_ca_certificates + resource_chain: [] + method: list + post: + description: >- + Create an Origin CA certificate. You can use an Origin CA Key as your + User Service Key or an API token when calling this endpoint ([see + above](#requests)). + operationId: origin-ca-create-certificate + requestBody: + content: + application/json: + schema: + properties: + csr: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCsr' + hostnames: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHostnames' + request_type: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesRequestType' + requested_validity: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesRequestedValidity + required: + - hostnames + - request_type + - csr + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateResponseSingle + description: Create Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatesComponentsSchemasCertificate + csr: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCsr' + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasExpiresOn + hostnames: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnames + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + request_type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesRequestType + requested_validity: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesRequestedValidity + required: + - hostnames + - csr + - requested_validity + - request_type + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Certificate response failure + security: + - user_service_key: [] + - api_token: [] + summary: Create Certificate + tags: + - Origin CA + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_ca_certificates + resource_chain: [] + method: create + /certificates/{certificate_id}: + delete: + description: >- + Revoke an existing Origin CA certificate by its serial number. You can + use an Origin CA Key as your User Service Key or an API token when + calling this endpoint ([see above](#requests)). + operationId: origin-ca-revoke-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateRevokeResponse + description: Revoke Certificate response + 4XX: + content: + application/json: + schema: + properties: + result: + properties: + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + revoked_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesRevokedAt + type: object + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: Revoke Certificate response failure + security: + - user_service_key: [] + - api_token: [] + summary: Revoke Certificate + tags: + - Origin CA + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_ca_certificates + resource_chain: [] + method: delete + get: + description: >- + Get an existing Origin CA certificate by its serial number. You can use + an Origin CA Key as your User Service Key or an API token when calling + this endpoint ([see above](#requests)). + operationId: origin-ca-get-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateResponseSingle + description: Get Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatesComponentsSchemasCertificate + csr: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCsr' + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasExpiresOn + hostnames: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnames + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + request_type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesRequestType + requested_validity: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesRequestedValidity + required: + - hostnames + - csr + - requested_validity + - request_type + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Certificate response failure + security: + - user_service_key: [] + - api_token: [] + summary: Get Certificate + tags: + - Origin CA + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_ca_certificates + resource_chain: [] + method: get +components: + schemas: + tlsCertificatesAndHostnamesCertificateRevokeResponse: + properties: + result: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + revoked_at: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesRevokedAt' + type: object + type: object + tlsCertificatesAndHostnamesCertificates: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatesComponentsSchemasCertificate + csr: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCsr' + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasExpiresOn + hostnames: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHostnames' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + request_type: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesRequestType' + requested_validity: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesRequestedValidity' + required: + - hostnames + - csr + - requested_validity + - request_type + type: object + tlsCertificatesAndHostnamesCertificatesComponentsSchemasCertificate: + description: The Origin CA certificate. Will be newline-encoded. + example: |- + -----BEGIN CERTIFICATE----- + MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV + BAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln + aUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG + 9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo + wp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c + 1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI + WDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ + wIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR + BPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ + KoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D + hJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY + Q4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/ + ZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn + 29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2 + 97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w= + -----END CERTIFICATE----- + readOnly: true + type: string + tlsCertificatesAndHostnamesComponentsSchemasExpiresOn: + description: When the certificate will expire. + example: 2014-01-01 05:20:00 +0000 UTC + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesCsr: + description: The Certificate Signing Request (CSR). Must be newline-encoded. + example: |- + -----BEGIN CERTIFICATE REQUEST----- + MIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz + Y28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI + hvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL + Hu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8 + 4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc + N8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi + g7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I + uOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG + CSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt + cGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx + pTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/ + auRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH + yc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J + hXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs + dcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ== + -----END CERTIFICATE REQUEST----- + type: string + tlsCertificatesAndHostnamesHostnames: + description: >- + Array of hostnames or wildcard names bound to the certificate. Hostnames + must be fully qualified domain names (FQDNs) belonging to zones on your + account (e.g., `example.com` or `sub.example.com`). Wildcards are + supported only as a `*.` prefix for a single level (e.g., + `*.example.com`). Double wildcards (`*.*.example.com`) and interior + wildcards (`foo.*.example.com`) are not allowed. The wildcard suffix + must be a multi-label domain (`*.example.com` is valid, but `*.com` is + not). Unicode/IDN hostnames are accepted and automatically converted to + punycode. + example: + - example.com + - '*.example.com' + - sub.example.com + items: + minLength: 1 + type: string + x-auditable: true + maxItems: 100 + minItems: 1 + type: array + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesRequestType: + description: >- + Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" + (ecdsa), or "keyless-certificate" (for Keyless SSL servers). + enum: + - origin-rsa + - origin-ecc + - keyless-certificate + example: origin-rsa + type: string + x-auditable: true + tlsCertificatesAndHostnamesRequestedValidity: + default: 5475 + description: The number of days for which the certificate should be valid. + enum: + - 7 + - 30 + - 90 + - 365 + - 730 + - 1095 + - 5475 + example: 5475 + type: number + x-auditable: true + tlsCertificatesAndHostnamesRevokedAt: + description: When the certificate was revoked. + example: '2024-09-06T18:43:47.928893Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasCertificateResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificates' + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesSchemasCertificateResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificates' + required: + - success + - errors + - messages + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + certificates: + id: cloudflare.origin_ca_certificates.certificates + name: certificates + title: Certificates + methods: + list: + operation: + $ref: '#/paths/~1certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1certificates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1certificates~1{certificate_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1certificates~1{certificate_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/certificates/methods/get' + - $ref: '#/components/x-stackQL-resources/certificates/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/origin_post_quantum_encryption.yaml b/providers/src/cloudflare/v00.00.00000/services/origin_post_quantum_encryption.yaml new file mode 100644 index 00000000..d0fca343 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/origin_post_quantum_encryption.yaml @@ -0,0 +1,369 @@ +openapi: 3.0.3 +info: + title: origin_post_quantum_encryption API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/cache/origin_post_quantum_encryption: + get: + description: >- + Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms + when connecting to your origin. Preferred instructs Cloudflare to + opportunistically send a Post-Quantum keyshare in the first message to + the origin (for fastest connections when the origin supports and prefers + PQ), supported means that PQ algorithms are advertised but only used + when requested by the origin, and off means that PQ algorithms are not + advertised. + operationId: zone-cache-settings-get-origin-post-quantum-encryption-setting + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRef9444735ca60712dbcf8afd832eb5716a + required: + - success + - errors + - messages + description: Get Origin Post-Quantum Encryption setting response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Get Origin Post-Quantum Encryption setting response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Origin Post-Quantum Encryption setting + tags: + - Origin Post-Quantum + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - Zone Read + - Zone Write + x-cfPermissionsRequired: + enum: + - '#zone_settings:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_post_quantum_encryption + resource_chain: [] + method: get + put: + description: >- + Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms + when connecting to your origin. Preferred instructs Cloudflare to + opportunistically send a Post-Quantum keyshare in the first message to + the origin (for fastest connections when the origin supports and prefers + PQ), supported means that PQ algorithms are advertised but only used + when requested by the origin, and off means that PQ algorithms are not + advertised. + operationId: zone-cache-settings-change-origin-post-quantum-encryption-setting + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + value: + $ref: >- + #/components/schemas/cacheRulesOriginPostQuantumEncryptionValue + required: + - value + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRef9444735ca60712dbcf8afd832eb5716a + required: + - success + - errors + - messages + description: Change Origin Post-Quantum Encryption setting response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Change Origin Post-Quantum Encryption setting response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Change Origin Post-Quantum Encryption setting + tags: + - Origin Post-Quantum + x-api-token-group: + - Zone Settings Write + - Zone Write + x-cfPermissionsRequired: + enum: + - '#zone_settings:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_post_quantum_encryption + resource_chain: [] + method: update +components: + schemas: + cacheRulesApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + items: + type: object + minLength: 1 + type: array + $ref: '#/components/schemas/cacheRulesMessages' + messages: + example: [] + items: + type: object + type: array + $ref: '#/components/schemas/cacheRulesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + cacheRulesEditable: + description: Whether the setting is editable. + type: boolean + x-auditable: true + cacheRulesMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + cacheRulesModifiedOn: + description: The time when the setting was last modified. + format: date-time + type: string + x-auditable: true + cacheRulesOriginPostQuantumEncryptionValue: + default: supported + description: Value of the Origin Post Quantum Encryption Setting. + enum: + - preferred + - supported + - 'off' + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef9444735ca60712dbcf8afd832eb5716a: + properties: + editable: + $ref: '#/components/schemas/cacheRulesEditable' + id: + description: The identifier of the caching setting. + type: string + x-auditable: true + enum: + - origin_pqe + modified_on: + $ref: '#/components/schemas/cacheRulesModifiedOn' + description: Last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: Value of the Origin Post Quantum Encryption Setting. + type: string + x-auditable: true + default: supported + enum: + - preferred + - supported + - 'off' + required: + - id + - value + - editable + - id + - value + type: object + title: Origin Post-Quantum Encryption + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + origin_post_quantum_encryption: + id: cloudflare.origin_post_quantum_encryption.origin_post_quantum_encryption + name: origin_post_quantum_encryption + title: Origin Post Quantum Encryption + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1cache~1origin_post_quantum_encryption/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1cache~1origin_post_quantum_encryption/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/origin_post_quantum_encryption/methods/list + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/origin_post_quantum_encryption/methods/update diff --git a/providers/src/cloudflare/v00.00.00000/services/origin_pulls.yaml b/providers/src/cloudflare/v00.00.00000/services/origin_pulls.yaml deleted file mode 100644 index 6d767098..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/origin_pulls.yaml +++ /dev/null @@ -1,1224 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Per_hostname Authenticated Origin Pull - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - origin_pulls - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - config: - items: - $ref: '#/components/schemas/hostname_certid_input' - type: array - hostname_aop_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/hostname-authenticated-origin-pull' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - hostname_certid_input: - properties: - cert_id: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier' - enabled: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled' - hostname: - $ref: '#/components/schemas/schemas-hostname' - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - hostname-authenticated-origin-pull: - allOf: - - $ref: '#/components/schemas/hostname_certid_object' - properties: - cert_id: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier' - certificate: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate' - enabled: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled' - hostname: - $ref: '#/components/schemas/schemas-hostname' - id: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier' - private_key: - $ref: '#/components/schemas/schemas-private_key' - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - hostname-authenticated-origin-pull_components-schemas-identifier: - description: Certificate identifier tag. - example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 - maxLength: 36 - readOnly: true - type: string - hostname-authenticated-origin-pull_components-schemas-enabled: - description: Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association. - example: true - nullable: true - type: boolean - schemas-hostname: - description: The hostname on the origin for which the client certificate uploaded will be used. - example: app.example.com - maxLength: 255 - type: string - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - hostname_certid_object: - properties: - cert_id: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier' - cert_status: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status' - cert_updated_at: - $ref: '#/components/schemas/updated_at' - cert_uploaded_on: - $ref: '#/components/schemas/components-schemas-uploaded_on' - certificate: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate' - created_at: - $ref: '#/components/schemas/schemas-created_at' - enabled: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled' - expires_on: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on' - hostname: - $ref: '#/components/schemas/schemas-hostname' - issuer: - $ref: '#/components/schemas/issuer' - serial_number: - $ref: '#/components/schemas/serial_number' - signature: - $ref: '#/components/schemas/signature' - status: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status' - updated_at: - $ref: '#/components/schemas/updated_at' - hostname-authenticated-origin-pull_components-schemas-certificate: - description: The hostname certificate. - example: | - -----BEGIN CERTIFICATE----- - MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV - BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX - aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF - MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 - ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB - CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 - CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB - KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 - 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI - dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 - izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 - 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI - GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV - BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF - MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 - 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP - Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG - SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq - 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw - YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= - -----END CERTIFICATE----- - type: string - schemas-private_key: - description: The hostname certificate's private key. - example: | - -----BEGIN RSA PRIVATE KEY----- - MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG - dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn - abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid - tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py - FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE - ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb - HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ - axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb - +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g - +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv - KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 - 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo - /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu - iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 - N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe - VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB - vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U - lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR - 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 - mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX - dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe - PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS - fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W - qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T - lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi - -----END RSA PRIVATE KEY----- - type: string - hostname-authenticated-origin-pull_components-schemas-status: - description: Status of the certificate or the association. - enum: - - initializing - - pending_deployment - - pending_deletion - - active - - deleted - - deployment_timed_out - - deletion_timed_out - example: active - readOnly: true - updated_at: - description: The time when the certificate was updated. - example: '2100-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - components-schemas-uploaded_on: - description: The time when the certificate was uploaded. - example: '2019-10-28T18:11:23.37411Z' - format: date-time - type: string - schemas-created_at: - description: The time when the certificate was created. - example: '2100-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - hostname-authenticated-origin-pull_components-schemas-expires_on: - description: The date when the certificate expires. - example: '2100-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - issuer: - description: The certificate authority that issued the certificate. - example: GlobalSign - readOnly: true - type: string - serial_number: - description: The serial number on the uploaded certificate. - example: '6743787633689793699141714808227354901' - type: string - signature: - description: The type of hash used for the certificate. - example: SHA256WithRSA - readOnly: true - type: string - hostname-authenticated-origin-pull_components-schemas-certificate_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/hostname-authenticated-origin-pull' - type: array - components-schemas-certificate_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/schemas-certificateObject' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - schemas-certificateObject: - properties: - certificate: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate' - expires_on: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on' - id: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier' - issuer: - $ref: '#/components/schemas/issuer' - serial_number: - $ref: '#/components/schemas/serial_number' - signature: - $ref: '#/components/schemas/signature' - status: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status' - uploaded_on: - $ref: '#/components/schemas/components-schemas-uploaded_on' - hostname_aop_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/hostname_certid_object' - components-schemas-certificate_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/zone-authenticated-origin-pull' - type: array - zone-authenticated-origin-pull: - allOf: - - $ref: '#/components/schemas/certificateObject' - properties: - certificate: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate' - enabled: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled' - id: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier' - private_key: - $ref: '#/components/schemas/private_key' - certificateObject: - properties: - certificate: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate' - expires_on: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-expires_on' - id: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier' - issuer: - $ref: '#/components/schemas/issuer' - signature: - $ref: '#/components/schemas/signature' - status: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-status' - uploaded_on: - $ref: '#/components/schemas/schemas-uploaded_on' - zone-authenticated-origin-pull_components-schemas-certificate: - description: The zone's leaf certificate. - example: | - -----BEGIN CERTIFICATE----- - MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV - BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX - aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF - MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 - ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB - CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 - CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB - KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 - 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI - dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 - izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 - 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI - GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV - BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF - MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 - 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP - Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG - SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq - 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw - YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= - -----END CERTIFICATE----- - type: string - zone-authenticated-origin-pull_components-schemas-enabled: - description: Indicates whether zone-level authenticated origin pulls is enabled. - example: true - type: boolean - zone-authenticated-origin-pull_components-schemas-identifier: - description: Certificate identifier tag. - example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 - maxLength: 36 - readOnly: true - type: string - private_key: - description: The zone's private key. - example: | - -----BEGIN RSA PRIVATE KEY----- - MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG - dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn - abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid - tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py - FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE - ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb - HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ - axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb - +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g - +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv - KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 - 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo - /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu - iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 - N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe - VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB - vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U - lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR - 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 - mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX - dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe - PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS - fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W - qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T - lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi - -----END RSA PRIVATE KEY----- - type: string - zone-authenticated-origin-pull_components-schemas-expires_on: - description: When the certificate from the authority expires. - example: '2100-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - zone-authenticated-origin-pull_components-schemas-status: - description: Status of the certificate activation. - enum: - - initializing - - pending_deployment - - pending_deletion - - active - - deleted - - deployment_timed_out - - deletion_timed_out - example: active - schemas-uploaded_on: - description: This is the time the certificate was uploaded. - example: '2019-10-28T18:11:23.37411Z' - format: date-time - type: string - certificate_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - enabled_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - enabled: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled' - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_origin_tls_client_auth_hostnames: - id: cloudflare.origin_pulls.zones_origin_tls_client_auth_hostnames - name: zones_origin_tls_client_auth_hostnames - title: Zones Origin Tls Client Auth Hostnames - methods: - per_hostname_authenticated_origin_pull_enable_or_disable_a_hostname_for_client_authentication: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames/put' - response: - mediaType: application/json - openAPIDocKey: '200' - per_hostname_authenticated_origin_pull_get_the_hostname_status_for_client_authentication: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1{hostname}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _per_hostname_authenticated_origin_pull_get_the_hostname_status_for_client_authentication: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1{hostname}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth_hostnames/methods/per_hostname_authenticated_origin_pull_get_the_hostname_status_for_client_authentication' - insert: [] - update: [] - delete: [] - zones_origin_tls_client_auth_hostnames_certificates: - id: cloudflare.origin_pulls.zones_origin_tls_client_auth_hostnames_certificates - name: zones_origin_tls_client_auth_hostnames_certificates - title: Zones Origin Tls Client Auth Hostnames Certificates - methods: - per_hostname_authenticated_origin_pull_list_certificates: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _per_hostname_authenticated_origin_pull_list_certificates: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - per_hostname_authenticated_origin_pull_upload_a_hostname_client_certificate: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1certificates/post' - response: - mediaType: application/json - openAPIDocKey: '200' - per_hostname_authenticated_origin_pull_delete_hostname_client_certificate: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1certificates~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - per_hostname_authenticated_origin_pull_get_the_hostname_client_certificate: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1certificates~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _per_hostname_authenticated_origin_pull_get_the_hostname_client_certificate: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1hostnames~1certificates~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth_hostnames_certificates/methods/per_hostname_authenticated_origin_pull_list_certificates' - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth_hostnames_certificates/methods/per_hostname_authenticated_origin_pull_get_the_hostname_client_certificate' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth_hostnames_certificates/methods/per_hostname_authenticated_origin_pull_delete_hostname_client_certificate' - zones_origin_tls_client_auth: - id: cloudflare.origin_pulls.zones_origin_tls_client_auth - name: zones_origin_tls_client_auth - title: Zones Origin Tls Client Auth - methods: - zone_level_authenticated_origin_pulls_list_certificates: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_authenticated_origin_pulls_list_certificates: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_authenticated_origin_pulls_upload_certificate: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_authenticated_origin_pulls_delete_certificate: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_authenticated_origin_pulls_get_certificate_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_authenticated_origin_pulls_get_certificate_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth/methods/zone_level_authenticated_origin_pulls_list_certificates' - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth/methods/zone_level_authenticated_origin_pulls_get_certificate_details' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth/methods/zone_level_authenticated_origin_pulls_delete_certificate' - zones_origin_tls_client_auth_settings: - id: cloudflare.origin_pulls.zones_origin_tls_client_auth_settings - name: zones_origin_tls_client_auth_settings - title: Zones Origin Tls Client Auth Settings - methods: - zone_level_authenticated_origin_pulls_get_enablement_setting_for_zone: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_level_authenticated_origin_pulls_get_enablement_setting_for_zone: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_authenticated_origin_pulls_set_enablement_for_zone: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1origin_tls_client_auth~1settings/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_origin_tls_client_auth_settings/methods/zone_level_authenticated_origin_pulls_get_enablement_setting_for_zone' - insert: [] - update: [] - delete: [] -paths: - '/zones/{zone_identifier}/origin_tls_client_auth/hostnames': - put: - description: 'Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association.' - operationId: per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - config: - $ref: '#/components/schemas/config' - required: - - config - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/hostname_aop_response_collection' - description: Enable or Disable a Hostname for Client Authentication response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/hostname_aop_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Enable or Disable a Hostname for Client Authentication response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Enable or Disable a Hostname for Client Authentication - tags: - - Per-hostname Authenticated Origin Pull - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates': - get: - operationId: per-hostname-authenticated-origin-pull-list-certificates - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection' - description: List Certificates response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Certificates response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Certificates - tags: - - Per-hostname Authenticated Origin Pull - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed. - operationId: per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - certificate: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate' - private_key: - $ref: '#/components/schemas/schemas-private_key' - required: - - certificate - - private_key - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-certificate_response_single' - description: Upload a Hostname Client Certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Upload a Hostname Client Certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Upload a Hostname Client Certificate - tags: - - Per-hostname Authenticated Origin Pull - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates/{identifier}': - delete: - operationId: per-hostname-authenticated-origin-pull-delete-hostname-client-certificate - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-certificate_response_single' - description: Delete Hostname Client Certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Hostname Client Certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Hostname Client Certificate - tags: - - Per-hostname Authenticated Origin Pull - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Get the certificate by ID to be used for client authentication on a hostname. - operationId: per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-certificate_response_single' - description: Get the Hostname Client Certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get the Hostname Client Certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get the Hostname Client Certificate - tags: - - Per-hostname Authenticated Origin Pull - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/origin_tls_client_auth/hostnames/{hostname}': - get: - operationId: per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication - parameters: - - in: path - name: hostname - required: true - schema: - $ref: '#/components/schemas/schemas-hostname' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/hostname_aop_single_response' - description: Get the Hostname Status for Client Authentication response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/hostname_aop_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get the Hostname Status for Client Authentication response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get the Hostname Status for Client Authentication - tags: - - Per-hostname Authenticated Origin Pull - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/origin_tls_client_auth': - get: - operationId: zone-level-authenticated-origin-pulls-list-certificates - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-certificate_response_collection' - description: List Certificates response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-certificate_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Certificates response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Certificates - tags: - - Zone-Level Authenticated Origin Pulls - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: 'Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.' - operationId: zone-level-authenticated-origin-pulls-upload-certificate - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - certificate: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate' - private_key: - $ref: '#/components/schemas/private_key' - required: - - certificate - - private_key - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_single' - description: Upload Certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Upload Certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Upload Certificate - tags: - - Zone-Level Authenticated Origin Pulls - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/origin_tls_client_auth/settings': - get: - description: Get whether zone-level authenticated origin pulls is enabled or not. It is false by default. - operationId: zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/enabled_response' - description: Get Enablement Setting for Zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/enabled_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Enablement Setting for Zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Enablement Setting for Zone - tags: - - Zone-Level Authenticated Origin Pulls - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use. - operationId: zone-level-authenticated-origin-pulls-set-enablement-for-zone - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - enabled: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled' - required: - - enabled - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/enabled_response' - description: Set Enablement for Zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/enabled_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Set Enablement for Zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Set Enablement for Zone - tags: - - Zone-Level Authenticated Origin Pulls - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/origin_tls_client_auth/{identifier}': - delete: - operationId: zone-level-authenticated-origin-pulls-delete-certificate - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_single' - description: Delete Certificate response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Certificate response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Certificate - tags: - - Zone-Level Authenticated Origin Pulls - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - operationId: zone-level-authenticated-origin-pulls-get-certificate-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_single' - description: Get Certificate Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Certificate Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Certificate Details - tags: - - Zone-Level Authenticated Origin Pulls - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true diff --git a/providers/src/cloudflare/v00.00.00000/services/origin_tls_client_auth.yaml b/providers/src/cloudflare/v00.00.00000/services/origin_tls_client_auth.yaml new file mode 100644 index 00000000..6b967d66 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/origin_tls_client_auth.yaml @@ -0,0 +1,2197 @@ +openapi: 3.0.3 +info: + title: origin_tls_client_auth API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/origin_tls_client_auth: + get: + description: >- + Lists all client certificates configured for zone-level authenticated + origin pulls. + operationId: zone-level-authenticated-origin-pulls-list-certificates + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseCollection + description: List Certificates response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPull + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Certificates response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Certificates + tags: + - Zone-Level Authenticated Origin Pulls + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: [] + method: list + post: + description: >- + Upload your own certificate you want Cloudflare to use for + edge-to-origin communication to override the shared certificate. Please + note that it is important to keep only one certificate active. Also, + make sure to enable zone-level authenticated origin pulls by making a + PUT call to settings endpoint to see the uploaded certificate in use. + operationId: zone-level-authenticated-origin-pulls-upload-certificate + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasCertificate + private_key: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPrivateKey' + required: + - certificate + - private_key + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseSingle + description: Upload Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasCertificate + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + private_key: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPrivateKey + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasExpiresOn + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasStatus + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasUploadedOn + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Upload Certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload Certificate + tags: + - Zone-Level Authenticated Origin Pulls + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: [] + method: create + /zones/{zone_id}/origin_tls_client_auth/hostnames: + get: + description: >- + List certificate ID - hostname associations for the given zone. Shows + which hostnames are associated to which certificates for authenticated + origin pulls. + operationId: per-hostname-authenticated-origin-pull-list-hostname-associations + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 50 + description: Number of associations per page. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: status + schema: + description: >- + Filter associations by status. Use comma-separated values to + filter by multiple statuses, or "all" to include every status. + Defaults to "active" if not provided. + enum: + - active + - pending_deployment + - pending_deletion + - deleted + - deployment_timed_out + - deletion_timed_out + - all + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAssocResponseCollection + description: List Hostname Associations response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: >- + Total results returned based on your search + parameters. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: Total pages available of results. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAssocObject + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Hostname Associations response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Hostname Associations + tags: + - Per-hostname Authenticated Origin Pull + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - hostnames + method: update + put: + description: >- + Associate a hostname to a certificate and enable, disable or invalidate + the association. If disabled, client certificate will not be sent to the + hostname even if activated at the zone level. 100 maximum associations + on a single certificate are allowed. Note: Use a null value for + parameter *enabled* to invalidate the association. + operationId: >- + per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesConfig' + required: + - config + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAopResponseCollection + description: Enable or Disable a Hostname for Client Authentication response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPull + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: >- + Enable or Disable a Hostname for Client Authentication response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Enable or Disable a Hostname for Client Authentication + tags: + - Per-hostname Authenticated Origin Pull + x-api-token-group: + - SSL and Certificates Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates: + get: + description: >- + Lists all client certificates configured for per-hostname authenticated + origin pulls on the zone. + operationId: per-hostname-authenticated-origin-pull-list-certificates + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificateResponseCollection + description: List Certificates response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateObject + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Certificates response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Certificates + tags: + - Per-hostname Authenticated Origin Pull + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - hostname_certificates + method: list + post: + description: >- + Upload a certificate to be used for client authentication on a hostname. + 10 hostname certificates per zone are allowed. + operationId: >- + per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificate + private_key: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasPrivateKey + required: + - certificate + - private_key + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificateResponseSingle + description: Upload a Hostname Client Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefD182888b36f93a765d9ce5aefa3009e9 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Upload a Hostname Client Certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload a Hostname Client Certificate + tags: + - Per-hostname Authenticated Origin Pull + x-api-token-group: + - SSL and Certificates Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - hostname_certificates + method: create + /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}: + delete: + description: >- + Removes a client certificate used for authenticated origin pulls on a + specific hostname. Note: Before deleting the certificate, you must first + invalidate the hostname for client authentication by sending a PUT + request with `enabled` set to null. After invalidating the association, + the certificate can be safely deleted. + operationId: >- + per-hostname-authenticated-origin-pull-delete-hostname-client-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificateResponseSingle + description: Delete Hostname Client Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefD182888b36f93a765d9ce5aefa3009e9 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Hostname Client Certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Hostname Client Certificate + tags: + - Per-hostname Authenticated Origin Pull + x-api-token-group: + - SSL and Certificates Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - hostname_certificates + method: delete + get: + description: >- + Get the certificate by ID to be used for client authentication on a + hostname. + operationId: >- + per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificateResponseSingle + description: Get the Hostname Client Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: >- + #/components/schemas/unnamedSchemaRefD182888b36f93a765d9ce5aefa3009e9 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get the Hostname Client Certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Hostname Client Certificate + tags: + - Per-hostname Authenticated Origin Pull + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - hostname_certificates + method: get + /zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}: + get: + description: >- + Retrieves the client certificate authentication status for a specific + hostname, showing whether authenticated origin pulls are enabled. + operationId: >- + per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication + parameters: + - in: path + name: hostname + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasHostname' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAopSingleResponse + description: Get the Hostname Status for Client Authentication response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + cert_id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + cert_status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + cert_updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt + cert_uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUploadedOn + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificate + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCreatedAt + readOnly: true + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasEnabled + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasExpiresOn + hostname: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasHostname + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + serial_number: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSerialNumber + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get the Hostname Status for Client Authentication response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Hostname Status for Client Authentication + tags: + - Per-hostname Authenticated Origin Pull + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - hostnames + method: get + /zones/{zone_id}/origin_tls_client_auth/settings: + get: + description: >- + Get whether zone-level authenticated origin pulls is enabled or not. It + is false by default. + operationId: zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesEnabledResponse + description: Get Enablement Setting for Zone response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Enablement Setting for Zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Enablement Setting for Zone + tags: + - Zone-Level Authenticated Origin Pulls + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - settings + method: get + put: + description: >- + Enable or disable zone-level authenticated origin pulls. 'enabled' + should be set true either before/after the certificate is uploaded to + see the certificate in use. + operationId: zone-level-authenticated-origin-pulls-set-enablement-for-zone + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + required: + - enabled + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesEnabledResponse + description: Set Enablement for Zone response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Set Enablement for Zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set Enablement for Zone + tags: + - Zone-Level Authenticated Origin Pulls + x-api-token-group: + - SSL and Certificates Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: + - settings + method: update + /zones/{zone_id}/origin_tls_client_auth/{certificate_id}: + delete: + description: >- + Removes a client certificate used for zone-level authenticated origin + pulls. + operationId: zone-level-authenticated-origin-pulls-delete-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseSingle + description: Delete Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasCertificate + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + private_key: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPrivateKey + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasExpiresOn + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasStatus + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasUploadedOn + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Certificate + tags: + - Zone-Level Authenticated Origin Pulls + x-api-token-group: + - SSL and Certificates Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: [] + method: delete + get: + description: >- + Retrieves details for a specific client certificate used in zone-level + authenticated origin pulls. + operationId: zone-level-authenticated-origin-pulls-get-certificate-details + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseSingle + description: Get Certificate Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasCertificate + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + private_key: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPrivateKey + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasExpiresOn + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + signature: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSignature + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasStatus + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasUploadedOn + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Certificate Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Certificate Details + tags: + - Zone-Level Authenticated Origin Pulls + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: origin_tls_client_auth + resource_chain: [] + method: get +components: + schemas: + tlsCertificatesAndHostnamesCertId: + description: Certificate identifier tag. + example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 + maxLength: 36 + type: string + x-auditable: true + tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPull + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesComponentsSchemasCertificateResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPull + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesComponentsSchemasCreatedAt: + description: The time when the certificate was created. + example: '2100-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt: + description: The time when the certificate was updated. + example: '2100-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesComponentsSchemasUploadedOn: + description: The time when the certificate was uploaded. + example: '2019-10-28T18:11:23.37411Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesConfig: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHostnameCertidInput' + type: array + tlsCertificatesAndHostnamesEnabledResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesHostnameAopResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPull + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesHostnameAopSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesHostnameCertidObject' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesHostnameAssocObject: + properties: + cert_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertId' + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCreatedAt + readOnly: true + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasEnabled + hostname: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasHostname' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt + readOnly: true + type: object + tlsCertificatesAndHostnamesHostnameAssocResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total results returned based on your search parameters. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 50 + type: number + total_count: + description: Total results available without any search parameters. + example: 1 + type: number + total_pages: + description: Total pages available of results. + example: 1 + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAssocObject + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPull: + properties: + cert_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificate + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasEnabled + hostname: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasHostname' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + private_key: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasPrivateKey' + cert_status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + cert_updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt + cert_uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUploadedOn + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCreatedAt + readOnly: true + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasExpiresOn + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + serial_number: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSerialNumber' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt + readOnly: true + type: object + tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificate: + description: The hostname certificate. + example: | + -----BEGIN CERTIFICATE----- + MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV + BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX + aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF + MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 + ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB + CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 + CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB + KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 + 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI + dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 + izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 + 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI + GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV + BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF + MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 + 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP + Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG + SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq + 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw + YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= + -----END CERTIFICATE----- + type: string + x-stainless-terraform: + normalize_newlines: true + tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificateResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateObject + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificateResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateObject + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasEnabled: + description: >- + Indicates whether hostname-level authenticated origin pulls is enabled. + A null value voids the association. + example: true + nullable: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasExpiresOn: + description: The date when the certificate expires. + example: '2100-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus: + description: Status of the certificate or the association. + enum: + - initializing + - pending_deployment + - pending_deletion + - active + - deleted + - deployment_timed_out + - deletion_timed_out + example: active + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesHostnameCertidInput: + properties: + cert_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertId' + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasEnabled + hostname: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasHostname' + type: object + tlsCertificatesAndHostnamesHostnameCertidObject: + properties: + cert_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + cert_status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + cert_updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt + cert_uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUploadedOn + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificate + created_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasCreatedAt + readOnly: true + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasEnabled + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasExpiresOn + hostname: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasHostname' + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + serial_number: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSerialNumber' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + updated_at: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUpdatedAt + readOnly: true + type: object + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesIssuer: + description: The certificate authority that issued the certificate. + example: GlobalSign + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesPrivateKey: + description: The zone's private key. + example: | + -----BEGIN RSA PRIVATE KEY----- + MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG + dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn + abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid + tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py + FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE + ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb + HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ + axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb + +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g + +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv + KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 + 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo + /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu + iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 + N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe + VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB + vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U + lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR + 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 + mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX + dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe + PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS + fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W + qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T + lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi + -----END RSA PRIVATE KEY----- + type: string + x-sensitive: true + tlsCertificatesAndHostnamesSchemasCertificateObject: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificate + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasExpiresOn + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + serial_number: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSerialNumber' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUploadedOn + type: object + tlsCertificatesAndHostnamesSchemasHostname: + description: >- + The hostname on the origin for which the client certificate uploaded + will be used. + example: app.example.com + maxLength: 255 + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasPrivateKey: + description: The hostname certificate's private key. + example: | + -----BEGIN RSA PRIVATE KEY----- + MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG + dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn + abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid + tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py + FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE + ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb + HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ + axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb + +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g + +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv + KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 + 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo + /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu + iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 + N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe + VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB + vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U + lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR + 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 + mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX + dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe + PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS + fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W + qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T + lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi + -----END RSA PRIVATE KEY----- + type: string + x-sensitive: true + tlsCertificatesAndHostnamesSchemasUploadedOn: + description: This is the time the certificate was uploaded. + example: '2019-10-28T18:11:23.37411Z' + format: date-time + type: string + x-auditable: true + tlsCertificatesAndHostnamesSerialNumber: + description: The serial number on the uploaded certificate. + example: '6743787633689793699141714808227354901' + type: string + x-auditable: true + tlsCertificatesAndHostnamesSignature: + description: The type of hash used for the certificate. + example: SHA256WithRSA + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesZoneAuthenticatedOriginPull: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasCertificate + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + private_key: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPrivateKey' + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasExpiresOn + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasStatus + uploaded_on: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasUploadedOn' + type: object + tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasCertificate: + description: The zone's leaf certificate. + example: | + -----BEGIN CERTIFICATE----- + MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV + BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX + aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF + MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 + ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB + CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 + CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB + KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 + 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI + dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 + izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 + 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI + GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV + BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF + MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 + 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP + Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG + SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq + 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw + YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= + -----END CERTIFICATE----- + type: string + x-stainless-terraform: + normalize_newlines: true + tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasEnabled: + description: Indicates whether zone-level authenticated origin pulls is enabled. + example: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasExpiresOn: + description: When the certificate from the authority expires. + example: '2100-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + tlsCertificatesAndHostnamesZoneAuthenticatedOriginPullComponentsSchemasStatus: + description: Status of the certificate activation. + enum: + - initializing + - pending_deployment + - pending_deletion + - active + - deleted + - deployment_timed_out + - deletion_timed_out + example: active + type: string + x-auditable: true + unnamedSchemaRefD182888b36f93a765d9ce5aefa3009e9: + properties: + certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasCertificate + expires_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasExpiresOn + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + issuer: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIssuer' + serial_number: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSerialNumber' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSignature' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesHostnameAuthenticatedOriginPullComponentsSchemasStatus + uploaded_on: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasUploadedOn + type: object + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + origin_tls_client_auth: + id: cloudflare.origin_tls_client_auth.origin_tls_client_auth + name: origin_tls_client_auth + title: Origin Tls Client Auth + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1origin_tls_client_auth/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1origin_tls_client_auth/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1{certificate_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1{certificate_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/origin_tls_client_auth/methods/get + - $ref: >- + #/components/x-stackQL-resources/origin_tls_client_auth/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/origin_tls_client_auth/methods/create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/origin_tls_client_auth/methods/delete + replace: [] + hostnames: + id: cloudflare.origin_tls_client_auth.hostnames + name: hostnames + title: Hostnames + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1hostnames/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + per_hostname_authenticated_origin_pull_enable_or_disable_a_hostname_for_client_authentication: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1hostnames/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1hostnames~1{hostname}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/get' + - $ref: '#/components/x-stackQL-resources/hostnames/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/hostnames/methods/per_hostname_authenticated_origin_pull_enable_or_disable_a_hostname_for_client_authentication + hostname_certificates: + id: cloudflare.origin_tls_client_auth.hostname_certificates + name: hostname_certificates + title: Hostname Certificates + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1hostnames~1certificates/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1hostnames~1certificates/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1hostnames~1certificates~1{certificate_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1hostnames~1certificates~1{certificate_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hostname_certificates/methods/get' + - $ref: >- + #/components/x-stackQL-resources/hostname_certificates/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/hostname_certificates/methods/create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/hostname_certificates/methods/delete + replace: [] + settings: + id: cloudflare.origin_tls_client_auth.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1origin_tls_client_auth~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/page_rules.yaml b/providers/src/cloudflare/v00.00.00000/services/page_rules.yaml new file mode 100644 index 00000000..7a5a3f33 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/page_rules.yaml @@ -0,0 +1,1073 @@ +openapi: 3.0.3 +info: + title: page_rules API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/pagerules: + get: + description: Fetches Page Rules in a zone. + operationId: page-rules-list-page-rules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: order + schema: + default: priority + description: The field used to sort returned Page Rules. + enum: + - status + - priority + type: string + - in: query + name: direction + schema: + default: desc + description: The direction used to sort returned Page Rules. + enum: + - asc + - desc + type: string + - in: query + name: match + schema: + default: all + description: >- + When set to `all`, all the search requirements must match. When + set to `any`, only one of the search requirements has to match. + enum: + - any + - all + type: string + - in: query + name: status + schema: + default: disabled + description: The status of the Page Rule. + enum: + - active + - disabled + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + $ref: '#/components/schemas/zonesSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/zonesPageRule' + type: array + required: + - success + - errors + - messages + type: object + description: List Page Rules response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: List Page Rules response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Page Rules + tags: + - Page Rules + x-api-token-group: + - Zone Read + - Zone Write + - Page Rules Write + - Page Rules Read + x-stackql-sdk: + service: page_rules + resource_chain: [] + method: list + post: + description: Creates a new Page Rule. + operationId: page-rules-create-a-page-rule + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + actions: + $ref: '#/components/schemas/zonesActions' + priority: + $ref: '#/components/schemas/zonesPriority' + status: + $ref: '#/components/schemas/zonesStatus' + targets: + $ref: '#/components/schemas/zonesTargets' + required: + - targets + - actions + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + $ref: '#/components/schemas/zonesSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/zonesPageRule' + required: + - success + - errors + - messages + description: Create a Page Rule response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Create a Page Rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Page Rule + tags: + - Page Rules + x-api-token-group: + - Zone Write + - Page Rules Write + x-stackql-sdk: + service: page_rules + resource_chain: [] + method: create + /zones/{zone_id}/pagerules/settings: + get: + deprecated: true + description: >- + Returns a list of settings (and their details) that Page Rules can apply + to matching requests. + operationId: available-page-rules-settings-list-available-page-rules-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + $ref: '#/components/schemas/zonesSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/zonesSettings' + required: + - success + - errors + - messages + type: object + description: List available Page Rules settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: List available Page Rules settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List available Page Rules settings + tags: + - Available Page Rules settings + x-api-token-group: + - Zone Read + - Zone Write + - Page Rules Write + - Page Rules Read + /zones/{zone_id}/pagerules/{pagerule_id}: + delete: + description: Deletes an existing Page Rule. + operationId: page-rules-delete-a-page-rule + parameters: + - in: path + name: pagerule_id + schema: + $ref: '#/components/schemas/zonesSchemasIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseSingleId' + description: Delete a Page Rule response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Delete a Page Rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Page Rule + tags: + - Page Rules + x-api-token-group: + - Zone Write + - Page Rules Write + x-stackql-sdk: + service: page_rules + resource_chain: [] + method: delete + get: + description: Fetches the details of a Page Rule. + operationId: page-rules-get-a-page-rule + parameters: + - in: path + name: pagerule_id + schema: + $ref: '#/components/schemas/zonesSchemasIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + $ref: '#/components/schemas/zonesSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/zonesPageRule' + required: + - success + - errors + - messages + description: Get a Page Rule response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Get a Page Rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Page Rule + tags: + - Page Rules + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - 'Zero Trust: PII Read' + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + - 'Access: Apps and Policies Revoke' + - 'Access: Mutual TLS Certificates Write' + - 'Access: Organizations, Identity Providers, and Groups Write' + - Zone Settings Write + - Zone Settings Read + - Zone Read + - DNS Read + - Workers Scripts Write + - Workers Scripts Read + - Zone Write + - Workers Routes Write + - Workers Routes Read + - Stream Write + - Stream Read + - SSL and Certificates Write + - SSL and Certificates Read + - Logs Write + - Logs Read + - Cache Purge + - Page Rules Write + - Page Rules Read + - Load Balancers Write + - Load Balancers Read + - Firewall Services Write + - Firewall Services Read + - DNS Write + - Apps Write + - Analytics Read + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: page_rules + resource_chain: [] + method: get + patch: + description: Updates one or more fields of an existing Page Rule. + operationId: page-rules-edit-a-page-rule + parameters: + - in: path + name: pagerule_id + schema: + $ref: '#/components/schemas/zonesSchemasIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + actions: + $ref: '#/components/schemas/zonesActions' + priority: + $ref: '#/components/schemas/zonesPriority' + status: + $ref: '#/components/schemas/zonesStatus' + targets: + $ref: '#/components/schemas/zonesTargets' + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + $ref: '#/components/schemas/zonesSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/zonesPageRule' + required: + - success + - errors + - messages + description: Edit a Page Rule response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Edit a Page Rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit a Page Rule + tags: + - Page Rules + x-api-token-group: + - Zone Write + - Page Rules Write + x-stackql-sdk: + service: page_rules + resource_chain: [] + method: edit + put: + description: >- + Replaces the configuration of an existing Page Rule. The configuration + of the updated Page Rule will exactly match the data passed in the API + request. + operationId: page-rules-update-a-page-rule + parameters: + - in: path + name: pagerule_id + schema: + $ref: '#/components/schemas/zonesSchemasIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + actions: + $ref: '#/components/schemas/zonesActions' + priority: + $ref: '#/components/schemas/zonesPriority' + status: + $ref: '#/components/schemas/zonesStatus' + targets: + $ref: '#/components/schemas/zonesTargets' + required: + - targets + - actions + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + $ref: '#/components/schemas/zonesSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/zonesPageRule' + required: + - success + - errors + - messages + description: Update a Page Rule response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Update a Page Rule response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Page Rule + tags: + - Page Rules + x-api-token-group: + - Zone Write + - Page Rules Write + x-stackql-sdk: + service: page_rules + resource_chain: [] + method: update +components: + schemas: + zonesActions: + description: >- + The set of actions to perform if the targets of this rule match the + request. Actions can redirect to another URL or override settings, but + not both. + example: + - id: browser_check + value: 'on' + items: + type: object + title: Always Use HTTPS + properties: + id: + description: >- + If enabled, any `http://`` URL is converted to `https://` through + a 301 redirect. + enum: + - always_use_https + type: string + x-auditable: true + value: + description: The status of Automatic HTTPS Rewrites. + enum: + - 'on' + - 'off' + example: 'on' + type: string + x-auditable: true + type: array + x-stainless-skip: + - terraform + zonesCreatedOn: + description: The timestamp of when the Page Rule was created. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + zonesModifiedOn: + description: The timestamp of when the Page Rule was last modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + zonesPageRule: + properties: + actions: + $ref: '#/components/schemas/zonesActions' + created_on: + $ref: '#/components/schemas/zonesCreatedOn' + readOnly: true + id: + $ref: '#/components/schemas/zonesSchemasIdentifier' + modified_on: + $ref: '#/components/schemas/zonesModifiedOn' + readOnly: true + priority: + $ref: '#/components/schemas/zonesPriority' + status: + $ref: '#/components/schemas/zonesStatus' + targets: + $ref: '#/components/schemas/zonesTargets' + required: + - id + - targets + - actions + - priority + - status + - modified_on + - created_on + type: object + zonesPriority: + default: 1 + description: >- + The priority of the rule, used to define which Page Rule is processed + over another. A higher number indicates a higher priority. For example, + if you have a catch-all Page Rule (rule A: `/images/*`) but want a more + specific Page Rule to take precedence (rule B: `/images/special/*`), + specify a higher priority for rule B so it overrides rule A. + type: integer + x-auditable: true + zonesSchemasApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/zonesSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + zonesSchemasApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + $ref: '#/components/schemas/zonesSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/zonesSchemasIdentifier' + required: + - id + type: object + required: + - success + - errors + - messages + zonesSchemasIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + zonesSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + zonesSettings: + description: Settings available for the zone. + example: + - id: browser_check + properties: + - name: value + type: toggle + - id: browser_cache_ttl + properties: + - max: 31536000 + min: 1800 + name: value + suggested_values: + - 1800 + - 3600 + - 7200 + - 10800 + - 14400 + - 18000 + - 28800 + - 43200 + - 57600 + - 72000 + - 86400 + - 172800 + - 259200 + - 345600 + - 432000 + - 691200 + - 1382400 + - 2073600 + - 2678400 + - 5356800 + - 16070400 + - 31536000 + type: range + - id: browser_check + properties: + - name: value + type: toggle + - id: cache_key_fields + properties: + - name: value + properties: + - allowEmpty: true + choices: + - include + - exclude + multiple: false + name: query_string + type: select + - allowEmpty: true + choices: + - include + - exclude + - check_presence + multiple: true + name: header + type: select + - allowEmpty: false + choices: + - resolved + multiple: true + name: host + type: select + - allowEmpty: true + choices: + - include + - check_presence + multiple: true + name: cookie + type: select + - allowEmpty: false + choices: + - device_type + - geo + - lang + multiple: true + name: user + type: select + type: object + - id: cache_deception_armor + properties: + - name: value + type: toggle + - id: cache_level + properties: + - choices: + - bypass + - basic + - simplified + - aggressive + - cache_everything + multiple: false + name: value + type: select + - id: cache_ttl_by_status + properties: + - allowEmpty: false + name: value + type: object + - id: disable_apps + properties: [] + - id: disable_performance + properties: [] + - id: disable_security + properties: [] + - id: edge_cache_ttl + properties: + - max: 2419200 + min: 7200 + name: value + suggested_values: + - 7200 + - 10800 + - 14400 + - 18000 + - 28800 + - 43200 + - 57600 + - 72000 + - 86400 + - 172800 + - 259200 + - 345600 + - 432000 + - 518400 + - 604800 + - 1209600 + - 2419200 + type: range + - id: email_obfuscation + properties: + - name: value + type: toggle + - id: forwarding_url + properties: + - choices: + - 301 + - 302 + multiple: false + name: status_code + type: choice + - name: url + type: forwardingUrl + - id: ip_geolocation + properties: + - name: value + type: toggle + - id: explicit_cache_control + properties: + - name: value + type: toggle + - id: rocket_loader + properties: + - name: value + type: toggle + - id: security_level + properties: + - choices: + - essentially_off + - low + - medium + - high + - under_attack + multiple: false + name: value + type: select + - id: server_side_exclude + properties: + - name: value + type: toggle + - id: ssl + properties: + - choices: + - 'off' + - flexible + - full + - strict + multiple: false + name: value + type: choice + items: + type: object + type: array + zonesStatus: + default: disabled + description: The status of the Page Rule. + enum: + - active + - disabled + example: active + type: string + x-auditable: true + zonesTarget: + description: A request condition target. + $ref: '#/components/schemas/zonesUrlTarget' + zonesTargets: + description: The rule targets to evaluate on each request. + example: + - constraint: + operator: matches + value: '*example.com/images/*' + target: url + items: + $ref: '#/components/schemas/zonesTarget' + type: array + x-stainless-skip: + - terraform + zonesUrlTarget: + description: URL target. + properties: + constraint: + description: String constraint. + type: object + properties: + operator: + default: contains + description: >- + The matches operator can use asterisks and pipes as wildcard and + 'or' operators. + enum: + - matches + - contains + - equals + - not_equal + - not_contain + x-auditable: true + type: string + value: + description: >- + The URL pattern to match against the current request. The + pattern may contain up to four asterisks ('*') as placeholders. + type: string + x-auditable: true + example: '*example.com/images/*' + required: + - operator + - value + target: + description: A target based on the URL of the request. + enum: + - url + example: url + x-auditable: true + type: string + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + pagerules: + id: cloudflare.page_rules.pagerules + name: pagerules + title: Pagerules + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pagerules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pagerules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pagerules~1{pagerule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pagerules~1{pagerule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pagerules~1{pagerule_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pagerules~1{pagerule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pagerules/methods/get' + - $ref: '#/components/x-stackQL-resources/pagerules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pagerules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/pagerules/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/pagerules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/pagerules/methods/update' + settings: + id: cloudflare.page_rules.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1pagerules~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/page_shield.yaml b/providers/src/cloudflare/v00.00.00000/services/page_shield.yaml index e71ab3bb..bb00779d 100644 --- a/providers/src/cloudflare/v00.00.00000/services/page_shield.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/page_shield.yaml @@ -1,188 +1,1616 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Page Shield - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - page_shield + title: page_shield API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/page_shield: + get: + description: Fetches the Page Shield settings. + operationId: page-shield-get-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + result: + nullable: true + type: object + $ref: '#/components/schemas/pageShieldGetZoneSettingsResponse' + required: + - success + description: Get Page Shield settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Get Page Shield settings response failure + security: + - api_email: [] + api_key: [] + summary: Get Page Shield settings + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: [] + method: get + put: + description: Updates Page Shield settings. + operationId: page-shield-update-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + enabled: + $ref: '#/components/schemas/pageShieldEnabled' + use_cloudflare_reporting_endpoint: + $ref: >- + #/components/schemas/pageShieldUseCloudflareReportingEndpoint + use_connection_url_path: + $ref: '#/components/schemas/pageShieldUseConnectionUrlPath' + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + result: + type: object + $ref: '#/components/schemas/pageShieldUpdateZoneSettingsResponse' + required: + - success + description: Update Page Shield settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Update Page Shield settings response failure + security: + - api_email: [] + api_key: [] + summary: Update Page Shield settings + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: [] + method: update + /zones/{zone_id}/page_shield/connections: + get: + description: Lists all connections detected by Page Shield. + operationId: page-shield-list-connections + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: exclude_urls + schema: + description: >- + Excludes connections whose URL contains one of the URL-encoded + URLs separated by commas. + type: string + - in: query + name: urls + schema: + description: >- + Includes connections whose URL contain one or more URL-encoded + URLs separated by commas. + type: string + - in: query + name: hosts + schema: + description: >- + Includes connections that match one or more URL-encoded hostnames + separated by commas. Wildcards are supported at the start and end + of each hostname to support starts with, ends with and contains. + If no wildcards are used, results will be filtered by exact match + type: string + - in: query + name: page + schema: + description: >- + The current page number of the paginated results. We additionally + support a special value "all". When "all" is used, the API will + return all the connections with the applied filters in a single + page. This feature is best-effort and it may only work for zones + with a low number of connections + type: string + - in: query + name: per_page + schema: + description: The number of results per page. + maximum: 100 + minimum: 1 + type: number + - in: query + name: order_by + schema: + description: The field used to sort returned connections. + enum: + - first_seen_at + - last_seen_at + type: string + - in: query + name: direction + schema: + description: The direction used to sort returned connections. + enum: + - asc + - desc + type: string + - in: query + name: prioritize_malicious + schema: + description: >- + When true, malicious connections appear first in the returned + connections. + type: boolean + - in: query + name: exclude_cdn_cgi + schema: + description: >- + When true, excludes connections seen in a `/cdn-cgi` path from the + returned connections. The default value is true. + type: boolean + - in: query + name: status + schema: + description: >- + Filters the returned connections using a comma-separated list of + connection statuses. Accepted values: `active`, `infrequent`, and + `inactive`. The default value is `active`. + type: string + - in: query + name: page_url + schema: + description: >- + Includes connections that match one or more page URLs (separated + by commas) where they were last seen Wildcards are supported at + the start and end of each page URL to support starts with, ends + with and contains. If no wildcards are used, results will be + filtered by exact match + type: string + - in: query + name: export + schema: + description: >- + Export the list of connections as a file, limited to 50000 + entries. + enum: + - csv + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldListZoneConnectionsResponse' + description: List Page Shield connections response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: List Page Shield connections response failure + security: + - api_email: [] + api_key: [] + summary: List Page Shield connections + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: page_shield + resource_chain: + - connections + method: list + /zones/{zone_id}/page_shield/connections/{connection_id}: + get: + description: Fetches a connection detected by Page Shield by connection ID. + operationId: page-shield-get-connection + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: connection_id + schema: + $ref: '#/components/schemas/pageShieldId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldGetZoneConnectionResponse' + description: Get a Page Shield connection response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Get a Page Shield connection response failure + security: + - api_email: [] + api_key: [] + summary: Get a Page Shield connection + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: page_shield + resource_chain: + - connections + method: get + /zones/{zone_id}/page_shield/cookies: + get: + description: Lists all cookies collected by Page Shield. + operationId: page-shield-list-cookies + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: hosts + schema: + description: >- + Includes cookies that match one or more URL-encoded hostnames + separated by commas. Wildcards are supported at the start and end + of each hostname to support starts with, ends with and contains. + If no wildcards are used, results will be filtered by exact match + type: string + - in: query + name: page + schema: + description: >- + The current page number of the paginated results. We additionally + support a special value "all". When "all" is used, the API will + return all the cookies with the applied filters in a single page. + This feature is best-effort and it may only work for zones with a + low number of cookies + type: string + - in: query + name: per_page + schema: + description: The number of results per page. + maximum: 100 + minimum: 1 + type: number + - in: query + name: order_by + schema: + description: The field used to sort returned cookies. + enum: + - first_seen_at + - last_seen_at + type: string + - in: query + name: direction + schema: + description: The direction used to sort returned cookies.' + enum: + - asc + - desc + type: string + - in: query + name: page_url + schema: + description: >- + Includes connections that match one or more page URLs (separated + by commas) where they were last seen Wildcards are supported at + the start and end of each page URL to support starts with, ends + with and contains. If no wildcards are used, results will be + filtered by exact match + type: string + - in: query + name: export + schema: + description: Export the list of cookies as a file, limited to 50000 entries. + enum: + - csv + type: string + - in: query + name: name + schema: + description: >- + Filters the returned cookies that match the specified name. + Wildcards are supported at the start and end to support starts + with, ends with and contains. e.g. session* + maxLength: 1024 + type: string + - in: query + name: secure + schema: + description: Filters the returned cookies that are set with Secure + type: boolean + - in: query + name: http_only + schema: + description: Filters the returned cookies that are set with HttpOnly + type: boolean + - in: query + name: same_site + schema: + description: >- + Filters the returned cookies that match the specified same_site + attribute + enum: + - lax + - strict + - none + type: string + - in: query + name: type + schema: + description: >- + Filters the returned cookies that match the specified type + attribute + enum: + - first_party + - unknown + type: string + - in: query + name: path + schema: + description: >- + Filters the returned cookies that match the specified path + attribute + maxLength: 1024 + type: string + - in: query + name: domain + schema: + description: >- + Filters the returned cookies that match the specified domain + attribute + maxLength: 1024 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldListZoneCookiesResponse' + description: List Page Shield cookies response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: List Page Shield cookies response failure + security: + - api_email: [] + api_key: [] + summary: List Page Shield Cookies + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: page_shield + resource_chain: + - cookies + method: list + /zones/{zone_id}/page_shield/cookies/{cookie_id}: + get: + description: Fetches a cookie collected by Page Shield by cookie ID. + operationId: page-shield-get-cookie + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: cookie_id + schema: + $ref: '#/components/schemas/pageShieldId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldGetZoneCookieResponse' + description: Get a Page Shield cookie response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Get a Page Shield cookie response failure + security: + - api_email: [] + api_key: [] + summary: Get a Page Shield cookie + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: page_shield + resource_chain: + - cookies + method: get + /zones/{zone_id}/page_shield/policies: + get: + description: Lists all Page Shield policies. + operationId: page-shield-list-policies + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldListZonePoliciesResponse' + description: List Page Shield policies response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: List Page Shield policies response failure + security: + - api_email: [] + api_key: [] + summary: List Page Shield policies + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: + - policies + method: list + post: + description: Create a Page Shield policy. + operationId: page-shield-create-policy + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldPolicy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldGetZonePolicyResponse' + description: Create a Page Shield policy response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Create a Page Shield policy response failure + security: + - api_email: [] + api_key: [] + summary: Create a Page Shield policy + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: + - policies + method: create + /zones/{zone_id}/page_shield/policies/{policy_id}: + delete: + description: Delete a Page Shield policy by ID. + operationId: page-shield-delete-policy + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + responses: + '204': + description: Delete a Page Shield policy response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Delete a Page Shield policy response failure + security: + - api_email: [] + api_key: [] + summary: Delete a Page Shield policy + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: + - policies + method: delete + get: + description: Fetches a Page Shield policy by ID. + operationId: page-shield-get-policy + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldGetZonePolicyResponse' + description: Get a Page Shield policy response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Get a Page Shield policy response failure + security: + - api_email: [] + api_key: [] + summary: Get a Page Shield policy + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: + - policies + method: get + put: + description: Update a Page Shield policy by ID. + operationId: page-shield-update-policy + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + $ref: '#/components/schemas/pageShieldPolicyAction' + description: + $ref: '#/components/schemas/pageShieldPolicyDescription' + enabled: + $ref: '#/components/schemas/pageShieldPolicyEnabled' + expression: + $ref: '#/components/schemas/pageShieldPolicyExpression' + value: + $ref: '#/components/schemas/pageShieldPolicyValue' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldGetZonePolicyResponse' + description: Update a Page Shield policy response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Update a Page Shield policy response failure + security: + - api_email: [] + api_key: [] + summary: Update a Page Shield policy + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: + - policies + method: update + /zones/{zone_id}/page_shield/scripts: + get: + description: Lists all scripts detected by Page Shield. + operationId: page-shield-list-scripts + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: exclude_urls + schema: + description: >- + Excludes scripts whose URL contains one of the URL-encoded URLs + separated by commas. + type: string + - in: query + name: urls + schema: + description: >- + Includes scripts whose URL contain one or more URL-encoded URLs + separated by commas. + type: string + - in: query + name: hosts + schema: + description: >- + Includes scripts that match one or more URL-encoded hostnames + separated by commas. Wildcards are supported at the start and end + of each hostname to support starts with, ends with and contains. + If no wildcards are used, results will be filtered by exact match + type: string + - in: query + name: page + schema: + description: >- + The current page number of the paginated results. We additionally + support a special value "all". When "all" is used, the API will + return all the scripts with the applied filters in a single page. + This feature is best-effort and it may only work for zones with a + low number of scripts + type: string + - in: query + name: per_page + schema: + description: The number of results per page. + maximum: 100 + minimum: 1 + type: number + - in: query + name: order_by + schema: + description: The field used to sort returned scripts. + enum: + - first_seen_at + - last_seen_at + type: string + - in: query + name: direction + schema: + description: The direction used to sort returned scripts. + enum: + - asc + - desc + type: string + - in: query + name: prioritize_malicious + schema: + description: When true, malicious scripts appear first in the returned scripts. + type: boolean + - in: query + name: exclude_cdn_cgi + schema: + default: true + description: >- + When true, excludes scripts seen in a `/cdn-cgi` path from the + returned scripts. The default value is true. + type: boolean + - in: query + name: exclude_duplicates + schema: + default: true + description: >- + When true, excludes duplicate scripts. We consider a script + duplicate of another if their javascript content matches and they + share the same url host and zone hostname. In such case, we return + the most recent script for the URL host and zone hostname + combination. + type: boolean + - in: query + name: status + schema: + description: >- + Filters the returned scripts using a comma-separated list of + scripts statuses. Accepted values: `active`, `infrequent`, and + `inactive`. The default value is `active`. + type: string + - in: query + name: page_url + schema: + description: >- + Includes scripts that match one or more page URLs (separated by + commas) where they were last seen Wildcards are supported at the + start and end of each page URL to support starts with, ends with + and contains. If no wildcards are used, results will be filtered + by exact match + type: string + - in: query + name: export + schema: + description: Export the list of scripts as a file, limited to 50000 entries. + enum: + - csv + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldListZoneScriptsResponse' + description: List Page Shield scripts response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: List Page Shield scripts response failure + security: + - api_email: [] + api_key: [] + summary: List Page Shield scripts + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: + - scripts + method: list + /zones/{zone_id}/page_shield/scripts/{script_id}: + get: + description: Fetches a script detected by Page Shield by script ID. + operationId: page-shield-get-script + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: script_id + schema: + $ref: '#/components/schemas/pageShieldId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldGetZoneScriptResponse' + description: Get a Page Shield script response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pageShieldApiResponseCommonFailure' + description: Get a Page Shield script response failure + security: + - api_email: [] + api_key: [] + summary: Get a Page Shield script + tags: + - Page Shield + x-api-token-group: + - Page Shield + - Domain Page Shield Read + - Domain Page Shield + - Page Shield Read + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: page_shield + resource_chain: + - scripts + method: get components: schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - zone_settings_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - get-zone-settings-response: + pageShieldApiResponseCommonFailure: + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + required: + - success + - errors + type: object + pageShieldConnection: + properties: + added_at: + example: '2021-08-18T10:51:10.09615Z' + format: date-time + type: string + domain_reported_malicious: + example: false + type: boolean + first_page_url: + example: blog.cloudflare.com/page + type: string + first_seen_at: + example: '2021-08-18T10:51:08Z' + format: date-time + type: string + host: + example: blog.cloudflare.com + type: string + id: + $ref: '#/components/schemas/pageShieldId' + last_seen_at: + example: '2021-09-02T09:57:54Z' + format: date-time + type: string + malicious_domain_categories: + example: + - Malware + items: + type: string + type: array + malicious_url_categories: + example: + - Malware + items: + type: string + type: array + page_urls: + example: + - blog.cloudflare.com/page1 + - blog.cloudflare.com/page2 + items: + type: string + type: array + url: + example: >- + https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js + type: string + url_contains_cdn_cgi_path: + example: false + type: boolean + url_reported_malicious: + example: false + type: boolean + required: + - id + - url + - added_at + - first_seen_at + - last_seen_at + - host + - url_contains_cdn_cgi_path + type: object + pageShieldCookie: properties: - enabled: - $ref: '#/components/schemas/script-monitor_components-schemas-enabled' - updated_at: - $ref: '#/components/schemas/schemas-updated_at' - use_cloudflare_reporting_endpoint: - $ref: '#/components/schemas/use_cloudflare_reporting_endpoint' - use_connection_url_path: - $ref: '#/components/schemas/use_connection_url_path' - api-response-common-failure: + domain_attribute: + example: cloudflare.com + type: string + expires_attribute: + example: '2021-10-02T09:57:54Z' + format: date-time + type: string + first_seen_at: + example: '2021-08-18T10:51:08Z' + format: date-time + type: string + host: + example: blog.cloudflare.com + type: string + http_only_attribute: + example: true + type: boolean + id: + $ref: '#/components/schemas/pageShieldId' + last_seen_at: + example: '2021-09-02T09:57:54Z' + format: date-time + type: string + max_age_attribute: + example: 3600 + type: integer + name: + example: session_id + type: string + page_urls: + example: + - blog.cloudflare.com/page1 + - blog.cloudflare.com/page2 + items: + type: string + type: array + path_attribute: + example: / + type: string + same_site_attribute: + enum: + - lax + - strict + - none + example: strict + type: string + secure_attribute: + example: true + type: boolean + type: + enum: + - first_party + - unknown + example: first_party + type: string + required: + - id + - type + - name + - host + - first_seen_at + - last_seen_at + type: object + pageShieldCryptominingScore: + description: The cryptomining score of the JavaScript content. + maximum: 99 + minimum: 1 + nullable: true + type: integer + pageShieldDataflowScore: + description: >- + The dataflow score of the JavaScript content. This field has been + deprecated in favour of js_integrity_score. + maximum: 99 + minimum: 1 + nullable: true + type: integer + pageShieldEnabled: + description: When true, indicates that Page Shield is enabled. + example: true + type: boolean + x-auditable: true + pageShieldFetchedAt: + description: The timestamp of when the script was last fetched. + nullable: true + type: string + pageShieldGetZoneConnectionResponse: + type: object properties: errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 + $ref: '#/components/schemas/pageShieldMessages' messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean result: + nullable: true + type: object + $ref: '#/components/schemas/pageShieldConnection' + required: + - success + - result + pageShieldGetZoneCookieResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful enum: - - null + - true + example: true + type: boolean + result: nullable: true + type: object + $ref: '#/components/schemas/pageShieldCookie' + required: + - success + - result + pageShieldGetZonePolicyResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' success: description: Whether the API call was successful enum: - - false - example: false + - true + example: true type: boolean + result: + nullable: true + type: object + $ref: '#/components/schemas/pageShieldPolicyWithId' required: - success - - errors - - messages - result + pageShieldGetZoneScriptResponse: type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result: + nullable: true + type: object + properties: + added_at: + example: '2021-08-18T10:51:10.09615Z' + format: date-time + type: string + cryptomining_score: + $ref: '#/components/schemas/pageShieldCryptominingScore' + dataflow_score: + deprecated: true + $ref: '#/components/schemas/pageShieldDataflowScore' + domain_reported_malicious: + example: false + type: boolean + fetched_at: + $ref: '#/components/schemas/pageShieldFetchedAt' + first_page_url: + example: blog.cloudflare.com/page + type: string + first_seen_at: + example: '2021-08-18T10:51:08Z' + format: date-time + type: string + hash: + $ref: '#/components/schemas/pageShieldHash' + host: + example: blog.cloudflare.com + type: string + id: + $ref: '#/components/schemas/pageShieldId' + js_integrity_score: + $ref: '#/components/schemas/pageShieldJsIntegrityScore' + last_seen_at: + example: '2021-09-02T09:57:54Z' + format: date-time + type: string + magecart_score: + $ref: '#/components/schemas/pageShieldMagecartScore' + malicious_domain_categories: + example: + - Malware + items: + type: string + type: array + malicious_url_categories: + example: + - Malware + items: + type: string + type: array + malware_score: + $ref: '#/components/schemas/pageShieldMalwareScore' + obfuscation_score: + deprecated: true + $ref: '#/components/schemas/pageShieldObfuscationScore' + page_urls: + example: + - blog.cloudflare.com/page1 + - blog.cloudflare.com/page2 + items: + type: string + type: array + url: + example: >- + https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js + type: string + url_contains_cdn_cgi_path: + example: false + type: boolean + url_reported_malicious: + example: false + type: boolean + versions: + example: + - cryptomining_score: 20 + fetched_at: '2021-08-18T10:51:08Z' + hash: >- + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423 + js_integrity_score: 2 + magecart_score: 10 + malware_score: 5 + items: + $ref: '#/components/schemas/pageShieldVersion' nullable: true - script-monitor_components-schemas-enabled: - description: 'When true, indicates that Page Shield is enabled.' - example: true - type: boolean - schemas-updated_at: - description: The timestamp of when Page Shield was last updated. - example: '2022-10-12T17:56:52.083582+01:00' + type: array + required: + - id + - url + - added_at + - first_seen_at + - last_seen_at + - host + - url_contains_cdn_cgi_path + required: + - success + - result + pageShieldGetZoneSettingsResponse: + properties: + enabled: + $ref: '#/components/schemas/pageShieldEnabled' + updated_at: + $ref: '#/components/schemas/pageShieldUpdatedAt' + readOnly: true + use_cloudflare_reporting_endpoint: + $ref: '#/components/schemas/pageShieldUseCloudflareReportingEndpoint' + use_connection_url_path: + $ref: '#/components/schemas/pageShieldUseConnectionUrlPath' + required: + - enabled + - updated_at + - use_cloudflare_reporting_endpoint + - use_connection_url_path + type: object + pageShieldHash: + description: The computed hash of the analyzed script. + maxLength: 64 + minLength: 64 + nullable: true type: string - use_cloudflare_reporting_endpoint: - description: 'When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report' - example: true - type: boolean - use_connection_url_path: - description: 'When true, the paths associated with connections URLs will also be analyzed.' - example: true - type: boolean - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: + pageShieldId: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + pageShieldJsIntegrityScore: + description: The integrity score of the JavaScript content. + maximum: 99 + minimum: 1 + nullable: true + type: integer + pageShieldListZoneConnectionsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/pageShieldResultInfo' + result: + items: + $ref: '#/components/schemas/pageShieldConnection' + type: array + required: + - success + - result_info + pageShieldListZoneCookiesResponse: + type: object properties: errors: - $ref: '#/components/schemas/messages' + $ref: '#/components/schemas/pageShieldMessages' messages: - $ref: '#/components/schemas/messages' + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/pageShieldResultInfo' result: - anyOf: - - type: object - - items: {} - type: array - - type: string + items: + $ref: '#/components/schemas/pageShieldCookie' + type: array + required: + - success + - result_info + - result + pageShieldListZonePoliciesResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' success: description: Whether the API call was successful enum: - true example: true type: boolean + result_info: + $ref: '#/components/schemas/pageShieldResultInfo' + result: + items: + $ref: '#/components/schemas/pageShieldPolicyWithId' + type: array required: - success - - errors - - messages + - result_info - result + pageShieldListZoneScriptsResponse: type: object - update-zone-settings-response: properties: + errors: + $ref: '#/components/schemas/pageShieldMessages' + messages: + $ref: '#/components/schemas/pageShieldMessages' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/pageShieldResultInfo' + result: + items: + $ref: '#/components/schemas/pageShieldScript' + type: array + required: + - success + - result_info + - result + pageShieldMagecartScore: + description: The magecart score of the JavaScript content. + maximum: 99 + minimum: 1 + nullable: true + type: integer + pageShieldMalwareScore: + description: The malware score of the JavaScript content. + maximum: 99 + minimum: 1 + nullable: true + type: integer + pageShieldMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + pageShieldObfuscationScore: + description: >- + The obfuscation score of the JavaScript content. This field has been + deprecated in favour of js_integrity_score. + maximum: 99 + minimum: 1 + nullable: true + type: integer + pageShieldPolicy: + properties: + action: + $ref: '#/components/schemas/pageShieldPolicyAction' + description: + $ref: '#/components/schemas/pageShieldPolicyDescription' enabled: - $ref: '#/components/schemas/script-monitor_components-schemas-enabled' - updated_at: - $ref: '#/components/schemas/schemas-updated_at' - use_cloudflare_reporting_endpoint: - $ref: '#/components/schemas/use_cloudflare_reporting_endpoint' - use_connection_url_path: - $ref: '#/components/schemas/use_connection_url_path' - list-zone-connections-response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/connection' - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' + $ref: '#/components/schemas/pageShieldPolicyEnabled' + expression: + $ref: '#/components/schemas/pageShieldPolicyExpression' + value: + $ref: '#/components/schemas/pageShieldPolicyValue' + required: + - description + - action + - expression + - enabled + - value type: object - connection: + pageShieldPolicyAction: + description: The action to take if the expression matches + enum: + - allow + - log + - add_reporting_directives + example: allow + type: string + x-auditable: true + pageShieldPolicyDescription: + description: A description for the policy + example: Checkout page CSP policy + type: string + x-auditable: true + pageShieldPolicyEnabled: + description: Whether the policy is enabled + example: true + type: boolean + x-auditable: true + pageShieldPolicyExpression: + description: >- + The expression which must match for the policy to be applied, using the + Cloudflare Firewall rule expression syntax + example: ends_with(http.request.uri.path, "/checkout") + type: string + x-auditable: true + pageShieldPolicyValue: + description: The policy which will be applied + example: script-src 'none'; + type: string + x-auditable: true + pageShieldPolicyWithId: + required: + - description + - action + - expression + - enabled + - value + - id properties: - added_at: - example: '2021-08-18T10:51:10.09615Z' - domain_reported_malicious: - example: false - first_page_url: - example: blog.cloudflare.com/page - first_seen_at: - example: '2021-08-18T10:51:08Z' - host: - example: blog.cloudflare.com + action: + $ref: '#/components/schemas/pageShieldPolicyAction' + description: + $ref: '#/components/schemas/pageShieldPolicyDescription' + enabled: + $ref: '#/components/schemas/pageShieldPolicyEnabled' + expression: + $ref: '#/components/schemas/pageShieldPolicyExpression' + value: + $ref: '#/components/schemas/pageShieldPolicyValue' id: - example: c9ef84a6bf5e47138c75d95e2f933e8f - last_seen_at: - example: '2021-09-02T09:57:54Z' - page_urls: - example: - - blog.cloudflare.com/page1 - - blog.cloudflare.com/page2 - url: - example: 'https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js' - url_contains_cdn_cgi_path: - example: false - result_info: + $ref: '#/components/schemas/pageShieldId' + type: object + pageShieldResultInfo: properties: count: description: Total number of results for the requested service @@ -200,133 +1628,222 @@ components: description: Total results available without any search parameters example: 2000 type: number - type: object - script-monitor_components-schemas-id: - description: The ID of the resource. - example: c9ef84a6bf5e47138c75d95e2f933e8f - maxLength: 32 - minLength: 32 - type: string - get-zone-connection-response: - allOf: - - $ref: '#/components/schemas/connection' - list-zone-scripts-response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/script' - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - script: + total_pages: + description: Total number of pages + example: 100 + type: number + required: + - page + - per_page + - count + - total_count + - total_pages + type: object + pageShieldScript: properties: added_at: example: '2021-08-18T10:51:10.09615Z' + format: date-time + type: string + cryptomining_score: + $ref: '#/components/schemas/pageShieldCryptominingScore' + dataflow_score: + deprecated: true + $ref: '#/components/schemas/pageShieldDataflowScore' domain_reported_malicious: example: false + type: boolean fetched_at: - example: '2021-09-02T10:17:54Z' + $ref: '#/components/schemas/pageShieldFetchedAt' first_page_url: example: blog.cloudflare.com/page + type: string first_seen_at: example: '2021-08-18T10:51:08Z' + format: date-time + type: string hash: - example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + $ref: '#/components/schemas/pageShieldHash' host: example: blog.cloudflare.com + type: string id: - example: c9ef84a6bf5e47138c75d95e2f933e8f + $ref: '#/components/schemas/pageShieldId' js_integrity_score: - example: 10 + $ref: '#/components/schemas/pageShieldJsIntegrityScore' last_seen_at: example: '2021-09-02T09:57:54Z' + format: date-time + type: string + magecart_score: + $ref: '#/components/schemas/pageShieldMagecartScore' + malicious_domain_categories: + example: + - Malware + items: + type: string + type: array + malicious_url_categories: + example: + - Malware + items: + type: string + type: array + malware_score: + $ref: '#/components/schemas/pageShieldMalwareScore' + obfuscation_score: + deprecated: true + $ref: '#/components/schemas/pageShieldObfuscationScore' page_urls: example: - blog.cloudflare.com/page1 - blog.cloudflare.com/page2 + items: + type: string + type: array url: - example: 'https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js' + example: >- + https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js + type: string url_contains_cdn_cgi_path: example: false - get-zone-script-response: - allOf: - - $ref: '#/components/schemas/script' - - properties: - versions: - example: - - fetched_at: '2021-08-18T10:51:08Z' - hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423 - js_integrity_score: 2 - items: - $ref: '#/components/schemas/components-schemas-version' - nullable: true - type: array - components-schemas-version: + type: boolean + url_reported_malicious: + example: false + type: boolean + required: + - id + - url + - added_at + - first_seen_at + - last_seen_at + - host + - url_contains_cdn_cgi_path + type: object + pageShieldUpdateZoneSettingsResponse: + properties: + enabled: + $ref: '#/components/schemas/pageShieldEnabled' + updated_at: + $ref: '#/components/schemas/pageShieldUpdatedAt' + readOnly: true + use_cloudflare_reporting_endpoint: + $ref: '#/components/schemas/pageShieldUseCloudflareReportingEndpoint' + use_connection_url_path: + $ref: '#/components/schemas/pageShieldUseConnectionUrlPath' + required: + - enabled + - updated_at + - use_cloudflare_reporting_endpoint + - use_connection_url_path + type: object + pageShieldUpdatedAt: + description: The timestamp of when Page Shield was last updated. + example: '2022-10-12T17:56:52.083582+01:00' + type: string + x-auditable: true + pageShieldUseCloudflareReportingEndpoint: + description: >- + When true, CSP reports will be sent to + https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report + example: true + type: boolean + x-auditable: true + pageShieldUseConnectionUrlPath: + description: >- + When true, the paths associated with connections URLs will also be + analyzed. + example: true + type: boolean + x-auditable: true + pageShieldVersion: description: The version of the analyzed script. properties: + cryptomining_score: + $ref: '#/components/schemas/pageShieldCryptominingScore' + dataflow_score: + deprecated: true + $ref: '#/components/schemas/pageShieldDataflowScore' fetched_at: - $ref: '#/components/schemas/fetched_at' + $ref: '#/components/schemas/pageShieldFetchedAt' hash: - $ref: '#/components/schemas/hash' + $ref: '#/components/schemas/pageShieldHash' js_integrity_score: - $ref: '#/components/schemas/js_integrity_score' + $ref: '#/components/schemas/pageShieldJsIntegrityScore' + magecart_score: + $ref: '#/components/schemas/pageShieldMagecartScore' + malware_score: + $ref: '#/components/schemas/pageShieldMalwareScore' + obfuscation_score: + deprecated: true + $ref: '#/components/schemas/pageShieldObfuscationScore' type: object - fetched_at: - description: The timestamp of when the script was last fetched. - nullable: true - type: string - hash: - description: The computed hash of the analyzed script. - maxLength: 64 - minLength: 64 - nullable: true - type: string - js_integrity_score: - description: The integrity score of the JavaScript content. - maximum: 99 - minimum: 1 - nullable: true - type: integer - responses: {} + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. api_key: in: header name: X-Auth-Key type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. api_token: scheme: bearer type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - zones: - id: cloudflare.page_shield.zones - name: zones - title: Zones + page_shield: + id: cloudflare.page_shield.page_shield + name: page_shield + title: Page Shield methods: - get_page_shield_settings: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _get_page_shield_settings: + list: operation: $ref: '#/paths/~1zones~1{zone_id}~1page_shield/get' response: mediaType: application/json openAPIDocKey: '200' - update_page_shield_settings: + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive operation: $ref: '#/paths/~1zones~1{zone_id}~1page_shield/put' response: @@ -334,343 +1851,146 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones/methods/get_page_shield_settings' + - $ref: '#/components/x-stackQL-resources/page_shield/methods/list' insert: [] update: [] delete: [] - zones_connections: - id: cloudflare.page_shield.zones_connections - name: zones_connections - title: Zones Connections + replace: + - $ref: '#/components/x-stackQL-resources/page_shield/methods/update' + connections: + id: cloudflare.page_shield.connections + name: connections + title: Connections methods: - list_page_shield_connections: + list: operation: $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1connections/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ - _list_page_shield_connections: + objectKey: $.result + get: operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1connections/get' + $ref: >- + #/paths/~1zones~1{zone_id}~1page_shield~1connections~1{connection_id}/get response: mediaType: application/json openAPIDocKey: '200' - get_a_page_shield_connection: + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connections/methods/get' + - $ref: '#/components/x-stackQL-resources/connections/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cookies: + id: cloudflare.page_shield.cookies + name: cookies + title: Cookies + methods: + list: operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1connections~1{id}/get' + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1cookies/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ - _get_a_page_shield_connection: + objectKey: $.result + get: operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1connections~1{id}/get' + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1cookies~1{cookie_id}/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones_connections/methods/list_page_shield_connections' - - $ref: '#/components/x-stackQL-resources/zones_connections/methods/get_a_page_shield_connection' + - $ref: '#/components/x-stackQL-resources/cookies/methods/get' + - $ref: '#/components/x-stackQL-resources/cookies/methods/list' insert: [] update: [] delete: [] - zones_scripts: - id: cloudflare.page_shield.zones_scripts - name: zones_scripts - title: Zones Scripts + replace: [] + policies: + id: cloudflare.page_shield.policies + name: policies + title: Policies methods: - list_page_shield_scripts: + list: operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1scripts/get' + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1policies/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ - _list_page_shield_scripts: + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1scripts/get' + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1policies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1page_shield~1policies~1{policy_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1policies~1{policy_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1policies~1{policy_id}/put' response: mediaType: application/json openAPIDocKey: '200' - get_a_page_shield_script: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/policies/methods/update' + scripts: + id: cloudflare.page_shield.scripts + name: scripts + title: Scripts + methods: + list: operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1scripts~1{id}/get' + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1scripts/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ - _get_a_page_shield_script: + objectKey: $.result + get: operation: - $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1scripts~1{id}/get' + $ref: '#/paths/~1zones~1{zone_id}~1page_shield~1scripts~1{script_id}/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones_scripts/methods/list_page_shield_scripts' - - $ref: '#/components/x-stackQL-resources/zones_scripts/methods/get_a_page_shield_script' + - $ref: '#/components/x-stackQL-resources/scripts/methods/get' + - $ref: '#/components/x-stackQL-resources/scripts/methods/list' insert: [] update: [] delete: [] -paths: - '/zones/{zone_id}/page_shield': - get: - description: Fetches the Page Shield settings. - operationId: page-shield-get-page-shield-settings - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/get-zone-settings-response' - description: Get Page Shield settings response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/get-zone-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Page Shield settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Page Shield settings - tags: - - Page Shield - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - put: - description: Updates Page Shield settings. - operationId: page-shield-update-page-shield-settings - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - enabled: - $ref: '#/components/schemas/script-monitor_components-schemas-enabled' - use_cloudflare_reporting_endpoint: - $ref: '#/components/schemas/use_cloudflare_reporting_endpoint' - use_connection_url_path: - $ref: '#/components/schemas/use_connection_url_path' - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/update-zone-settings-response' - description: Update Page Shield settings response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/update-zone-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Page Shield settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Page Shield settings - tags: - - Page Shield - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_id}/page_shield/connections': - get: - description: Lists all connections detected by Page Shield. - operationId: page-shield-list-page-shield-connections - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/list-zone-connections-response' - description: List Page Shield connections response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/list-zone-connections-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Page Shield connections response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Page Shield connections - tags: - - Page Shield - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_id}/page_shield/connections/{id}': - get: - description: Fetches a connection detected by Page Shield by connection ID. - operationId: page-shield-get-a-page-shield-connection - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/script-monitor_components-schemas-id' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/get-zone-connection-response' - description: Get a Page Shield connection response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/get-zone-connection-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Page Shield connection response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Page Shield connection - tags: - - Page Shield - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_id}/page_shield/scripts': - get: - description: Lists all scripts detected by Page Shield. - operationId: page-shield-list-page-shield-scripts - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/list-zone-scripts-response' - description: List Page Shield scripts response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/list-zone-scripts-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Page Shield scripts response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Page Shield scripts - tags: - - Page Shield - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_id}/page_shield/scripts/{id}': - get: - description: Fetches a script detected by Page Shield by script ID. - operationId: page-shield-get-a-page-shield-script - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/script-monitor_components-schemas-id' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/get-zone-script-response' - description: Get a Page Shield script response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/get-zone-script-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Page Shield script response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Page Shield script - tags: - - Page Shield - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/pages.yaml b/providers/src/cloudflare/v00.00.00000/services/pages.yaml index 43f09b60..59bf439b 100644 --- a/providers/src/cloudflare/v00.00.00000/services/pages.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/pages.yaml @@ -1,3181 +1,3025 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Available Page Rules settings - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - pages + title: pages API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - pagerule_settings_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - $ref: '#/components/schemas/settings' - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - settings: - description: Settings available for the zone. - example: - - id: browser_check - properties: - - name: value - type: toggle - - id: browser_cache_ttl - properties: - - max: 31536000 - min: 1800 - name: value - suggested_values: - - 1800 - - 3600 - - 7200 - - 10800 - - 14400 - - 18000 - - 28800 - - 43200 - - 57600 - - 72000 - - 86400 - - 172800 - - 259200 - - 345600 - - 432000 - - 691200 - - 1382400 - - 2073600 - - 2678400 - - 5356800 - - 16070400 - - 31536000 - type: range - - id: browser_check - properties: - - name: value - type: toggle - - id: cache_key_fields - properties: - - name: value - properties: - - allowEmpty: true - choices: - - include - - exclude - multiple: false - name: query_string - type: select - - allowEmpty: true - choices: - - include - - exclude - - check_presence - multiple: true - name: header - type: select - - allowEmpty: false - choices: - - resolved - multiple: true - name: host - type: select - - allowEmpty: true - choices: - - include - - check_presence - multiple: true - name: cookie - type: select - - allowEmpty: false - choices: - - device_type - - geo - - lang - multiple: true - name: user - type: select - type: object - - id: cache_deception_armor - properties: - - name: value - type: toggle - - id: cache_level - properties: - - choices: - - bypass - - basic - - simplified - - aggressive - - cache_everything - multiple: false - name: value - type: select - - id: cache_ttl_by_status - properties: - - allowEmpty: false - name: value - type: object - - id: disable_apps - properties: [] - - id: disable_performance - properties: [] - - id: disable_security - properties: [] - - id: edge_cache_ttl - properties: - - max: 2419200 - min: 7200 - name: value - suggested_values: - - 7200 - - 10800 - - 14400 - - 18000 - - 28800 - - 43200 - - 57600 - - 72000 - - 86400 - - 172800 - - 259200 - - 345600 - - 432000 - - 518400 - - 604800 - - 1209600 - - 2419200 - type: range - - id: email_obfuscation - properties: - - name: value - type: toggle - - id: forwarding_url - properties: - - choices: - - 301 - - 302 - multiple: false - name: status_code - type: choice - - name: url - type: forwardingUrl - - id: ip_geolocation - properties: - - name: value - type: toggle - - id: minify - properties: - - allowEmpty: true - choices: - - html - - css - - js - multiple: true - name: value - type: select - - id: explicit_cache_control - properties: - - name: value - type: toggle - - id: rocket_loader - properties: - - name: value - type: toggle - - id: security_level - properties: - - choices: - - essentially_off - - low - - medium - - high - - under_attack - multiple: false - name: value - type: select - - id: server_side_exclude - properties: - - name: value - type: toggle - - id: ssl - properties: - - choices: - - 'off' - - flexible - - full - - strict - multiple: false - name: value - type: choice - items: - type: object - type: array - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/pages/projects: + get: + description: Fetch a list of all user projects. + operationId: pages-project-get-projects + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - custom_pages_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - type: object - type: array - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - custom-pages_components-schemas-identifier: - description: The name of the custom page type. - enum: - - basic_challenge - - managed_challenge - - waf_block - - ratelimit_block - - country_challenge - - ip_block - - under_attack - - 500_errors - - 1000_errors - example: basic_challenge - readOnly: true - custom_pages_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - schemas-state: - description: The custom page state. - enum: - - default - - customized - example: default - type: string - url: - default: '' - description: The URL associated with the custom page. - example: 'http://www.example.com' - format: uri - type: string - custom-pages_components-schemas-identifier-2: - description: The name of the custom page type. - enum: - - basic_challenge - - managed_challenge - - waf_block - - country_challenge - - ip_block - - under_attack - - ratelimit_block - - 500_errors - - 1000_errors - example: basic_challenge - readOnly: true - components-schemas-state: - description: The custom page state. - enum: - - default - - customized - example: default - pagerule_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/page-rule' - type: array - page-rule: - properties: - actions: - $ref: '#/components/schemas/schemas-actions' - created_on: - $ref: '#/components/schemas/created_on' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - modified_on: - $ref: '#/components/schemas/page-rule_components-schemas-modified_on' - priority: - $ref: '#/components/schemas/page-rule_components-schemas-priority' - status: - $ref: '#/components/schemas/page-rule_components-schemas-status' - targets: - $ref: '#/components/schemas/targets' - required: - - id - - targets - - actions - - priority - - status - - modified_on - - created_on - type: object - schemas-actions: - description: 'The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.' - example: - - id: browser_check - value: 'on' - items: - oneOf: - - $ref: '#/components/schemas/route' - type: array - created_on: - description: The timestamp of when the Page Rule was created. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - page-rule_components-schemas-modified_on: - description: The timestamp of when the Page Rule was last modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - page-rule_components-schemas-priority: - default: 1 - description: 'The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: `/images/*`) but want a more specific Page Rule to take precedence (rule B: `/images/special/*`), specify a higher priority for rule B so it overrides rule A.' - type: integer - page-rule_components-schemas-status: - default: disabled - description: The status of the Page Rule. - enum: - - active - - disabled - example: active - type: string - targets: - description: The rule targets to evaluate on each request. - example: - - constraint: - operator: matches - value: '*example.com/images/*' - target: url - items: - $ref: '#/components/schemas/target' - type: array - route: - properties: - modified_on: - description: The timestamp of when the override was last modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - name: - description: The type of route. - enum: - - forward_url - example: forward_url - value: - properties: - type: - description: The response type for the URL redirect. - enum: - - temporary - - permanent - example: temporary - url: - description: |- - The URL to redirect the request to. - Notes: ${num} refers to the position of '*' in the constraint value. - example: 'http://www.example.com/somewhere/$1/astring/$2/anotherstring/$3' - type: string - type: object - target: - description: A request condition target. - oneOf: - - $ref: '#/components/schemas/url_target' - required: - - target - - constraint - url_target: - description: URL target. - properties: - constraint: - allOf: - - $ref: '#/components/schemas/string_constraint' - - properties: - value: - description: The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders. - example: '*example.com/images/*' - pattern: '^(https?://)?(([-a-zA-Z0-9*]*\.)+[-a-zA-Z0-9]{2,20})(:(8080|8443|443|80))?(/[\S]+)?$' - type: string - description: The constraint of a target. - type: object - target: - description: A target based on the URL of the request. - enum: - - url - example: url - type: object - string_constraint: - description: String constraint. - properties: - operator: - default: contains - description: The matches operator can use asterisks and pipes as wildcard and 'or' operators. - enum: - - matches - - contains - - equals - - not_equal - - not_contain - value: - description: The value to apply the operator to. - type: string - required: - - operator - - value - type: object - pagerule_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-single-id: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - type: object - project_name: - description: Name of the project. - example: this-is-my-project-01 - pattern: '^[a-z0-9][a-z0-9-]*$' - type: string - deployment-list-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - type: object - - properties: - result: - items: + - in: query + name: page + schema: + description: Which page of projects to fetch. + type: integer + - in: query + name: per_page + schema: + description: How many projects to return per page. + type: integer + responses: + '200': + content: + application/json: + schema: type: object - type: array - deployment-new-deployment: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - $ref: '#/components/schemas/deployments' - deployments: - properties: - aliases: - description: A list of alias URLs pointing to this deployment. - example: - - 'https://branchname.projectname.pages.dev' - items: {} - nullable: true - readOnly: true - type: array - build_config: - readOnly: true - created_on: - description: When the deployment was created. - example: '2021-03-09T00:55:03.923456Z' - format: date-time - readOnly: true - type: string - deployment_trigger: - description: Info about what caused the deployment. - properties: - metadata: - description: Additional info about the trigger. + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/pagesProject' + type: array + required: + - success + - errors + - messages + - result + description: Get projects response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Get projects response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get projects + tags: + - Pages Project + x-api-token-group: + - Pages Read + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + method: list + post: + description: Create a new project. + operationId: pages-project-create-project + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: properties: - branch: - description: Where the trigger happened. - example: main - readOnly: true - type: string - commit_hash: - description: Hash of the deployment trigger commit. - example: ad9ccd918a81025731e10e40267e11273a263421 - readOnly: true + build_config: + description: Configs for the project build process. + properties: + build_caching: + description: Enable build caching for the project. + type: boolean + x-auditable: true + build_command: + description: Command used to build project. + type: string + x-auditable: true + destination_dir: + description: Output directory of the build. + type: string + x-auditable: true + root_dir: + description: Directory to run the command. + type: string + x-auditable: true + web_analytics_tag: + description: The classifying tag for analytics. + nullable: true + type: string + x-auditable: true + web_analytics_token: + description: The auth token for analytics. + nullable: true + type: string + x-sensitive: true + type: object + deployment_configs: + description: Configs for deployments in a project. + properties: + preview: + description: Configs for preview deploys. + $ref: '#/components/schemas/pagesDeploymentConfigValuesRequest' + production: + description: Configs for production deploys. + $ref: '#/components/schemas/pagesDeploymentConfigValuesRequest' + type: object + name: + description: Name of the project. type: string - commit_message: - description: Message of the deployment trigger commit. - example: Update index.html - readOnly: true + x-auditable: true + production_branch: + description: >- + Production branch of the project. Used to identify + production deployments. type: string + x-auditable: true + source: + description: Configs for the project source control. + properties: + config: + properties: + deployments_enabled: + deprecated: true + description: >- + Whether to enable automatic deployments when pushing + to the source repository. When disabled, no + deployments (production or preview) will be + triggered automatically. + type: boolean + x-auditable: true + x-stainless-deprecation-message: >- + Use `production_deployments_enabled` and + `preview_deployment_setting` for more granular + control. + owner: + description: The owner of the repository. + type: string + x-auditable: true + owner_id: + description: The owner ID of the repository. + type: string + x-auditable: true + path_excludes: + description: >- + A list of paths that should be excluded from + triggering a preview deployment. Wildcard syntax + (`*`) is supported. + items: + type: string + x-auditable: true + type: array + path_includes: + description: >- + A list of paths that should be watched to trigger a + preview deployment. Wildcard syntax (`*`) is + supported. + items: + type: string + x-auditable: true + type: array + pr_comments_enabled: + description: Whether to enable PR comments. + type: boolean + x-auditable: true + preview_branch_excludes: + description: >- + A list of branches that should not trigger a preview + deployment. Wildcard syntax (`*`) is supported. Must + be used with `preview_deployment_setting` set to + `custom`. + items: + type: string + x-auditable: true + type: array + preview_branch_includes: + description: >- + A list of branches that should trigger a preview + deployment. Wildcard syntax (`*`) is supported. Must + be used with `preview_deployment_setting` set to + `custom`. + items: + type: string + x-auditable: true + type: array + preview_deployment_setting: + description: >- + Controls whether commits to preview branches trigger + a preview deployment. + enum: + - all + - none + - custom + type: string + x-auditable: true + production_branch: + description: The production branch of the repository. + type: string + x-auditable: true + production_deployments_enabled: + description: >- + Whether to trigger a production deployment on + commits to the production branch. + type: boolean + x-auditable: true + repo_id: + description: The ID of the repository. + type: string + x-auditable: true + repo_name: + description: The name of the repository. + type: string + x-auditable: true + type: object + type: + description: The source control management provider. + enum: + - github + - gitlab + type: string + x-auditable: true + required: + - type + - config + type: object + required: + - name + - production_branch type: object - type: - description: What caused the deployment. - example: ad_hoc - pattern: push|ad_hoc - readOnly: true - type: string - readOnly: true - type: object - env_vars: - description: A dict of env variables to build this deploy. - example: - BUILD_VERSION: - value: '3.3' - ENV: - value: STAGING - readOnly: true - type: object - environment: - description: Type of deploy. - example: preview - pattern: preview|production - readOnly: true - type: string - id: - description: Id of the deployment. - example: f64788e9-fccd-4d4a-a28a-cb84f88f6 - readOnly: true - type: string - is_skipped: - description: If the deployment has been skipped. - example: true - readOnly: true - type: boolean - latest_stage: - readOnly: true - modified_on: - description: When the deployment was last modified. - example: '2021-03-09T00:58:59.045655' - format: date-time - readOnly: true - type: string - project_id: - description: Id of the project. - example: 7b162ea7-7367-4d67-bcde-1160995d5 - readOnly: true - type: string - project_name: - description: Name of the project. - example: ninjakittens - readOnly: true - type: string - short_id: - description: Short Id (8 character) of the deployment. - example: f64788e9 - readOnly: true - type: string - source: - readOnly: true - stages: - description: List of past stages. - example: - - ended_on: '2021-06-03T15:39:03.134378Z' - name: queued - started_on: '2021-06-03T15:38:15.608194Z' - status: active - - ended_on: null - name: initialize - started_on: null - status: idle - - ended_on: null - name: clone_repo - started_on: null - status: idle - - ended_on: null - name: build - started_on: null - status: idle - - ended_on: null - name: deploy - started_on: null - status: idle - items: - $ref: '#/components/schemas/stage' - readOnly: true - type: array - url: - description: The live URL to view this deployment. - example: 'https://f64788e9.ninjakittens.pages.dev' - readOnly: true - type: string - type: object - stage: - description: The status of the deployment. - properties: - ended_on: - description: When the stage ended. - example: '2021-03-09T00:58:59.045655' - format: date-time - nullable: true - readOnly: true - type: string - name: - description: The current build stage. - example: deploy - pattern: queued|initialize|clone_repo|build|deploy - type: string - started_on: - description: When the stage started. - example: '2021-03-09T00:55:03.923456Z' - format: date-time - nullable: true - readOnly: true - type: string - status: - description: State of the current stage. - example: success - pattern: success|idle|active|failure|canceled - readOnly: true - type: string - readOnly: true - type: object - deployment-response-details: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - $ref: '#/components/schemas/deployments' - deployment-response-logs: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - example: - data: - - line: Cloning repository... - ts: '2021-04-20T19:35:29.0749819Z' - - line: 'From https://github.com/cloudflare/example' - ts: '2021-04-20T19:35:30.0749819Z' - - line: ' * branch 209c5bb11d89533f426b2f8469bcae12fdccf71b -> FETCH_HEAD' - ts: '2021-04-20T19:35:30.0749819Z' - - line: '' - ts: '2021-04-20T19:35:30.0749819Z' - - line: HEAD is now at 209c5bb Update index.html - ts: '2021-04-20T19:35:30.0749819Z' - - line: '' - ts: '2021-04-20T19:35:30.0749819Z' - - line: '' - ts: '2021-04-20T19:35:30.0749819Z' - - line: 'Success: Finished cloning repository files' - ts: '2021-04-20T19:35:30.0749819Z' - - line: Installing dependencies - ts: '2021-04-20T19:35:59.0749819Z' - - line: Python version set to 2.7 - ts: '2021-04-20T19:35:59.0931208Z' - - line: v12.18.0 is already installed. - ts: '2021-04-20T19:36:02.2369501Z' - - line: Now using node v12.18.0 (npm v6.14.4) - ts: '2021-04-20T19:36:02.6028886Z' - - line: Started restoring cached build plugins - ts: '2021-04-20T19:36:02.624555Z' - - line: Finished restoring cached build plugins - ts: '2021-04-20T19:36:02.6340688Z' - - line: 'Attempting ruby version 2.7.1, read from environment' - ts: '2021-04-20T19:36:02.963095Z' - - line: Using ruby version 2.7.1 - ts: '2021-04-20T19:36:04.2236084Z' - - line: Using PHP version 5.6 - ts: '2021-04-20T19:36:04.5450152Z' - - line: 5.2 is already installed. - ts: '2021-04-20T19:36:04.5740509Z' - - line: Using Swift version 5.2 - ts: '2021-04-20T19:36:04.577035Z' - - line: Installing Hugo 0.54.0 - ts: '2021-04-20T19:36:04.5771615Z' - - line: 'Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z' - ts: '2021-04-20T19:36:05.4786868Z' - - line: Started restoring cached go cache - ts: '2021-04-20T19:36:05.4794366Z' - - line: Finished restoring cached go cache - ts: '2021-04-20T19:36:05.481977Z' - - line: go version go1.14.4 linux/amd64 - ts: '2021-04-20T19:36:05.9049776Z' - - line: go version go1.14.4 linux/amd64 - ts: '2021-04-20T19:36:05.9086053Z' - - line: Installing missing commands - ts: '2021-04-20T19:36:05.9163568Z' - - line: Verify run directory - ts: '2021-04-20T19:36:05.9163934Z' - - line: 'Executing user command: echo "skipping build step: no build command specified"' - ts: '2021-04-20T19:36:05.9164636Z' - - line: 'skipping build step: no build command specified' - ts: '2021-04-20T19:36:05.9165087Z' - - line: Finished - ts: '2021-04-20T19:36:05.917412Z' - includes_container_logs: true - total: 30 - type: object - deployment_stage_name: - description: Deployment stage name. - example: deploy - pattern: queued|initialize|clone_repo|build|deploy - type: string - deployment-response-stage-logs: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - example: - data: - - id: 15 - message: Installing dependencies - timestamp: '2021-04-20T19:35:59.0749819Z' - - id: 16 - message: Python version set to 2.7 - timestamp: '2021-04-20T19:35:59.0931208Z' - - id: 17 - message: v12.18.0 is already installed. - timestamp: '2021-04-20T19:36:02.2369501Z' - - id: 18 - message: Now using node v12.18.0 (npm v6.14.4) - timestamp: '2021-04-20T19:36:02.6028886Z' - - id: 19 - message: Started restoring cached build plugins - timestamp: '2021-04-20T19:36:02.624555Z' - - id: 20 - message: Finished restoring cached build plugins - timestamp: '2021-04-20T19:36:02.6340688Z' - - id: 21 - message: 'Attempting ruby version 2.7.1, read from environment' - timestamp: '2021-04-20T19:36:02.963095Z' - - id: 22 - message: Using ruby version 2.7.1 - timestamp: '2021-04-20T19:36:04.2236084Z' - - id: 23 - message: Using PHP version 5.6 - timestamp: '2021-04-20T19:36:04.5450152Z' - - id: 24 - message: 5.2 is already installed. - timestamp: '2021-04-20T19:36:04.5740509Z' - - id: 25 - message: Using Swift version 5.2 - timestamp: '2021-04-20T19:36:04.577035Z' - - id: 26 - message: Installing Hugo 0.54.0 - timestamp: '2021-04-20T19:36:04.5771615Z' - - id: 27 - message: 'Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z' - timestamp: '2021-04-20T19:36:05.4786868Z' - - id: 28 - message: Started restoring cached go cache - timestamp: '2021-04-20T19:36:05.4794366Z' - - id: 29 - message: Finished restoring cached go cache - timestamp: '2021-04-20T19:36:05.481977Z' - - id: 30 - message: go version go1.14.4 linux/amd64 - timestamp: '2021-04-20T19:36:05.9049776Z' - - id: 31 - message: go version go1.14.4 linux/amd64 - timestamp: '2021-04-20T19:36:05.9086053Z' - - id: 32 - message: Installing missing commands - timestamp: '2021-04-20T19:36:05.9163568Z' - - id: 33 - message: Verify run directory - timestamp: '2021-04-20T19:36:05.9163934Z' - - id: 34 - message: 'Executing user command: echo "skipping build step: no build command specified"' - timestamp: '2021-04-20T19:36:05.9164636Z' - - id: 35 - message: 'skipping build step: no build command specified' - timestamp: '2021-04-20T19:36:05.9165087Z' - - id: 36 - message: Finished - timestamp: '2021-04-20T19:36:05.917412Z' - end: 37 - ended_on: '2021-04-20T19:36:06.38889Z' - name: build - start: 0 - started_on: '2021-04-20T19:35:58.238757Z' - status: success - total: 37 - type: object - domain-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - type: object - - properties: - result: - items: + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesProject' + required: + - success + - errors + - messages + - result type: object - type: array - domains-post: - example: - name: example.com - domain-response-single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - domain_name: - description: Name of the domain. - example: this-is-my-domain-01.com - pattern: '^[a-z0-9][a-z0-9-]*$' - type: string - projects-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - type: object - - properties: - result: - items: + description: Create project response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Create project response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create project + tags: + - Pages Project + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + method: create + /accounts/{account_id}/pages/projects/{project_name}: + delete: + description: Delete a project by name. + operationId: pages-project-delete-project + parameters: + - name: project_name + in: path + required: true + description: The Pages project name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + required: + - success + - errors + - messages + - result type: object - type: array - projects: - properties: - build_config: - $ref: '#/components/schemas/build_config' - canonical_deployment: - description: Most recent deployment to the repo. - oneOf: - - nullable: true - - $ref: '#/components/schemas/deployments' - readOnly: true - created_on: - description: When the project was created. - example: '2017-01-01T00:00:00Z' - format: date-time - readOnly: true - type: string - deployment_configs: - $ref: '#/components/schemas/deployment_configs' - domains: - description: A list of associated custom domains for the project. - example: - - customdomain.com - - customdomain.org - items: {} - readOnly: true - type: array - id: - description: Id of the project. - example: 7b162ea7-7367-4d67-bcde-1160995d5 - readOnly: true - type: string - latest_deployment: - description: Most recent deployment to the repo. - oneOf: - - nullable: true - - $ref: '#/components/schemas/deployments' - readOnly: true - name: - description: Name of the project. - example: NextJS Blog - type: string - production_branch: - description: Production branch of the project. Used to identify production deployments. - example: main - type: string - source: - readOnly: true - subdomain: - description: The Cloudflare subdomain associated with the project. - example: helloworld.pages.dev - readOnly: true - type: string - type: object - new-project-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - type: object - build_config: - description: Configs for the project build process. - properties: - build_command: - description: Command used to build project. - example: npm run build - nullable: true - type: string - destination_dir: - description: Output directory of the build. - example: build - nullable: true - type: string - root_dir: - description: Directory to run the command. - example: / - nullable: true - type: string - web_analytics_tag: - description: The classifying tag for analytics. - example: cee1c73f6e4743d0b5e6bb1a0bcaabcc - nullable: true - type: string - web_analytics_token: - description: The auth token for analytics. - example: 021e1057c18547eca7b79f2516f06o7x - nullable: true - type: string - type: object - deployment_configs: - description: Configs for deployments in a project. - properties: - preview: - description: Configs for preview deploys. - properties: - compatibility_date: - description: Compatibility date used for Pages Functions. - example: '2022-01-01' - type: string - compatibility_flags: - description: Compatibility flags used for Pages Functions. - example: - - url_standard - items: {} - type: array - d1_databases: - description: D1 databases used for Pages Functions. + description: Delete project response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Delete project response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete project + tags: + - Pages Project + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + method: delete + get: + description: Fetch a project by name. + operationId: pages-project-get-project + parameters: + - name: project_name + in: path + required: true + description: The Pages project name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesProject' + required: + - success + - errors + - messages + - result + type: object + description: Get project response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Get project response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get project + tags: + - Pages Project + x-api-token-group: + - Pages Read + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + method: get + patch: + description: >- + Set new attributes for an existing project. Modify environment + variables. To delete an environment variable, set the key to null. + operationId: pages-project-update-project + parameters: + - name: project_name + in: path + required: true + description: The Pages project name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: properties: - D1_BINDING: - description: D1 binding. - example: - id: 445e2955-951a-43f8-a35b-a4d0c8138f63 + build_config: + description: Configs for the project build process. properties: - id: - description: UUID of the D1 database. - example: 445e2955-951a-43f8-a35b-a4d0c8138f63 + build_caching: + description: Enable build caching for the project. + type: boolean + x-auditable: true + build_command: + description: Command used to build project. type: string - type: object - type: object - durable_object_namespaces: - description: Durabble Object namespaces used for Pages Functions. - properties: - DO_BINDING: - description: Durabble Object binding. - example: - namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 - properties: - namespace_id: - description: ID of the Durabble Object namespace. - example: 5eb63bbbe01eeed093cb22bb8f5acdc3 + x-auditable: true + destination_dir: + description: Output directory of the build. + type: string + x-auditable: true + root_dir: + description: Directory to run the command. + type: string + x-auditable: true + web_analytics_tag: + description: The classifying tag for analytics. + nullable: true type: string + x-auditable: true + web_analytics_token: + description: The auth token for analytics. + nullable: true + type: string + x-sensitive: true type: object - type: object - env_vars: - description: Environment variables for build configs. - nullable: true - properties: - BUILD_VERSION: - description: Environment variable. - example: - value: '3.3' + deployment_configs: + description: Configs for deployments in a project. properties: - value: - description: Environment variable value. - example: '3.3' - type: string + preview: + description: Configs for preview deploys. + $ref: '#/components/schemas/pagesDeploymentConfigValuesRequest' + production: + description: Configs for production deploys. + $ref: '#/components/schemas/pagesDeploymentConfigValuesRequest' type: object - type: object - kv_namespaces: - description: KV namespaces used for Pages Functions. - properties: - KV_BINDING: - description: KV binding. - example: - namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 + name: + description: Name of the project. + type: string + x-auditable: true + production_branch: + description: >- + Production branch of the project. Used to identify + production deployments. + type: string + x-auditable: true + source: + description: Configs for the project source control. properties: - namespace_id: - description: ID of the KV namespace. - example: 5eb63bbbe01eeed093cb22bb8f5acdc3 + config: + properties: + deployments_enabled: + deprecated: true + description: >- + Whether to enable automatic deployments when pushing + to the source repository. When disabled, no + deployments (production or preview) will be + triggered automatically. + type: boolean + x-auditable: true + x-stainless-deprecation-message: >- + Use `production_deployments_enabled` and + `preview_deployment_setting` for more granular + control. + owner: + description: The owner of the repository. + type: string + x-auditable: true + owner_id: + description: The owner ID of the repository. + type: string + x-auditable: true + path_excludes: + description: >- + A list of paths that should be excluded from + triggering a preview deployment. Wildcard syntax + (`*`) is supported. + items: + type: string + x-auditable: true + type: array + path_includes: + description: >- + A list of paths that should be watched to trigger a + preview deployment. Wildcard syntax (`*`) is + supported. + items: + type: string + x-auditable: true + type: array + pr_comments_enabled: + description: Whether to enable PR comments. + type: boolean + x-auditable: true + preview_branch_excludes: + description: >- + A list of branches that should not trigger a preview + deployment. Wildcard syntax (`*`) is supported. Must + be used with `preview_deployment_setting` set to + `custom`. + items: + type: string + x-auditable: true + type: array + preview_branch_includes: + description: >- + A list of branches that should trigger a preview + deployment. Wildcard syntax (`*`) is supported. Must + be used with `preview_deployment_setting` set to + `custom`. + items: + type: string + x-auditable: true + type: array + preview_deployment_setting: + description: >- + Controls whether commits to preview branches trigger + a preview deployment. + enum: + - all + - none + - custom + type: string + x-auditable: true + production_branch: + description: The production branch of the repository. + type: string + x-auditable: true + production_deployments_enabled: + description: >- + Whether to trigger a production deployment on + commits to the production branch. + type: boolean + x-auditable: true + repo_id: + description: The ID of the repository. + type: string + x-auditable: true + repo_name: + description: The name of the repository. + type: string + x-auditable: true + type: object + type: + description: The source control management provider. + enum: + - github + - gitlab type: string + x-auditable: true + required: + - type + - config type: object type: object - r2_buckets: - description: R2 buckets used for Pages Functions. - properties: - R2_BINDING: - description: R2 binding. - example: - name: some-bucket - properties: - name: - description: Name of the R2 bucket. - example: some-bucket - type: string - type: object - type: object - type: object - production: - description: Configs for production deploys. - properties: - compatibility_date: - description: Compatibility date used for Pages Functions. - example: '2022-01-01' - type: string - compatibility_flags: - description: Compatibility flags used for Pages Functions. - example: - - url_standard - items: {} - type: array - d1_databases: - description: D1 databases used for Pages Functions. - properties: - D1_BINDING: - description: D1 binding. - example: - id: 445e2955-951a-43f8-a35b-a4d0c8138f63 - properties: - id: - description: UUID of the D1 database. - example: 445e2955-951a-43f8-a35b-a4d0c8138f63 - type: string - type: object - type: object - durable_object_namespaces: - description: Durabble Object namespaces used for Pages Functions. - properties: - DO_BINDING: - description: Durabble Object binding. - example: - namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 - properties: - namespace_id: - description: ID of the Durabble Object namespace. - example: 5eb63bbbe01eeed093cb22bb8f5acdc3 - type: string - type: object - type: object - env_vars: - description: Environment variables for build configs. - nullable: true - properties: - BUILD_VERSION: - description: Environment variable. - example: - value: '3.3' - properties: - value: - description: Environment variable value. - example: '3.3' - type: string - type: object - type: object - kv_namespaces: - description: KV namespaces used for Pages Functions. - properties: - KV_BINDING: - description: KV binding. - example: - namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 - properties: - namespace_id: - description: ID of the KV namespace. - example: 5eb63bbbe01eeed093cb22bb8f5acdc3 - type: string - type: object - type: object - r2_buckets: - description: R2 buckets used for Pages Functions. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesProject' + required: + - success + - errors + - messages + - result + type: object + description: Update project response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Update project response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update project + tags: + - Pages Project + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + method: edit + /accounts/{account_id}/pages/projects/{project_name}/deployments: + get: + description: Fetch a list of project deployments. + operationId: pages-deployment-get-deployments + parameters: + - name: project_name + in: path + required: true + description: The Pages project name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: env + schema: + description: What type of deployments to fetch. + enum: + - production + - preview + type: string + - in: query + name: page + schema: + description: Which page of deployments to fetch. + type: integer + - in: query + name: per_page + schema: + description: How many deployments to return per page. + type: integer + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/pagesDeployment' + type: array + required: + - success + - errors + - messages + - result + description: Get deployments response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Get deployments response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get deployments + tags: + - Pages Deployment + x-api-token-group: + - Pages Read + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - deployments + method: list + post: + description: >- + Start a new deployment from production. The repository and account must + have already been authorized on the Cloudflare Pages dashboard. + operationId: pages-deployment-create-deployment + parameters: + - name: project_name + in: path + required: true + description: The Pages project name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + encoding: + _headers: + contentType: text/plain + _redirects: + contentType: text/plain + _routes.json: + contentType: application/json + _worker.bundle: + contentType: multipart/form-data + _worker.js: + contentType: >- + application/javascript+module, text/javascript+module, + application/javascript, text/javascript + functions-filepath-routing-config.json: + contentType: application/json + manifest: + contentType: application/json + schema: properties: - R2_BINDING: - description: R2 binding. - example: - name: some-bucket - properties: - name: - description: Name of the R2 bucket. - example: some-bucket - type: string - type: object - type: object - type: object - type: object - project-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - type: object - project-patch: - example: - deployment_configs: - production: - compatibility_date: '2022-01-01' - compatibility_flags: - - url_standard - env_vars: - BUILD_VERSION: - value: '3.3' - delete_this_env_var: null - r2-single-bucket-operation-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: + _headers: + description: Headers configuration file for the deployment. + format: binary + type: string + _redirects: + description: Redirects configuration file for the deployment. + format: binary + type: string + _routes.json: + description: Routes configuration file defining routing rules. + format: binary + type: string + _worker.bundle: + description: >- + Worker bundle file in multipart/form-data format. Mutually + exclusive with `_worker.js`. Cannot specify both + `_worker.js` and `_worker.bundle` in the same request. + Maximum size: 25 MiB. + format: binary + type: string + _worker.js: + description: >- + Worker JavaScript file. Mutually exclusive with + `_worker.bundle`. Cannot specify both `_worker.js` and + `_worker.bundle` in the same request. + format: binary + type: string + branch: + description: >- + The branch to build the new deployment from. The `HEAD` of + the branch will be used. If omitted, the production branch + will be used by default. + type: string + x-auditable: true + commit_dirty: + description: >- + Boolean string indicating if the working directory has + uncommitted changes. + enum: + - 'true' + - 'false' + type: string + commit_hash: + description: Git commit SHA associated with this deployment. + type: string + commit_message: + description: Git commit message associated with this deployment. + type: string + functions-filepath-routing-config.json: + description: Functions routing configuration file. + format: binary + type: string + manifest: + description: >- + JSON string containing a manifest of files to deploy. Maps + file paths to their content hashes. Required for direct + upload deployments. Maximum 20,000 entries. + type: string + pages_build_output_dir: + description: The build output directory path. + type: string + wrangler_config_hash: + description: >- + Hash of the Wrangler configuration file used for this + deployment. + type: string type: object - bucket_name: - description: Name of the bucket. The name must be greater than 2 and less than 64 characters. - example: example-bucket - pattern: '^[a-z0-9][a-z0-9-]*[a-z0-9]' - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_pagerules_settings: - id: cloudflare.pages.zones_pagerules_settings - name: zones_pagerules_settings - title: Zones Pagerules Settings - methods: - available_page_rules_settings_list_available_page_rules_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _available_page_rules_settings_list_available_page_rules_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_pagerules_settings/methods/available_page_rules_settings_list_available_page_rules_settings' - insert: [] - update: [] - delete: [] - zones_custom_pages: - id: cloudflare.pages.zones_custom_pages - name: zones_custom_pages - title: Zones Custom Pages - methods: - custom_pages_for_a_zone_list_custom_pages: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_pages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _custom_pages_for_a_zone_list_custom_pages: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_pages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_pages_for_a_zone_get_a_custom_page: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_pages~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _custom_pages_for_a_zone_get_a_custom_page: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_pages~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_pages_for_a_zone_update_a_custom_page: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_pages~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_custom_pages/methods/custom_pages_for_a_zone_list_custom_pages' - - $ref: '#/components/x-stackQL-resources/zones_custom_pages/methods/custom_pages_for_a_zone_get_a_custom_page' - insert: [] - update: [] - delete: [] - accounts_custom_pages: - id: cloudflare.pages.accounts_custom_pages - name: accounts_custom_pages - title: Accounts Custom Pages - methods: - custom_pages_for_an_account_list_custom_pages: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1custom_pages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _custom_pages_for_an_account_list_custom_pages: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1custom_pages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_pages_for_an_account_get_a_custom_page: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1custom_pages~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _custom_pages_for_an_account_get_a_custom_page: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1custom_pages~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_pages_for_an_account_update_a_custom_page: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1custom_pages~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_custom_pages/methods/custom_pages_for_an_account_list_custom_pages' - - $ref: '#/components/x-stackQL-resources/accounts_custom_pages/methods/custom_pages_for_an_account_get_a_custom_page' - insert: [] - update: [] - delete: [] - zones_pagerules: - id: cloudflare.pages.zones_pagerules - name: zones_pagerules - title: Zones Pagerules - methods: - page_rules_list_page_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _page_rules_list_page_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - page_rules_create_a_page_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - page_rules_delete_a_page_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - page_rules_get_a_page_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _page_rules_get_a_page_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - page_rules_edit_a_page_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - page_rules_update_a_page_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1pagerules~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_pagerules/methods/page_rules_list_page_rules' - - $ref: '#/components/x-stackQL-resources/zones_pagerules/methods/page_rules_get_a_page_rule' - insert: - - $ref: '#/components/x-stackQL-resources/zones_pagerules/methods/page_rules_create_a_page_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_pagerules/methods/page_rules_delete_a_page_rule' - accounts_projects_deployments: - id: cloudflare.pages.accounts_projects_deployments - name: accounts_projects_deployments - title: Accounts Projects Deployments - methods: - deployment_get_deployments: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _deployment_get_deployments: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - deployment_create_deployment: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - deployment_delete_deployment: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - deployment_get_deployment_info: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _deployment_get_deployment_info: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - deployment_retry_deployment: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}~1retry/post' - response: - mediaType: application/json - openAPIDocKey: '200' - deployment_rollback_deployment: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}~1rollback/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_projects_deployments/methods/deployment_get_deployments' - - $ref: '#/components/x-stackQL-resources/accounts_projects_deployments/methods/deployment_get_deployment_info' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_projects_deployments/methods/deployment_create_deployment' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_projects_deployments/methods/deployment_delete_deployment' - accounts_projects_deployments_history_logs: - id: cloudflare.pages.accounts_projects_deployments_history_logs - name: accounts_projects_deployments_history_logs - title: Accounts Projects Deployments History Logs - methods: - deployment_get_deployment_logs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}~1history~1logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _deployment_get_deployment_logs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}~1history~1logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - deployment_get_deployment_stage_logs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}~1history~1{deployment_stage_name}~1logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _deployment_get_deployment_stage_logs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1deployments~1{deployment_identifier}~1history~1{deployment_stage_name}~1logs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_projects_deployments_history_logs/methods/deployment_get_deployment_logs' - - $ref: '#/components/x-stackQL-resources/accounts_projects_deployments_history_logs/methods/deployment_get_deployment_stage_logs' - insert: [] - update: [] - delete: [] - accounts_projects_domains: - id: cloudflare.pages.accounts_projects_domains - name: accounts_projects_domains - title: Accounts Projects Domains - methods: - domains_get_domains: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _domains_get_domains: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - domains_add_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1domains/post' - response: - mediaType: application/json - openAPIDocKey: '200' - domains_delete_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1domains~1{domain_name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - domains_get_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1domains~1{domain_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _domains_get_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1domains~1{domain_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - domains_patch_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}~1domains~1{domain_name}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_projects_domains/methods/domains_get_domains' - - $ref: '#/components/x-stackQL-resources/accounts_projects_domains/methods/domains_get_domain' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_projects_domains/methods/domains_delete_domain' - accounts_projects: - id: cloudflare.pages.accounts_projects - name: accounts_projects - title: Accounts Projects - methods: - project_get_projects: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _project_get_projects: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects/get' - response: - mediaType: application/json - openAPIDocKey: '200' - project_create_project: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects/post' - response: - mediaType: application/json - openAPIDocKey: '200' - project_delete_project: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - project_get_project: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _project_get_project: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - project_update_project: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1pages~1projects~1{project_name}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_projects/methods/project_get_projects' - - $ref: '#/components/x-stackQL-resources/accounts_projects/methods/project_get_project' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_projects/methods/project_create_project' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_projects/methods/project_delete_project' - accounts_r2_buckets: - id: cloudflare.pages.accounts_r2_buckets - name: accounts_r2_buckets - title: Accounts R2 Buckets - methods: - r_2_bucket_create_bucket: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1r2~1buckets/post' - response: - mediaType: application/json - openAPIDocKey: '200' - r_2_bucket_delete_bucket: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1r2~1buckets~1{bucket_name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/accounts_r2_buckets/methods/r_2_bucket_create_bucket' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_r2_buckets/methods/r_2_bucket_delete_bucket' -paths: - '/zones/{zone_identifier}/pagerules/settings': - get: - description: Returns a list of settings (and their details) that Page Rules can apply to matching requests. - operationId: available-page-rules-settings-list-available-page-rules-settings - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pagerule_settings_response_collection' - description: List available Page Rules settings response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDeployment' + required: + - success + - errors + - messages + - result + type: object + description: Create deployment response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pagerule_settings_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List available Page Rules settings response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Create deployment response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: List available Page Rules settings - tags: - - Available Page Rules settings - x-cfPermissionsRequired: - enum: - - '#zone:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/custom_pages': - get: - description: Fetches all the custom pages at the zone level. - operationId: custom-pages-for-a-zone-list-custom-pages - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/custom_pages_response_collection' - description: List custom pages response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/custom_pages_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List custom pages response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: List custom pages + summary: Create deployment tags: - - Custom pages for a zone - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/custom_pages/{identifier}': - get: - description: Fetches the details of a custom page. - operationId: custom-pages-for-a-zone-get-a-custom-page + - Pages Deployment + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - deployments + method: create + /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}: + delete: + description: Delete a deployment. + operationId: pages-deployment-delete-deployment parameters: - in: path - name: identifier + name: deployment_id + schema: + $ref: '#/components/schemas/pagesIdentifier' + required: true + - name: project_name + in: path required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/custom-pages_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - in: query + name: force + schema: + description: >- + Allow deletion of aliased non-production deployments when a normal + delete would be rejected. + type: boolean responses: '200': content: application/json: schema: - $ref: '#/components/schemas/custom_pages_response_single' - description: Get a custom page response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + required: + - success + - errors + - messages + - result + type: object + description: Delete deployment response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_pages_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a custom page response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Delete deployment response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get a custom page + summary: Delete deployment tags: - - Custom pages for a zone - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - put: - description: Updates the configuration of an existing custom page. - operationId: custom-pages-for-a-zone-update-a-custom-page + - Pages Deployment + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - deployments + method: delete + get: + description: Fetch information about a deployment. + operationId: pages-deployment-get-deployment-info parameters: - in: path - name: identifier + name: deployment_id + schema: + $ref: '#/components/schemas/pagesIdentifier' required: true + - name: project_name + in: path + required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/custom-pages_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - state: - $ref: '#/components/schemas/schemas-state' - url: - $ref: '#/components/schemas/url' - required: - - url - - state - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/custom_pages_response_single' - description: Update a custom page response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDeployment' + required: + - success + - errors + - messages + - result + type: object + description: Get deployment info response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_pages_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a custom page response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Get deployment info response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update a custom page + summary: Get deployment info tags: - - Custom pages for a zone - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/accounts/{account_identifier}/custom_pages': + - Pages Deployment + x-api-token-group: + - Pages Read + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - deployments + method: get + /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs: get: - description: Fetches all the custom pages at the account level. - operationId: custom-pages-for-an-account-list-custom-pages + description: Fetch deployment logs for a project. + operationId: pages-deployment-get-deployment-logs parameters: - in: path - name: account_identifier + name: deployment_id + schema: + $ref: '#/components/schemas/pagesIdentifier' + required: true + - name: project_name + in: path required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/custom_pages_response_collection' - description: List custom pages response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDeploymentLog' + required: + - success + - errors + - messages + - result + type: object + description: Get deployment logs response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_pages_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List custom pages response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Get deployment logs response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List custom pages + summary: Get deployment logs tags: - - Custom pages for an account - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/accounts/{account_identifier}/custom_pages/{identifier}': - get: - description: Fetches the details of a custom page. - operationId: custom-pages-for-an-account-get-a-custom-page + - Pages Deployment + x-api-token-group: + - Pages Read + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - deployments + - history + - logs + method: get + /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry: + post: + description: Retry a previous deployment. + operationId: pages-deployment-retry-deployment parameters: - in: path - name: identifier + name: deployment_id + schema: + $ref: '#/components/schemas/pagesIdentifier' required: true + - name: project_name + in: path + required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/custom-pages_components-schemas-identifier-2' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/custom_pages_response_single' - description: Get a custom page response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDeployment' + required: + - success + - errors + - messages + - result + type: object + description: Retry deployment response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_pages_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a custom page response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Retry deployment response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get a custom page + summary: Retry deployment tags: - - Custom pages for an account - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - put: - description: Updates the configuration of an existing custom page. - operationId: custom-pages-for-an-account-update-a-custom-page + - Pages Deployment + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - deployments + method: retry + /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback: + post: + description: >- + Rollback the production deployment to a previous deployment. You can + only rollback to succesful builds on production. + operationId: pages-deployment-rollback-deployment parameters: - in: path - name: identifier + name: deployment_id + schema: + $ref: '#/components/schemas/pagesIdentifier' required: true + - name: project_name + in: path + required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/custom-pages_components-schemas-identifier-2' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - state: - $ref: '#/components/schemas/components-schemas-state' - url: - $ref: '#/components/schemas/url' - required: - - url - - state - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/custom_pages_response_single' - description: Update a custom page response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDeployment' + required: + - success + - errors + - messages + - result + type: object + description: Rollback deployment response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/custom_pages_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a custom page response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Rollback deployment response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update a custom page + summary: Rollback deployment tags: - - Custom pages for an account - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/pagerules': + - Pages Deployment + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - deployments + method: rollback + /accounts/{account_id}/pages/projects/{project_name}/domains: get: - description: Fetches Page Rules in a zone. - operationId: page-rules-list-page-rules + description: Fetch a list of all domains associated with a Pages project. + operationId: pages-domains-get-domains parameters: - - in: path - name: zone_identifier + - name: project_name + in: path + required: true + description: The Pages project name. + schema: + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pagerule_response_collection' - description: List Page Rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pagerule_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Page Rules response failure + type: object + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/pagesDomain' + type: array + required: + - success + - errors + - messages + - result + description: Get domains response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Get domains response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List Page Rules + summary: Get domains tags: - - Page Rules - x-cfPermissionsRequired: - enum: - - '#zone:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true + - Pages Domains + x-api-token-group: + - Pages Read + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - domains + method: list post: - description: Creates a new Page Rule. - operationId: page-rules-create-a-page-rule + description: Add a new domain for the Pages project. + operationId: pages-domains-add-domain parameters: - - in: path - name: zone_identifier + - name: project_name + in: path + required: true + description: The Pages project name. + schema: + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: - actions: - $ref: '#/components/schemas/schemas-actions' - priority: - $ref: '#/components/schemas/page-rule_components-schemas-priority' - status: - $ref: '#/components/schemas/page-rule_components-schemas-status' - targets: - $ref: '#/components/schemas/targets' + name: + $ref: '#/components/schemas/pagesDomainName' required: - - targets - - actions + - name type: object - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/pagerule_response_single' - description: Create a Page Rule response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDomain' + required: + - success + - errors + - messages + - result + type: object + description: Add domain response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pagerule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a Page Rule response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Add domain response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create a Page Rule + summary: Add domain tags: - - Page Rules - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/pagerules/{identifier}': + - Pages Domains + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - domains + method: create + /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}: delete: - description: Deletes an existing Page Rule. - operationId: page-rules-delete-a-page-rule + description: Delete a Pages project's domain. + operationId: pages-domains-delete-domain parameters: - in: path - name: identifier + name: domain_name + schema: + $ref: '#/components/schemas/pagesDomainName' required: true + - name: project_name + in: path + required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete a Page Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a Page Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a Page Rule - tags: - - Page Rules - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the details of a Page Rule. - operationId: page-rules-get-a-page-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pagerule_response_single' - description: Get a Page Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pagerule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Page Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Page Rule - tags: - - Page Rules - x-cfPermissionsRequired: - enum: - - '#zone:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Updates one or more fields of an existing Page Rule. - operationId: page-rules-edit-a-page-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - actions: - $ref: '#/components/schemas/schemas-actions' - priority: - $ref: '#/components/schemas/page-rule_components-schemas-priority' - status: - $ref: '#/components/schemas/page-rule_components-schemas-status' - targets: - $ref: '#/components/schemas/targets' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pagerule_response_single' - description: Edit a Page Rule response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + required: + - success + - errors + - messages + - result + type: object + description: Delete domain response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/pagerule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit a Page Rule response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Delete domain response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Edit a Page Rule - tags: - - Page Rules - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request. - operationId: page-rules-update-a-page-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - actions: - $ref: '#/components/schemas/schemas-actions' - priority: - $ref: '#/components/schemas/page-rule_components-schemas-priority' - status: - $ref: '#/components/schemas/page-rule_components-schemas-status' - targets: - $ref: '#/components/schemas/targets' - required: - - targets - - actions - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/pagerule_response_single' - description: Update a Page Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/pagerule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a Page Rule response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: Update a Page Rule + summary: Delete domain tags: - - Page Rules - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/accounts/{account_identifier}/pages/projects/{project_name}/deployments': + - Pages Domains + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - domains + method: delete get: - description: Fetch a list of deployments from a project. - operationId: pages-deployment-get-deployments + description: Fetch a single domain. + operationId: pages-domains-get-domain parameters: - in: path - name: project_name - required: true + name: domain_name schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier + $ref: '#/components/schemas/pagesDomainName' required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deployment-list-response' - description: Get deployments response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/deployment-list-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get deployments response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get deployments - tags: - - Pages Deployment - post: - description: Start a new deployment from production. The repo/account must have been authorized through the Pages UI dash before. - operationId: pages-deployment-create-deployment - parameters: - - in: path - name: project_name + - name: project_name + in: path required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/deployment-new-deployment' - description: Create deployment response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDomain' + required: + - success + - errors + - messages + - result + type: object + description: Get domain response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/deployment-new-deployment' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create deployment response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Get domain response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Create deployment - tags: - - Pages Deployment - '/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}': - delete: - description: Destroy a deployment. - operationId: pages-deployment-delete-deployment - parameters: - - in: path - name: deployment_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - example: - errors: [] - messages: [] - result: null - success: true - description: Delete deployment response - 4xx: - content: - application/json: - schema: - allOf: - - example: - errors: [] - messages: [] - result: null - success: true - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete deployment response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: Delete deployment + summary: Get domain tags: - - Pages Deployment - get: - description: Fetch a deployment. - operationId: pages-deployment-get-deployment-info + - Pages Domains + x-api-token-group: + - Pages Read + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - domains + method: get + patch: + description: Retry the validation status of a single domain. + operationId: pages-domains-patch-domain parameters: - in: path - name: deployment_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true + name: domain_name schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deployment-response-details' - description: Get deployment info response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/deployment-response-details' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get deployment info response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get deployment info - tags: - - Pages Deployment - '/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/history/logs': - get: - description: Fetch deploy logs. - operationId: pages-deployment-get-deployment-logs - parameters: - - in: path - name: deployment_identifier + $ref: '#/components/schemas/pagesDomainName' required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: project_name + - name: project_name + in: path required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/deployment-response-logs' - description: Get deployment logs response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/pagesDomain' + required: + - success + - errors + - messages + - result + type: object + description: Patch domain response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/deployment-response-logs' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get deployment logs response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Patch domain response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Get deployment logs - tags: - - Pages Deployment - '/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/history/{deployment_stage_name}/logs': - get: - deprecated: true - description: Fetch deploy logs. - operationId: pages-deployment-get-deployment-stage-logs - parameters: - - in: path - name: deployment_stage_name - required: true - schema: - $ref: '#/components/schemas/deployment_stage_name' - - in: path - name: deployment_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deployment-response-stage-logs' - description: Get deployment stage logs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/deployment-response-stage-logs' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get deployment stage logs response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: Get deployment stage logs + summary: Patch domain tags: - - Pages Deployment - x-cfDeprecation: - $ref: '#/components/schemas/deployments/x-cfDeprecations/logs_v1_deprecated' - '/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/retry': + - Pages Domains + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + - domains + method: edit + /accounts/{account_id}/pages/projects/{project_name}/purge_build_cache: post: - description: Retry a previous deployment. - operationId: pages-deployment-retry-deployment + description: Purge all cached build artifacts for a Pages project + operationId: pages-purge-build-cache parameters: - - in: path - name: deployment_identifier + - name: project_name + in: path required: true + description: The Pages project name. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/deployment-new-deployment' - description: Retry deployment response - 4xx: + properties: + errors: + $ref: '#/components/schemas/pagesMessages' + messages: + $ref: '#/components/schemas/pagesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: object + required: + - success + - errors + - messages + - result + type: object + description: Purge build cache response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/deployment-new-deployment' - - $ref: '#/components/schemas/api-response-common-failure' - description: Retry deployment response failure + $ref: '#/components/schemas/pagesApiResponseCommonFailure' + description: Purge build cache failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Retry deployment - tags: - - Pages Deployment - '/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/rollback': - post: - description: Rollback the production deployment to a previous deploy. You can only rollback to succesful builds on production. - operationId: pages-deployment-rollback-deployment - parameters: - - in: path - name: deployment_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deployment-response-details' - description: Rollback deployment response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/deployment-response-details' - - $ref: '#/components/schemas/api-response-common-failure' - description: Rollback deployment response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: Rollback deployment + summary: Purge build cache tags: - - Pages Deployment - '/accounts/{account_identifier}/pages/projects/{project_name}/domains': - get: - description: Fetch a list of all domains. - operationId: pages-domains-get-domains - parameters: - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain-response-collection' - description: Get domains response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get domains response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get domains - tags: - - Pages Domains - post: - description: Add a new domain for the Pages project. - operationId: pages-domains-add-domain - parameters: - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/domains-post' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain-response-single' - description: Add domain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Add domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Add domain - tags: - - Pages Domains - '/accounts/{account_identifier}/pages/projects/{project_name}/domains/{domain_name}': - delete: - description: Delete a domain. - operationId: pages-domains-delete-domain - parameters: - - in: path - name: domain_name - required: true - schema: - $ref: '#/components/schemas/domain_name' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - example: - errors: [] - messages: [] - result: null - success: true - description: Delete domain response - 4xx: - content: - application/json: - schema: - allOf: - - example: - errors: [] - messages: [] - result: null - success: true - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete domain - tags: - - Pages Domains - get: - description: Fetch a single domain. - operationId: pages-domains-get-domain - parameters: - - in: path - name: domain_name - required: true - schema: - $ref: '#/components/schemas/domain_name' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain-response-single' - description: Get domain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get domain - tags: - - Pages Domains - patch: - description: Retry the validation status of a single domain. - operationId: pages-domains-patch-domain - parameters: - - in: path - name: domain_name - required: true - schema: - $ref: '#/components/schemas/domain_name' - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/domain-response-single' - description: Patch domain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/domain-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Patch domain - tags: - - Pages Domains - '/accounts/{account_identifier}/pages/projects': - get: - description: Fetch a list of all user projects. - operationId: pages-project-get-projects - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/projects-response' - description: Get projects response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/projects-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get projects response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get projects - tags: - - Pages Project - post: - description: Make a new project. - operationId: pages-project-create-project - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/projects' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/new-project-response' - description: Create project response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/new-project-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create project response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create project - tags: - - Pages Project - '/accounts/{account_identifier}/pages/projects/{project_name}': - delete: - description: Destroy a project by name. - operationId: pages-project-delete-project - parameters: - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - example: - errors: [] - messages: [] - result: null - success: true - description: Delete project response - 4xx: - content: - application/json: - schema: - allOf: - - example: - errors: [] - messages: [] - result: null - success: true - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete project response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete project - tags: - - Pages Project - get: - description: Fetch a project by name. - operationId: pages-project-get-project - parameters: - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/project-response' - description: Get project response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/project-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get project response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get project - tags: - - Pages Project - patch: - description: 'Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.' - operationId: pages-project-update-project - parameters: - - in: path - name: project_name - required: true - schema: - $ref: '#/components/schemas/project_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/project-patch' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/new-project-response' - description: Update project response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/new-project-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update project response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update project - tags: - - Pages Project - '/accounts/{account_identifier}/r2/buckets': - post: - description: Creates a new R2 bucket. - operationId: r-2-bucket-create-bucket - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: '{''name'': ''example-bucket''}' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/r2-single-bucket-operation-response' - description: Create Bucket response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/r2-single-bucket-operation-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Bucket response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Bucket - tags: - - R2 Bucket - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.r2.bucket.create - '/accounts/{account_identifier}/r2/buckets/{bucket_name}': - delete: - description: Deletes an existing R2 bucket. - operationId: r-2-bucket-delete-bucket - parameters: - - in: path - name: bucket_name - required: true - schema: - $ref: '#/components/schemas/bucket_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/r2-single-bucket-operation-response' - description: Delete Bucket response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/r2-single-bucket-operation-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Bucket response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Bucket - tags: - - R2 Bucket - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.r2.bucket.delete + - Pages Build Cache + x-api-token-group: + - Pages Write + x-stackql-sdk: + service: pages + resource_chain: + - projects + method: purge_build_cache +components: + schemas: + pagesApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/pagesMessages' + messages: + example: [] + $ref: '#/components/schemas/pagesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + pagesBuildConfig: + description: Configs for the project build process. + properties: + build_caching: + description: Enable build caching for the project. + example: true + nullable: true + type: boolean + x-auditable: true + build_command: + description: Command used to build project. + example: npm run build + nullable: true + type: string + x-auditable: true + destination_dir: + description: Assets output directory of the build. + example: build + nullable: true + type: string + x-auditable: true + root_dir: + description: Directory to run the command. + example: / + nullable: true + type: string + x-auditable: true + web_analytics_tag: + description: The classifying tag for analytics. + example: cee1c73f6e4743d0b5e6bb1a0bcaabcc + nullable: true + type: string + x-auditable: true + web_analytics_token: + description: The auth token for analytics. + example: 021e1057c18547eca7b79f2516f06o7x + nullable: true + type: string + x-sensitive: true + required: + - web_analytics_tag + - web_analytics_token + type: object + pagesDeployment: + properties: + aliases: + description: A list of alias URLs pointing to this deployment. + example: + - https://branchname.projectname.pages.dev + items: + type: string + x-auditable: true + nullable: true + readOnly: true + type: array + build_config: + $ref: '#/components/schemas/pagesBuildConfig' + created_on: + description: When the deployment was created. + example: '2021-03-09T00:55:03.923456Z' + format: date-time + readOnly: true + type: string + x-auditable: true + deployment_trigger: + description: Info about what caused the deployment. + properties: + metadata: + description: Additional info about the trigger. + properties: + branch: + description: Where the trigger happened. + example: main + type: string + x-auditable: true + commit_dirty: + description: Whether the deployment trigger commit was dirty. + example: false + type: boolean + x-auditable: true + commit_hash: + description: Hash of the deployment trigger commit. + example: ad9ccd918a81025731e10e40267e11273a263421 + type: string + x-auditable: true + commit_message: + description: Message of the deployment trigger commit. + example: Update index.html + type: string + x-auditable: true + required: + - branch + - commit_hash + - commit_message + - commit_dirty + type: object + type: + description: What caused the deployment. + enum: + - github:push + - ad_hoc + - deploy_hook + example: ad_hoc + type: string + x-auditable: true + readOnly: true + required: + - type + - metadata + type: object + env_vars: + $ref: '#/components/schemas/pagesEnvVars' + environment: + description: Type of deploy. + enum: + - preview + - production + example: preview + readOnly: true + type: string + x-auditable: true + id: + description: Id of the deployment. + example: f64788e9-fccd-4d4a-a28a-cb84f88f6 + readOnly: true + type: string + x-auditable: true + is_skipped: + description: If the deployment has been skipped. + example: true + readOnly: true + type: boolean + x-auditable: true + latest_stage: + $ref: '#/components/schemas/pagesStage' + modified_on: + description: When the deployment was last modified. + example: '2021-03-09T00:58:59.045655Z' + format: date-time + readOnly: true + type: string + x-auditable: true + project_id: + description: Id of the project. + example: 7b162ea7-7367-4d67-bcde-1160995d5 + readOnly: true + type: string + x-auditable: true + project_name: + $ref: '#/components/schemas/pagesProjectName' + short_id: + description: Short Id (8 character) of the deployment. + example: f64788e9 + readOnly: true + type: string + x-auditable: true + source: + $ref: '#/components/schemas/pagesSource' + stages: + description: List of past stages. + example: + - ended_on: '2021-06-03T15:39:03.134378Z' + name: queued + started_on: '2021-06-03T15:38:15.608194Z' + status: active + - ended_on: null + name: initialize + started_on: null + status: idle + - ended_on: null + name: clone_repo + started_on: null + status: idle + - ended_on: null + name: build + started_on: null + status: idle + - ended_on: null + name: deploy + started_on: null + status: idle + items: + $ref: '#/components/schemas/pagesStage' + readOnly: true + type: array + url: + description: The live URL to view this deployment. + example: https://f64788e9.ninjakittens.pages.dev + readOnly: true + type: string + x-auditable: true + uses_functions: + description: Whether the deployment uses functions. + nullable: true + readOnly: true + type: boolean + x-auditable: true + required: + - aliases + - build_config + - created_on + - deployment_trigger + - environment + - env_vars + - id + - is_skipped + - latest_stage + - modified_on + - project_id + - project_name + - short_id + - source + - stages + - url + type: object + pagesDeploymentConfigValues: + properties: + ai_bindings: + description: Constellation bindings used for Pages Functions. + example: + AI_BINDING: + project_id: some-project-id + type: object + always_use_latest_compatibility_date: + description: >- + Whether to always use the latest compatibility date for Pages + Functions. + example: false + type: boolean + x-auditable: true + analytics_engine_datasets: + description: Analytics Engine bindings used for Pages Functions. + example: + ANALYTICS_ENGINE_BINDING: + dataset: api_analytics + type: object + browsers: + description: Browser bindings used for Pages Functions. + example: + BROWSER: {} + type: object + build_image_major_version: + description: The major version of the build image to use for Pages Functions. + example: 3 + type: integer + x-auditable: true + compatibility_date: + description: Compatibility date used for Pages Functions. + example: '2025-01-01' + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + compatibility_flags: + description: Compatibility flags used for Pages Functions. + example: + - url_standard + items: + type: string + x-auditable: true + type: array + d1_databases: + description: D1 databases used for Pages Functions. + example: + D1_BINDING: + id: 445e2955-951a-43f8-a35b-a4d0c8138f63 + type: object + durable_object_namespaces: + description: Durable Object namespaces used for Pages Functions. + example: + DO_BINDING: + namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 + type: object + env_vars: + $ref: '#/components/schemas/pagesEnvVars' + fail_open: + description: Whether to fail open when the deployment config cannot be applied. + example: true + type: boolean + x-auditable: true + hyperdrive_bindings: + description: Hyperdrive bindings used for Pages Functions. + example: + HYPERDRIVE: + id: a76a99bc342644deb02c38d66082262a + type: object + kv_namespaces: + description: KV namespaces used for Pages Functions. + example: + KV_BINDING: + namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 + type: object + limits: + description: Limits for Pages Functions. + example: + cpu_ms: 100 + properties: + cpu_ms: + description: CPU time limit in milliseconds. + example: 100 + type: integer + x-auditable: true + required: + - cpu_ms + type: object + mtls_certificates: + description: mTLS bindings used for Pages Functions. + example: + MTLS: + certificate_id: d7cdd17c-916f-4cb7-aabe-585eb382ec4e + type: object + placement: + description: Placement setting used for Pages Functions. + example: + mode: smart + properties: + mode: + description: Placement mode. + example: smart + type: string + x-auditable: true + required: + - mode + type: object + queue_producers: + description: Queue Producer bindings used for Pages Functions. + example: + QUEUE_PRODUCER_BINDING: + name: some-queue + type: object + r2_buckets: + description: R2 buckets used for Pages Functions. + example: + R2_BINDING: + name: some-bucket + type: object + services: + description: Services used for Pages Functions. + example: + SERVICE_BINDING: + entrypoint: MyHandler + environment: production + service: example-worker + type: object + usage_model: + deprecated: true + description: The usage model for Pages Functions. + enum: + - standard + - bundled + - unbound + example: standard + type: string + x-auditable: true + x-stainless-deprecation-message: All new projects now use the Standard usage model. + vectorize_bindings: + description: Vectorize bindings used for Pages Functions. + example: + VECTORIZE: + index_name: my_index + type: object + wrangler_config_hash: + description: Hash of the Wrangler configuration used for the deployment. + example: abc123def456 + type: string + x-auditable: true + required: + - env_vars + - fail_open + - always_use_latest_compatibility_date + - compatibility_date + - compatibility_flags + - build_image_major_version + - usage_model + type: object + pagesDeploymentConfigValuesRequest: + properties: + ai_bindings: + description: Constellation bindings used for Pages Functions. + example: + AI_BINDING: + project_id: some-project-id + type: object + always_use_latest_compatibility_date: + default: false + description: >- + Whether to always use the latest compatibility date for Pages + Functions. + example: false + type: boolean + x-auditable: true + analytics_engine_datasets: + description: Analytics Engine bindings used for Pages Functions. + example: + ANALYTICS_ENGINE_BINDING: + dataset: api_analytics + type: object + browsers: + description: Browser bindings used for Pages Functions. + example: + BROWSER: {} + type: object + build_image_major_version: + default: 3 + description: The major version of the build image to use for Pages Functions. + example: 3 + type: integer + x-auditable: true + compatibility_date: + description: Compatibility date used for Pages Functions. + example: '2025-01-01' + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + compatibility_flags: + description: Compatibility flags used for Pages Functions. + example: + - url_standard + items: + type: string + x-auditable: true + type: array + d1_databases: + description: D1 databases used for Pages Functions. + example: + D1_BINDING: + id: 445e2955-951a-43f8-a35b-a4d0c8138f63 + type: object + durable_object_namespaces: + description: Durable Object namespaces used for Pages Functions. + example: + DO_BINDING: + namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 + type: object + env_vars: + description: Environment variables used for builds and Pages Functions. + type: object + fail_open: + default: true + description: Whether to fail open when the deployment config cannot be applied. + example: true + type: boolean + x-auditable: true + hyperdrive_bindings: + description: Hyperdrive bindings used for Pages Functions. + example: + HYPERDRIVE: + id: a76a99bc342644deb02c38d66082262a + type: object + kv_namespaces: + description: KV namespaces used for Pages Functions. + example: + KV_BINDING: + namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 + type: object + limits: + description: Limits for Pages Functions. + example: + cpu_ms: 100 + properties: + cpu_ms: + description: CPU time limit in milliseconds. + example: 100 + type: integer + x-auditable: true + required: + - cpu_ms + type: object + mtls_certificates: + description: mTLS bindings used for Pages Functions. + example: + MTLS: + certificate_id: d7cdd17c-916f-4cb7-aabe-585eb382ec4e + type: object + placement: + description: Placement setting used for Pages Functions. + example: + mode: smart + properties: + mode: + description: Placement mode. + example: smart + type: string + x-auditable: true + required: + - mode + type: object + queue_producers: + description: Queue Producer bindings used for Pages Functions. + example: + QUEUE_PRODUCER_BINDING: + name: some-queue + type: object + r2_buckets: + description: R2 buckets used for Pages Functions. + example: + R2_BINDING: + name: some-bucket + type: object + services: + description: Services used for Pages Functions. + example: + SERVICE_BINDING: + entrypoint: MyHandler + environment: production + service: example-worker + type: object + usage_model: + default: standard + deprecated: true + description: The usage model for Pages Functions. + enum: + - standard + - bundled + - unbound + example: standard + type: string + x-auditable: true + x-stainless-deprecation-message: All new projects now use the Standard usage model. + vectorize_bindings: + description: Vectorize bindings used for Pages Functions. + example: + VECTORIZE: + index_name: my_index + type: object + wrangler_config_hash: + description: Hash of the Wrangler configuration used for the deployment. + example: abc123def456 + type: string + x-auditable: true + type: object + pagesDeploymentLog: + example: + data: + - line: Cloning repository... + ts: '2021-04-20T19:35:29.0749819Z' + - line: From https://github.com/cloudflare/example + ts: '2021-04-20T19:35:30.0749819Z' + - line: ' * branch 209c5bb11d89533f426b2f8469bcae12fdccf71b -> FETCH_HEAD' + ts: '2021-04-20T19:35:30.0749819Z' + - line: '' + ts: '2021-04-20T19:35:30.0749819Z' + - line: HEAD is now at 209c5bb Update index.html + ts: '2021-04-20T19:35:30.0749819Z' + - line: '' + ts: '2021-04-20T19:35:30.0749819Z' + - line: '' + ts: '2021-04-20T19:35:30.0749819Z' + - line: 'Success: Finished cloning repository files' + ts: '2021-04-20T19:35:30.0749819Z' + - line: Installing dependencies + ts: '2021-04-20T19:35:59.0749819Z' + - line: Python version set to 2.7 + ts: '2021-04-20T19:35:59.0931208Z' + - line: v12.18.0 is already installed. + ts: '2021-04-20T19:36:02.2369501Z' + - line: Now using node v12.18.0 (npm v6.14.4) + ts: '2021-04-20T19:36:02.6028886Z' + - line: Started restoring cached build plugins + ts: '2021-04-20T19:36:02.624555Z' + - line: Finished restoring cached build plugins + ts: '2021-04-20T19:36:02.6340688Z' + - line: Attempting ruby version 2.7.1, read from environment + ts: '2021-04-20T19:36:02.963095Z' + - line: Using ruby version 2.7.1 + ts: '2021-04-20T19:36:04.2236084Z' + - line: Using PHP version 5.6 + ts: '2021-04-20T19:36:04.5450152Z' + - line: 5.2 is already installed. + ts: '2021-04-20T19:36:04.5740509Z' + - line: Using Swift version 5.2 + ts: '2021-04-20T19:36:04.577035Z' + - line: Installing Hugo 0.54.0 + ts: '2021-04-20T19:36:04.5771615Z' + - line: >- + Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 + BuildDate: 2019-02-01T10:04:38Z + ts: '2021-04-20T19:36:05.4786868Z' + - line: Started restoring cached go cache + ts: '2021-04-20T19:36:05.4794366Z' + - line: Finished restoring cached go cache + ts: '2021-04-20T19:36:05.481977Z' + - line: go version go1.14.4 linux/amd64 + ts: '2021-04-20T19:36:05.9049776Z' + - line: go version go1.14.4 linux/amd64 + ts: '2021-04-20T19:36:05.9086053Z' + - line: Installing missing commands + ts: '2021-04-20T19:36:05.9163568Z' + - line: Verify run directory + ts: '2021-04-20T19:36:05.9163934Z' + - line: >- + Executing user command: echo "skipping build step: no build + command specified" + ts: '2021-04-20T19:36:05.9164636Z' + - line: 'skipping build step: no build command specified' + ts: '2021-04-20T19:36:05.9165087Z' + - line: Finished + ts: '2021-04-20T19:36:05.917412Z' + includes_container_logs: true + total: 30 + properties: + data: + items: + $ref: '#/components/schemas/pagesDeploymentLog_data_item' + type: array + includes_container_logs: + readOnly: true + type: boolean + total: + readOnly: true + type: integer + required: + - total + - includes_container_logs + - data + type: object + pagesDeploymentLog_data_item: + properties: + line: + readOnly: true + type: string + ts: + readOnly: true + type: string + required: + - ts + - line + type: object + pagesDomain: + properties: + certificate_authority: + enum: + - google + - lets_encrypt + example: lets_encrypt + readOnly: true + type: string + x-auditable: true + created_on: + readOnly: true + type: string + x-auditable: true + domain_id: + readOnly: true + type: string + x-auditable: true + id: + readOnly: true + type: string + x-auditable: true + name: + $ref: '#/components/schemas/pagesDomainName' + status: + enum: + - initializing + - pending + - active + - deactivated + - blocked + - error + readOnly: true + type: string + x-auditable: true + validation_data: + properties: + error_message: + type: string + x-auditable: true + method: + enum: + - http + - txt + type: string + x-auditable: true + status: + enum: + - initializing + - pending + - active + - deactivated + - error + type: string + x-auditable: true + txt_name: + type: string + x-auditable: true + txt_value: + type: string + x-auditable: true + readOnly: true + required: + - status + - method + type: object + verification_data: + properties: + error_message: + type: string + x-auditable: true + status: + enum: + - pending + - active + - deactivated + - blocked + - error + type: string + readOnly: true + required: + - status + type: object + zone_tag: + readOnly: true + type: string + x-auditable: true + required: + - id + - domain_id + - name + - status + - created_on + - certificate_authority + - zone_tag + - validation_data + - verification_data + type: object + pagesDomainName: + description: The domain name. + example: this-is-my-domain-01.com + type: string + x-auditable: true + pagesEnvVars: + description: Environment variables used for builds and Pages Functions. + nullable: true + type: object + pagesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + pagesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + pagesProject: + properties: + build_config: + $ref: '#/components/schemas/pagesBuildConfig' + canonical_deployment: + $ref: '#/components/schemas/pagesDeployment' + description: Most recent production deployment of the project. + nullable: true + readOnly: true + type: object + created_on: + description: When the project was created. + example: '2017-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + deployment_configs: + description: Configs for deployments in a project. + properties: + preview: + description: Configs for preview deploys. + $ref: '#/components/schemas/pagesDeploymentConfigValues' + production: + description: Configs for production deploys. + $ref: '#/components/schemas/pagesDeploymentConfigValues' + required: + - production + - preview + type: object + domains: + description: A list of associated custom domains for the project. + example: + - customdomain.com + - customdomain.org + items: + type: string + x-auditable: true + readOnly: true + type: array + framework: + description: Framework the project is using. + readOnly: true + type: string + x-auditable: true + framework_version: + description: Version of the framework the project is using. + readOnly: true + type: string + x-auditable: true + id: + description: ID of the project. + example: 7b162ea7-7367-4d67-bcde-1160995d5 + readOnly: true + type: string + x-auditable: true + latest_deployment: + $ref: '#/components/schemas/pagesDeployment' + description: Most recent deployment of the project. + nullable: true + readOnly: true + type: object + name: + $ref: '#/components/schemas/pagesProjectName' + preview_script_name: + description: Name of the preview script. + example: pages-worker--1234567-preview + readOnly: true + type: string + x-auditable: true + production_branch: + description: >- + Production branch of the project. Used to identify production + deployments. + example: main + type: string + x-auditable: true + production_script_name: + description: Name of the production script. + example: pages-worker--1234567-production + readOnly: true + type: string + x-auditable: true + source: + $ref: '#/components/schemas/pagesSource' + subdomain: + description: The Cloudflare subdomain associated with the project. + example: helloworld.pages.dev + readOnly: true + type: string + x-auditable: true + uses_functions: + description: Whether the project uses functions. + nullable: true + readOnly: true + type: boolean + x-auditable: true + required: + - id + - name + - deployment_configs + - latest_deployment + - canonical_deployment + - created_on + - production_branch + - production_script_name + - preview_script_name + - uses_functions + - framework + - framework_version + type: object + pagesProjectName: + description: Name of the project. + example: this-is-my-project-01 + type: string + x-auditable: true + pagesSource: + description: Configs for the project source control. + properties: + config: + properties: + deployments_enabled: + deprecated: true + description: >- + Whether to enable automatic deployments when pushing to the + source repository. When disabled, no deployments (production or + preview) will be triggered automatically. + type: boolean + x-auditable: true + x-stainless-deprecation-message: >- + Use `production_deployments_enabled` and + `preview_deployment_setting` for more granular control. + owner: + description: The owner of the repository. + example: my-org + type: string + x-auditable: true + owner_id: + description: The owner ID of the repository. + example: '12345678' + type: string + x-auditable: true + path_excludes: + description: >- + A list of paths that should be excluded from triggering a + preview deployment. Wildcard syntax (`*`) is supported. + items: + type: string + x-auditable: true + type: array + path_includes: + description: >- + A list of paths that should be watched to trigger a preview + deployment. Wildcard syntax (`*`) is supported. + items: + type: string + x-auditable: true + type: array + pr_comments_enabled: + description: Whether to enable PR comments. + type: boolean + x-auditable: true + preview_branch_excludes: + description: >- + A list of branches that should not trigger a preview deployment. + Wildcard syntax (`*`) is supported. Must be used with + `preview_deployment_setting` set to `custom`. + items: + type: string + x-auditable: true + type: array + preview_branch_includes: + description: >- + A list of branches that should trigger a preview deployment. + Wildcard syntax (`*`) is supported. Must be used with + `preview_deployment_setting` set to `custom`. + items: + type: string + x-auditable: true + type: array + preview_deployment_setting: + description: >- + Controls whether commits to preview branches trigger a preview + deployment. + enum: + - all + - none + - custom + type: string + x-auditable: true + production_branch: + description: The production branch of the repository. + example: main + type: string + x-auditable: true + production_deployments_enabled: + description: >- + Whether to trigger a production deployment on commits to the + production branch. + type: boolean + x-auditable: true + repo_id: + description: The ID of the repository. + example: '12345678' + type: string + x-auditable: true + repo_name: + description: The name of the repository. + example: my-repo + type: string + x-auditable: true + required: + - deployments_enabled + - owner + - owner_id + - path_excludes + - path_includes + - pr_comments_enabled + - preview_branch_excludes + - preview_branch_includes + - preview_deployment_setting + - production_branch + - production_deployments_enabled + - repo_id + - repo_name + type: object + type: + description: The source control management provider. + enum: + - github + - gitlab + example: github + type: string + x-auditable: true + required: + - type + - config + type: object + pagesStage: + description: The status of the deployment. + properties: + ended_on: + description: When the stage ended. + example: '2021-03-09T00:58:59.045655Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + name: + description: The current build stage. + enum: + - queued + - initialize + - clone_repo + - build + - deploy + example: deploy + type: string + x-auditable: true + started_on: + description: When the stage started. + example: '2021-03-09T00:55:03.923456Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + status: + description: State of the current stage. + enum: + - success + - idle + - active + - failure + - canceled + example: success + readOnly: true + type: string + x-auditable: true + readOnly: true + required: + - name + - started_on + - ended_on + - status + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + projects: + id: cloudflare.pages.projects + name: projects + title: Projects + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pages~1projects/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pages~1projects/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + purge_build_cache: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1purge_build_cache/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/projects/methods/get' + - $ref: '#/components/x-stackQL-resources/projects/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete' + replace: [] + deployments: + id: cloudflare.pages.deployments + name: deployments + title: Deployments + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1deployments~1{deployment_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1deployments~1{deployment_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + retry: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1deployments~1{deployment_id}~1retry/post + response: + mediaType: application/json + openAPIDocKey: '200' + rollback: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1deployments~1{deployment_id}~1rollback/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/deployments/methods/get' + - $ref: '#/components/x-stackQL-resources/deployments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' + replace: [] + logs: + id: cloudflare.pages.logs + name: logs + title: Logs + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1deployments~1{deployment_id}~1history~1logs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.data + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + domains: + id: cloudflare.pages.domains + name: domains + title: Domains + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1domains/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1domains/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1domains~1{domain_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1domains~1{domain_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pages~1projects~1{project_name}~1domains~1{domain_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/pipelines.yaml b/providers/src/cloudflare/v00.00.00000/services/pipelines.yaml new file mode 100644 index 00000000..f468300f --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/pipelines.yaml @@ -0,0 +1,3211 @@ +openapi: 3.0.3 +info: + title: pipelines API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/pipelines: + get: + deprecated: true + description: >- + [DEPRECATED] List, filter, and paginate pipelines in an account. Use the + new /pipelines/v1/pipelines endpoint instead. + operationId: getV4AccountsByAccount_idPipelines_deprecated + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: search + schema: + description: Specifies the prefix of pipeline name to search. + type: string + - in: query + name: page + schema: + default: '1' + description: Specifies which page to retrieve. + type: string + - in: query + name: per_page + schema: + default: '25' + description: Specifies the number of pipelines per page. + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result_info: + properties: + count: + description: Indicates the number of items on current page. + type: number + page: + description: Indicates the current page number. + type: number + per_page: + description: Indicates the number of items per page. + type: number + total_count: + description: Indicates the total number of items. + type: number + required: + - count + - page + - per_page + - total_count + type: object + results: + items: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkersPipelinesPipeline + type: array + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - results + - result_info + type: object + description: >- + [DEPRECATED] Lists the pipelines. Use /pipelines/v1/pipelines + instead. + 4XX: + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + results: + nullable: true + type: object + x-stainless-empty-object: true + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - results + - errors + type: object + description: Indicates the error trying to list pipelines. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: '[DEPRECATED] List Pipelines' + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: list + post: + deprecated: true + description: >- + [DEPRECATED] Create a new pipeline. Use the new /pipelines/v1/pipelines + endpoint instead. + operationId: postV4AccountsByAccount_idPipelines_deprecated + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination: + properties: + batch: + properties: + max_bytes: + default: 100000000 + description: Specifies rough maximum size of files. + maximum: 100000000 + minimum: 1000 + type: integer + max_duration_s: + default: 300 + description: >- + Specifies duration to wait to aggregate batches + files. + maximum: 300 + minimum: 0.25 + type: number + max_rows: + default: 10000000 + description: Specifies rough maximum number of rows per file. + maximum: 10000000 + minimum: 100 + type: integer + type: object + compression: + properties: + type: + default: gzip + description: >- + Specifies the desired compression algorithm and + format. + enum: + - none + - gzip + - deflate + type: string + type: object + credentials: + properties: + access_key_id: + description: Specifies the R2 Bucket Access Key Id. + type: string + endpoint: + description: Specifies the R2 Endpoint. + type: string + secret_access_key: + description: Specifies the R2 Bucket Secret Access Key. + type: string + required: + - endpoint + - access_key_id + - secret_access_key + type: object + format: + description: Specifies the format of data to deliver. + enum: + - json + type: string + path: + properties: + bucket: + description: Specifies the R2 Bucket to store files. + type: string + filename: + description: >- + Specifies the name pattern to for individual data + files. + type: string + filepath: + description: Specifies the name pattern for directory. + type: string + prefix: + description: Specifies the base directory within the bucket. + type: string + required: + - bucket + type: object + type: + description: Specifies the type of destination. + enum: + - r2 + type: string + required: + - type + - format + - batch + - compression + - path + - credentials + type: object + name: + description: Defines the name of the pipeline. + maxLength: 128 + minLength: 1 + type: string + source: + items: + type: object + description: >- + [DEPRECATED] HTTP source configuration. Use the new + streams API instead. + properties: + authentication: + description: >- + Specifies whether authentication is required to send + to this pipeline via HTTP. + type: boolean + cors: + properties: + origins: + description: >- + Specifies allowed origins to allow Cross Origin + HTTP Requests. + items: + type: string + maxItems: 5 + type: array + type: object + format: + description: Specifies the format of source data. + enum: + - json + type: string + type: + type: string + required: + - format + - type + minItems: 1 + type: array + required: + - name + - source + - destination + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkersPipelinesPipeline + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: >- + [DEPRECATED] Indicates a successfully created pipeline. Use + /pipelines/v1/pipelines instead. + 4XX: + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + results: + nullable: true + type: object + x-stainless-empty-object: true + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - results + - errors + type: object + description: Indicates an error in creating a pipeline. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: '[DEPRECATED] Create Pipeline' + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: create + /accounts/{account_id}/pipelines/v1/pipelines: + get: + description: List/Filter Pipelines in Account. + operationId: getV4AccountsByAccount_idPipelinesV1Pipelines + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + type: number + - in: query + name: per_page + schema: + type: number + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + type: string + readOnly: true + id: + description: Indicates a unique identifier for this pipeline. + type: string + modified_at: + type: string + readOnly: true + name: + description: Indicates the name of the Pipeline. + maxLength: 128 + minLength: 1 + type: string + sql: + description: Specifies SQL for the Pipeline processing flow. + type: string + status: + description: Indicates the current status of the Pipeline. + type: string + required: + - id + - name + - created_at + - modified_at + - sql + - status + type: object + type: array + result_info: + properties: + count: + description: Indicates the number of items on current page. + type: number + page: + description: Indicates the current page number. + type: number + per_page: + description: Indicates the number of items per page. + type: number + total_count: + description: Indicates the total number of items. + type: number + required: + - count + - page + - per_page + - total_count + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + - result_info + type: object + description: Indicates a successfully listed Pipelines. + 4XX: + description: Indicates an error in listing Pipelines. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Pipelines + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: list_v1 + post: + description: Create a new Pipeline. + operationId: postV4AccountsByAccount_idPipelinesV1Pipelines + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + description: Specifies the name of the Pipeline. + maxLength: 128 + minLength: 1 + type: string + sql: + description: Specifies SQL for the Pipeline processing flow. + type: string + required: + - name + - sql + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + type: string + readOnly: true + id: + description: Indicates a unique identifier for this pipeline. + type: string + modified_at: + type: string + readOnly: true + name: + description: Indicates the name of the Pipeline. + maxLength: 128 + minLength: 1 + type: string + sql: + description: Specifies SQL for the Pipeline processing flow. + type: string + status: + description: Indicates the current status of the Pipeline. + type: string + required: + - id + - name + - created_at + - modified_at + - sql + - status + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully created Pipeline. + 4XX: + description: Indicates an error in creating a Pipeline. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Pipeline + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: create_v1 + /accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id}: + delete: + description: Delete Pipeline in Account. + operationId: deleteV4AccountsByAccount_idPipelinesV1PipelinesByPipeline_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pipeline_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesPipelineId' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully deleted Pipeline. + 4XX: + description: Indicates an error in listing Pipelines. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Pipelines + tags: + - workers_pipelines_other + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: delete_v1 + get: + description: Get Pipelines Details. + operationId: getV4AccountsByAccount_idPipelinesV1PipelinesByPipeline_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pipeline_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesPipelineId' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + type: string + readOnly: true + failure_reason: + description: Indicates the reason for the failure of the Pipeline. + type: string + id: + description: Indicates a unique identifier for this pipeline. + type: string + modified_at: + type: string + readOnly: true + name: + description: Indicates the name of the Pipeline. + maxLength: 128 + minLength: 1 + type: string + sql: + description: Specifies SQL for the Pipeline processing flow. + type: string + status: + description: Indicates the current status of the Pipeline. + type: string + tables: + description: List of streams and sinks used by this pipeline. + items: + properties: + id: + description: >- + Unique identifier for the connection (stream or + sink). + type: string + latest: + description: Latest available version of the connection. + type: integer + name: + description: Name of the connection. + maxLength: 128 + minLength: 1 + type: string + type: + description: Type of the connection. + enum: + - stream + - sink + type: string + version: + description: >- + Current version of the connection used by this + pipeline. + type: integer + required: + - id + - version + - latest + - type + - name + type: object + type: array + required: + - id + - name + - created_at + - modified_at + - sql + - status + - tables + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully retrieved Pipeline. + 4XX: + description: Indicates an error in retrieving Pipelines. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Pipeline Details + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: get_v1 + /accounts/{account_id}/pipelines/v1/sinks: + get: + description: List/Filter Sinks in Account. + operationId: getV4AccountsByAccount_idPipelinesV1Sinks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: pipeline_id + schema: + type: string + - in: query + name: page + schema: + default: 1 + type: number + - in: query + name: per_page + schema: + type: number + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + config: + description: Defines the configuration of the R2 Sink. + type: object + title: R2 Sink Public + properties: + account_id: + description: Cloudflare Account ID for the bucket + title: Account ID + type: string + bucket: + description: R2 Bucket to write to + title: Bucket + type: string + file_naming: + description: Controls filename prefix/suffix and strategy. + properties: + prefix: + description: >- + The prefix to use in file name. i.e + prefix-.parquet + title: Filename Prefix + type: string + strategy: + description: Filename generation strategy. + enum: + - serial + - uuid + - uuid_v7 + - ulid + title: Filename Strategy + type: string + suffix: + description: >- + This will overwrite the default file suffix. + i.e .parquet, use with caution + title: Filename Suffix + type: string + title: File Naming + type: object + jurisdiction: + description: Jurisdiction this bucket is hosted in + title: Jurisdiction + type: string + partitioning: + description: Data-layout partitioning for sinks. + properties: + time_pattern: + description: The pattern of the date string + title: Time Partition Pattern + type: string + title: Partitioning Configuration + type: object + path: + description: Subpath within the bucket to write to + title: Path + type: string + rolling_policy: + description: >- + Rolling policy for file sinks (when & why to + close a file and open a new one). + properties: + file_size_bytes: + description: >- + Files will be rolled after reaching this + number of bytes + format: uint64 + minimum: 0 + title: File Size + type: integer + inactivity_seconds: + description: >- + Number of seconds of inactivity to wait + before rolling over to a new file + format: uint64 + minimum: 1 + title: Inactivity Seconds + type: integer + interval_seconds: + description: >- + Number of seconds to wait before rolling + over to a new file + format: uint64 + minimum: 1 + title: Interval Seconds + type: integer + title: File Rolling Policy + type: object + namespace: + description: Table namespace + title: Namespace + type: string + table_name: + description: Table name + title: Table Name + type: string + required: + - account_id + - bucket + created_at: + format: date-time + type: string + readOnly: true + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + id: + description: Indicates a unique identifier for this sink. + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + description: Defines the name of the Sink. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: >- + #/components/schemas/cloudflarePipelinesConnectionSchema + type: + description: Specifies the type of sink. + enum: + - r2 + - r2_data_catalog + type: string + required: + - id + - name + - created_at + - modified_at + - type + type: object + type: array + result_info: + properties: + count: + description: Indicates the number of items on current page. + type: number + page: + description: Indicates the current page number. + type: number + per_page: + description: Indicates the number of items per page. + type: number + total_count: + description: Indicates the total number of items. + type: number + required: + - count + - page + - per_page + - total_count + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + - result_info + type: object + description: Indicates successfully listed Sinks. + 4XX: + description: Indicates an error in listing Sinks. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Sinks + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - sinks + method: list + post: + description: Create a new Sink. + operationId: postV4AccountsByAccount_idPipelinesV1Sinks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config: + description: Defines the configuration of the R2 Sink. + type: object + title: R2 Sink + properties: + account_id: + description: Cloudflare Account ID for the bucket + title: Account ID + type: string + bucket: + description: R2 Bucket to write to + title: Bucket + type: string + credentials: + properties: + access_key_id: + description: Cloudflare Account ID for the bucket + format: var-str + title: Access Key ID + type: string + secret_access_key: + description: Cloudflare Account ID for the bucket + format: var-str + title: Access Key ID + type: string + x-sensitive: true + required: + - access_key_id + - secret_access_key + title: R2 Credentials + type: object + file_naming: + description: Controls filename prefix/suffix and strategy. + properties: + prefix: + description: >- + The prefix to use in file name. i.e + prefix-.parquet + title: Filename Prefix + type: string + strategy: + description: Filename generation strategy. + enum: + - serial + - uuid + - uuid_v7 + - ulid + title: Filename Strategy + type: string + suffix: + description: >- + This will overwrite the default file suffix. i.e + .parquet, use with caution + title: Filename Suffix + type: string + title: File Naming + type: object + jurisdiction: + description: Jurisdiction this bucket is hosted in + title: Jurisdiction + type: string + partitioning: + description: Data-layout partitioning for sinks. + properties: + time_pattern: + description: The pattern of the date string + title: Time Partition Pattern + type: string + title: Partitioning Configuration + type: object + path: + description: Subpath within the bucket to write to + title: Path + type: string + rolling_policy: + description: >- + Rolling policy for file sinks (when & why to close a + file and open a new one). + properties: + file_size_bytes: + description: >- + Files will be rolled after reaching this number of + bytes + format: uint64 + minimum: 0 + title: File Size + type: integer + inactivity_seconds: + description: >- + Number of seconds of inactivity to wait before + rolling over to a new file + format: uint64 + minimum: 1 + title: Inactivity Seconds + type: integer + interval_seconds: + description: >- + Number of seconds to wait before rolling over to a + new file + format: uint64 + minimum: 1 + title: Interval Seconds + type: integer + title: File Rolling Policy + type: object + namespace: + description: Table namespace + title: Namespace + type: string + table_name: + description: Table name + title: Table Name + type: string + token: + description: Authentication token + format: var-str + type: string + x-sensitive: true + required: + - account_id + - bucket + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + name: + description: Defines the name of the Sink. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: '#/components/schemas/cloudflarePipelinesConnectionSchema' + type: + description: Specifies the type of sink. + enum: + - r2 + - r2_data_catalog + type: string + required: + - name + - type + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + config: + type: object + title: R2 Sink + properties: + account_id: + description: Cloudflare Account ID for the bucket + title: Account ID + type: string + bucket: + description: R2 Bucket to write to + title: Bucket + type: string + credentials: + properties: + access_key_id: + description: Cloudflare Account ID for the bucket + format: var-str + title: Access Key ID + type: string + secret_access_key: + description: Cloudflare Account ID for the bucket + format: var-str + title: Access Key ID + type: string + x-sensitive: true + required: + - access_key_id + - secret_access_key + title: R2 Credentials + type: object + file_naming: + description: Controls filename prefix/suffix and strategy. + properties: + prefix: + description: >- + The prefix to use in file name. i.e + prefix-.parquet + title: Filename Prefix + type: string + strategy: + description: Filename generation strategy. + enum: + - serial + - uuid + - uuid_v7 + - ulid + title: Filename Strategy + type: string + suffix: + description: >- + This will overwrite the default file suffix. + i.e .parquet, use with caution + title: Filename Suffix + type: string + title: File Naming + type: object + jurisdiction: + description: Jurisdiction this bucket is hosted in + title: Jurisdiction + type: string + partitioning: + description: Data-layout partitioning for sinks. + properties: + time_pattern: + description: The pattern of the date string + title: Time Partition Pattern + type: string + title: Partitioning Configuration + type: object + path: + description: Subpath within the bucket to write to + title: Path + type: string + rolling_policy: + description: >- + Rolling policy for file sinks (when & why to close + a file and open a new one). + properties: + file_size_bytes: + description: >- + Files will be rolled after reaching this + number of bytes + format: uint64 + minimum: 0 + title: File Size + type: integer + inactivity_seconds: + description: >- + Number of seconds of inactivity to wait before + rolling over to a new file + format: uint64 + minimum: 1 + title: Inactivity Seconds + type: integer + interval_seconds: + description: >- + Number of seconds to wait before rolling over + to a new file + format: uint64 + minimum: 1 + title: Interval Seconds + type: integer + title: File Rolling Policy + type: object + namespace: + description: Table namespace + title: Namespace + type: string + table_name: + description: Table name + title: Table Name + type: string + token: + description: Authentication token + format: var-str + type: string + x-sensitive: true + required: + - account_id + - bucket + description: R2 Data Catalog Sink + created_at: + format: date-time + type: string + readOnly: true + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + id: + description: Indicates a unique identifier for this sink. + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + description: Defines the name of the Sink. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: >- + #/components/schemas/cloudflarePipelinesConnectionSchema + type: + description: Specifies the type of sink. + enum: + - r2 + - r2_data_catalog + type: string + required: + - id + - name + - created_at + - modified_at + - type + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully created Sink. + 4XX: + description: Indicates an error in creating a Sink. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Sink + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - sinks + method: create + /accounts/{account_id}/pipelines/v1/sinks/{sink_id}: + delete: + description: Delete Pipeline in Account. + operationId: deleteV4AccountsByAccount_idPipelinesV1SinksBySink_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sink_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesSinkId' + required: true + - in: query + name: force + schema: + description: >- + Delete sink forcefully, including deleting any dependent + pipelines. + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully deleted Sink. + 4XX: + description: Indicates an error in listing Sinks. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Sink + tags: + - workers_pipelines_other + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - sinks + method: delete + get: + description: Get Sink Details. + operationId: getV4AccountsByAccount_idPipelinesV1SinksBySink_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sink_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesSinkId' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + config: + description: Defines the configuration of the R2 Sink. + type: object + title: R2 Sink Public + properties: + account_id: + description: Cloudflare Account ID for the bucket + title: Account ID + type: string + bucket: + description: R2 Bucket to write to + title: Bucket + type: string + file_naming: + description: Controls filename prefix/suffix and strategy. + properties: + prefix: + description: >- + The prefix to use in file name. i.e + prefix-.parquet + title: Filename Prefix + type: string + strategy: + description: Filename generation strategy. + enum: + - serial + - uuid + - uuid_v7 + - ulid + title: Filename Strategy + type: string + suffix: + description: >- + This will overwrite the default file suffix. + i.e .parquet, use with caution + title: Filename Suffix + type: string + title: File Naming + type: object + jurisdiction: + description: Jurisdiction this bucket is hosted in + title: Jurisdiction + type: string + partitioning: + description: Data-layout partitioning for sinks. + properties: + time_pattern: + description: The pattern of the date string + title: Time Partition Pattern + type: string + title: Partitioning Configuration + type: object + path: + description: Subpath within the bucket to write to + title: Path + type: string + rolling_policy: + description: >- + Rolling policy for file sinks (when & why to close + a file and open a new one). + properties: + file_size_bytes: + description: >- + Files will be rolled after reaching this + number of bytes + format: uint64 + minimum: 0 + title: File Size + type: integer + inactivity_seconds: + description: >- + Number of seconds of inactivity to wait before + rolling over to a new file + format: uint64 + minimum: 1 + title: Inactivity Seconds + type: integer + interval_seconds: + description: >- + Number of seconds to wait before rolling over + to a new file + format: uint64 + minimum: 1 + title: Interval Seconds + type: integer + title: File Rolling Policy + type: object + namespace: + description: Table namespace + title: Namespace + type: string + table_name: + description: Table name + title: Table Name + type: string + required: + - account_id + - bucket + created_at: + format: date-time + type: string + readOnly: true + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + id: + description: Indicates a unique identifier for this sink. + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + description: Defines the name of the Sink. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: >- + #/components/schemas/cloudflarePipelinesConnectionSchema + type: + description: Specifies the type of sink. + enum: + - r2 + - r2_data_catalog + type: string + required: + - id + - name + - created_at + - modified_at + - type + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates that Sink was retrieved. + 4XX: + description: Indicates an error in listing Sinks. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Sink Details + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - sinks + method: get + /accounts/{account_id}/pipelines/v1/streams: + get: + description: List/Filter Streams in Account. + operationId: getV4AccountsByAccount_idPipelinesV1Streams + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: pipeline_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesPipelineId' + - in: query + name: page + schema: + default: 1 + type: number + - in: query + name: per_page + schema: + type: number + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + endpoint: + description: Indicates the endpoint URL of this stream. + format: uri + type: string + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + http: + properties: + authentication: + description: >- + Indicates that authentication is required for + the HTTP endpoint. + type: boolean + cors: + description: >- + Specifies the CORS options for the HTTP + endpoint. + properties: + origins: + items: + type: string + maxItems: 5 + type: array + type: object + enabled: + description: Indicates that the HTTP endpoint is enabled. + type: boolean + required: + - enabled + - authentication + type: object + id: + description: Indicates a unique identifier for this stream. + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + description: Indicates the name of the Stream. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: >- + #/components/schemas/cloudflarePipelinesConnectionSchema + version: + description: Indicates the current version of this stream. + type: integer + worker_binding: + properties: + enabled: + description: Indicates that the worker binding is enabled. + type: boolean + required: + - enabled + type: object + required: + - id + - name + - version + - created_at + - modified_at + - http + - worker_binding + type: object + type: array + result_info: + properties: + count: + description: Indicates the number of items on current page. + type: number + page: + description: Indicates the current page number. + type: number + per_page: + description: Indicates the number of items per page. + type: number + total_count: + description: Indicates the total number of items. + type: number + required: + - count + - page + - per_page + - total_count + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + - result_info + type: object + description: Indicates a successfully created Stream. + 4XX: + description: Indicates an error in listing Streams. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Streams + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - streams + method: list + post: + description: Create a new Stream. + operationId: postV4AccountsByAccount_idPipelinesV1Streams + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + http: + default: + authentication: false + enabled: true + properties: + authentication: + description: >- + Indicates that authentication is required for the HTTP + endpoint. + type: boolean + cors: + description: Specifies the CORS options for the HTTP endpoint. + properties: + origins: + items: + type: string + maxItems: 5 + type: array + type: object + enabled: + description: Indicates that the HTTP endpoint is enabled. + type: boolean + required: + - enabled + - authentication + type: object + name: + description: Specifies the name of the Stream. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: '#/components/schemas/cloudflarePipelinesConnectionSchema' + worker_binding: + default: + enabled: true + properties: + enabled: + description: Indicates that the worker binding is enabled. + type: boolean + required: + - enabled + type: object + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + endpoint: + description: Indicates the endpoint URL of this stream. + format: uri + type: string + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + http: + properties: + authentication: + description: >- + Indicates that authentication is required for the + HTTP endpoint. + type: boolean + cors: + description: Specifies the CORS options for the HTTP endpoint. + properties: + origins: + items: + type: string + maxItems: 5 + type: array + type: object + enabled: + description: Indicates that the HTTP endpoint is enabled. + type: boolean + required: + - enabled + - authentication + type: object + id: + description: Indicates a unique identifier for this stream. + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + description: Indicates the name of the Stream. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: >- + #/components/schemas/cloudflarePipelinesConnectionSchema + version: + description: Indicates the current version of this stream. + type: integer + worker_binding: + properties: + enabled: + description: Indicates that the worker binding is enabled. + type: boolean + required: + - enabled + type: object + required: + - id + - name + - version + - created_at + - modified_at + - http + - worker_binding + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully created Stream. + 4XX: + description: Indicates an error in creating a Stream. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Stream + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - streams + method: create + /accounts/{account_id}/pipelines/v1/streams/{stream_id}: + delete: + description: Delete Stream in Account. + operationId: deleteV4AccountsByAccount_idPipelinesV1StreamsByStream_id + parameters: + - in: query + name: force + schema: + description: >- + Delete stream forcefully, including deleting any dependent + pipelines. + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: stream_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesStreamId' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully deleted Stream. + 4XX: + description: Indicates an error in listing Streams. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Stream + tags: + - workers_pipelines_other + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - streams + method: delete + get: + description: Get Stream Details. + operationId: getV4AccountsByAccount_idPipelinesV1StreamsByStream_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: stream_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesStreamId' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + endpoint: + description: Indicates the endpoint URL of this stream. + format: uri + type: string + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + http: + properties: + authentication: + description: >- + Indicates that authentication is required for the + HTTP endpoint. + type: boolean + cors: + description: Specifies the CORS options for the HTTP endpoint. + properties: + origins: + items: + type: string + maxItems: 5 + type: array + type: object + enabled: + description: Indicates that the HTTP endpoint is enabled. + type: boolean + required: + - enabled + - authentication + type: object + id: + description: Indicates a unique identifier for this stream. + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + description: Indicates the name of the Stream. + maxLength: 128 + minLength: 1 + type: string + schema: + $ref: >- + #/components/schemas/cloudflarePipelinesConnectionSchema + version: + description: Indicates the current version of this stream. + type: integer + worker_binding: + properties: + enabled: + description: Indicates that the worker binding is enabled. + type: boolean + required: + - enabled + type: object + required: + - id + - name + - version + - created_at + - modified_at + - http + - worker_binding + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully retrieved Stream. + 4XX: + description: Indicates an error in retrieving Stream. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Stream Details + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - streams + method: get + patch: + description: Update a Stream. + operationId: patchV4AccountsByAccount_idPipelinesV1StreamsByStream_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: stream_id + schema: + $ref: '#/components/schemas/cloudflarePipelinesWorkersPipelinesStreamId' + required: true + requestBody: + content: + application/json: + schema: + properties: + http: + properties: + authentication: + description: >- + Indicates that authentication is required for the HTTP + endpoint. + type: boolean + cors: + description: Specifies the CORS options for the HTTP endpoint. + properties: + origins: + items: + type: string + maxItems: 5 + type: array + type: object + enabled: + description: Indicates that the HTTP endpoint is enabled. + type: boolean + required: + - enabled + - authentication + type: object + worker_binding: + properties: + enabled: + description: Indicates that the worker binding is enabled. + type: boolean + required: + - enabled + type: object + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + endpoint: + description: Indicates the endpoint URL of this stream. + format: uri + type: string + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + http: + properties: + authentication: + description: >- + Indicates that authentication is required for the + HTTP endpoint. + type: boolean + cors: + description: Specifies the CORS options for the HTTP endpoint. + properties: + origins: + items: + type: string + maxItems: 5 + type: array + type: object + enabled: + description: Indicates that the HTTP endpoint is enabled. + type: boolean + required: + - enabled + - authentication + type: object + id: + description: Indicates a unique identifier for this stream. + type: string + modified_at: + format: date-time + type: string + readOnly: true + name: + description: Indicates the name of the Stream. + maxLength: 128 + minLength: 1 + type: string + version: + description: Indicates the current version of this stream. + type: integer + worker_binding: + properties: + enabled: + description: Indicates that the worker binding is enabled. + type: boolean + required: + - enabled + type: object + required: + - id + - name + - version + - created_at + - modified_at + - http + - worker_binding + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates a successfully updated Stream. + 4XX: + description: Indicates an error in creating a Stream. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Stream + tags: + - workers_pipelines_other + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: + - streams + method: update + /accounts/{account_id}/pipelines/v1/validate_sql: + post: + description: Validate Arroyo SQL. + operationId: postV4AccountsByAccount_idPipelinesV1Validate_sql + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + sql: + description: Specifies SQL to validate. + type: string + required: + - sql + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + graph: + $ref: '#/components/schemas/cloudflarePipelinesPipelineGraph' + tables: + description: Indicates tables involved in the processing. + type: object + required: + - tables + type: object + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: Indicates SQL validation success. + 4XX: + description: Indicates SQL validation failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate SQL + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: validate_sql + /accounts/{account_id}/pipelines/{pipeline_name}: + delete: + deprecated: true + description: >- + [DEPRECATED] Delete a pipeline. Use the new /pipelines/v1/pipelines + endpoint instead. + operationId: deleteV4AccountsByAccount_idPipelinesByPipeline_name_deprecated + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pipeline_name + schema: + description: Defines the name of the pipeline. + maxLength: 128 + minLength: 1 + type: string + required: true + responses: + '200': + description: '[DEPRECATED] Indicates a successfully deleted pipeline.' + 4XX: + description: Indicates an error in deleting a pipeline. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: '[DEPRECATED] Delete Pipeline' + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: delete + get: + deprecated: true + description: >- + [DEPRECATED] Get configuration of a pipeline. Use the new + /pipelines/v1/pipelines endpoint instead. + operationId: getV4AccountsByAccount_idPipelinesByPipeline_name_deprecated + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pipeline_name + schema: + description: Defines the name of the pipeline. + maxLength: 128 + minLength: 1 + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkersPipelinesPipeline + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: '[DEPRECATED] Describes the configuration of a pipeline.' + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + results: + nullable: true + type: object + x-stainless-empty-object: true + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - results + - errors + type: object + description: Indicates that the pipeline was not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: '[DEPRECATED] Get Pipeline' + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + - Pipelines Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: get + put: + deprecated: true + description: >- + [DEPRECATED] Update an existing pipeline. Use the new + /pipelines/v1/pipelines endpoint instead. + operationId: putV4AccountsByAccount_idPipelinesByPipeline_name_deprecated + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: pipeline_name + schema: + description: Defines the name of the pipeline. + maxLength: 128 + minLength: 1 + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + destination: + properties: + batch: + properties: + max_bytes: + default: 100000000 + description: Specifies rough maximum size of files. + maximum: 100000000 + minimum: 1000 + type: integer + max_duration_s: + default: 300 + description: >- + Specifies duration to wait to aggregate batches + files. + maximum: 300 + minimum: 0.25 + type: number + max_rows: + default: 10000000 + description: Specifies rough maximum number of rows per file. + maximum: 10000000 + minimum: 100 + type: integer + type: object + compression: + properties: + type: + default: gzip + description: >- + Specifies the desired compression algorithm and + format. + enum: + - none + - gzip + - deflate + type: string + type: object + credentials: + properties: + access_key_id: + description: Specifies the R2 Bucket Access Key Id. + type: string + endpoint: + description: Specifies the R2 Endpoint. + type: string + secret_access_key: + description: Specifies the R2 Bucket Secret Access Key. + type: string + required: + - endpoint + - access_key_id + - secret_access_key + type: object + format: + description: Specifies the format of data to deliver. + enum: + - json + type: string + path: + properties: + bucket: + description: Specifies the R2 Bucket to store files. + type: string + filename: + description: >- + Specifies the name pattern to for individual data + files. + type: string + filepath: + description: Specifies the name pattern for directory. + type: string + prefix: + description: Specifies the base directory within the bucket. + type: string + required: + - bucket + type: object + type: + description: Specifies the type of destination. + enum: + - r2 + type: string + required: + - type + - format + - batch + - compression + - path + type: object + name: + description: Defines the name of the pipeline. + maxLength: 128 + minLength: 1 + type: string + source: + items: + type: object + description: >- + [DEPRECATED] HTTP source configuration. Use the new + streams API instead. + properties: + authentication: + description: >- + Specifies whether authentication is required to send + to this pipeline via HTTP. + type: boolean + cors: + properties: + origins: + description: >- + Specifies allowed origins to allow Cross Origin + HTTP Requests. + items: + type: string + maxItems: 5 + type: array + type: object + format: + description: Specifies the format of source data. + enum: + - json + type: string + type: + type: string + required: + - format + - type + minItems: 1 + type: array + required: + - name + - source + - destination + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkersPipelinesPipeline + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - result + type: object + description: '[DEPRECATED] Indicates a successfully updated pipeline.' + 4XX: + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + results: + nullable: true + type: object + x-stainless-empty-object: true + success: + $ref: >- + #/components/schemas/cloudflarePipelinesWorkerPipelinesCommonSuccess + required: + - success + - results + - errors + type: object + description: Indicates an error updating pipeline. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: '[DEPRECATED] Update Pipeline' + tags: + - workers_pipelines_other + x-api-token-group: + - Pipelines Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: pipelines + resource_chain: [] + method: update +components: + schemas: + cloudflarePipelinesConnectionSchema: + properties: + fields: + items: + $ref: '#/components/schemas/cloudflarePipelinesSourceField' + type: array + format: + $ref: '#/components/schemas/cloudflarePipelinesFormat' + inferred: + nullable: true + type: boolean + type: object + cloudflarePipelinesDecimalEncoding: + enum: + - number + - string + - bytes + type: string + cloudflarePipelinesFormat: + type: object + title: Json + properties: + decimal_encoding: + $ref: '#/components/schemas/cloudflarePipelinesDecimalEncoding' + timestamp_format: + $ref: '#/components/schemas/cloudflarePipelinesTimestampFormat' + unstructured: + type: boolean + type: + enum: + - json + type: string + compression: + $ref: '#/components/schemas/cloudflarePipelinesParquetCompression' + row_group_bytes: + format: int64 + minimum: 0 + nullable: true + type: integer + required: + - type + cloudflarePipelinesParquetCompression: + enum: + - uncompressed + - snappy + - gzip + - zstd + - lz4 + type: string + cloudflarePipelinesPipelineEdge: + properties: + dest_id: + format: int32 + minimum: 0 + type: integer + edge_type: + type: string + key_type: + type: string + src_id: + format: int32 + minimum: 0 + type: integer + value_type: + type: string + required: + - src_id + - dest_id + - key_type + - value_type + - edge_type + type: object + cloudflarePipelinesPipelineGraph: + properties: + edges: + items: + $ref: '#/components/schemas/cloudflarePipelinesPipelineEdge' + type: array + nodes: + items: + $ref: '#/components/schemas/cloudflarePipelinesPipelineNode' + type: array + required: + - nodes + - edges + type: object + cloudflarePipelinesPipelineNode: + properties: + description: + type: string + node_id: + format: int32 + minimum: 0 + type: integer + operator: + type: string + parallelism: + format: int32 + minimum: 0 + type: integer + required: + - node_id + - operator + - description + - parallelism + type: object + cloudflarePipelinesSourceField: + properties: + metadata_key: + nullable: true + type: string + name: + type: string + sql_name: + type: string + type: + enum: + - int32 + type: string + unit: + $ref: '#/components/schemas/cloudflarePipelinesTimestampUnit' + fields: + items: + $ref: '#/components/schemas/cloudflarePipelinesSourceField' + type: array + items: + $ref: '#/components/schemas/cloudflarePipelinesSourceField' + required: + - type + type: object + title: Int32 + cloudflarePipelinesTimestampFormat: + enum: + - rfc3339 + - unix_millis + type: string + cloudflarePipelinesTimestampUnit: + enum: + - second + - millisecond + - microsecond + - nanosecond + type: string + cloudflarePipelinesWorkerPipelinesCommonSuccess: + description: Indicates whether the API call was successful. + example: true + type: boolean + cloudflarePipelinesWorkersPipelinesPipeline: + deprecated: true + description: >- + [DEPRECATED] Describes the configuration of a pipeline. Use the new + streams/sinks/pipelines API instead. + properties: + destination: + properties: + batch: + properties: + max_bytes: + default: 100000000 + description: Specifies rough maximum size of files. + maximum: 100000000 + minimum: 1000 + type: integer + max_duration_s: + default: 300 + description: Specifies duration to wait to aggregate batches files. + maximum: 300 + minimum: 0.25 + type: number + max_rows: + default: 10000000 + description: Specifies rough maximum number of rows per file. + maximum: 10000000 + minimum: 100 + type: integer + required: + - max_rows + - max_bytes + - max_duration_s + type: object + compression: + properties: + type: + default: gzip + description: Specifies the desired compression algorithm and format. + enum: + - none + - gzip + - deflate + example: gzip + type: string + required: + - type + type: object + format: + description: Specifies the format of data to deliver. + enum: + - json + type: string + path: + example: + bucket: bucket + prefix: base + properties: + bucket: + description: Specifies the R2 Bucket to store files. + example: bucket + type: string + filename: + description: Specifies the name pattern to for individual data files. + example: ${slug}${extension} + type: string + filepath: + description: Specifies the name pattern for directory. + example: ${date}/${hour} + type: string + prefix: + description: Specifies the base directory within the bucket. + example: base + type: string + required: + - bucket + type: object + type: + description: Specifies the type of destination. + enum: + - r2 + type: string + required: + - type + - format + - batch + - compression + - path + type: object + endpoint: + description: Indicates the endpoint URL to send traffic. + example: https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com + type: string + id: + description: Specifies the pipeline identifier. + example: 123f8a8258064ed892a347f173372359 + type: string + name: + description: Defines the name of the pipeline. + example: sample_pipeline + maxLength: 128 + minLength: 1 + type: string + source: + items: + type: object + description: >- + [DEPRECATED] HTTP source configuration. Use the new streams API + instead. + properties: + authentication: + description: >- + Specifies whether authentication is required to send to this + pipeline via HTTP. + type: boolean + cors: + properties: + origins: + description: >- + Specifies allowed origins to allow Cross Origin HTTP + Requests. + example: + - '*' + items: + type: string + maxItems: 5 + type: array + type: object + format: + description: Specifies the format of source data. + enum: + - json + type: string + type: + type: string + required: + - format + - type + minItems: 1 + type: array + version: + description: Indicates the version number of last saved configuration. + example: 2 + type: number + required: + - name + - source + - destination + - id + - version + - endpoint + type: object + cloudflarePipelinesWorkersPipelinesPipelineId: + description: Specifies the public ID of the pipeline. + example: 043e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + minLength: 32 + type: string + cloudflarePipelinesWorkersPipelinesSinkId: + description: Specifies the publid ID of the sink. + example: 0223105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + minLength: 32 + type: string + cloudflarePipelinesWorkersPipelinesStreamId: + description: Specifies the public ID of the stream. + example: 033e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + minLength: 32 + type: string + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + accounts_pipelines: + id: cloudflare.pipelines.accounts_pipelines + name: accounts_pipelines + title: Accounts Pipelines + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1{pipeline_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/accounts_pipelines/methods/get_by_account + - $ref: '#/components/x-stackQL-resources/accounts_pipelines/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/accounts_pipelines/methods/create' + update: [] + delete: [] + replace: [] + v1_pipelines: + id: cloudflare.pipelines.v1_pipelines + name: v1_pipelines + title: V1 Pipelines + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_v1: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines~1{pipeline_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/v1_pipelines/methods/get_by_account + - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/v1_pipelines/methods/create_v1' + update: [] + delete: [] + replace: [] + pipelines: + id: cloudflare.pipelines.pipelines + name: pipelines + title: Pipelines + methods: + delete_v1: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1v1~1pipelines~1{pipeline_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + validate_sql_v1: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1validate_sql/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1{pipeline_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1{pipeline_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_v1' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update' + sinks: + id: cloudflare.pipelines.sinks + name: sinks + title: Sinks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1sinks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1sinks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1v1~1sinks~1{sink_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1v1~1sinks~1{sink_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sinks/methods/get' + - $ref: '#/components/x-stackQL-resources/sinks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/sinks/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/sinks/methods/delete' + replace: [] + streams: + id: cloudflare.pipelines.streams + name: streams + title: Streams + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1streams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1pipelines~1v1~1streams/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1v1~1streams~1{stream_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1v1~1streams~1{stream_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1pipelines~1v1~1streams~1{stream_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/streams/methods/get' + - $ref: '#/components/x-stackQL-resources/streams/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/streams/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/queues.yaml b/providers/src/cloudflare/v00.00.00000/services/queues.yaml new file mode 100644 index 00000000..52d11ac3 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/queues.yaml @@ -0,0 +1,2615 @@ +openapi: 3.0.3 +info: + title: queues API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/event_subscriptions/subscriptions: + get: + description: >- + Get a paginated list of event subscriptions with optional sorting and + filtering + operationId: subscriptions-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number for pagination + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Number of items per page + in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - description: Field to sort by + in: query + name: order + schema: + default: name + enum: + - created_at + - name + - enabled + - source + type: string + - description: Sort direction + in: query + name: direction + schema: + default: asc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + items: + $ref: '#/components/schemas/mqEventSubscription' + type: array + result_info: + properties: + count: + description: Number of items in current page + type: integer + page: + description: Current page number + type: integer + per_page: + description: Items per page + type: integer + total_count: + description: Total number of items + type: integer + total_pages: + description: Total number of pages + type: integer + required: + - count + - total_count + - page + - per_page + - total_pages + type: object + description: List of event subscriptions + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Event Subscriptions + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: queues + resource_chain: + - subscriptions + method: list + post: + description: Create a new event subscription for a queue + operationId: subscriptions-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination: + $ref: '#/components/schemas/mqEventDestination' + enabled: + description: Whether the subscription is active + type: boolean + x-auditable: true + events: + description: List of event types this subscription handles + items: + type: string + minItems: 1 + type: array + x-auditable: true + name: + description: Name of the subscription + type: string + x-auditable: true + source: + $ref: '#/components/schemas/mqEventSource' + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqEventSubscription' + description: Successfully created event subscription + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Invalid request body or validation errors + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Queue does not exist or resource not found on source + '405': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Multiple subscriptions on same resource not supported + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Event Subscription + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-stackql-sdk: + service: queues + resource_chain: + - subscriptions + method: create + /accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}: + delete: + description: Delete an existing event subscription + operationId: subscriptions-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: subscription_id + in: path + required: true + description: The subscription ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqEventSubscription' + description: Successfully created event subscription + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Event Subscription + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-stackql-sdk: + service: queues + resource_chain: + - subscriptions + method: delete + get: + description: Get details about an existing event subscription + operationId: subscriptions-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: subscription_id + in: path + required: true + description: The subscription ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqEventSubscription' + description: Details about an event subscription + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Event subscription does not exist + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Event Subscription + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-stackql-sdk: + service: queues + resource_chain: + - subscriptions + method: get + patch: + description: Update an existing event subscription + operationId: subscriptions-patch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: subscription_id + in: path + required: true + description: The subscription ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + destination: + $ref: '#/components/schemas/mqEventDestination' + enabled: + description: Whether the subscription is active + type: boolean + x-auditable: true + events: + description: List of event types this subscription handles + items: + type: string + minItems: 1 + type: array + x-auditable: true + name: + description: Name of the subscription + type: string + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqEventSubscription' + description: Successfully created event subscription + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Invalid request body or validation errors + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Queue does not exist or resource not found on source + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Event Subscription + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-stackql-sdk: + service: queues + resource_chain: + - subscriptions + method: update + /accounts/{account_id}/queues: + get: + description: Returns the queues owned by an account. + operationId: queues-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + items: + $ref: '#/components/schemas/mqQueue' + type: array + result_info: + properties: + count: + description: Total number of queues + type: number + page: + description: Current page within paginated list of queues + type: number + per_page: + description: Number of queues per page + type: number + total_count: + description: Total queues available without any search parameters + type: number + total_pages: + description: Total pages available without any search parameters + type: number + type: object + description: List of all Queues that belong to this account + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Queues + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.list + x-stackql-sdk: + service: queues + resource_chain: [] + method: list + post: + description: Create a new queue + operationId: queues-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + queue_name: + $ref: '#/components/schemas/mqQueueName' + required: + - queue_name + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqQueue' + description: Created Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Queue + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.create + x-stackql-sdk: + service: queues + resource_chain: [] + method: create + /accounts/{account_id}/queues/{queue_id}: + delete: + description: Deletes a queue + operationId: queues-delete + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Success' + description: Successful delete + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Queue + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.delete + x-stackql-sdk: + service: queues + resource_chain: [] + method: delete + get: + description: Get details about a specific queue. + operationId: queues-get + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqQueue' + description: Details of the requested Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Queue + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.read + x-stackql-sdk: + service: queues + resource_chain: [] + method: get + patch: + description: Updates a Queue. + operationId: queues-update-partial + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mqQueue' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: object + $ref: '#/components/schemas/mqQueue' + description: Updated Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Queue + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + x-stackql-sdk: + service: queues + resource_chain: [] + method: edit + put: + description: >- + Updates a Queue. Note that this endpoint does not support partial + updates. If successful, the Queue's configuration is overwritten with + the supplied configuration. + operationId: queues-update + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mqQueue' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: object + $ref: '#/components/schemas/mqQueue' + description: Updated Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Queue + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + x-stackql-sdk: + service: queues + resource_chain: [] + method: update + /accounts/{account_id}/queues/{queue_id}/consumers: + get: + description: Returns the consumers for a Queue + operationId: queues-list-consumers + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + items: + $ref: '#/components/schemas/mqConsumerResponse' + type: array + description: All consumers attached to this Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Queue Consumers + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.list + x-stackql-sdk: + service: queues + resource_chain: + - consumers + method: list + post: + description: Creates a new consumer for a Queue + operationId: queues-create-consumer + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mqConsumerRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqConsumerResponse' + description: Create Queue Consumer response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Queue Consumer + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.create + x-stackql-sdk: + service: queues + resource_chain: + - consumers + method: create + /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}: + delete: + description: Deletes the consumer for a queue. + operationId: queues-delete-consumer + parameters: + - in: path + name: consumer_id + schema: + $ref: '#/components/schemas/mqIdentifier' + required: true + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Success' + description: Successful consumer delete + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Queue Consumer + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.delete + x-stackql-sdk: + service: queues + resource_chain: + - consumers + method: delete + get: + description: Fetches the consumer for a queue by consumer id + operationId: queues-get-consumer + parameters: + - in: path + name: consumer_id + schema: + $ref: '#/components/schemas/mqIdentifier' + required: true + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqConsumerResponse' + description: Get Queue Consumer response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Get Queue Consumer response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Queue Consumer + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.read + x-stackql-sdk: + service: queues + resource_chain: + - consumers + method: get + put: + description: Updates the consumer for a queue, or creates one if it does not exist. + operationId: queues-update-consumer + parameters: + - in: path + name: consumer_id + schema: + $ref: '#/components/schemas/mqIdentifier' + required: true + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mqConsumerRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqConsumerResponse' + description: Update Queue Consumer response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Update Queue Consumer response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Queue Consumer + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + x-stackql-sdk: + service: queues + resource_chain: + - consumers + method: update + /accounts/{account_id}/queues/{queue_id}/messages: + post: + description: Push a message to a Queue + operationId: queues-push-message + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mqQueueMessage' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + metadata: + properties: + metrics: + $ref: '#/components/schemas/mqQueueMetrics' + type: object + type: object + description: Successful message ingestion. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Push Message + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-auditable: false + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + x-stackql-sdk: + service: queues + resource_chain: + - messages + method: push + /accounts/{account_id}/queues/{queue_id}/messages/ack: + post: + description: Acknowledge + Retry messages from a Queue + operationId: queues-ack-messages + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + acks: + items: + properties: + lease_id: + $ref: '#/components/schemas/mqLeaseId' + type: object + type: array + retries: + items: + properties: + delay_seconds: + $ref: '#/components/schemas/mqRetryDelay' + lease_id: + $ref: '#/components/schemas/mqLeaseId' + type: object + type: array + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + ackCount: + description: >- + The number of messages that were succesfully + acknowledged. + type: number + retryCount: + description: The number of messages that were succesfully retried. + type: number + warnings: + description: >- + Map of lease IDs to warning messages encountered + during acknowledgement. + type: object + type: object + description: Details of ACKs and retries + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Acknowledge + Retry Queue Messages + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-auditable: false + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + x-stackql-sdk: + service: queues + resource_chain: + - messages + method: ack + /accounts/{account_id}/queues/{queue_id}/messages/batch: + post: + description: Push a batch of message to a Queue + operationId: queues-push-messages + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mqQueueBatch' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + metadata: + properties: + metrics: + $ref: '#/components/schemas/mqQueueMetrics' + type: object + type: object + description: Successful batch ingestion. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Push Message Batch + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-auditable: false + x-stackql-sdk: + service: queues + resource_chain: + - messages + method: bulk_push + /accounts/{account_id}/queues/{queue_id}/messages/preview: + post: + description: >- + Preview messages from a Queue without leasing them. Messages remain + available for subsequent preview or pull operations. + operationId: queues-preview-messages + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + batch_size: + $ref: '#/components/schemas/mqBatchSize' + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + messages: + $ref: '#/components/schemas/mqQueuePullBatch' + type: object + description: A batch of previewed messages from the Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Preview Queue Messages + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-auditable: false + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + /accounts/{account_id}/queues/{queue_id}/messages/preview/ack: + post: + description: >- + Delete previewed messages from a Queue. Note that messages acknowledged + this way aren't considered delivered, they are instantly deleted from + this queue and do not affect metrics. + operationId: queues-ack-preview-messages + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + acks: + items: + properties: + lease_id: + $ref: '#/components/schemas/mqLeaseId' + type: object + type: array + retries: + items: + properties: + delay_seconds: + $ref: '#/components/schemas/mqRetryDelay' + lease_id: + $ref: '#/components/schemas/mqLeaseId' + type: object + type: array + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + warnings: + description: >- + Map of lease IDs to warning messages encountered + during acknowledgement. + type: object + type: object + description: Result of acknowledging previewed messages + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Previewed Queue Messages + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-auditable: false + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + /accounts/{account_id}/queues/{queue_id}/messages/pull: + post: + description: Pull a batch of messages from a Queue + operationId: queues-pull-messages + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + batch_size: + $ref: '#/components/schemas/mqBatchSize' + visibility_timeout_ms: + $ref: '#/components/schemas/mqVisibilityTimeout' + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + message_backlog_count: + description: The number of unacknowledged messages in the queue. + type: number + messages: + $ref: '#/components/schemas/mqQueuePullBatch' + metadata: + properties: + metrics: + $ref: '#/components/schemas/mqQueueMetrics' + type: object + type: object + description: A batch of messages in the Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Pull Queue Messages + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-auditable: false + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + x-stackql-sdk: + service: queues + resource_chain: + - messages + method: pull + /accounts/{account_id}/queues/{queue_id}/metrics: + get: + description: >- + Return best-effort metrics for a queue. Values may be approximate due to + the distributed nature of queues. + operationId: queues-get-metrics + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/mqQueueMetrics' + text/event-stream: + schema: + $ref: '#/components/schemas/mqQueueMetrics' + description: Queue metrics. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Queue Metrics + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: queues + resource_chain: [] + method: get_metrics + /accounts/{account_id}/queues/{queue_id}/purge: + get: + description: Get details about a Queue's purge status. + operationId: queues-purge-get + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + completed: + description: >- + Indicates if the last purge operation completed + successfully. + readOnly: true + type: string + x-auditable: true + started_at: + description: Timestamp when the last purge operation started. + readOnly: true + type: string + x-auditable: true + type: object + description: Details of the requested Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Queue Purge Status + tags: + - Queue + x-api-token-group: + - Queues Write + - Queues Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.read + x-stackql-sdk: + service: queues + resource_chain: + - purge + method: status + post: + description: Deletes all messages from the Queue. + operationId: queues-purge + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + delete_messages_permanently: + description: Confimation that all messages will be deleted permanently. + type: boolean + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: object + $ref: '#/components/schemas/mqQueue' + description: Updated Queue + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/mqApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Purge Queue + tags: + - Queue + x-api-token-group: + - Queues Write + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.worker.queue.update + x-stackql-sdk: + service: queues + resource_chain: + - purge + method: start +components: + schemas: + mqApiV4Error: + example: + - code: 7003 + message: No route for the URI + items: + $ref: '#/components/schemas/responseInfo' + minLength: 1 + type: array + mqApiV4Failure: + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - false + example: false + type: boolean + x-auditable: true + type: object + mqApiV4Message: + example: [] + items: + type: string + x-auditable: true + type: array + mqApiV4Success: + properties: + errors: + $ref: '#/components/schemas/mqApiV4Error' + messages: + $ref: '#/components/schemas/mqApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + type: object + mqBatchSize: + description: The maximum number of messages to include in a batch. + example: 50 + type: number + x-auditable: true + mqConsumerRequest: + description: Request body for creating or updating a consumer + type: object + properties: + dead_letter_queue: + $ref: '#/components/schemas/mqQueueName' + script_name: + $ref: '#/components/schemas/mqScriptName' + settings: + properties: + batch_size: + $ref: '#/components/schemas/mqBatchSize' + max_concurrency: + $ref: '#/components/schemas/mqMaxConcurrency' + max_retries: + $ref: '#/components/schemas/mqMaxRetries' + max_wait_time_ms: + $ref: '#/components/schemas/mqMaxWaitTime' + retry_delay: + $ref: '#/components/schemas/mqRetryDelay' + type: object + type: + enum: + - worker + type: string + x-auditable: true + required: + - type + mqConsumerResponse: + description: Response body representing a consumer + type: object + properties: + consumer_id: + $ref: '#/components/schemas/mqIdentifier' + created_on: + format: date-time + type: string + x-auditable: true + readOnly: true + dead_letter_queue: + description: Name of the dead letter queue, or empty string if not configured + type: string + x-auditable: true + queue_name: + $ref: '#/components/schemas/mqQueueName' + script_name: + $ref: '#/components/schemas/mqScriptName' + settings: + properties: + batch_size: + $ref: '#/components/schemas/mqBatchSize' + max_concurrency: + $ref: '#/components/schemas/mqMaxConcurrency' + max_retries: + $ref: '#/components/schemas/mqMaxRetries' + max_wait_time_ms: + $ref: '#/components/schemas/mqMaxWaitTime' + retry_delay: + $ref: '#/components/schemas/mqRetryDelay' + type: object + type: + enum: + - worker + type: string + x-auditable: true + mqEventDestination: + description: Destination configuration for the subscription + type: object + $ref: '#/components/schemas/mqEventDestinationQueue' + mqEventDestinationQueue: + properties: + queue_id: + description: ID of the target queue + type: string + x-auditable: true + type: + description: Type of destination + enum: + - queues.queue + type: string + x-auditable: true + required: + - type + - queue_id + type: object + mqEventSource: + description: Source configuration for the subscription + type: object + properties: + type: + description: Type of source + enum: + - images + type: string + x-auditable: true + model_name: + description: Name of the Workers AI model + type: string + x-auditable: true + x-stainless-naming: + python: + property_name: ai_model_name + worker_name: + description: Name of the worker + type: string + x-auditable: true + workflow_name: + description: Name of the workflow + type: string + x-auditable: true + mqEventSubscription: + properties: + created_at: + description: When the subscription was created + format: date-time + type: string + x-auditable: true + readOnly: true + destination: + $ref: '#/components/schemas/mqEventDestination' + enabled: + description: Whether the subscription is active + type: boolean + x-auditable: true + events: + description: List of event types this subscription handles + items: + type: string + minItems: 1 + type: array + x-auditable: true + id: + description: Unique identifier for the subscription + type: string + x-auditable: true + modified_at: + description: When the subscription was last modified + format: date-time + type: string + x-auditable: true + readOnly: true + name: + description: Name of the subscription + type: string + x-auditable: true + source: + $ref: '#/components/schemas/mqEventSource' + required: + - id + - created_at + - modified_at + - name + - enabled + - source + - destination + - events + type: object + mqIdentifier: + description: A Resource identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + mqLeaseId: + description: >- + An ID that represents an "in-flight" message that has been pulled from a + Queue. You must hold on to this ID and use it to acknowledge this + message. + example: >- + eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0 + type: string + x-auditable: true + mqMaxConcurrency: + description: >- + Maximum number of concurrent consumers that may consume from this Queue. + Set to `null` to automatically opt in to the platform's maximum + (recommended). + example: 10 + type: number + x-auditable: true + mqMaxRetries: + description: The maximum number of retries + example: 3 + type: number + x-auditable: true + mqMaxWaitTime: + description: >- + The number of milliseconds to wait for a batch to fill up before + attempting to deliver it + example: 5000 + type: number + x-auditable: true + mqProducer: + type: object + properties: + script: + type: string + x-auditable: true + type: + enum: + - worker + type: string + x-auditable: true + bucket_name: + type: string + x-auditable: true + mqQueue: + properties: + consumers: + items: + $ref: '#/components/schemas/mqConsumerResponse' + readOnly: true + type: array + consumers_total_count: + readOnly: true + type: number + created_on: + readOnly: true + type: string + x-auditable: true + modified_on: + readOnly: true + type: string + x-auditable: true + producers: + items: + $ref: '#/components/schemas/mqProducer' + readOnly: true + type: array + producers_total_count: + readOnly: true + type: number + x-auditable: true + queue_id: + readOnly: true + type: string + x-auditable: true + queue_name: + $ref: '#/components/schemas/mqQueueName' + settings: + $ref: '#/components/schemas/mqQueueSettings' + type: object + mqQueueBatch: + properties: + delay_seconds: + description: >- + The number of seconds to wait for attempting to deliver this batch + to consumers + type: number + x-auditable: true + messages: + items: + $ref: '#/components/schemas/mqQueueMessage' + type: array + type: object + mqQueueMessage: + properties: + delay_seconds: + description: >- + The number of seconds to wait for attempting to deliver this message + to consumers + type: number + x-auditable: true + body: + type: string + content_type: + enum: + - text + type: string + x-auditable: true + type: object + mqQueueMetrics: + description: >- + Best-effort metrics for the queue. Values may be approximate due to the + distributed nature of queues. + properties: + backlog_bytes: + description: The size in bytes of unacknowledged messages in the queue. + example: 1024 + type: number + x-auditable: true + backlog_count: + description: The number of unacknowledged messages in the queue. + example: 5 + type: number + x-auditable: true + oldest_message_timestamp_ms: + description: >- + Unix timestamp in milliseconds of the oldest unacknowledged message + in the queue. Returns 0 if unknown. + example: 1710950954154 + type: number + x-auditable: true + required: + - backlog_count + - backlog_bytes + - oldest_message_timestamp_ms + type: object + mqQueueName: + example: example-queue + type: string + x-auditable: true + mqQueuePullBatch: + items: + properties: + attempts: + example: 1 + readOnly: true + type: number + x-auditable: true + body: + example: hello world + readOnly: true + type: string + id: + example: b01b5594f784d0165c2985833f5660dd + readOnly: true + type: string + x-auditable: true + lease_id: + $ref: '#/components/schemas/mqLeaseId' + metadata: + example: + CF-Content-Type: text + CF-sourceMessageSource: dash + readOnly: true + type: object + timestamp_ms: + example: 1710950954154 + readOnly: true + type: number + x-auditable: true + type: object + type: array + mqQueueSettings: + properties: + delivery_delay: + description: Number of seconds to delay delivery of all messages to consumers. + example: 5 + type: number + x-auditable: true + delivery_paused: + description: Indicates if message delivery to consumers is currently paused. + example: true + type: boolean + x-auditable: true + message_retention_period: + description: Number of seconds after which an unconsumed message will be delayed. + example: 345600 + type: number + x-auditable: true + type: object + mqRetryDelay: + description: >- + The number of seconds to delay before making the message available for + another attempt. + example: 10 + type: number + x-auditable: true + mqScriptName: + description: Name of a Worker + example: my-consumer-worker + type: string + x-auditable: true + mqVisibilityTimeout: + description: >- + The number of milliseconds that a message is exclusively leased. After + the timeout, the message becomes available for another attempt. + example: 6000 + type: number + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + subscriptions: + id: cloudflare.queues.subscriptions + name: subscriptions + title: Subscriptions + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_subscriptions~1subscriptions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_subscriptions~1subscriptions/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_subscriptions~1subscriptions~1{subscription_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_subscriptions~1subscriptions~1{subscription_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_subscriptions~1subscriptions~1{subscription_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/get' + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/delete' + replace: [] + queues: + id: cloudflare.queues.queues + name: queues + title: Queues + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_messages: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages/post + response: + mediaType: application/json + openAPIDocKey: '200' + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1batch/post + response: + mediaType: application/json + openAPIDocKey: '200' + preview: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1preview/post + response: + mediaType: application/json + openAPIDocKey: '200' + pull: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1pull/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queues/methods/get' + - $ref: '#/components/x-stackQL-resources/queues/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/queues/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/queues/methods/update' + consumers: + id: cloudflare.queues.consumers + name: consumers + title: Consumers + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1consumers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1consumers/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1consumers~1{consumer_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1consumers~1{consumer_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1consumers~1{consumer_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumers/methods/get' + - $ref: '#/components/x-stackQL-resources/consumers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/consumers/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/consumers/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/consumers/methods/update' + messages_ack: + id: cloudflare.queues.messages_ack + name: messages_ack + title: Messages Ack + methods: + ack: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1ack/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + preview_ack: + id: cloudflare.queues.preview_ack + name: preview_ack + title: Preview Ack + methods: + ack: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1messages~1preview~1ack/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + metrics: + id: cloudflare.queues.metrics + name: metrics + title: Metrics + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1metrics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metrics/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + purge: + id: cloudflare.queues.purge + name: purge + title: Purge + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1purge/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + start: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1queues~1{queue_id}~1purge/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/purge/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/r2.yaml b/providers/src/cloudflare/v00.00.00000/services/r2.yaml new file mode 100644 index 00000000..01868660 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/r2.yaml @@ -0,0 +1,4648 @@ +openapi: 3.0.3 +info: + title: r2 API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration: + get: + description: List all event notification rules for a bucket. + operationId: r2-get-event-notification-configs + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2BucketConfig' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Read Configuration response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: No Configuration Found response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Read Configuration failure. + security: + - api_token: [] + summary: List Event Notification Rules + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + - Workers R2 Storage Read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - event_notifications + method: list + /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}: + delete: + description: >- + Delete an event notification rule. **If no body is provided, all rules + for specified queue will be deleted**. + operationId: r2-event-notification-delete-config + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + type: object + description: Delete Configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Delete Configuration failure. + security: + - api_token: [] + summary: Delete Event Notification Rules + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - event_notifications + method: delete + get: + description: Get a single event notification rule. + operationId: r2-get-event-notification-config + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + default: default + description: The bucket jurisdiction. + enum: + - default + - eu + - fedramp + type: string + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2QueuesConfig' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Read Configuration response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: No Configuration Found response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Read Configuration failure. + security: + - api_token: [] + summary: Get Event Notification Rule + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + - Workers R2 Storage Read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - event_notifications + method: get + put: + description: Create event notification rule. + operationId: r2-put-event-notification-config + parameters: + - name: queue_id + in: path + required: true + description: The Cloudflare Queue ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + properties: + rules: + description: Array of rules to drive notifications. + items: + $ref: '#/components/schemas/r2Rule' + minItems: 1 + type: array + required: + - rules + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + type: object + description: Create Configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Create Configuration failure. + security: + - api_token: [] + summary: Create Event Notification Rule + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - event_notifications + method: update + /accounts/{account_id}/r2/buckets: + get: + description: Lists all R2 buckets on your account. + operationId: r2-list-buckets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name_contains + schema: + description: >- + Bucket names to filter by. Only buckets with this phrase in their + name will be returned. + type: string + - in: query + name: start_after + schema: + description: >- + Bucket name to start searching after. Buckets are ordered + lexicographically. + type: string + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of buckets to return in a single call. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: order + schema: + description: Field to order buckets by. + enum: + - name + type: string + - in: query + name: direction + schema: + description: Direction to order buckets. + enum: + - asc + - desc + type: string + - in: query + name: cursor + schema: + description: >- + Pagination cursor received during the last List Buckets call. R2 + buckets are paginated using cursors instead of page numbers. + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + properties: + buckets: + items: + $ref: '#/components/schemas/r2Bucket' + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/r2ResultInfo' + required: + - success + - errors + - messages + - result + type: object + description: List Buckets response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: List Buckets response failure. + security: + - api_token: [] + summary: List Buckets + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + - Workers R2 Storage Read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + method: list + post: + description: Creates a new R2 bucket. + operationId: r2-create-bucket + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + properties: + locationHint: + $ref: '#/components/schemas/r2BucketLocation' + x-stainless-naming: + terraform: + property_name: location + name: + $ref: '#/components/schemas/r2BucketName' + storageClass: + $ref: '#/components/schemas/r2StorageClass' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2Bucket' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Create Bucket response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Create Bucket response failure. + security: + - api_token: [] + summary: Create Bucket + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + method: create + /accounts/{account_id}/r2/buckets/{bucket_name}: + delete: + description: Deletes an existing R2 bucket. + operationId: r2-delete-bucket + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + description: Delete Bucket response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Delete Bucket response failure. + security: + - api_token: [] + summary: Delete Bucket + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + method: delete + get: + description: Gets properties of an existing R2 bucket. + operationId: r2-get-bucket + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2Bucket' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Get Bucket response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Get Bucket response failure. + security: + - api_token: [] + summary: Get Bucket + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + method: get + patch: + description: Updates properties of an existing R2 bucket. + operationId: r2-patch-bucket + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + - in: header + name: cf-r2-storage-class + schema: + x-stainless-param: storage_class + $ref: '#/components/schemas/r2StorageClass' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2Bucket' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Patch Bucket response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Get Bucket response failure. + security: + - api_token: [] + summary: Patch Bucket + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + method: edit + /accounts/{account_id}/r2/buckets/{bucket_name}/cors: + delete: + description: Delete the CORS policy for a bucket. + operationId: r2-delete-bucket-cors-policy + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Delete Bucket CORS Policy + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - cors + method: delete + get: + description: Get the CORS policy for a bucket. + operationId: r2-get-bucket-cors-policy + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + properties: + rules: + items: + $ref: '#/components/schemas/r2CorsRule' + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Get Bucket CORS Policy + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - cors + method: get + put: + description: Set the CORS policy for a bucket. + operationId: r2-put-bucket-cors-policy + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + properties: + rules: + items: + $ref: '#/components/schemas/r2CorsRule' + type: array + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Put Bucket CORS Policy + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - cors + method: update + /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom: + get: + description: Gets a list of all custom domains registered with an existing R2 bucket. + operationId: r2-list-custom-domains + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2ListCustomDomainsResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: List Custom Domains response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: List Custom Domains response failure. + security: + - api_token: [] + summary: List Custom Domains of Bucket + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - domains + - custom + method: list + post: + description: Register a new custom domain for an existing R2 bucket. + operationId: r2-add-custom-domain + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2AddCustomDomainRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2AddCustomDomainResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Add Custom Domain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Add Custom Domain response failure. + security: + - api_token: [] + summary: Attach Custom Domain To Bucket + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - domains + - custom + method: create + /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain}: + delete: + description: Remove custom domain registration from an existing R2 bucket. + operationId: r2-delete-custom-domain + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain + schema: + $ref: '#/components/schemas/r2DomainName' + required: true + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2RemoveCustomDomainResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Delete Custom Domain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Delete Custom Domain response failure. + security: + - api_token: [] + summary: Remove Custom Domain From Bucket + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - domains + - custom + method: delete + get: + description: Get the configuration for a custom domain on an existing R2 bucket. + operationId: r2-get-custom-domain-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: path + name: domain + schema: + $ref: '#/components/schemas/r2DomainName' + required: true + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2GetCustomDomainResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Get Custom Domain Configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Get Custom Domain Configuration response failure. + security: + - api_token: [] + summary: Get Custom Domain Settings + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + - Workers R2 Storage Read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - domains + - custom + method: get + put: + description: Edit the configuration for a custom domain on an existing R2 bucket. + operationId: r2-edit-custom-domain-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: path + name: domain + schema: + $ref: '#/components/schemas/r2DomainName' + required: true + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2EditCustomDomainRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2EditCustomDomainResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Edit Custom Domain Configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Edit Custom Domain Configuration response failure. + security: + - api_token: [] + summary: Configure Custom Domain Settings + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - domains + - custom + method: update + /accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed: + get: + description: >- + Gets state of public access over the bucket's R2-managed (r2.dev) + domain. + operationId: r2-get-bucket-public-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2ManagedDomainResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Get Managed Subdomain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Get Managed Subdomain response failure. + security: + - api_token: [] + summary: Get r2.dev Domain of Bucket + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - domains + - managed + method: list + put: + description: >- + Updates state of public access over the bucket's R2-managed (r2.dev) + domain. + operationId: r2-put-bucket-public-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2EditManagedDomainRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2ManagedDomainResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Update Managed Subdomain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Update Managed Subdomain response failure. + security: + - api_token: [] + summary: Update r2.dev Domain of Bucket + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - domains + - managed + method: update + /accounts/{account_id}/r2/buckets/{bucket_name}/lifecycle: + get: + description: Get object lifecycle rules for a bucket. + operationId: r2-get-bucket-lifecycle-configuration + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2LifecycleConfig' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Get Object Lifecycle Rules + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - lifecycle + method: get + put: + description: Set the object lifecycle rules for a bucket. + operationId: r2-put-bucket-lifecycle-configuration + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + properties: + rules: + items: + $ref: '#/components/schemas/r2LifecycleRule' + type: array + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Put Object Lifecycle Rules + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - lifecycle + method: update + /accounts/{account_id}/r2/buckets/{bucket_name}/local-uploads: + get: + description: >- + Get the local uploads configuration for a bucket. When enabled, object's + data is written to the nearest region first, then asynchronously + replicated to the bucket's primary region. + operationId: r2-get-bucket-local-uploads-configuration + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2LocalUploadsConfiguration' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Get Local Uploads Configuration + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.read + put: + description: >- + Set the local uploads configuration for a bucket. When enabled, object's + data is written to the nearest region first, then asynchronously + replicated to the bucket's primary region. + operationId: r2-put-bucket-local-uploads-configuration + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + enabled: + description: Whether to enable local uploads for this bucket. + type: boolean + x-auditable: true + required: + - enabled + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Put Local Uploads Configuration + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.write + /accounts/{account_id}/r2/buckets/{bucket_name}/lock: + get: + description: Get lock rules for a bucket. + operationId: r2-get-bucket-lock-configuration + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2BucketLockRuleConfig' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Get Bucket Lock Rules + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - locks + method: get + put: + description: Set lock rules for a bucket. + operationId: r2-put-bucket-lock-configuration + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + properties: + rules: + items: + $ref: '#/components/schemas/r2BucketLockRule' + type: array + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4Response' + type: object + description: Success Response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Error Response. + security: + - api_token: [] + summary: Put Bucket Lock Rules + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - locks + method: update + /accounts/{account_id}/r2/buckets/{bucket_name}/sippy: + delete: + description: Disables Sippy on this bucket. + operationId: r2-delete-bucket-sippy-config + parameters: + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + properties: + enabled: + enum: + - false + type: boolean + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Delete Sippy Configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Delete Sippy Configuration response failure. + security: + - api_token: [] + summary: Disable Sippy + tags: + - R2 Bucket + x-api-token-group: + - Workers R2 Storage Write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - sippy + method: delete + get: + description: Gets configuration for Sippy for an existing R2 bucket. + operationId: r2-get-bucket-sippy-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2Sippy' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Get Sippy Configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Get Sippy Configuration response failure. + security: + - api_token: [] + summary: Get Sippy Configuration + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.read + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - sippy + method: get + put: + description: Sets configuration for Sippy for an existing R2 bucket. + operationId: r2-put-bucket-sippy-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - in: header + name: cf-r2-jurisdiction + schema: + $ref: '#/components/schemas/r2Jurisdiction' + x-stainless-param: jurisdiction + requestBody: + content: + application/json: + schema: + type: object + properties: + destination: + description: R2 bucket to copy objects to. + properties: + accessKeyId: + description: >- + ID of a Cloudflare API token. This is the value labelled + "Access Key ID" when creating an API. token from the [R2 + dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens). + Sippy will use this token when writing objects to R2, so + it is best to scope this token to the bucket you're + enabling Sippy for. + type: string + provider: + $ref: '#/components/schemas/r2SippyProvider' + secretAccessKey: + description: >- + Value of a Cloudflare API token. This is the value + labelled "Secret Access Key" when creating an API. token + from the [R2 + dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens). + Sippy will use this token when writing objects to R2, so + it is best to scope this token to the bucket you're + enabling Sippy for. + type: string + x-sensitive: true + type: object + source: + description: AWS S3 bucket to copy objects from. + properties: + accessKeyId: + description: >- + Access Key ID of an IAM credential (ideally scoped to a + single S3 bucket). + type: string + bucket: + description: Name of the AWS S3 bucket. + type: string + x-auditable: true + provider: + enum: + - aws + type: string + x-auditable: true + region: + description: Name of the AWS availability zone. + type: string + x-auditable: true + secretAccessKey: + description: >- + Secret Access Key of an IAM credential (ideally scoped + to a single S3 bucket). + type: string + x-sensitive: true + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2Sippy' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Set Sippy Configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Get Sippy Configuration response failure. + security: + - api_token: [] + summary: Enable Sippy + tags: + - R2 Bucket + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.r2.bucket.write + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - sippy + method: update + /accounts/{account_id}/r2/metrics: + get: + description: >- + Get Storage/Object Count Metrics across all buckets in your account. + Note that Account-Level Metrics may not immediately reflect the latest + data. + operationId: r2-get-account-level-metrics + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2AccountLevelMetrics' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Get Account-Level Metrics response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Get Account-Level Metrics response failure. + security: + - api_token: [] + summary: Get Account-Level Metrics + tags: + - R2 Account + x-cfPermissionsRequired: null + x-stackql-sdk: + service: r2 + resource_chain: + - buckets + - metrics + method: list + /accounts/{account_id}/r2/temp-access-credentials: + post: + description: >- + Creates temporary access credentials on a bucket that can be optionally + scoped to prefixes or objects. + operationId: r2-create-temp-access-credentials + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2TempAccessCredsRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + $ref: '#/components/schemas/r2TempAccessCredsResponse' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Create temporary access credentials response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2V4ResponseFailure' + description: Create temporary access credentials response failure. + security: + - api_token: [] + summary: Create Temporary Access Credentials + tags: + - R2 Bucket + x-stackql-sdk: + service: r2 + resource_chain: + - temporary_credentials + method: create + /accounts/{account_id}/slurper/jobs: + get: + description: >- + Lists all R2 Super Slurper migration jobs for the account with their + status. + operationId: slurper-list-jobs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: limit + schema: + maximum: 50 + type: integer + - in: query + name: offset + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + items: + $ref: '#/components/schemas/r2SlurperJobResponse' + type: array + description: A list of jobs + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List jobs + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: list + post: + description: >- + Creates a new R2 Super Slurper migration job to transfer objects from a + source bucket (e.g. S3, GCS, R2) to R2. + operationId: slurper-create-job + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperCreateJobRequest' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + properties: + id: + type: string + type: object + description: Job created + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Maximum number of concurrent jobs has been reached + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a job + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: create + /accounts/{account_id}/slurper/jobs/abortAll: + put: + description: >- + Cancels all running R2 Super Slurper migration jobs for the account. Any + objects in the middle of a transfer will finish, but no new objects will + start transferring. + operationId: slurper-abort-all-jobs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: string + description: All jobs aborted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Abort all jobs + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: abort_all + /accounts/{account_id}/slurper/jobs/{job_id}: + delete: + description: >- + Deletes a completed, aborted, or errored R2 Super Slurper migration job. + Active jobs cannot be deleted. + operationId: slurper-delete-job + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: string + description: Job deleted + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Job is still active + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a job + tags: + - R2 Super Slurper + get: + description: >- + Retrieves detailed status and configuration for a specific R2 Super + Slurper migration job. + operationId: slurper-get-job + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/r2SlurperJobResponse' + description: Job details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get job details + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: get + /accounts/{account_id}/slurper/jobs/{job_id}/abort: + put: + description: >- + Cancels a specific R2 Super Slurper migration job. Any objects in the + middle of a transfer will finish, but no new objects will start + transferring. + operationId: slurper-abort-job + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: string + description: Job aborted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Abort a job + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: abort + /accounts/{account_id}/slurper/jobs/{job_id}/logs: + get: + description: >- + Gets log entries for an R2 Super Slurper migration job, showing + migration status changes, errors, etc. + operationId: slurper-get-job-logs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + - in: query + name: limit + schema: + maximum: 50 + type: integer + - in: query + name: offset + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + items: + $ref: '#/components/schemas/r2SlurperJobLogResponse' + type: array + description: Job logs + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get job logs + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + - logs + method: list + /accounts/{account_id}/slurper/jobs/{job_id}/pause: + put: + description: >- + Pauses a running R2 Super Slurper migration job. The job can be resumed + later to continue transferring. + operationId: slurper-pause-job + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: string + description: Job paused + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Job is not paused + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Pause a job + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: pause + /accounts/{account_id}/slurper/jobs/{job_id}/progress: + get: + description: Retrieves current progress metrics for an R2 Super Slurper migration job + operationId: slurper-get-job-progress + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/r2SlurperJobProgressResponse' + description: Job progress + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get job progress + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: progress + /accounts/{account_id}/slurper/jobs/{job_id}/resume: + put: + description: >- + Resumes a paused R2 Super Slurper migration job, continuing the transfer + from where it stopped. + operationId: slurper-resume-job + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: job_id + in: path + required: true + description: The job ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + type: string + description: Job resumed + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Resume a job + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - jobs + method: resume + /accounts/{account_id}/slurper/source/connectivity-precheck: + put: + description: Check whether tokens are valid against the source bucket + operationId: slurper-check-source-connectivity + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperSourceJobSchema' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/r2SlurperConnectivityResponse' + description: Source connectivity checked + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Check source connectivity + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - connectivity_precheck + method: source + /accounts/{account_id}/slurper/target/connectivity-precheck: + put: + description: Check whether tokens are valid against the target bucket + operationId: slurper-check-target-connectivity + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperR2TargetSchema' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/r2SlurperConnectivityResponse' + description: Target connectivity checked + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/r2SlurperApiV4Failure' + description: Failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Check target connectivity + tags: + - R2 Super Slurper + x-stackql-sdk: + service: r2 + resource_chain: + - super_slurper + - connectivity_precheck + method: target +components: + schemas: + r2AccountLevelMetrics: + description: Metrics based on the class they belong to. + properties: + infrequentAccess: + $ref: '#/components/schemas/r2ClassBasedMetrics' + standard: + $ref: '#/components/schemas/r2ClassBasedMetrics' + type: object + r2AddCustomDomainRequest: + example: + domain: prefix.example-domain.com + enabled: true + zoneId: 36ca64a6d92827b8a6b90be344bb1bfd + properties: + ciphers: + description: >- + An allowlist of ciphers for TLS termination. These ciphers must be + in the BoringSSL format. + items: + type: string + type: array + x-auditable: true + domain: + description: Name of the custom domain to be added. + type: string + x-auditable: true + enabled: + description: >- + Whether to enable public bucket access at the custom domain. If + undefined, the domain will be enabled. + type: boolean + x-auditable: true + minTLS: + description: >- + Minimum TLS Version the custom domain will accept for incoming + connections. If not set, defaults to 1.0. + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + type: string + x-auditable: true + zoneId: + description: Zone ID of the custom domain. + type: string + x-auditable: true + required: + - domain + - zoneId + - enabled + type: object + r2AddCustomDomainResponse: + example: + domain: example-domain.com + enabled: true + zoneId: 36ca64a6d92827b8a6b90be344bb1bfd + properties: + ciphers: + description: >- + An allowlist of ciphers for TLS termination. These ciphers must be + in the BoringSSL format. + items: + type: string + type: array + x-auditable: true + domain: + description: Domain name of the affected custom domain. + type: string + x-auditable: true + enabled: + description: >- + Whether this bucket is publicly accessible at the specified custom + domain. + type: boolean + minTLS: + description: >- + Minimum TLS Version the custom domain will accept for incoming + connections. If not set, defaults to 1.0. + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + type: string + x-auditable: true + zoneId: + description: Zone ID of the custom domain. + type: string + x-auditable: true + required: + - domain + - enabled + - zoneId + type: object + r2Bucket: + description: A single R2 bucket. + properties: + creation_date: + description: Creation timestamp. + type: string + jurisdiction: + $ref: '#/components/schemas/r2Jurisdiction' + location: + $ref: '#/components/schemas/r2BucketLocation' + name: + $ref: '#/components/schemas/r2BucketName' + storage_class: + $ref: '#/components/schemas/r2StorageClass' + type: object + r2BucketConfig: + properties: + bucketName: + description: Name of the bucket. + type: string + x-auditable: true + queues: + description: List of queues associated with the bucket. + items: + $ref: '#/components/schemas/r2QueuesConfig' + type: array + type: object + r2BucketLocation: + description: Location of the bucket. + enum: + - apac + - eeur + - enam + - weur + - wnam + - oc + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + r2BucketLockRule: + properties: + condition: + type: object + description: Condition to apply a lock rule to an object for how long in seconds. + properties: + maxAgeSeconds: + example: 100 + type: integer + x-auditable: true + type: + enum: + - Age + type: string + x-auditable: true + date: + format: date-time + type: string + x-auditable: true + required: + - type + enabled: + description: Whether or not this rule is in effect. + type: boolean + x-auditable: true + id: + description: Unique identifier for this rule. + example: Lock all objects for 24 hours + type: string + x-auditable: true + prefix: + description: >- + Rule will only apply to objects/uploads in the bucket that start + with the given prefix, an empty prefix can be provided to scope rule + to all objects/uploads. + type: string + x-auditable: true + required: + - id + - condition + - enabled + type: object + r2BucketLockRuleConfig: + properties: + rules: + items: + $ref: '#/components/schemas/r2BucketLockRule' + type: array + type: object + r2BucketName: + description: Name of the bucket. + example: example-bucket + maxLength: 64 + minLength: 3 + type: string + x-auditable: true + r2ClassBasedMetrics: + description: Metrics based on what state they are in(uploaded or published). + properties: + published: + $ref: '#/components/schemas/r2ObjectSizeMetrics' + uploaded: + $ref: '#/components/schemas/r2ObjectSizeMetrics' + type: object + r2CorsRule: + properties: + allowed: + description: >- + Object specifying allowed origins, methods and headers for this CORS + rule. + properties: + headers: + description: >- + Specifies the value for the Access-Control-Allow-Headers header + R2 sets when requesting objects in this bucket from a browser. + Cross-origin requests that include custom headers (e.g. + x-user-id) should specify these headers as AllowedHeaders. + items: + example: x-requested-by + type: string + x-auditable: true + type: array + methods: + description: >- + Specifies the value for the Access-Control-Allow-Methods header + R2 sets when requesting objects in a bucket from a browser. + items: + enum: + - GET + - PUT + - POST + - DELETE + - HEAD + type: string + x-auditable: true + type: array + origins: + description: >- + Specifies the value for the Access-Control-Allow-Origin header + R2 sets when requesting objects in a bucket from a browser. + items: + example: http://localhost:3000 + type: string + x-auditable: true + type: array + required: + - methods + - origins + type: object + exposeHeaders: + description: >- + Specifies the headers that can be exposed back, and accessed by, the + JavaScript making the cross-origin request. If you need to access + headers beyond the safelisted response headers, such as + Content-Encoding or cf-cache-status, you must specify it here. + items: + example: Content-Encoding + type: string + x-auditable: true + type: array + id: + description: Identifier for this rule. + example: Allow Local Development + type: string + x-auditable: true + maxAgeSeconds: + description: >- + Specifies the amount of time (in seconds) browsers are allowed to + cache CORS preflight responses. Browsers may limit this to 2 hours + or less, even if the maximum value (86400) is specified. + example: 3600 + type: number + x-auditable: true + required: + - allowed + type: object + r2DomainName: + description: Name of the custom domain. + example: example-domain/custom-domain.com + type: string + x-auditable: true + r2EditCustomDomainRequest: + example: + enabled: true + minTLS: '1.2' + properties: + ciphers: + description: >- + An allowlist of ciphers for TLS termination. These ciphers must be + in the BoringSSL format. + items: + type: string + type: array + x-auditable: true + enabled: + description: >- + Whether to enable public bucket access at the specified custom + domain. + type: boolean + x-auditable: true + minTLS: + description: >- + Minimum TLS Version the custom domain will accept for incoming + connections. If not set, defaults to previous value. + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + type: string + x-auditable: true + type: object + r2EditCustomDomainResponse: + example: + domain: example-domain.com + enabled: true + properties: + ciphers: + description: >- + An allowlist of ciphers for TLS termination. These ciphers must be + in the BoringSSL format. + items: + type: string + type: array + x-auditable: true + domain: + description: Domain name of the affected custom domain. + type: string + x-auditable: true + enabled: + description: >- + Whether this bucket is publicly accessible at the specified custom + domain. + type: boolean + x-auditable: true + minTLS: + description: >- + Minimum TLS Version the custom domain will accept for incoming + connections. If not set, defaults to 1.0. + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + type: string + x-auditable: true + required: + - domain + type: object + r2EditManagedDomainRequest: + example: + enabled: true + properties: + enabled: + description: Whether to enable public bucket access at the r2.dev domain. + type: boolean + x-auditable: true + required: + - enabled + type: object + r2Errors: + items: + $ref: '#/components/schemas/responseInfo' + type: array + r2GetCustomDomainResponse: + example: + domain: prefix.example-domain.one.com + enabled: false + status: + ownership: deactivated + ssl: pending + zoneId: 36ca64a6d92827b8a6b90be344bb1bfd + zoneName: example-domain.one.com + properties: + ciphers: + description: >- + An allowlist of ciphers for TLS termination. These ciphers must be + in the BoringSSL format. + items: + type: string + type: array + x-auditable: true + domain: + description: Domain name of the custom domain to be added. + type: string + x-auditable: true + enabled: + description: >- + Whether this bucket is publicly accessible at the specified custom + domain. + type: boolean + x-auditable: true + minTLS: + description: >- + Minimum TLS Version the custom domain will accept for incoming + connections. If not set, defaults to 1.0. + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + type: string + x-auditable: true + status: + properties: + ownership: + description: Ownership status of the domain. + enum: + - pending + - active + - deactivated + - blocked + - error + - unknown + type: string + x-auditable: true + ssl: + description: SSL certificate status. + enum: + - initializing + - pending + - active + - deactivated + - error + - unknown + type: string + x-auditable: true + required: + - ssl + - ownership + type: object + zoneId: + description: Zone ID of the custom domain resides in. + type: string + x-auditable: true + zoneName: + description: Zone that the custom domain resides in. + type: string + x-auditable: true + required: + - domain + - status + - enabled + type: object + r2Jurisdiction: + default: default + description: Jurisdiction where objects in this bucket are guaranteed to be stored. + enum: + - default + - eu + - fedramp + type: string + x-auditable: true + x-stainless-param: jurisdiction + r2LifecycleAgeCondition: + description: >- + Condition for lifecycle transitions to apply after an object reaches an + age in seconds. + properties: + maxAge: + type: integer + x-auditable: true + type: + enum: + - Age + type: string + x-auditable: true + required: + - type + - maxAge + type: object + r2LifecycleConfig: + properties: + rules: + items: + $ref: '#/components/schemas/r2LifecycleRule' + type: array + type: object + r2LifecycleRule: + properties: + abortMultipartUploadsTransition: + description: Transition to abort ongoing multipart uploads. + properties: + condition: + $ref: '#/components/schemas/r2LifecycleAgeCondition' + type: object + conditions: + description: Conditions that apply to all transitions of this rule. + properties: + prefix: + description: >- + Transitions will only apply to objects/uploads in the bucket + that start with the given prefix, an empty prefix can be + provided to scope rule to all objects/uploads. + type: string + x-auditable: true + required: + - prefix + type: object + deleteObjectsTransition: + description: Transition to delete objects. + properties: + condition: + type: object + description: >- + Condition for lifecycle transitions to apply after an object + reaches an age in seconds. + properties: + maxAge: + type: integer + x-auditable: true + type: + enum: + - Age + type: string + x-auditable: true + date: + format: date-time + type: string + x-auditable: true + required: + - type + type: object + enabled: + description: Whether or not this rule is in effect. + type: boolean + x-auditable: true + id: + description: Unique identifier for this rule. + example: Expire all objects older than 24 hours + type: string + x-auditable: true + storageClassTransitions: + description: Transitions to change the storage class of objects. + items: + $ref: '#/components/schemas/r2LifecycleStorageTransition' + type: array + required: + - id + - conditions + - enabled + type: object + r2LifecycleStorageTransition: + properties: + condition: + type: object + description: >- + Condition for lifecycle transitions to apply after an object reaches + an age in seconds. + properties: + maxAge: + type: integer + x-auditable: true + type: + enum: + - Age + type: string + x-auditable: true + date: + format: date-time + type: string + x-auditable: true + required: + - type + storageClass: + enum: + - InfrequentAccess + type: string + x-auditable: true + required: + - condition + - storageClass + type: object + r2ListCustomDomainsResponse: + example: + domains: + - domain: prefix.example-domain.one.com + enabled: false + status: + ownership: deactivated + ssl: pending + zoneId: 36ca64a6d92827b8a6b90be344bb1bfd + zoneName: example-domain.one.com + - domain: prefix.example-domain.two.com + enabled: true + status: + ownership: active + ssl: active + zoneId: d9d28585d5f8f5b0f857b055bf574f19 + properties: + domains: + items: + properties: + ciphers: + description: >- + An allowlist of ciphers for TLS termination. These ciphers + must be in the BoringSSL format. + items: + type: string + type: array + x-auditable: true + domain: + description: Domain name of the custom domain to be added. + type: string + x-auditable: true + enabled: + description: >- + Whether this bucket is publicly accessible at the specified + custom domain. + type: boolean + x-auditable: true + minTLS: + description: >- + Minimum TLS Version the custom domain will accept for incoming + connections. If not set, defaults to 1.0. + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + type: string + x-auditable: true + status: + properties: + ownership: + description: Ownership status of the domain. + enum: + - pending + - active + - deactivated + - blocked + - error + - unknown + type: string + x-auditable: true + ssl: + description: SSL certificate status. + enum: + - initializing + - pending + - active + - deactivated + - error + - unknown + type: string + x-auditable: true + required: + - ssl + - ownership + type: object + zoneId: + description: Zone ID of the custom domain resides in. + type: string + x-auditable: true + zoneName: + description: Zone that the custom domain resides in. + type: string + x-auditable: true + required: + - domain + - status + - enabled + type: object + type: array + required: + - domains + type: object + r2LocalUploadsConfiguration: + description: Configuration for local uploads on a bucket. + properties: + enabled: + description: >- + Whether local uploads is enabled for this bucket. When enabled, + object's data is written to the nearest region first, then + asynchronously replicated to the bucket's primary region. + type: boolean + x-auditable: true + type: object + r2ManagedDomainResponse: + example: + bucketId: 0113a9e4549cf9b1ff1bf56e04da0cef + domain: pub-0113a9e4549cf9b1ff1bf56e04da0cef.r2.dev + enabled: true + properties: + bucketId: + description: Bucket ID. + maxLength: 32 + type: string + x-auditable: true + domain: + description: Domain name of the bucket's r2.dev domain. + type: string + x-auditable: true + enabled: + description: Whether this bucket is publicly accessible at the r2.dev domain. + type: boolean + x-auditable: true + required: + - bucketId + - domain + - enabled + type: object + r2Messages: + items: + type: string + type: array + r2ObjectSizeMetrics: + description: Metrics on number of objects/amount of storage used. + properties: + metadataSize: + description: Amount of. + type: number + objects: + description: Number of objects stored. + type: number + payloadSize: + description: Amount of storage used by object data. + type: number + type: object + r2QueuesConfig: + properties: + queueId: + description: Queue ID. + example: 11111aa1-11aa-111a-a1a1-a1a111a11a11 + type: string + x-auditable: true + queueName: + description: Name of the queue. + example: first-queue + type: string + x-auditable: true + rules: + items: + properties: + actions: + description: Array of R2 object actions that will trigger notifications. + example: + - PutObject + - CopyObject + items: + $ref: '#/components/schemas/r2R2Action' + type: array + uniqueItems: true + description: + description: >- + A description that can be used to identify the event + notification rule after creation. + example: Notifications from source bucket to queue + type: string + x-auditable: true + prefix: + description: Notifications will be sent only for objects with this prefix. + example: img/ + type: string + x-auditable: true + suffix: + description: Notifications will be sent only for objects with this suffix. + example: .jpeg + type: string + x-auditable: true + createdAt: + description: Timestamp when the rule was created. + example: '2024-09-19T21:54:48.405Z' + type: string + x-auditable: true + ruleId: + description: Rule ID. + example: 11111aa1-11aa-111a-a1a1-a1a111a11a11 + type: string + x-auditable: true + required: + - actions + type: object + type: array + type: object + r2R2Action: + enum: + - PutObject + - CopyObject + - DeleteObject + - CompleteMultipartUpload + - LifecycleDeletion + type: string + x-auditable: true + r2RemoveCustomDomainResponse: + example: + domain: example-domain/custom-domain.com + properties: + domain: + description: Name of the removed custom domain. + type: string + x-auditable: true + required: + - domain + type: object + r2ResultInfo: + properties: + cursor: + description: >- + A continuation token that should be used to fetch the next page of + results. + example: >- + 1-JTdCJTIydiUyMiUzQTElMkMlMjJzdGFydEFmdGVyJTIyJTNBJTIyZGF2aWRwdWJsaWMlMjIlN0Q= + type: string + per_page: + description: Maximum number of results on this page. + example: 20 + type: number + type: object + r2Rule: + properties: + actions: + description: Array of R2 object actions that will trigger notifications. + example: + - PutObject + - CopyObject + items: + $ref: '#/components/schemas/r2R2Action' + type: array + uniqueItems: true + description: + description: >- + A description that can be used to identify the event notification + rule after creation. + example: Notifications from source bucket to queue + type: string + x-auditable: true + prefix: + description: Notifications will be sent only for objects with this prefix. + example: img/ + type: string + x-auditable: true + suffix: + description: Notifications will be sent only for objects with this suffix. + example: .jpeg + type: string + x-auditable: true + required: + - actions + type: object + r2Sippy: + properties: + destination: + description: Details about the configured destination bucket. + properties: + accessKeyId: + description: >- + ID of the Cloudflare API token used when writing objects to this + bucket. + type: string + account: + type: string + x-auditable: true + bucket: + description: Name of the bucket on the provider. + type: string + x-auditable: true + provider: + $ref: '#/components/schemas/r2SippyProvider' + type: object + enabled: + description: State of Sippy for this bucket. + type: boolean + x-auditable: true + source: + description: Details about the configured source bucket. + properties: + bucket: + description: Name of the bucket on the provider (AWS, GCS only). + nullable: true + type: string + x-auditable: true + bucketUrl: + description: S3-compatible URL (Generic S3-compatible providers only). + nullable: true + type: string + x-auditable: true + provider: + enum: + - aws + - gcs + - s3 + type: string + x-auditable: true + region: + description: Region where the bucket resides (AWS only). + nullable: true + type: string + x-auditable: true + type: object + type: object + r2SippyProvider: + enum: + - r2 + type: string + x-auditable: true + r2SlurperApiV4Error: + example: + - code: 7003 + message: No route for the URI + items: + $ref: '#/components/schemas/responseInfo' + minLength: 1 + type: array + r2SlurperApiV4Failure: + properties: + errors: + $ref: '#/components/schemas/r2SlurperApiV4Error' + messages: + $ref: '#/components/schemas/r2SlurperApiV4Message' + success: + description: Indicates if the API call was successful or not. + enum: + - false + example: false + type: boolean + x-auditable: true + type: object + r2SlurperApiV4Message: + example: [] + items: + type: string + x-auditable: true + type: array + r2SlurperConnectivityResponse: + properties: + connectivityStatus: + enum: + - success + - error + type: string + type: object + r2SlurperCreateJobRequest: + properties: + overwrite: + default: true + type: boolean + source: + $ref: '#/components/schemas/r2SlurperSourceJobSchema' + target: + $ref: '#/components/schemas/r2SlurperR2TargetSchema' + type: object + r2SlurperJobLogResponse: + properties: + createdAt: + type: string + job: + type: string + logType: + enum: + - migrationStart + - migrationComplete + - migrationAbort + - migrationError + - migrationPause + - migrationResume + - migrationErrorFailedContinuation + - importErrorRetryExhaustion + - importSkippedStorageClass + - importSkippedOversized + - importSkippedEmptyObject + - importSkippedUnsupportedContentType + - importSkippedExcludedContentType + - importSkippedInvalidMedia + - importSkippedRequiresRetrieval + type: string + message: + nullable: true + type: string + objectKey: + nullable: true + type: string + type: object + r2SlurperJobProgressResponse: + properties: + createdAt: + type: string + failedObjects: + type: integer + id: + type: string + objects: + type: integer + skippedObjects: + type: integer + status: + $ref: '#/components/schemas/r2SlurperJobStatus' + transferredObjects: + type: integer + type: object + r2SlurperJobResponse: + properties: + createdAt: + type: string + finishedAt: + nullable: true + type: string + id: + type: string + overwrite: + type: boolean + source: + type: object + title: S3SourceResponseSchema + properties: + bucket: + type: string + endpoint: + nullable: true + type: string + keys: + items: + type: string + nullable: true + type: array + pathPrefix: + nullable: true + type: string + vendor: + enum: + - s3 + type: string + jurisdiction: + $ref: '#/components/schemas/r2SlurperJurisdiction' + status: + $ref: '#/components/schemas/r2SlurperJobStatus' + target: + properties: + bucket: + type: string + jurisdiction: + $ref: '#/components/schemas/r2SlurperJurisdiction' + vendor: + $ref: '#/components/schemas/r2SippyProvider' + title: R2TargetResponseSchema + type: object + type: object + r2SlurperJobStatus: + enum: + - running + - paused + - aborted + - completed + type: string + r2SlurperJurisdiction: + enum: + - default + - eu + - fedramp + type: string + r2SlurperR2TargetSchema: + properties: + bucket: + type: string + jurisdiction: + $ref: '#/components/schemas/r2SlurperJurisdiction' + secret: + $ref: '#/components/schemas/r2SlurperS3LikeCredsSchema' + vendor: + $ref: '#/components/schemas/r2SippyProvider' + required: + - vendor + - bucket + - secret + type: object + r2SlurperS3LikeCredsSchema: + properties: + accessKeyId: + type: string + secretAccessKey: + type: string + x-sensitive: true + required: + - accessKeyId + - secretAccessKey + type: object + r2SlurperSourceJobSchema: + type: object + properties: + bucket: + type: string + endpoint: + nullable: true + type: string + keys: + items: + type: string + maxItems: 10000 + nullable: true + type: array + pathPrefix: + nullable: true + type: string + region: + nullable: true + type: string + secret: + $ref: '#/components/schemas/r2SlurperS3LikeCredsSchema' + vendor: + enum: + - s3 + type: string + jurisdiction: + $ref: '#/components/schemas/r2SlurperJurisdiction' + required: + - bucket + - secret + - vendor + r2StorageClass: + default: Standard + description: Storage class for newly uploaded objects, unless specified otherwise. + enum: + - Standard + - InfrequentAccess + type: string + x-auditable: true + r2TempAccessCredsRequest: + example: + bucket: example-bucket + objects: + - example-object + parentAccessKeyId: example-access-key-id + permission: object-read-write + prefixes: + - example-prefix/ + ttlSeconds: 3600 + properties: + bucket: + description: Name of the R2 bucket. + type: string + x-auditable: true + objects: + description: Optional object paths to scope the credentials to. + items: + type: string + x-auditable: true + type: array + parentAccessKeyId: + description: The parent access key id to use for signing. + type: string + permission: + description: Permissions allowed on the credentials. + enum: + - admin-read-write + - admin-read-only + - object-read-write + - object-read-only + type: string + x-auditable: true + prefixes: + description: Optional prefix paths to scope the credentials to. + items: + type: string + x-auditable: true + type: array + ttlSeconds: + default: 900 + description: How long the credentials will live for in seconds. + maximum: 604800 + type: number + x-auditable: true + required: + - bucket + - permission + - ttlSeconds + - parentAccessKeyId + type: object + r2TempAccessCredsResponse: + example: + accessKeyId: example-access-key-id + secretAccessKey: example-secret-key + sessionToken: example-session-token + properties: + accessKeyId: + description: ID for new access key. + type: string + secretAccessKey: + description: Secret access key. + type: string + x-sensitive: true + sessionToken: + description: Security token. + type: string + x-sensitive: true + type: object + r2V4Response: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + type: object + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + r2V4ResponseFailure: + properties: + errors: + $ref: '#/components/schemas/r2Errors' + messages: + $ref: '#/components/schemas/r2Messages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + event_notifications: + id: cloudflare.r2.event_notifications + name: event_notifications + title: Event Notifications + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_notifications~1r2~1{bucket_name}~1configuration/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_notifications~1r2~1{bucket_name}~1configuration~1queues~1{queue_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_notifications~1r2~1{bucket_name}~1configuration~1queues~1{queue_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1event_notifications~1r2~1{bucket_name}~1configuration~1queues~1{queue_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/event_notifications/methods/get' + - $ref: '#/components/x-stackQL-resources/event_notifications/methods/list' + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/event_notifications/methods/delete + replace: + - $ref: >- + #/components/x-stackQL-resources/event_notifications/methods/update + buckets: + id: cloudflare.r2.buckets + name: buckets + title: Buckets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2~1buckets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.buckets + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2~1buckets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/buckets/methods/get' + - $ref: '#/components/x-stackQL-resources/buckets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/buckets/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete' + replace: [] + cors: + id: cloudflare.r2.cors + name: cors + title: Cors + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1cors/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1cors/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.rules + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1cors/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cors/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/cors/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/cors/methods/update' + custom: + id: cloudflare.r2.custom + name: custom + title: Custom + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1domains~1custom/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.domains + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1domains~1custom/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1domains~1custom~1{domain}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1domains~1custom~1{domain}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1domains~1custom~1{domain}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom/methods/get' + - $ref: '#/components/x-stackQL-resources/custom/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/custom/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/custom/methods/update' + managed: + id: cloudflare.r2.managed + name: managed + title: Managed + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1domains~1managed/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1domains~1managed/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/managed/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/managed/methods/update' + lifecycle: + id: cloudflare.r2.lifecycle + name: lifecycle + title: Lifecycle + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1lifecycle/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.rules + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1lifecycle/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/lifecycle/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/lifecycle/methods/update' + local_uploads: + id: cloudflare.r2.local_uploads + name: local_uploads + title: Local Uploads + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1local-uploads/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + r2_put_bucket_local_uploads_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1local-uploads/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/local_uploads/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/local_uploads/methods/r2_put_bucket_local_uploads_configuration + locks: + id: cloudflare.r2.locks + name: locks + title: Locks + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1lock/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.rules + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1lock/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locks/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + sippy: + id: cloudflare.r2.sippy + name: sippy + title: Sippy + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1sippy/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1sippy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2~1buckets~1{bucket_name}~1sippy/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sippy/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/sippy/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/sippy/methods/update' + metrics: + id: cloudflare.r2.metrics + name: metrics + title: Metrics + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2~1metrics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metrics/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + r2: + id: cloudflare.r2.r2 + name: r2 + title: R2 + methods: + create_temp_access_credentials: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2~1temp-access-credentials/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + slurper_jobs: + id: cloudflare.r2.slurper_jobs + name: slurper_jobs + title: Slurper Jobs + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1slurper~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/slurper_jobs/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + jobs: + id: cloudflare.r2.jobs + name: jobs + title: Jobs + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1slurper~1jobs/post' + response: + mediaType: application/json + openAPIDocKey: '201' + abort_all: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1slurper~1jobs~1abortAll/put' + response: + mediaType: application/json + openAPIDocKey: '200' + slurper_delete_job: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1slurper~1jobs~1{job_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1slurper~1jobs~1{job_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + abort: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1slurper~1jobs~1{job_id}~1abort/put + response: + mediaType: application/json + openAPIDocKey: '200' + pause: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1slurper~1jobs~1{job_id}~1pause/put + response: + mediaType: application/json + openAPIDocKey: '200' + resume: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1slurper~1jobs~1{job_id}~1resume/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/slurper_delete_job' + replace: + - $ref: '#/components/x-stackQL-resources/jobs/methods/abort_all' + logs: + id: cloudflare.r2.logs + name: logs + title: Logs + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1slurper~1jobs~1{job_id}~1logs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + jobs_progress: + id: cloudflare.r2.jobs_progress + name: jobs_progress + title: Jobs Progress + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1slurper~1jobs~1{job_id}~1progress/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/jobs_progress/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + source_connectivity_precheck: + id: cloudflare.r2.source_connectivity_precheck + name: source_connectivity_precheck + title: Source Connectivity Precheck + methods: + update_connectivity_precheck: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1slurper~1source~1connectivity-precheck/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + target_connectivity_precheck: + id: cloudflare.r2.target_connectivity_precheck + name: target_connectivity_precheck + title: Target Connectivity Precheck + methods: + update_connectivity_precheck: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1slurper~1target~1connectivity-precheck/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml b/providers/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml new file mode 100644 index 00000000..3cc9e351 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/r2_data_catalog.yaml @@ -0,0 +1,1705 @@ +openapi: 3.0.3 +info: + title: r2_data_catalog API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/r2-catalog: + get: + description: >- + Returns a list of R2 buckets that have been enabled as Apache Iceberg + catalogs for the specified account. Each catalog represents an R2 bucket + configured to store Iceberg metadata and data files. + operationId: list-catalogs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: '#/components/schemas/r2DataCatalogCatalogList' + required: + - success + - errors + - messages + type: object + description: List of R2 catalogs. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List R2 catalogs + tags: + - R2 Catalog Management + x-api-token-group: + - Workers R2 Data Catalog Write + - Workers R2 Data Catalog Read + x-stackql-sdk: + service: r2_data_catalog + resource_chain: [] + method: list + /accounts/{account_id}/r2-catalog/{bucket_name}: + get: + description: >- + Retrieve detailed information about a specific R2 catalog by bucket + name. Returns catalog status, maintenance configuration, and credential + status. + operationId: get-catalog-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: '#/components/schemas/r2DataCatalogCatalog' + required: + - success + - errors + - messages + type: object + description: R2 catalog details. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get R2 catalog details + tags: + - R2 Catalog Management + x-api-token-group: + - Workers R2 Data Catalog Write + - Workers R2 Data Catalog Read + x-stackql-sdk: + service: r2_data_catalog + resource_chain: [] + method: get + /accounts/{account_id}/r2-catalog/{bucket_name}/credential: + post: + description: >- + Store authentication credentials for a catalog. These credentials are + used to authenticate with R2 storage when performing catalog operations. + operationId: store-credentials + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogCatalogCredentialRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Credentials stored successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Store catalog credentials + tags: + - Credential Management + x-api-token-group: + - Workers R2 Data Catalog Write + x-stackql-sdk: + service: r2_data_catalog + resource_chain: + - credentials + method: create + /accounts/{account_id}/r2-catalog/{bucket_name}/disable: + post: + description: >- + Disable an R2 bucket as a catalog. This operation deactivates the + catalog but preserves existing metadata and data files. The catalog can + be re-enabled later. + operationId: disable-catalog + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + responses: + '204': + description: Catalog disabled successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Disable R2 catalog + tags: + - R2 Catalog Management + x-api-token-group: + - Workers R2 Data Catalog Write + x-stackql-sdk: + service: r2_data_catalog + resource_chain: [] + method: disable + /accounts/{account_id}/r2-catalog/{bucket_name}/enable: + post: + description: >- + Enable an R2 bucket as an Apache Iceberg catalog. This operation creates + the necessary catalog infrastructure and activates the bucket for + storing Iceberg metadata and data files. + operationId: enable-catalog + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: >- + #/components/schemas/r2DataCatalogCatalogActivationResponse + required: + - success + - errors + - messages + type: object + description: Catalog enabled successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog already enabled. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Enable R2 bucket as a catalog + tags: + - R2 Catalog Management + x-api-token-group: + - Workers R2 Data Catalog Write + x-stackql-sdk: + service: r2_data_catalog + resource_chain: [] + method: enable + /accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs: + get: + description: >- + Retrieve the maintenance configuration for a specific catalog, including + compaction settings and credential status. + operationId: get-maintenance-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: >- + #/components/schemas/r2DataCatalogCatalogMaintenanceConfigResponse + required: + - success + - errors + - messages + type: object + description: Maintenance configuration retrieved successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get catalog maintenance configuration + tags: + - Maintenance Configuration + x-api-token-group: + - Workers R2 Data Catalog Write + - Workers R2 Data Catalog Read + x-stackql-sdk: + service: r2_data_catalog + resource_chain: + - maintenance_configs + method: get + post: + description: >- + Update the maintenance configuration for a catalog. This allows you to + enable or disable compaction and adjust target file sizes for + optimization. + operationId: update-maintenance-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/r2DataCatalogCatalogMaintenanceUpdateRequest + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceConfig' + required: + - success + - errors + - messages + type: object + description: Maintenance configuration updated successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update catalog maintenance configuration + tags: + - Maintenance Configuration + x-api-token-group: + - Workers R2 Data Catalog Write + x-stackql-sdk: + service: r2_data_catalog + resource_chain: + - maintenance_configs + method: update + /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces: + get: + description: >- + Returns a list of namespaces in the specified R2 catalog. Supports + hierarchical filtering and pagination for efficient traversal of large + namespace hierarchies. + operationId: list-namespaces + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - description: >- + Opaque pagination token from a previous response. Use this to fetch + the next page of results. + in: query + name: page_token + schema: + type: string + - description: >- + Maximum number of namespaces to return per page. Defaults to 100, + maximum 1000. + in: query + name: page_size + schema: + default: 100 + maximum: 1000 + minimum: 1 + type: integer + - description: >- + Parent namespace to filter by. Only returns direct children of this + namespace. For nested namespaces, use %1F as separator (e.g., + "bronze%1Fanalytics"). Omit this parameter to list top-level + namespaces. + in: query + name: parent + schema: + type: string + - description: >- + Whether to include namespace UUIDs in the response. Set to true to + receive the namespace_uuids array. + in: query + name: return_uuids + schema: + default: false + type: boolean + - description: >- + Whether to include additional metadata (timestamps). When true, + response includes created_at and updated_at arrays. + in: query + name: return_details + schema: + default: false + type: boolean + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: '#/components/schemas/r2DataCatalogNamespaceListResponse' + required: + - success + - errors + - messages + type: object + description: List of namespaces retrieved successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request (e.g., invalid page_size, malformed parent namespace). + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List namespaces in catalog + tags: + - Namespace Management + x-api-token-group: + - Workers R2 Data Catalog Write + - Workers R2 Data Catalog Read + x-stackql-sdk: + service: r2_data_catalog + resource_chain: + - namespaces + method: list + /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables: + get: + description: >- + Returns a list of tables in the specified namespace within an R2 + catalog. Supports pagination for efficient traversal of large table + collections. + operationId: list-tables + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - description: >- + The namespace identifier. For nested namespaces, use %1F as + separator (e.g., "bronze%1Fanalytics"). + in: path + name: namespace + schema: + type: string + required: true + - description: >- + Opaque pagination token from a previous response. Use this to fetch + the next page of results. + in: query + name: page_token + schema: + type: string + - description: >- + Maximum number of tables to return per page. Defaults to 100, + maximum 1000. + in: query + name: page_size + schema: + default: 100 + maximum: 1000 + minimum: 1 + type: integer + - description: >- + Whether to include table UUIDs in the response. Set to true to + receive the table_uuids array. + in: query + name: return_uuids + schema: + default: false + type: boolean + - description: >- + Whether to include additional metadata (timestamps, locations). When + true, response includes created_at, updated_at, metadata_locations, + and locations arrays. + in: query + name: return_details + schema: + default: false + type: boolean + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: '#/components/schemas/r2DataCatalogTableListResponse' + required: + - success + - errors + - messages + type: object + description: List of tables retrieved successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request (e.g., invalid page_size, malformed namespace). + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Catalog or namespace not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List tables in namespace + tags: + - Table Management + x-api-token-group: + - Workers R2 Data Catalog Write + - Workers R2 Data Catalog Read + x-stackql-sdk: + service: r2_data_catalog + resource_chain: + - namespaces + - tables + method: list + /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs: + get: + description: >- + Retrieve the maintenance configuration for a specific table, including + compaction settings. + operationId: get-table-maintenance-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - description: >- + The namespace identifier (use %1F as separator for nested + namespaces). + in: path + name: namespace + schema: + type: string + required: true + - description: The table name. + in: path + name: table_name + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: >- + #/components/schemas/r2DataCatalogTableMaintenanceConfigResponse + required: + - success + - errors + - messages + type: object + description: Table maintenance configuration retrieved successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Table not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get table maintenance configuration + tags: + - Table Maintenance Configuration + x-api-token-group: + - Workers R2 Data Catalog Write + - Workers R2 Data Catalog Read + x-stackql-sdk: + service: r2_data_catalog + resource_chain: + - namespaces + - tables + - maintenance_configs + method: get + post: + description: >- + Update the maintenance configuration for a specific table. This allows + you to enable or disable compaction and adjust target file sizes for + optimization. + operationId: update-table-maintenance-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: bucket_name + in: path + required: true + description: The R2 bucket name. + schema: + type: string + - description: >- + The namespace identifier (use %1F as separator for nested + namespaces). + in: path + name: namespace + schema: + type: string + required: true + - description: The table name. + in: path + name: table_name + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogTableMaintenanceUpdateRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/r2DataCatalogApiResponseErrors' + messages: + $ref: '#/components/schemas/r2DataCatalogApiResponseMessages' + success: + $ref: '#/components/schemas/r2DataCatalogApiResponseSuccess' + result: + $ref: '#/components/schemas/r2DataCatalogTableMaintenanceConfig' + required: + - success + - errors + - messages + type: object + description: Table maintenance configuration updated successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Bad request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Authentication failed. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Forbidden. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Table not found. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/r2DataCatalogApiResponseCommonFailure' + description: Internal server error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update table maintenance configuration + tags: + - Table Maintenance Configuration + x-api-token-group: + - Workers R2 Data Catalog Write + x-stackql-sdk: + service: r2_data_catalog + resource_chain: + - namespaces + - tables + - maintenance_configs + method: update +components: + schemas: + r2DataCatalogApiResponseCommonFailure: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + minItems: 1 + type: array + messages: + items: + type: object + type: array + success: + enum: + - false + type: boolean + type: object + r2DataCatalogApiResponseErrors: + description: Contains errors if the API call was unsuccessful. + items: + properties: + code: + description: Specifies the error code. + type: integer + message: + description: Describes the error. + type: string + required: + - code + - message + type: object + type: array + r2DataCatalogApiResponseMessages: + description: Contains informational messages. + items: + properties: + code: + description: Specifies the message code. + type: integer + message: + description: Contains the message text. + type: string + required: + - code + - message + type: object + type: array + r2DataCatalogApiResponseSuccess: + description: Indicates whether the API call was successful. + example: true + type: boolean + r2DataCatalogCatalog: + description: Contains R2 Data Catalog information. + properties: + bucket: + description: Specifies the associated R2 bucket name. + example: my-data-bucket + type: string + credential_status: + description: Shows the credential configuration status. + nullable: true + type: string + $ref: '#/components/schemas/r2DataCatalogCredentialStatus' + id: + description: Use this to uniquely identify the catalog. + example: 550e8400-e29b-41d4-a716-446655440000 + format: uuid + type: string + maintenance_config: + description: Configures maintenance for the catalog. + nullable: true + type: object + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceConfig' + name: + description: Specifies the catalog name (generated from account and bucket name). + example: account123_my-bucket + type: string + status: + $ref: '#/components/schemas/r2DataCatalogCatalogStatus' + required: + - id + - name + - bucket + - status + type: object + r2DataCatalogCatalogActivationResponse: + description: Contains response from activating an R2 bucket as a catalog. + properties: + id: + description: Use this to uniquely identify the activated catalog. + example: 550e8400-e29b-41d4-a716-446655440000 + format: uuid + type: string + name: + description: Specifies the name of the activated catalog. + example: account123_my-bucket + type: string + required: + - id + - name + type: object + r2DataCatalogCatalogCompactionConfig: + description: Configures compaction for catalog maintenance. + properties: + state: + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceState' + target_size_mb: + $ref: '#/components/schemas/r2DataCatalogCatalogTargetFileSize' + required: + - state + - target_size_mb + type: object + r2DataCatalogCatalogCredentialRequest: + description: Contains request to store catalog credentials. + properties: + token: + description: Provides the Cloudflare API token for accessing R2. + example: your-cloudflare-api-token-here + type: string + required: + - token + type: object + r2DataCatalogCatalogList: + description: Contains the list of catalogs. + properties: + warehouses: + description: Lists catalogs in the account. + items: + $ref: '#/components/schemas/r2DataCatalogCatalog' + type: array + required: + - warehouses + type: object + r2DataCatalogCatalogMaintenanceConfig: + description: Configures maintenance for the catalog. + properties: + compaction: + $ref: '#/components/schemas/r2DataCatalogCatalogCompactionConfig' + snapshot_expiration: + $ref: '#/components/schemas/r2DataCatalogSnapshotExpirationConfig' + type: object + r2DataCatalogCatalogMaintenanceConfigResponse: + description: Contains maintenance configuration and credential status. + properties: + credential_status: + $ref: '#/components/schemas/r2DataCatalogCredentialStatus' + maintenance_config: + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceConfig' + required: + - maintenance_config + - credential_status + type: object + r2DataCatalogCatalogMaintenanceState: + description: Specifies the state of maintenance operations. + enum: + - enabled + - disabled + example: enabled + type: string + r2DataCatalogCatalogMaintenanceUpdateRequest: + description: Contains request to update catalog maintenance configuration. + $ref: '#/components/schemas/r2DataCatalogMaintenanceUpdateParams' + r2DataCatalogCatalogStatus: + description: Indicates the status of the catalog. + enum: + - active + - inactive + example: active + type: string + r2DataCatalogCatalogTargetFileSize: + description: >- + Sets the target file size for compaction in megabytes. Defaults to + "128". + enum: + - '64' + - '128' + - '256' + - '512' + example: '128' + type: string + r2DataCatalogCompactionUpdateParams: + description: Updates compaction configuration (all fields optional). + properties: + state: + description: Updates the state optionally. + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceState' + target_size_mb: + description: Updates the target file size optionally. + $ref: '#/components/schemas/r2DataCatalogCatalogTargetFileSize' + type: object + r2DataCatalogCredentialStatus: + description: Shows the credential configuration status. + enum: + - present + - absent + example: present + type: string + r2DataCatalogMaintenanceUpdateParams: + description: Contains maintenance update parameters. + properties: + compaction: + $ref: '#/components/schemas/r2DataCatalogCompactionUpdateParams' + snapshot_expiration: + $ref: '#/components/schemas/r2DataCatalogSnapshotExpirationUpdateParams' + type: object + r2DataCatalogNamespaceDetails: + description: Contains namespace with metadata details. + properties: + created_at: + description: Indicates the creation timestamp in ISO 8601 format. + format: date-time + nullable: true + type: string + readOnly: true + namespace: + $ref: '#/components/schemas/r2DataCatalogNamespaceIdentifier' + namespace_uuid: + description: Contains the UUID that persists across renames. + format: uuid + type: string + updated_at: + description: >- + Shows the last update timestamp in ISO 8601 format. Null if never + updated. + format: date-time + nullable: true + type: string + readOnly: true + required: + - namespace + - namespace_uuid + type: object + r2DataCatalogNamespaceIdentifier: + description: >- + Specifies the hierarchical namespace parts as an array of strings. For + example, ["bronze", "analytics"] represents the namespace + "bronze.analytics". + example: + - bronze + - analytics + items: + type: string + maxItems: 16 + minItems: 1 + type: array + r2DataCatalogNamespaceListResponse: + description: Contains the list of namespaces with optional pagination. + properties: + details: + description: >- + Contains detailed metadata for each namespace when return_details is + true. Each object includes the namespace, UUID, and timestamps. + items: + $ref: '#/components/schemas/r2DataCatalogNamespaceDetails' + nullable: true + type: array + namespace_uuids: + description: >- + Contains UUIDs for each namespace when return_uuids is true. The + order corresponds to the namespaces array. + example: + - 0199b999-6869-7383-bb1f-d30e059d5326 + - 0199b99b-2c88-73b3-8dbb-421e0e8f2757 + items: + format: uuid + type: string + nullable: true + type: array + namespaces: + description: Lists namespaces in the catalog. + items: + $ref: '#/components/schemas/r2DataCatalogNamespaceIdentifier' + type: array + next_page_token: + description: >- + Use this opaque token to fetch the next page of results. A null or + absent value indicates the last page. + example: >- + MSYxNzU5NzU1NTc4NTA0MTk0JjAxOTliOTliLTJjODgtNzNiMy04ZGJiLTQyMWUwZThmMjc1Nw + nullable: true + type: string + required: + - namespaces + type: object + r2DataCatalogSnapshotExpirationConfig: + description: Configures snapshot expiration settings. + properties: + max_snapshot_age: + description: >- + Specifies the maximum age for snapshots. The system deletes + snapshots older than this age. Format: where unit is + d (days), h (hours), m (minutes), or s (seconds). Examples: "7d" (7 + days), "48h" (48 hours), "2880m" (2,880 minutes). Defaults to "7d". + example: 7d + type: string + min_snapshots_to_keep: + description: >- + Specifies the minimum number of snapshots to retain. Defaults to + 100. + example: 100 + format: int64 + minimum: 1 + type: integer + state: + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceState' + required: + - state + - min_snapshots_to_keep + - max_snapshot_age + type: object + r2DataCatalogSnapshotExpirationUpdateParams: + description: Updates snapshot expiration configuration (all fields optional). + properties: + max_snapshot_age: + description: Updates the maximum age for snapshots optionally. + type: string + min_snapshots_to_keep: + description: Updates the minimum number of snapshots to retain optionally. + format: int64 + minimum: 1 + type: integer + state: + description: Updates the state optionally. + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceState' + type: object + r2DataCatalogTableCompactionConfig: + description: Configures compaction settings for table optimization. + properties: + state: + $ref: '#/components/schemas/r2DataCatalogCatalogMaintenanceState' + target_size_mb: + $ref: '#/components/schemas/r2DataCatalogCatalogTargetFileSize' + required: + - state + - target_size_mb + type: object + r2DataCatalogTableDetails: + description: Contains table with metadata. + properties: + created_at: + description: Indicates the creation timestamp in ISO 8601 format. + format: date-time + nullable: true + type: string + readOnly: true + identifier: + $ref: '#/components/schemas/r2DataCatalogTableIdentifier' + location: + description: Specifies the base S3 URI for table storage location. + nullable: true + type: string + metadata_location: + description: Contains the S3 URI to table metadata file. Null for staged tables. + nullable: true + type: string + table_uuid: + description: Contains the UUID that persists across renames. + format: uuid + type: string + updated_at: + description: >- + Shows the last update timestamp in ISO 8601 format. Null if never + updated. + format: date-time + nullable: true + type: string + readOnly: true + required: + - identifier + - table_uuid + type: object + r2DataCatalogTableIdentifier: + description: Specifies a unique table identifier within a catalog. + properties: + name: + description: Specifies the table name. + example: events + type: string + namespace: + $ref: '#/components/schemas/r2DataCatalogNamespaceIdentifier' + required: + - namespace + - name + type: object + r2DataCatalogTableListResponse: + description: Contains the list of tables with optional pagination. + properties: + details: + description: >- + Contains detailed metadata for each table when return_details is + true. Each object includes identifier, UUID, timestamps, and + locations. + items: + $ref: '#/components/schemas/r2DataCatalogTableDetails' + nullable: true + type: array + identifiers: + description: Lists tables in the namespace. + items: + $ref: '#/components/schemas/r2DataCatalogTableIdentifier' + type: array + next_page_token: + description: >- + Use this opaque token to fetch the next page of results. A null or + absent value indicates the last page. + example: >- + MSYxNzU5NzU2MTI4NTU2Njk2JjAxOTliOWEzLTkxMmUtN2ZhMS05YzllLTg5MTAxMGQzYTg0MQ + nullable: true + type: string + table_uuids: + description: >- + Contains UUIDs for each table when return_uuids is true. The order + corresponds to the identifiers array. + example: + - 0199b9a1-28a0-71e0-a73e-b0fc32c8468e + - 0199b9a1-3c74-7731-bf53-d8c67ead079d + items: + format: uuid + type: string + nullable: true + type: array + required: + - identifiers + type: object + r2DataCatalogTableMaintenanceConfig: + description: Configures maintenance for the table. + properties: + compaction: + $ref: '#/components/schemas/r2DataCatalogTableCompactionConfig' + snapshot_expiration: + $ref: '#/components/schemas/r2DataCatalogSnapshotExpirationConfig' + type: object + r2DataCatalogTableMaintenanceConfigResponse: + description: Contains table maintenance configuration. + properties: + maintenance_config: + $ref: '#/components/schemas/r2DataCatalogTableMaintenanceConfig' + required: + - maintenance_config + type: object + r2DataCatalogTableMaintenanceUpdateRequest: + description: Contains request to update table maintenance configuration. + $ref: '#/components/schemas/r2DataCatalogMaintenanceUpdateParams' + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + r2_catalog: + id: cloudflare.r2_data_catalog.r2_catalog + name: r2_catalog + title: R2 Catalog + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2-catalog/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.warehouses + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_credential: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1credential/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1disable/post + response: + mediaType: application/json + openAPIDocKey: '204' + enable: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/r2_catalog/methods/get' + - $ref: '#/components/x-stackQL-resources/r2_catalog/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + r2_catalog_maintenance_configs: + id: cloudflare.r2_data_catalog.r2_catalog_maintenance_configs + name: r2_catalog_maintenance_configs + title: R2 Catalog Maintenance Configs + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1maintenance-configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1maintenance-configs/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/r2_catalog_maintenance_configs/methods/list_by_account + insert: + - $ref: >- + #/components/x-stackQL-resources/r2_catalog_maintenance_configs/methods/update_by_account + update: [] + delete: [] + replace: [] + namespaces: + id: cloudflare.r2_data_catalog.namespaces + name: namespaces + title: Namespaces + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1namespaces/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tables: + id: cloudflare.r2_data_catalog.tables + name: tables + title: Tables + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1namespaces~1{namespace}~1tables/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tables/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tables_maintenance_configs: + id: cloudflare.r2_data_catalog.tables_maintenance_configs + name: tables_maintenance_configs + title: Tables Maintenance Configs + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1namespaces~1{namespace}~1tables~1{table_name}~1maintenance-configs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1r2-catalog~1{bucket_name}~1namespaces~1{namespace}~1tables~1{table_name}~1maintenance-configs/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/tables_maintenance_configs/methods/list_by_account + insert: + - $ref: >- + #/components/x-stackQL-resources/tables_maintenance_configs/methods/update_by_account + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/radar.yaml b/providers/src/cloudflare/v00.00.00000/services/radar.yaml index f9dcf760..d459e9c1 100644 --- a/providers/src/cloudflare/v00.00.00000/services/radar.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/radar.yaml @@ -1,9599 +1,77927 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Radar BGP - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - radar - version: 4.0.0 -components: - schemas: - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - bot_class: - default: LIKELY_AUTOMATED - description: Bot class. - enum: - - LIKELY_AUTOMATED - - LIKELY_HUMAN - type: string - device_type: - default: DESKTOP - description: Device type. - enum: - - DESKTOP - - MOBILE - - OTHER - type: string - http_protocol: - default: HTTP - description: HTTP Protocol. - enum: - - HTTP - - HTTPS - type: string - http_version: - default: HTTPv1 - description: HTTP version. - enum: - - HTTPv1 - - HTTPv2 - - HTTPv3 - type: string - ip_version: - default: IPv4 - description: IP version. - enum: - - IPv4 - - IPv6 - type: string - tls_version: - default: TLSv1_0 - description: TLS version. - enum: - - TLSv1_0 - - TLSv1_1 - - TLSv1_2 - - TLSv1_3 - - TLSvQUIC - type: string - entities_components-schemas-asn: - description: Autonomous System Number (ASN). - type: integer - location: - description: Alpha-2 country code. - example: US - type: string - eventAlias: - description: Special Event alias - example: eurovision-2022 - type: string - categoryAlias: - description: Special Event Category alias - example: videos - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - bgp_timeseries: - id: cloudflare.radar.bgp_timeseries - name: bgp_timeseries - title: Bgp Timeseries - methods: - bgp_get_bgp_time_series: - operation: - $ref: '#/paths/~1radar~1bgp~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _bgp_get_bgp_time_series: - operation: - $ref: '#/paths/~1radar~1bgp~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bgp_timeseries/methods/bgp_get_bgp_time_series' - insert: [] - update: [] - delete: [] - bgp_top_ases: - id: cloudflare.radar.bgp_top_ases - name: bgp_top_ases - title: Bgp Top Ases - methods: - bgp_get_top_autonomous_systems: - operation: - $ref: '#/paths/~1radar~1bgp~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _bgp_get_top_autonomous_systems: - operation: - $ref: '#/paths/~1radar~1bgp~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bgp_top_ases/methods/bgp_get_top_autonomous_systems' - insert: [] - update: [] - delete: [] - bgp_top_prefixes: - id: cloudflare.radar.bgp_top_prefixes - name: bgp_top_prefixes - title: Bgp Top Prefixes - methods: - bgp_get_top_prefixes: - operation: - $ref: '#/paths/~1radar~1bgp~1top~1prefixes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _bgp_get_top_prefixes: - operation: - $ref: '#/paths/~1radar~1bgp~1top~1prefixes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/bgp_top_prefixes/methods/bgp_get_top_prefixes' - insert: [] - update: [] - delete: [] - dns_timeseries: - id: cloudflare.radar.dns_timeseries - name: dns_timeseries - title: Dns Timeseries - methods: - dns_get_dns_time_series: - operation: - $ref: '#/paths/~1radar~1dns~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dns_get_dns_time_series: - operation: - $ref: '#/paths/~1radar~1dns~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_timeseries/methods/dns_get_dns_time_series' - insert: [] - update: [] - delete: [] - dns_top_ases: - id: cloudflare.radar.dns_top_ases - name: dns_top_ases - title: Dns Top Ases - methods: - dns_get_top_autonomous_systems_by_dns_queries_: - operation: - $ref: '#/paths/~1radar~1dns~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dns_get_top_autonomous_systems_by_dns_queries_: - operation: - $ref: '#/paths/~1radar~1dns~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_top_ases/methods/dns_get_top_autonomous_systems_by_dns_queries_' - insert: [] - update: [] - delete: [] - dns_top_locations: - id: cloudflare.radar.dns_top_locations - name: dns_top_locations - title: Dns Top Locations - methods: - dns_get_top_locations_by_dns_queries: - operation: - $ref: '#/paths/~1radar~1dns~1top~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _dns_get_top_locations_by_dns_queries: - operation: - $ref: '#/paths/~1radar~1dns~1top~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_top_locations/methods/dns_get_top_locations_by_dns_queries' - insert: [] - update: [] - delete: [] - http_summary_bot_class: - id: cloudflare.radar.http_summary_bot_class - name: http_summary_bot_class - title: Http Summary Bot Class - methods: - http_get_a_summary_of_bot_classes: - operation: - $ref: '#/paths/~1radar~1http~1summary~1bot_class/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_a_summary_of_bot_classes: - operation: - $ref: '#/paths/~1radar~1http~1summary~1bot_class/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_summary_bot_class/methods/http_get_a_summary_of_bot_classes' - insert: [] - update: [] - delete: [] - http_summary_device_type: - id: cloudflare.radar.http_summary_device_type - name: http_summary_device_type - title: Http Summary Device Type - methods: - http_get_a_summary_of_device_types: - operation: - $ref: '#/paths/~1radar~1http~1summary~1device_type/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_a_summary_of_device_types: - operation: - $ref: '#/paths/~1radar~1http~1summary~1device_type/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_summary_device_type/methods/http_get_a_summary_of_device_types' - insert: [] - update: [] - delete: [] - http_summary_http_protocol: - id: cloudflare.radar.http_summary_http_protocol - name: http_summary_http_protocol - title: Http Summary Http Protocol - methods: - http_get_a_summary_of_http_protocols: - operation: - $ref: '#/paths/~1radar~1http~1summary~1http_protocol/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_a_summary_of_http_protocols: - operation: - $ref: '#/paths/~1radar~1http~1summary~1http_protocol/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_summary_http_protocol/methods/http_get_a_summary_of_http_protocols' - insert: [] - update: [] - delete: [] - http_summary_http_version: - id: cloudflare.radar.http_summary_http_version - name: http_summary_http_version - title: Http Summary Http Version - methods: - http_get_a_summary_of_http_versions: - operation: - $ref: '#/paths/~1radar~1http~1summary~1http_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_a_summary_of_http_versions: - operation: - $ref: '#/paths/~1radar~1http~1summary~1http_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_summary_http_version/methods/http_get_a_summary_of_http_versions' - insert: [] - update: [] - delete: [] - http_summary_ip_version: - id: cloudflare.radar.http_summary_ip_version - name: http_summary_ip_version - title: Http Summary Ip Version - methods: - http_get_a_summary_of_ip_versions: - operation: - $ref: '#/paths/~1radar~1http~1summary~1ip_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_a_summary_of_ip_versions: - operation: - $ref: '#/paths/~1radar~1http~1summary~1ip_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_summary_ip_version/methods/http_get_a_summary_of_ip_versions' - insert: [] - update: [] - delete: [] - http_summary_tls_version: - id: cloudflare.radar.http_summary_tls_version - name: http_summary_tls_version - title: Http Summary Tls Version - methods: - http_get_a_summary_of_tls_versions: - operation: - $ref: '#/paths/~1radar~1http~1summary~1tls_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_a_summary_of_tls_versions: - operation: - $ref: '#/paths/~1radar~1http~1summary~1tls_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_summary_tls_version/methods/http_get_a_summary_of_tls_versions' - insert: [] - update: [] - delete: [] - http_timeseries_bot_class: - id: cloudflare.radar.http_timeseries_bot_class - name: http_timeseries_bot_class - title: Http Timeseries Bot Class - methods: - http_get_time_series_of_bot_classes: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1bot_class/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_bot_classes: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1bot_class/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_bot_class/methods/http_get_time_series_of_bot_classes' - insert: [] - update: [] - delete: [] - http_timeseries_browser: - id: cloudflare.radar.http_timeseries_browser - name: http_timeseries_browser - title: Http Timeseries Browser - methods: - http_get_time_series_of_user_agents: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1browser/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_user_agents: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1browser/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_browser/methods/http_get_time_series_of_user_agents' - insert: [] - update: [] - delete: [] - http_timeseries_browser_family: - id: cloudflare.radar.http_timeseries_browser_family - name: http_timeseries_browser_family - title: Http Timeseries Browser Family - methods: - http_get_time_series_of_user_agents_aggregated_in_families: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1browser_family/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_user_agents_aggregated_in_families: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1browser_family/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_browser_family/methods/http_get_time_series_of_user_agents_aggregated_in_families' - insert: [] - update: [] - delete: [] - http_timeseries_device_type: - id: cloudflare.radar.http_timeseries_device_type - name: http_timeseries_device_type - title: Http Timeseries Device Type - methods: - http_get_time_series_of_device_types: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1device_type/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_device_types: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1device_type/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_device_type/methods/http_get_time_series_of_device_types' - insert: [] - update: [] - delete: [] - http_timeseries_http_protocol: - id: cloudflare.radar.http_timeseries_http_protocol - name: http_timeseries_http_protocol - title: Http Timeseries Http Protocol - methods: - http_get_time_series_of_http_protocols: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1http_protocol/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_http_protocols: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1http_protocol/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_http_protocol/methods/http_get_time_series_of_http_protocols' - insert: [] - update: [] - delete: [] - http_timeseries_http_version: - id: cloudflare.radar.http_timeseries_http_version - name: http_timeseries_http_version - title: Http Timeseries Http Version - methods: - http_get_time_series_of_http_versions: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1http_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_http_versions: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1http_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_http_version/methods/http_get_time_series_of_http_versions' - insert: [] - update: [] - delete: [] - http_timeseries_ip_version: - id: cloudflare.radar.http_timeseries_ip_version - name: http_timeseries_ip_version - title: Http Timeseries Ip Version - methods: - http_get_time_series_of_ip_versions: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1ip_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_ip_versions: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1ip_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_ip_version/methods/http_get_time_series_of_ip_versions' - insert: [] - update: [] - delete: [] - http_timeseries_tls_version: - id: cloudflare.radar.http_timeseries_tls_version - name: http_timeseries_tls_version - title: Http Timeseries Tls Version - methods: - http_get_time_series_of_tls_versions: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1tls_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_time_series_of_tls_versions: - operation: - $ref: '#/paths/~1radar~1http~1timeseries~1tls_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_timeseries_tls_version/methods/http_get_time_series_of_tls_versions' - insert: [] - update: [] - delete: [] - http_top_ases: - id: cloudflare.radar.http_top_ases - name: http_top_ases - title: Http Top Ases - methods: - http_get_top_autonomous_systems_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_autonomous_systems_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_ases/methods/http_get_top_autonomous_systems_by_http_requests' - insert: [] - update: [] - delete: [] - http_top_ases_bot_class: - id: cloudflare.radar.http_top_ases_bot_class - name: http_top_ases_bot_class - title: Http Top Ases Bot Class - methods: - http_get_top_autonomous_systems_by_bot_class: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1bot_class~1{bot_class}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_autonomous_systems_by_bot_class: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1bot_class~1{bot_class}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_ases_bot_class/methods/http_get_top_autonomous_systems_by_bot_class' - insert: [] - update: [] - delete: [] - http_top_ases_device_type: - id: cloudflare.radar.http_top_ases_device_type - name: http_top_ases_device_type - title: Http Top Ases Device Type - methods: - http_get_top_autonomous_systems_by_device_type: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1device_type~1{device_type}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_autonomous_systems_by_device_type: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1device_type~1{device_type}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_ases_device_type/methods/http_get_top_autonomous_systems_by_device_type' - insert: [] - update: [] - delete: [] - http_top_ases_http_protocol: - id: cloudflare.radar.http_top_ases_http_protocol - name: http_top_ases_http_protocol - title: Http Top Ases Http Protocol - methods: - http_get_top_autonomous_systems_by_http_protocol: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1http_protocol~1{http_protocol}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_autonomous_systems_by_http_protocol: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1http_protocol~1{http_protocol}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_ases_http_protocol/methods/http_get_top_autonomous_systems_by_http_protocol' - insert: [] - update: [] - delete: [] - http_top_ases_http_version: - id: cloudflare.radar.http_top_ases_http_version - name: http_top_ases_http_version - title: Http Top Ases Http Version - methods: - http_get_top_autonomous_systems_by_http_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1http_version~1{http_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_autonomous_systems_by_http_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1http_version~1{http_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_ases_http_version/methods/http_get_top_autonomous_systems_by_http_version' - insert: [] - update: [] - delete: [] - http_top_ases_ip_version: - id: cloudflare.radar.http_top_ases_ip_version - name: http_top_ases_ip_version - title: Http Top Ases Ip Version - methods: - http_get_top_autonomous_systems_by_ip_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1ip_version~1{ip_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_autonomous_systems_by_ip_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1ip_version~1{ip_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_ases_ip_version/methods/http_get_top_autonomous_systems_by_ip_version' - insert: [] - update: [] - delete: [] - http_top_ases_tls_version: - id: cloudflare.radar.http_top_ases_tls_version - name: http_top_ases_tls_version - title: Http Top Ases Tls Version - methods: - http_get_top_autonomous_systems_by_tls_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1tls_version~1{tls_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_autonomous_systems_by_tls_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1ases~1tls_version~1{tls_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_ases_tls_version/methods/http_get_top_autonomous_systems_by_tls_version' - insert: [] - update: [] - delete: [] - http_top_browser_families: - id: cloudflare.radar.http_top_browser_families - name: http_top_browser_families - title: Http Top Browser Families - methods: - http_get_top_user_agents_aggregated_in_families_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1browser_families/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_user_agents_aggregated_in_families_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1browser_families/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_browser_families/methods/http_get_top_user_agents_aggregated_in_families_by_http_requests' - insert: [] - update: [] - delete: [] - http_top_browsers: - id: cloudflare.radar.http_top_browsers - name: http_top_browsers - title: Http Top Browsers - methods: - http_get_top_user_agents_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1browsers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_user_agents_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1browsers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_browsers/methods/http_get_top_user_agents_by_http_requests' - insert: [] - update: [] - delete: [] - http_top_locations: - id: cloudflare.radar.http_top_locations - name: http_top_locations - title: Http Top Locations - methods: - http_get_top_locations_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_locations_by_http_requests: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_locations/methods/http_get_top_locations_by_http_requests' - insert: [] - update: [] - delete: [] - http_top_locations_bot_class: - id: cloudflare.radar.http_top_locations_bot_class - name: http_top_locations_bot_class - title: Http Top Locations Bot Class - methods: - http_get_top_locations_by_bot_class: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1bot_class~1{bot_class}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_locations_by_bot_class: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1bot_class~1{bot_class}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_locations_bot_class/methods/http_get_top_locations_by_bot_class' - insert: [] - update: [] - delete: [] - http_top_locations_device_type: - id: cloudflare.radar.http_top_locations_device_type - name: http_top_locations_device_type - title: Http Top Locations Device Type - methods: - http_get_top_locations_by_device_type: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1device_type~1{device_type}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_locations_by_device_type: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1device_type~1{device_type}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_locations_device_type/methods/http_get_top_locations_by_device_type' - insert: [] - update: [] - delete: [] - http_top_locations_http_protocol: - id: cloudflare.radar.http_top_locations_http_protocol - name: http_top_locations_http_protocol - title: Http Top Locations Http Protocol - methods: - http_get_top_locations_by_http_protocol: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1http_protocol~1{http_protocol}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_locations_by_http_protocol: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1http_protocol~1{http_protocol}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_locations_http_protocol/methods/http_get_top_locations_by_http_protocol' - insert: [] - update: [] - delete: [] - http_top_locations_http_version: - id: cloudflare.radar.http_top_locations_http_version - name: http_top_locations_http_version - title: Http Top Locations Http Version - methods: - http_get_top_locations_by_http_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1http_version~1{http_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_locations_by_http_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1http_version~1{http_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_locations_http_version/methods/http_get_top_locations_by_http_version' - insert: [] - update: [] - delete: [] - http_top_locations_ip_version: - id: cloudflare.radar.http_top_locations_ip_version - name: http_top_locations_ip_version - title: Http Top Locations Ip Version - methods: - http_get_top_locations_by_ip_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1ip_version~1{ip_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_locations_by_ip_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1ip_version~1{ip_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_locations_ip_version/methods/http_get_top_locations_by_ip_version' - insert: [] - update: [] - delete: [] - http_top_locations_tls_version: - id: cloudflare.radar.http_top_locations_tls_version - name: http_top_locations_tls_version - title: Http Top Locations Tls Version - methods: - http_get_top_locations_by_tls_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1tls_version~1{tls_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _http_get_top_locations_by_tls_version: - operation: - $ref: '#/paths/~1radar~1http~1top~1locations~1tls_version~1{tls_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/http_top_locations_tls_version/methods/http_get_top_locations_by_tls_version' - insert: [] - update: [] - delete: [] - netflows_timeseries: - id: cloudflare.radar.netflows_timeseries - name: netflows_timeseries - title: Netflows Timeseries - methods: - net_flows_get_net_flow_time_series: - operation: - $ref: '#/paths/~1radar~1netflows~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _net_flows_get_net_flow_time_series: - operation: - $ref: '#/paths/~1radar~1netflows~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/netflows_timeseries/methods/net_flows_get_net_flow_time_series' - insert: [] - update: [] - delete: [] - netflows_top_ases: - id: cloudflare.radar.netflows_top_ases - name: netflows_top_ases - title: Netflows Top Ases - methods: - net_flows_get_top_autonomous_systems: - operation: - $ref: '#/paths/~1radar~1netflows~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.top_0 - _net_flows_get_top_autonomous_systems: - operation: - $ref: '#/paths/~1radar~1netflows~1top~1ases/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/netflows_top_ases/methods/net_flows_get_top_autonomous_systems' - insert: [] - update: [] - delete: [] - netflows_top_locations: - id: cloudflare.radar.netflows_top_locations - name: netflows_top_locations - title: Netflows Top Locations - methods: - net_flows_get_top_locations: - operation: - $ref: '#/paths/~1radar~1netflows~1top~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.top_0 - _net_flows_get_top_locations: - operation: - $ref: '#/paths/~1radar~1netflows~1top~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/netflows_top_locations/methods/net_flows_get_top_locations' - insert: [] - update: [] - delete: [] - annotations_outages: - id: cloudflare.radar.annotations_outages - name: annotations_outages - title: Annotations Outages - methods: - annotations_get_outages_annotations: - operation: - $ref: '#/paths/~1radar~1annotations~1outages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.annotations - _annotations_get_outages_annotations: - operation: - $ref: '#/paths/~1radar~1annotations~1outages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotations_outages/methods/annotations_get_outages_annotations' - insert: [] - update: [] - delete: [] - annotations_outages_locations: - id: cloudflare.radar.annotations_outages_locations - name: annotations_outages_locations - title: Annotations Outages Locations - methods: - annotations_get_top_outages_annotations: - operation: - $ref: '#/paths/~1radar~1annotations~1outages~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.annotations - _annotations_get_top_outages_annotations: - operation: - $ref: '#/paths/~1radar~1annotations~1outages~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotations_outages_locations/methods/annotations_get_top_outages_annotations' - insert: [] - update: [] - delete: [] - attacks_layer3_summary: - id: cloudflare.radar.attacks_layer3_summary - name: attacks_layer3_summary - title: Attacks Layer3 Summary - methods: - attacks_get_a_summary_of_layer_3_attacks: - operation: - $ref: '#/paths/~1radar~1attacks~1layer3~1summary/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _attacks_get_a_summary_of_layer_3_attacks: - operation: - $ref: '#/paths/~1radar~1attacks~1layer3~1summary/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer3_summary/methods/attacks_get_a_summary_of_layer_3_attacks' - insert: [] - update: [] - delete: [] - attacks_layer3_timeseries: - id: cloudflare.radar.attacks_layer3_timeseries - name: attacks_layer3_timeseries - title: Attacks Layer3 Timeseries - methods: - attacks_get_layer_3_attacks_time_series: - operation: - $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _attacks_get_layer_3_attacks_time_series: - operation: - $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer3_timeseries/methods/attacks_get_layer_3_attacks_time_series' - insert: [] - update: [] - delete: [] - attacks_layer3_timeseries_groups: - id: cloudflare.radar.attacks_layer3_timeseries_groups - name: attacks_layer3_timeseries_groups - title: Attacks Layer3 Timeseries Groups - methods: - 'attacks_get_layer_3_attacks_by_network_protocol,_over_time': - operation: - $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - '_attacks_get_layer_3_attacks_by_network_protocol,_over_time': - operation: - $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer3_timeseries_groups/methods/attacks_get_layer_3_attacks_by_network_protocol,_over_time' - insert: [] - update: [] - delete: [] - attacks_layer7_summary: - id: cloudflare.radar.attacks_layer7_summary - name: attacks_layer7_summary - title: Attacks Layer7 Summary - methods: - attacks_get_a_summary_of_layer_7_attacks: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1summary/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _attacks_get_a_summary_of_layer_7_attacks: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1summary/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer7_summary/methods/attacks_get_a_summary_of_layer_7_attacks' - insert: [] - update: [] - delete: [] - attacks_layer7_timeseries: - id: cloudflare.radar.attacks_layer7_timeseries - name: attacks_layer7_timeseries - title: Attacks Layer7 Timeseries - methods: - attacks_get_attacks_layer_7_time_series: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _attacks_get_attacks_layer_7_time_series: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer7_timeseries/methods/attacks_get_attacks_layer_7_time_series' - insert: [] - update: [] - delete: [] - attacks_layer7_timeseries_groups: - id: cloudflare.radar.attacks_layer7_timeseries_groups - name: attacks_layer7_timeseries_groups - title: Attacks Layer7 Timeseries Groups - methods: - 'attacks_get_layer_7_attacks_by_mitigation_technique,_over_time': - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - '_attacks_get_layer_7_attacks_by_mitigation_technique,_over_time': - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer7_timeseries_groups/methods/attacks_get_layer_7_attacks_by_mitigation_technique,_over_time' - insert: [] - update: [] - delete: [] - attacks_layer7_top_ases_origin: - id: cloudflare.radar.attacks_layer7_top_ases_origin - name: attacks_layer7_top_ases_origin - title: Attacks Layer7 Top Ases Origin - methods: - attacks_get_layer_7_top_origin_a_ses: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1ases~1origin/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.top_0 - _attacks_get_layer_7_top_origin_a_ses: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1ases~1origin/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer7_top_ases_origin/methods/attacks_get_layer_7_top_origin_a_ses' - insert: [] - update: [] - delete: [] - attacks_layer7_top_attacks: - id: cloudflare.radar.attacks_layer7_top_attacks - name: attacks_layer7_top_attacks - title: Attacks Layer7 Top Attacks - methods: - attacks_get_layer_7_top_attack_pairs___origin_and_target_locations_: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1attacks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.top_0 - _attacks_get_layer_7_top_attack_pairs___origin_and_target_locations_: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1attacks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer7_top_attacks/methods/attacks_get_layer_7_top_attack_pairs___origin_and_target_locations_' - insert: [] - update: [] - delete: [] - attacks_layer7_top_locations_origin: - id: cloudflare.radar.attacks_layer7_top_locations_origin - name: attacks_layer7_top_locations_origin - title: Attacks Layer7 Top Locations Origin - methods: - attacks_get_layer_7_top_origin_locations: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1locations~1origin/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.top_0 - _attacks_get_layer_7_top_origin_locations: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1locations~1origin/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer7_top_locations_origin/methods/attacks_get_layer_7_top_origin_locations' - insert: [] - update: [] - delete: [] - attacks_layer7_top_locations_target: - id: cloudflare.radar.attacks_layer7_top_locations_target - name: attacks_layer7_top_locations_target - title: Attacks Layer7 Top Locations Target - methods: - attacks_get_layer_7_top_target_locations: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1locations~1target/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _attacks_get_layer_7_top_target_locations: - operation: - $ref: '#/paths/~1radar~1attacks~1layer7~1top~1locations~1target/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attacks_layer7_top_locations_target/methods/attacks_get_layer_7_top_target_locations' - insert: [] - update: [] - delete: [] - datasets: - id: cloudflare.radar.datasets - name: datasets - title: Datasets - methods: - get_datasets: - operation: - $ref: '#/paths/~1radar~1datasets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.datasets - _get_datasets: - operation: - $ref: '#/paths/~1radar~1datasets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - datasets_get_dataset_download_url: - operation: - $ref: '#/paths/~1radar~1datasets~1download/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/datasets/methods/get_datasets' - insert: [] - update: [] - delete: [] - reports_datasets: - id: cloudflare.radar.reports_datasets - name: reports_datasets - title: Reports Datasets - methods: - datasets_get_datasets: - operation: - $ref: '#/paths/~1radar~1reports~1datasets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.datasets - _datasets_get_datasets: - operation: - $ref: '#/paths/~1radar~1reports~1datasets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - datasets_get_dataset_download_url: - operation: - $ref: '#/paths/~1radar~1reports~1datasets~1download/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/reports_datasets/methods/datasets_get_datasets' - insert: [] - update: [] - delete: [] - entities_asns: - id: cloudflare.radar.entities_asns - name: entities_asns - title: Entities Asns - methods: - entities_get_autonomous_systems: - operation: - $ref: '#/paths/~1radar~1entities~1asns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.ases - _entities_get_autonomous_systems: - operation: - $ref: '#/paths/~1radar~1entities~1asns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - entities_get_autonomous_system___as__by_id: - operation: - $ref: '#/paths/~1radar~1entities~1asns~1{asn}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.asn - _entities_get_autonomous_system___as__by_id: - operation: - $ref: '#/paths/~1radar~1entities~1asns~1{asn}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entities_asns/methods/entities_get_autonomous_systems' - - $ref: '#/components/x-stackQL-resources/entities_asns/methods/entities_get_autonomous_system___as__by_id' - insert: [] - update: [] - delete: [] - entities_asns_ip: - id: cloudflare.radar.entities_asns_ip - name: entities_asns_ip - title: Entities Asns Ip - methods: - entities_get_autonomous_system_information_by_ip_address: - operation: - $ref: '#/paths/~1radar~1entities~1asns~1ip/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.asn - _entities_get_autonomous_system_information_by_ip_address: - operation: - $ref: '#/paths/~1radar~1entities~1asns~1ip/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entities_asns_ip/methods/entities_get_autonomous_system_information_by_ip_address' - insert: [] - update: [] - delete: [] - entities_locations: - id: cloudflare.radar.entities_locations - name: entities_locations - title: Entities Locations - methods: - entities_get_locations: - operation: - $ref: '#/paths/~1radar~1entities~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.locations - _entities_get_locations: - operation: - $ref: '#/paths/~1radar~1entities~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - entities_get_location: - operation: - $ref: '#/paths/~1radar~1entities~1locations~1{location}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.location - _entities_get_location: - operation: - $ref: '#/paths/~1radar~1entities~1locations~1{location}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entities_locations/methods/entities_get_locations' - - $ref: '#/components/x-stackQL-resources/entities_locations/methods/entities_get_location' - insert: [] - update: [] - delete: [] - ranking_timeseries: - id: cloudflare.radar.ranking_timeseries - name: ranking_timeseries - title: Ranking Timeseries - methods: - ranking_get_domains_rank_time_series: - operation: - $ref: '#/paths/~1radar~1ranking~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _ranking_get_domains_rank_time_series: - operation: - $ref: '#/paths/~1radar~1ranking~1timeseries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/ranking_timeseries/methods/ranking_get_domains_rank_time_series' - insert: [] - update: [] - delete: [] - ranking_top: - id: cloudflare.radar.ranking_top - name: ranking_top - title: Ranking Top - methods: - ranking_get_domains_rank_top: - operation: - $ref: '#/paths/~1radar~1ranking~1top/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _ranking_get_domains_rank_top: - operation: - $ref: '#/paths/~1radar~1ranking~1top/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/ranking_top/methods/ranking_get_domains_rank_top' - insert: [] - update: [] - delete: [] - search_global: - id: cloudflare.radar.search_global - name: search_global - title: Search Global - methods: - 'search_search_for_locations,_autonomous_systems___as__and_reports': - operation: - $ref: '#/paths/~1radar~1search~1global/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - '_search_search_for_locations,_autonomous_systems___as__and_reports': - operation: - $ref: '#/paths/~1radar~1search~1global/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/search_global/methods/search_search_for_locations,_autonomous_systems___as__and_reports' - insert: [] - update: [] - delete: [] - specialevents: - id: cloudflare.radar.specialevents - name: specialevents - title: Specialevents - methods: - list_special_events: - operation: - $ref: '#/paths/~1radar~1specialevents/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.specialEvents - _list_special_events: - operation: - $ref: '#/paths/~1radar~1specialevents/get' - response: - mediaType: application/json - openAPIDocKey: '200' - get_a_single_special_events: - operation: - $ref: '#/paths/~1radar~1specialevents~1{eventAlias}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.specialEvent - _get_a_single_special_events: - operation: - $ref: '#/paths/~1radar~1specialevents~1{eventAlias}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - get_special_events_time_series: - operation: - $ref: '#/paths/~1radar~1specialevents~1{eventAlias}~1{categoryAlias}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_special_events_time_series: - operation: - $ref: '#/paths/~1radar~1specialevents~1{eventAlias}~1{categoryAlias}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/specialevents/methods/list_special_events' - - $ref: '#/components/x-stackQL-resources/specialevents/methods/get_a_single_special_events' - - $ref: '#/components/x-stackQL-resources/specialevents/methods/get_special_events_time_series' - insert: [] - update: [] - delete: [] - verified_bots_top_bots: - id: cloudflare.radar.verified_bots_top_bots - name: verified_bots_top_bots - title: Verified Bots Top Bots - methods: - verified_bots_get_top_verified_bots_by_http_requests: - operation: - $ref: '#/paths/~1radar~1verified_bots~1top~1bots/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _verified_bots_get_top_verified_bots_by_http_requests: - operation: - $ref: '#/paths/~1radar~1verified_bots~1top~1bots/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/verified_bots_top_bots/methods/verified_bots_get_top_verified_bots_by_http_requests' - insert: [] - update: [] - delete: [] - verified_bots_top_categories: - id: cloudflare.radar.verified_bots_top_categories - name: verified_bots_top_categories - title: Verified Bots Top Categories - methods: - verified_bots_get_top_verified_bot_categories_by_http_requests: - operation: - $ref: '#/paths/~1radar~1verified_bots~1top~1categories/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _verified_bots_get_top_verified_bot_categories_by_http_requests: - operation: - $ref: '#/paths/~1radar~1verified_bots~1top~1categories/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/verified_bots_top_categories/methods/verified_bots_get_top_verified_bot_categories_by_http_requests' - insert: [] - update: [] - delete: [] -paths: - /radar/bgp/timeseries: - get: - description: 'Gets BGP updates change over time. Raw values are returned. When requesting updates of an autonomous system (AS), only BGP updates of type announcement are returned.' - operationId: radar-bgp-get-bgp-time-series - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get BGP time series response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get BGP time series response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get BGP time series - tags: - - Radar BGP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/bgp/top/ases: - get: - description: Get the top autonomous systems (AS) by BGP updates (announcements only). Values are a percentage out of the total updates. - operationId: radar-bgp-get-top-autonomous-systems - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - ASName: - example: Apple-Engineering - type: string - asn: - example: '714' - type: string - value: - description: Percentage of updates by this AS out of the total updates by all autonomous systems. - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - ASName: - example: Apple-Engineering - type: string - asn: - example: '714' - type: string - value: - description: Percentage of updates by this AS out of the total updates by all autonomous systems. - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems - tags: - - Radar BGP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/bgp/top/prefixes: - get: - description: Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates. - operationId: radar-bgp-get-top-prefixes - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - prefix: - example: '2804:77cc:8000::/33' - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top prefixes response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - prefix: - example: '2804:77cc:8000::/33' - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top prefixes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top prefixes - tags: - - Radar BGP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/dns/timeseries: - get: - description: Get DNS queries change over time. - operationId: radar-dns-get-dns-time-series - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get DNS time series response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get DNS time series response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get DNS time series - tags: - - Radar DNS - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/dns/top/ases: - get: - description: Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver. - operationId: radar-dns-get-top-autonomous-systems-by-dns-queries. - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '174' - type: string - clientASName: - example: Cogent-174 - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by DNS queries. response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '174' - type: string - clientASName: - example: Cogent-174 - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by DNS queries. response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by DNS queries. - tags: - - Radar DNS - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/dns/top/locations: - get: - description: Get top locations by DNS queries made to Cloudflare's public DNS resolver. - operationId: radar-dns-get-top-locations-by-dns-queries - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: PT - type: string - clientCountryName: - example: Portugal - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by DNS queries response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: PT - type: string - clientCountryName: - example: Portugal - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by DNS queries response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by DNS queries - tags: - - Radar DNS - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/summary/bot_class: - get: - description: Percentage distribution of traffic classified as automated or human. - operationId: radar-http-get-a-summary-of-bot-classes - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - bot: - example: '35' - type: string - human: - example: '65' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of bot classes response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - bot: - example: '35' - type: string - human: - example: '65' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of bot classes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of bot classes - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/summary/device_type: - get: - description: Percentage distribution of traffic per device type. - operationId: radar-http-get-a-summary-of-device-types - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - desktop: - example: '65' - type: string - mobile: - example: '30' - type: string - other: - example: '5' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of device types response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - desktop: - example: '65' - type: string - mobile: - example: '30' - type: string - other: - example: '5' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of device types response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of device types - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/summary/http_protocol: - get: - description: Percentage distribution of traffic per HTTP protocol. - operationId: radar-http-get-a-summary-of-http-protocols - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - http: - example: '99' - type: string - https: - example: '1' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of HTTP protocols response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - http: - example: '99' - type: string - https: - example: '1' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of HTTP protocols response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of HTTP protocols - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/summary/http_version: - get: - description: Percentage distribution of traffic per HTTP protocol version. - operationId: radar-http-get-a-summary-of-http-versions - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - HTTP/1.x: - example: '1' - type: string - HTTP/2: - example: '39' - type: string - HTTP/3: - example: '60' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of HTTP versions response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - HTTP/1.x: - example: '1' - type: string - HTTP/2: - example: '39' - type: string - HTTP/3: - example: '60' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of HTTP versions response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of HTTP versions - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/summary/ip_version: - get: - description: Percentage distribution of traffic per IP protocol version. - operationId: radar-http-get-a-summary-of-ip-versions - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - IPv4: - example: '65' - type: string - IPv6: - example: '35' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of IP versions response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - IPv4: - example: '65' - type: string - IPv6: - example: '35' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of IP versions response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of IP versions - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/summary/tls_version: - get: - description: Percentage distribution of traffic per TLS protocol version. - operationId: radar-http-get-a-summary-of-tls-versions - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - TLS 1.0: - example: '0.5' - type: string - TLS 1.1: - example: '0.5' - type: string - TLS 1.2: - example: '60' - type: string - TLS 1.3: - example: '10' - type: string - TLS QUIC: - example: '29' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of TLS versions response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - summary_0: - properties: - TLS 1.0: - example: '0.5' - type: string - TLS 1.1: - example: '0.5' - type: string - TLS 1.2: - example: '60' - type: string - TLS 1.3: - example: '10' - type: string - TLS QUIC: - example: '29' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of TLS versions response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of TLS versions - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/bot_class: - get: - description: Percentage distribution of traffic classified as automated or human over time. - operationId: radar-http-get-time-series-of-bot-classes - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - bot: - items: - type: string - type: array - human: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of bot classes response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - bot: - items: - type: string - type: array - human: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of bot classes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of bot classes - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/browser: - get: - description: 'Percentage distribution of traffic of the top user agents in the selected time range, over time.' - operationId: radar-http-get-time-series-of-user-agents - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - : - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of user agents response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - : - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of user agents response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of user agents - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/browser_family: - get: - description: 'Percentage distribution of traffic of the top user agents aggregated in families in the selected time range, over time.' - operationId: radar-http-get-time-series-of-user-agents-aggregated-in-families - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - : - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of user agents aggregated in families response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - : - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of user agents aggregated in families response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of user agents aggregated in families - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/device_type: - get: - description: Percentage distribution of traffic per device type over time. - operationId: radar-http-get-time-series-of-device-types - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - desktop: - items: - type: string - type: array - mobile: - items: - type: string - type: array - other: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of device types response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - desktop: - items: - type: string - type: array - mobile: - items: - type: string - type: array - other: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of device types response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of device types - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/http_protocol: - get: - description: Percentage distribution of traffic per HTTP protocol over time. - operationId: radar-http-get-time-series-of-http-protocols - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - http: - items: - type: string - type: array - https: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of HTTP protocols response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - http: - items: - type: string - type: array - https: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of HTTP protocols response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of HTTP protocols - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/http_version: - get: - description: Percentage distribution of traffic per HTTP protocol version over time. - operationId: radar-http-get-time-series-of-http-versions - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - HTTP/1.x: - items: - type: string - type: array - HTTP/2: - items: - type: string - type: array - HTTP/3: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of HTTP versions response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - HTTP/1.x: - items: - type: string - type: array - HTTP/2: - items: - type: string - type: array - HTTP/3: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of HTTP versions response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of HTTP versions - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/ip_version: - get: - description: Percentage distribution of traffic per IP protocol version over time. - operationId: radar-http-get-time-series-of-ip-versions - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - IPv4: - items: - type: string - type: array - IPv6: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of IP versions response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - IPv4: - items: - type: string - type: array - IPv6: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of IP versions response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of IP versions - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/timeseries/tls_version: - get: - description: Percentage distribution of traffic per TLS protocol version over time. - operationId: radar-http-get-time-series-of-tls-versions - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - TLS 1.0: - items: - type: string - type: array - TLS 1.1: - items: - type: string - type: array - TLS 1.2: - items: - type: string - type: array - TLS 1.3: - items: - type: string - type: array - TLS QUIC: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get time series of TLS versions response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - type: object - serie_0: - properties: - TLS 1.0: - items: - type: string - type: array - TLS 1.1: - items: - type: string - type: array - TLS 1.2: - items: - type: string - type: array - TLS 1.3: - items: - type: string - type: array - TLS QUIC: - items: - type: string - type: array - timestamps: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get time series of TLS versions response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get time series of TLS versions - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/top/ases: - get: - description: Get the top autonomous systems (AS) by HTTP traffic. Values are a percentage out of the total traffic. - operationId: radar-http-get-top-autonomous-systems-by-http-requests - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by HTTP requests response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by HTTP requests response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by HTTP requests - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/ases/bot_class/{bot_class}': - get: - description: 'Get the top autonomous systems (AS), by HTTP traffic, of the requested bot class. These two categories use Cloudflare''s bot score - refer to [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more information. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-autonomous-systems-by-bot-class - parameters: - - in: path - name: bot_class - required: true - schema: - $ref: '#/components/schemas/bot_class' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by bot class response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by bot class response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by bot class - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/ases/device_type/{device_type}': - get: - description: 'Get the top autonomous systems (AS), by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-autonomous-systems-by-device-type - parameters: - - in: path - name: device_type - required: true - schema: - $ref: '#/components/schemas/device_type' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by device type response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by device type response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by device type - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/ases/http_protocol/{http_protocol}': - get: - description: 'Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-autonomous-systems-by-http-protocol - parameters: - - in: path - name: http_protocol - required: true - schema: - $ref: '#/components/schemas/http_protocol' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by HTTP protocol response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by HTTP protocol response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by HTTP protocol - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/ases/http_version/{http_version}': - get: - description: 'Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol version. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-autonomous-systems-by-http-version - parameters: - - in: path - name: http_version - required: true - schema: - $ref: '#/components/schemas/http_version' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by HTTP version response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by HTTP version response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by HTTP version - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/ases/ip_version/{ip_version}': - get: - description: 'Get the top autonomous systems, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-autonomous-systems-by-ip-version - parameters: - - in: path - name: ip_version - required: true - schema: - $ref: '#/components/schemas/ip_version' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by IP version response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by IP version response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by IP version - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/ases/tls_version/{tls_version}': - get: - description: 'Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-autonomous-systems-by-tls-version - parameters: - - in: path - name: tls_version - required: true - schema: - $ref: '#/components/schemas/tls_version' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems by TLS version response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientASN: - example: '3243' - type: string - clientASName: - example: MEO - type: string - value: - example: '3' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems by TLS version response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems by TLS version - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/top/browser_families: - get: - description: Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic. - operationId: radar-http-get-top-user-agents-aggregated-in-families-by-http-requests - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - : - type: string - value: - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top user agents aggregated in families by HTTP requests response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - : - type: string - value: - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top user agents aggregated in families by HTTP requests response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top user agents aggregated in families by HTTP requests - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/top/browsers: - get: - description: Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic. - operationId: radar-http-get-top-user-agents-by-http-requests - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - : - type: string - value: - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top user agents by HTTP requests response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - : - type: string - value: - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top user agents by HTTP requests response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top user agents by HTTP requests - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/http/top/locations: - get: - description: Get the top locations by HTTP traffic. Values are a percentage out of the total traffic. - operationId: radar-http-get-top-locations-by-http-requests - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by HTTP requests response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by HTTP requests response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by HTTP requests - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/locations/bot_class/{bot_class}': - get: - description: 'Get the top locations, by HTTP traffic, of the requested bot class. These two categories use Cloudflare''s bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-locations-by-bot-class - parameters: - - in: path - name: bot_class - required: true - schema: - $ref: '#/components/schemas/bot_class' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by bot class response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by bot class response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by bot class - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/locations/device_type/{device_type}': - get: - description: 'Get the top locations, by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-locations-by-device-type - parameters: - - in: path - name: device_type - required: true - schema: - $ref: '#/components/schemas/device_type' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by device type response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by device type response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by device type - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/locations/http_protocol/{http_protocol}': - get: - description: 'Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-locations-by-http-protocol - parameters: - - in: path - name: http_protocol - required: true - schema: - $ref: '#/components/schemas/http_protocol' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by HTTP protocol response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by HTTP protocol response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by HTTP protocol - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/locations/http_version/{http_version}': - get: - description: 'Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-locations-by-http-version - parameters: - - in: path - name: http_version - required: true - schema: - $ref: '#/components/schemas/http_version' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by HTTP version response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by HTTP version response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by HTTP version - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/locations/ip_version/{ip_version}': - get: - description: 'Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-locations-by-ip-version - parameters: - - in: path - name: ip_version - required: true - schema: - $ref: '#/components/schemas/ip_version' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by IP version response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by IP version response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by IP version - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/http/top/locations/tls_version/{tls_version}': - get: - description: 'Get the top locations, by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.' - operationId: radar-http-get-top-locations-by-tls-version - parameters: - - in: path - name: tls_version - required: true - schema: - $ref: '#/components/schemas/tls_version' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations by TLS version response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations by TLS version response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations by TLS version - tags: - - Radar HTTP - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/netflows/timeseries: - get: - description: 'Get network traffic change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.' - operationId: radar-net-flows-get-net-flow-time-series - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get NetFlow time series response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get NetFlow time series response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get NetFlow time series - tags: - - Radar NetFlows - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/netflows/top/ases: - get: - description: Get the top autonomous systems (AS) by network traffic. Values are a percentage out of the total network traffic. - operationId: radar-net-flows-get-top-autonomous-systems - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - top_0: - items: - properties: - clientASN: - example: 16509 - type: number - clientASName: - example: AMAZON-02 - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top autonomous systems response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - top_0: - items: - properties: - clientASN: - example: 16509 - type: number - clientASName: - example: AMAZON-02 - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top autonomous systems response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top autonomous systems - tags: - - Radar NetFlows - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/netflows/top/locations: - get: - description: Get the top locations by network traffic. Values are a percentage out of the total network traffic. - operationId: radar-net-flows-get-top-locations - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top locations response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - top_0: - items: - properties: - clientCountryAlpha2: - example: US - type: string - clientCountryName: - example: United States - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top locations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top locations - tags: - - Radar NetFlows - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/annotations/outages: - get: - operationId: radar-annotations-get-outages-annotations - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - annotations: - items: - properties: - asns: - items: - type: integer - type: array - dataSource: - example: ALL - type: string - description: - example: example - type: string - endDate: - example: '2022-09-08T10:00:28Z' - type: string - eventType: - example: OUTAGE - type: string - linkedUrl: - example: 'http://example.com' - type: string - locations: - items: - example: MX - type: string - type: array - outage: - properties: - outageCause: - example: CABLE_CUT - type: string - outageType: - example: NATIONWIDE - type: string - type: object - scope: - example: 'Colima, Michoacán, México' - type: string - startDate: - example: '2022-09-06T10:00:28Z' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get outages annotations response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - annotations: - items: - properties: - asns: - items: - type: integer - type: array - dataSource: - example: ALL - type: string - description: - example: example - type: string - endDate: - example: '2022-09-08T10:00:28Z' - type: string - eventType: - example: OUTAGE - type: string - linkedUrl: - example: 'http://example.com' - type: string - locations: - items: - example: MX - type: string - type: array - outage: - properties: - outageCause: - example: CABLE_CUT - type: string - outageType: - example: NATIONWIDE - type: string - type: object - scope: - example: 'Colima, Michoacán, México' - type: string - startDate: - example: '2022-09-06T10:00:28Z' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get outages annotations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get outages annotations - tags: - - Radar annotations - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/annotations/outages/locations: - get: - operationId: radar-annotations-get-top-outages-annotations - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - annotations: - items: - properties: - clientCountryAlpha2: - example: PT - type: string - clientCountryName: - example: Portugal - type: string - value: - example: '5' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top outages annotations response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - annotations: - items: - properties: - clientCountryAlpha2: - example: PT - type: string - clientCountryName: - example: Portugal - type: string - value: - example: '5' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top outages annotations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top outages annotations - tags: - - Radar annotations - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer3/summary: - get: - description: Percentage distribution of network protocols in layer 3/4 attacks. - operationId: radar-attacks-get-a-summary-of-layer-3-attacks - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - summary_0: - properties: - gre: - example: '0.9' - type: string - icmp: - example: '0.1' - type: string - tcp: - example: '60' - type: string - udp: - example: '39' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of layer 3 attacks response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - summary_0: - properties: - gre: - example: '0.9' - type: string - icmp: - example: '0.1' - type: string - tcp: - example: '60' - type: string - udp: - example: '39' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of layer 3 attacks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of layer 3 attacks - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer3/timeseries: - get: - description: 'Get layer 3/4 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentual relative change of the 1st/main series, with respect to the 2nd/control series - for example, to get the relative change of this week from the previous week, the 1st series would have a date range of 7d, the 2nd, a date range of 7dControl, and the normalization would be set to PERCENTAGE_CHANGE.' - operationId: radar-attacks-get-layer-3-attacks-time-series - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get layer 3 attacks time series response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get layer 3 attacks time series response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get layer 3 attacks time series - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer3/timeseries_groups: - get: - description: 'Get percentage of what type of network protocols are used in layer 3/4 attacks, over time.' - operationId: 'radar-attacks-get-layer-3-attacks-by-network-protocol,-over-time' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - serie_0: - properties: - gre: - items: - example: '0.9' - type: string - type: array - icmp: - items: - example: '0.1' - type: string - type: array - tcp: - items: - example: '70' - type: string - type: array - timeseries: - items: - type: string - type: array - udp: - items: - example: '29' - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: 'Get layer 3 attacks by network protocol, over time response' - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - serie_0: - properties: - gre: - items: - example: '0.9' - type: string - type: array - icmp: - items: - example: '0.1' - type: string - type: array - tcp: - items: - example: '70' - type: string - type: array - timeseries: - items: - type: string - type: array - udp: - items: - example: '29' - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: 'Get layer 3 attacks by network protocol, over time response failure' - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: 'Get layer 3 attacks by network protocol, over time' - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer7/summary: - get: - description: Percentage distribution of mitigation techniques in layer 7 attacks. - operationId: radar-attacks-get-a-summary-of-layer-7-attacks - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - summary_0: - properties: - gre: - example: '0.1' - type: string - icmp: - example: '0.9' - type: string - tcp: - example: '65' - type: string - udp: - example: '34' - type: string - type: object - type: object - success: - type: string - type: object - description: Get a summary of layer 7 attacks response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - summary_0: - properties: - gre: - example: '0.1' - type: string - icmp: - example: '0.9' - type: string - tcp: - example: '65' - type: string - udp: - example: '34' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a summary of layer 7 attacks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a summary of layer 7 attacks - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer7/timeseries: - get: - description: 'Get layer 7 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.' - operationId: radar-attacks-get-attacks-layer-7-time-series - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get attacks layer 7 time series response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - series: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get attacks layer 7 time series response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get attacks layer 7 time series - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer7/timeseries_groups: - get: - description: 'Get percentage of what type of mitigation techniques are used to block layer 7 attacks, over time.' - operationId: 'radar-attacks-get-layer-7-attacks-by-mitigation-technique,-over-time' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - serie_0: - properties: - gre: - items: - example: '5' - type: string - type: array - icmp: - items: - example: '5' - type: string - type: array - tcp: - items: - example: '60' - type: string - type: array - timeseries: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - udp: - items: - example: '30' - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: 'Get layer 7 attacks by mitigation technique, over time response' - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - aggInterval: - example: 1h - type: string - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - example: ALL - type: string - description: - example: Cable cut in Tonga - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - example: OUTAGE - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - lastUpdated: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - serie_0: - properties: - gre: - items: - example: '5' - type: string - type: array - icmp: - items: - example: '5' - type: string - type: array - tcp: - items: - example: '60' - type: string - type: array - timeseries: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - udp: - items: - example: '30' - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: 'Get layer 7 attacks by mitigation technique, over time response failure' - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: 'Get layer 7 attacks by mitigation technique, over time' - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer7/top/ases/origin: - get: - description: Get the top origin ASes by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP. - operationId: radar-attacks-get-layer-7-top-origin-a-ses - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - top_0: - items: - properties: - originAsn: - example: 16509 - type: number - originAsnName: - example: AMAZON-02 - type: string - rank: - example: '1' - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get layer 7 top origin ASes response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - top_0: - items: - properties: - originAsn: - example: 16509 - type: number - originAsnName: - example: AMAZON-02 - type: string - rank: - example: '1' - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get layer 7 top origin ASes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get layer 7 top origin ASes - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer7/top/attacks: - get: - description: Get the top attacks from origin to target location. Values are a percentage out of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks per origin/target location (useful if all the top attacks are from or to the same location). - operationId: radar-attacks-get-layer-7-top-attack-pairs-(-origin-and-target-locations) - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - top_0: - items: - properties: - originCountryAlpha2: - example: US - type: string - originCountryName: - example: United States - type: string - rank: - example: '1' - type: string - targetCountryAlpha2: - example: PT - type: string - targetCountryName: - example: Portugal - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get layer 7 top attack pairs (origin and target locations) response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - top_0: - items: - properties: - originCountryAlpha2: - example: US - type: string - originCountryName: - example: United States - type: string - rank: - example: '1' - type: string - targetCountryAlpha2: - example: PT - type: string - targetCountryName: - example: Portugal - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get layer 7 top attack pairs (origin and target locations) response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get layer 7 top attack pairs (origin and target locations) - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer7/top/locations/origin: - get: - description: Get the top origin locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP. - operationId: radar-attacks-get-layer-7-top-origin-locations - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - top_0: - items: - properties: - originCountryAlpha2: - example: US - type: string - originCountryName: - example: United States - type: string - rank: - example: '1' - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get layer 7 top origin locations response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - top_0: - items: - properties: - originCountryAlpha2: - example: US - type: string - originCountryName: - example: United States - type: string - rank: - example: '1' - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get layer 7 top origin locations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get layer 7 top origin locations - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/attacks/layer7/top/locations/target: - get: - description: 'Get the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone''s billing country, when available.' - operationId: radar-attacks-get-layer-7-top-target-locations - responses: - '200': - content: - application/json: - schema: - properties: - data: - properties: - top_0: - items: - properties: - rank: - example: '1' - type: string - targetCountryAlpha2: - example: US - type: string - targetCountryName: - example: United States - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - type: object - description: Get layer 7 top target locations response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - data: - properties: - top_0: - items: - properties: - rank: - example: '1' - type: string - targetCountryAlpha2: - example: US - type: string - targetCountryName: - example: United States - type: string - value: - example: '0.73996' - type: string - type: object - type: array - type: object - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get layer 7 top target locations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get layer 7 top target locations - tags: - - Radar attacks - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/datasets: - get: - description: Get a list of datasets. - operationId: radar-datasets-get-datasets - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - datasets: - items: - properties: - description: - example: This dataset contains a list of the op 20000 domains globally - type: string - id: - type: integer - meta: - type: object - tags: - items: - example: global - type: string - type: array - title: - example: Top bucket 20000 domains - type: string - type: - example: RANKING_BUCKET - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get Datasets response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - datasets: - items: - properties: - description: - example: This dataset contains a list of the op 20000 domains globally - type: string - id: - type: integer - meta: - type: object - tags: - items: - example: global - type: string - type: array - title: - example: Top bucket 20000 domains - type: string - type: - example: RANKING_BUCKET - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Datasets response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Datasets - tags: - - Radar datasets - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/datasets/download: - post: - description: Get a list of datasets. - operationId: radar-datasets-get-dataset-download-url - requestBody: - content: - application/json: - schema: - properties: - datasetId: - type: integer - type: object - required: true - responses: - '200': - content: - application/json: - schema: - properties: - dataset: - items: - properties: - url: - example: 'https://example.com/download' - type: string - type: object - type: array - type: object - description: Get Dataset download url response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - dataset: - items: - properties: - url: - example: 'https://example.com/download' - type: string - type: object - type: array - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Dataset download url response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Dataset download url - tags: - - Radar datasets - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/reports/datasets: - get: - description: Get a list of datasets. - operationId: radar-datasets-get-datasets - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - datasets: - items: - properties: - description: - example: This dataset contains a list of the op 20000 domains globally - type: string - id: - type: integer - meta: - type: object - tags: - items: - example: global - type: string - type: array - title: - example: Top bucket 20000 domains - type: string - type: - example: RANKING_BUCKET - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get Datasets response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - datasets: - items: - properties: - description: - example: This dataset contains a list of the op 20000 domains globally - type: string - id: - type: integer - meta: - type: object - tags: - items: - example: global - type: string - type: array - title: - example: Top bucket 20000 domains - type: string - type: - example: RANKING_BUCKET - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Datasets response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Datasets - tags: - - Radar datasets - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/reports/datasets/download: - post: - description: Get a list of datasets. - operationId: radar-datasets-get-dataset-download-url - requestBody: - content: - application/json: - schema: - properties: - datasetId: - type: integer - type: object - required: true - responses: - '200': - content: - application/json: - schema: - properties: - dataset: - items: - properties: - url: - example: 'https://example.com/download' - type: string - type: object - type: array - type: object - description: Get Dataset download url response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - dataset: - items: - properties: - url: - example: 'https://example.com/download' - type: string - type: object - type: array - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Dataset download url response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Dataset download url - tags: - - Radar datasets - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/entities/asns: - get: - description: Gets a list of autonomous systems (AS). - operationId: radar-entities-get-autonomous-systems - responses: - '200': - content: - application/json: - schema: - properties: - ases: - items: - properties: - aka: - type: string - asn: - type: integer - name: - example: Apple Inc. - type: string - nameLong: - type: string - website: - example: 'https://www.apple.com/support/systemstatus/' - type: string - type: object - type: array - type: object - description: Get autonomous systems response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - ases: - items: - properties: - aka: - type: string - asn: - type: integer - name: - example: Apple Inc. - type: string - nameLong: - type: string - website: - example: 'https://www.apple.com/support/systemstatus/' - type: string - type: object - type: array - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get autonomous systems response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get autonomous systems - tags: - - Radar entities - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/entities/asns/ip: - get: - operationId: radar-entities-get-autonomous-system-information-by-ip-address - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - asn: - properties: - aka: - type: string - asn: - type: integer - country: - type: string - name: - example: Apple Inc. - type: string - nameLong: - type: string - related: - items: - properties: - aka: - type: string - asn: - type: integer - name: - type: string - type: object - type: array - website: - example: 'https://www.apple.com/support/systemstatus/' - type: string - type: object - type: object - success: - type: string - type: object - description: Get autonomous system information by IP address response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - asn: - properties: - aka: - type: string - asn: - type: integer - country: - type: string - name: - example: Apple Inc. - type: string - nameLong: - type: string - related: - items: - properties: - aka: - type: string - asn: - type: integer - name: - type: string - type: object - type: array - website: - example: 'https://www.apple.com/support/systemstatus/' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get autonomous system information by IP address response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get autonomous system information by IP address - tags: - - Radar entities - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/entities/asns/{asn}': - get: - description: Get the requested autonomous system information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). - operationId: radar-entities-get-autonomous-system-(-as)-by-id - parameters: - - in: path - name: asn - required: true - schema: - $ref: '#/components/schemas/entities_components-schemas-asn' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - asn: - properties: - aka: - type: string - asn: - type: integer - confidenceLevel: - type: integer - country: - type: string - name: - example: Apple Inc. - type: string - nameLong: - type: string - related: - items: - properties: - aka: - example: '' - type: string - asn: - type: integer - name: - example: Cogent-174 - type: string - type: object - type: array - website: - example: 'https://www.apple.com/support/systemstatus/' - type: string - type: object - type: object - success: - type: string - type: object - description: Get autonomous system (AS) by ID response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - asn: - properties: - aka: - type: string - asn: - type: integer - confidenceLevel: - type: integer - country: - type: string - name: - example: Apple Inc. - type: string - nameLong: - type: string - related: - items: - properties: - aka: - example: '' - type: string - asn: - type: integer - name: - example: Cogent-174 - type: string - type: object - type: array - website: - example: 'https://www.apple.com/support/systemstatus/' - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get autonomous system (AS) by ID response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get autonomous system (AS) by ID - tags: - - Radar entities - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/entities/locations: - get: - description: Get a list of locations. - operationId: radar-entities-get-locations - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - locations: - items: - properties: - alpha2: - example: AF - type: string - latitude: - type: string - longitude: - type: string - name: - example: Afghanistan - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get locations response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - locations: - items: - properties: - alpha2: - example: AF - type: string - latitude: - type: string - longitude: - type: string - name: - example: Afghanistan - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get locations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get locations - tags: - - Radar entities - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/entities/locations/{location}': - get: - description: Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location). - operationId: radar-entities-get-location - parameters: - - in: path - name: location - required: true - schema: - $ref: '#/components/schemas/location' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - location: - properties: - alpha2: - example: AF - type: string - confidenceLvel: - type: integer - latitude: - type: string - longitude: - type: string - name: - example: Afghanistan - type: string - region: - example: Middle East - type: string - subregion: - example: Southern Asia - type: string - type: object - type: object - success: - type: string - type: object - description: Get location response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - location: - properties: - alpha2: - example: AF - type: string - confidenceLvel: - type: integer - latitude: - type: string - longitude: - type: string - name: - example: Afghanistan - type: string - region: - example: Middle East - type: string - subregion: - example: Southern Asia - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get location response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get location - tags: - - Radar entities - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/ranking/timeseries: - get: - description: Gets Domains Rank updates change over time. Raw values are returned. - operationId: radar-ranking-get-domains-rank-time-series - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - serie_0: - properties: - : - items: - type: integer - type: array - timestamps: - items: - example: '2022-09-02' - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get Domains Rank time series response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - dateRange: - properties: - endTime: - description: Adjusted end of date range. - example: '2022-09-17T10:22:57.555Z' - format: date-time - type: string - startTime: - description: Adjusted start of date range. - example: '2022-09-16T10:22:57.555Z' - format: date-time - type: string - type: object - type: object - serie_0: - properties: - : - items: - type: integer - type: array - timestamps: - items: - example: '2022-09-02' - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Domains Rank time series response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Domains Rank time series - tags: - - Radar ranking - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/ranking/top: - get: - description: Gets Top Domains Rank globally or by country. - operationId: radar-ranking-get-domains-rank-top - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - top_0: - properties: - date: - example: '2022-09-19' - type: string - type: object - type: object - top_0: - items: - properties: - domain: - example: google.com - type: string - rank: - type: integer - type: object - type: array - type: object - success: - type: string - type: object - description: Get Domains Rank top response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - top_0: - properties: - date: - example: '2022-09-19' - type: string - type: object - type: object - top_0: - items: - properties: - domain: - example: google.com - type: string - rank: - type: integer - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Domains Rank top response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Domains Rank top - tags: - - Radar ranking - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/search/global: - get: - description: 'Lets you search for locations, autonomous systems (AS) and reports.' - operationId: 'radar-search-search-for-locations,-autonomous-systems-(-as)-and-reports' - responses: - '200': - content: - application/json: - schema: - properties: - result: - items: - properties: - code: - example: '13335' - type: string - name: - example: Cloudflare - type: string - type: - example: asn - type: string - type: object - type: array - success: - type: string - type: object - description: 'Search for locations, autonomous systems (AS) and reports response' - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - items: - properties: - code: - example: '13335' - type: string - name: - example: Cloudflare - type: string - type: - example: asn - type: string - type: object - type: array - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: 'Search for locations, autonomous systems (AS) and reports response failure' - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: 'Search for locations, autonomous systems (AS) and reports' - tags: - - Radar search - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/specialevents: - get: - description: Get a list of Special Events. - operationId: radar-specialevents-list-special-events - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - specialEvents: - items: - properties: - alias: - example: euro2020 - type: string - categories: - items: - properties: - categoryAlias: - example: streaming - type: string - location: - example: GLOBAL - type: string - type: object - type: array - description: - example: The 2020 UEFA European Football Championship - type: string - id: - type: integer - title: - example: Euro2020 - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: List Special Events response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - specialEvents: - items: - properties: - alias: - example: euro2020 - type: string - categories: - items: - properties: - categoryAlias: - example: streaming - type: string - location: - example: GLOBAL - type: string - type: object - type: array - description: - example: The 2020 UEFA European Football Championship - type: string - id: - type: integer - title: - example: Euro2020 - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Special Events response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Special Events - tags: - - Radar specialevents - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/specialevents/{eventAlias}': - get: - description: Get a single Special Event. - operationId: radar-specialevents-get-a-single-special-events - parameters: - - in: path - name: eventAlias - required: true - schema: - $ref: '#/components/schemas/eventAlias' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - specialEvent: - properties: - alias: - example: euro2020 - type: string - categories: - items: - properties: - categoryAlias: - example: streaming - type: string - location: - example: GLOBAL - type: string - type: object - type: array - description: - example: The 2020 UEFA European Football Championship - type: string - id: - type: integer - title: - example: Euro2020 - type: string - type: object - type: object - success: - type: string - type: object - description: Get a Single Special Events response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - specialEvent: - properties: - alias: - example: euro2020 - type: string - categories: - items: - properties: - categoryAlias: - example: streaming - type: string - location: - example: GLOBAL - type: string - type: object - type: array - description: - example: The 2020 UEFA European Football Championship - type: string - id: - type: integer - title: - example: Euro2020 - type: string - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Single Special Events response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Single Special Events - tags: - - Radar specialevents - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/radar/specialevents/{eventAlias}/{categoryAlias}': - get: - operationId: radar-specialevents-get-special-events-time-series - parameters: - - in: path - name: categoryAlias - required: true - schema: - $ref: '#/components/schemas/categoryAlias' - - in: path - name: eventAlias - required: true - schema: - $ref: '#/components/schemas/eventAlias' - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - serie_0: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - description: Get Special Events time series response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - serie_0: - properties: - timestamps: - items: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: array - values: - items: - type: string - type: array - type: object - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Special Events time series response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Special Events time series - tags: - - Radar specialevents - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/verified_bots/top/bots: - get: - description: 'Get top verified bots by HTTP requests, with owner and category.' - operationId: radar-verified-bots-get-top-verified-bots-by-http-requests - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - botCategory: - example: Search Engine Crawler - type: string - botName: - example: GoogleBot - type: string - botOwner: - example: Google - type: string - value: - example: '29.034407' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top verified bots by HTTP requests response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - botCategory: - example: Search Engine Crawler - type: string - botName: - example: GoogleBot - type: string - botOwner: - example: Google - type: string - value: - example: '29.034407' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top verified bots by HTTP requests response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top verified bots by HTTP requests - tags: - - Radar verified bots - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /radar/verified_bots/top/categories: - get: - description: 'Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.' - operationId: radar-verified-bots-get-top-verified-bot-categories-by-http-requests - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - botCategory: - example: Search - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - description: Get top verified bot categories by HTTP requests response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - meta: - properties: - confidenceInfo: - properties: - annotations: - items: - properties: - dataSource: - type: string - description: - type: string - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - eventType: - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: array - level: - type: integer - type: object - dateRange: - properties: - endTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - startTime: - example: '2022-09-15T00:00:00Z' - format: date-time - type: string - type: object - type: object - top_0: - items: - properties: - botCategory: - example: Search - type: string - value: - example: '65' - type: string - type: object - type: array - type: object - success: - type: string - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Get top verified bot categories by HTTP requests response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get top verified bot categories by HTTP requests - tags: - - Radar verified bots - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true +openapi: 3.0.3 +info: + title: radar API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /radar/agent_readiness/summary/{dimension}: + get: + description: Returns a summary of AI agent readiness scores across scanned domains, grouped by the specified dimension. Data is sourced from weekly bulk scans. All values are raw domain counts. + operationId: radar-get-agent-readiness-summary + parameters: + - description: Specifies the agent readiness data dimension by which to group the results. + in: path + name: dimension + schema: + description: Specifies the agent readiness data dimension by which to group the results. + enum: + - CHECK + type: string + required: true + - description: Filters results by the specified date. + in: query + name: date + schema: + description: Filters results by the specified date. + format: date + type: string + - description: Filters results by domain category. + in: query + name: domainCategory + schema: + description: Filters results by domain category. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + date: + description: Date of the returned scan (YYYY-MM-DD). May differ from the requested date if no scan exists for that exact date. + type: string + domainCategories: + description: Available domain sub-categories with their scan counts. Use as filter options for the domainCategory parameter. + items: + properties: + name: + description: Sub-category name. + type: string + value: + description: Number of successfully scanned domains in this sub-category. + type: integer + required: + - name + - value + type: object + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + successfulDomains: + description: Domains successfully scanned (excludes errors). + type: integer + totalDomains: + description: Total domains attempted in the scan. + type: integer + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - date + - totalDomains + - successfulDomains + - normalization + - lastUpdated + - units + - domainCategories + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get agent readiness summary + tags: + - Radar Agent Readiness + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - agent_readiness + method: summary + /radar/ai/bots/summary/user_agent: + get: + deprecated: true + description: Retrieves the distribution of traffic by AI user agent. + operationId: radar-get-ai-bots-summary-by-user-agent + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AI user agents summary + tags: + - Radar AI Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AI Bots Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - ai + - bots + - summary + method: user_agent + /radar/ai/bots/summary/{dimension}: + get: + description: Retrieves an aggregated summary of AI bots HTTP requests grouped by the specified dimension. + operationId: radar-get-ai-bots-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - USER_AGENT + - CRAWL_PURPOSE + - INDUSTRY + - VERTICAL + - CONTENT_TYPE + - RESPONSE_STATUS + - RESPONSE_STATUS_CATEGORY + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by bot crawl purpose. + in: query + name: crawlPurpose + schema: + description: Filters results by bot crawl purpose. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by user agent. + in: query + name: userAgent + schema: + description: Filters results by user agent. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by vertical. + in: query + name: vertical + schema: + description: Filters results by vertical. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by industry. + in: query + name: industry + schema: + description: Filters results by industry. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by content type category. + in: query + name: contentType + schema: + description: Filters results by content type category. + items: + enum: + - HTML + - IMAGES + - JSON + - JAVASCRIPT + - CSS + - PLAIN_TEXT + - FONTS + - XML + - YAML + - VIDEO + - AUDIO + - MARKDOWN + - DOCUMENTS + - BINARY + - SERIALIZATION + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + in: query + name: responseStatus + schema: + description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + items: + type: string + type: array + explode: true + - description: Filters results by HTTP response status code category. + in: query + name: responseStatusCategory + schema: + description: Filters results by HTTP response status code category. + items: + enum: + - INFORMATIONAL + - SUCCESS + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AI bots HTTP requests distribution by dimension + tags: + - Radar AI Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ai + - timeseries_groups + method: summary + /radar/ai/bots/timeseries: + get: + description: Retrieves AI bots HTTP request volume over time. + operationId: radar-get-ai-bots-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by bot crawl purpose. + in: query + name: crawlPurpose + schema: + description: Filters results by bot crawl purpose. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by user agent. + in: query + name: userAgent + schema: + description: Filters results by user agent. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by industry. + in: query + name: industry + schema: + description: Filters results by industry. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by vertical. + in: query + name: vertical + schema: + description: Filters results by vertical. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by content type category. + in: query + name: contentType + schema: + description: Filters results by content type category. + items: + enum: + - HTML + - IMAGES + - JSON + - JAVASCRIPT + - CSS + - PLAIN_TEXT + - FONTS + - XML + - YAML + - VIDEO + - AUDIO + - MARKDOWN + - DOCUMENTS + - BINARY + - SERIALIZATION + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + in: query + name: responseStatus + schema: + description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + items: + type: string + type: array + explode: true + - description: Filters results by HTTP response status code category. + in: query + name: responseStatusCategory + schema: + description: Filters results by HTTP response status code category. + items: + enum: + - INFORMATIONAL + - SUCCESS + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AI bots HTTP requests time series + tags: + - Radar AI Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ai + - timeseries_groups + method: timeseries + /radar/ai/bots/timeseries_groups/user_agent: + get: + deprecated: true + description: Retrieves the distribution of traffic by AI user agent over time. + operationId: radar-get-ai-bots-timeseries-group-by-user-agent + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AI user agents time series + tags: + - Radar AI Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AI Bots Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/timeseries_groups/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - ai + - timeseries_groups + method: user_agent + /radar/ai/bots/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of HTTP requests from AI bots, grouped by the specified dimension over time. + operationId: radar-get-ai-bots-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - USER_AGENT + - CRAWL_PURPOSE + - INDUSTRY + - VERTICAL + - CONTENT_TYPE + - RESPONSE_STATUS + - RESPONSE_STATUS_CATEGORY + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by bot crawl purpose. + in: query + name: crawlPurpose + schema: + description: Filters results by bot crawl purpose. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by user agent. + in: query + name: userAgent + schema: + description: Filters results by user agent. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by industry. + in: query + name: industry + schema: + description: Filters results by industry. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by vertical. + in: query + name: vertical + schema: + description: Filters results by vertical. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by content type category. + in: query + name: contentType + schema: + description: Filters results by content type category. + items: + enum: + - HTML + - IMAGES + - JSON + - JAVASCRIPT + - CSS + - PLAIN_TEXT + - FONTS + - XML + - YAML + - VIDEO + - AUDIO + - MARKDOWN + - DOCUMENTS + - BINARY + - SERIALIZATION + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + in: query + name: responseStatus + schema: + description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + items: + type: string + type: array + explode: true + - description: Filters results by HTTP response status code category. + in: query + name: responseStatusCategory + schema: + description: Filters results by HTTP response status code category. + items: + enum: + - INFORMATIONAL + - SUCCESS + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get time series distribution of AI bots HTTP requests by dimension. + tags: + - Radar AI Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ai + - timeseries_groups + method: timeseries_groups + /radar/ai/inference/summary/model: + get: + deprecated: true + description: Retrieves the distribution of unique accounts by model. + operationId: radar-get-ai-inference-summary-by-model + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workers AI models summary + tags: + - Radar AI Inference + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AI Inference Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - ai + - inference + - summary + method: model + /radar/ai/inference/summary/task: + get: + deprecated: true + description: Retrieves the distribution of unique accounts by task. + operationId: radar-get-ai-inference-summary-by-task + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workers AI tasks summary + tags: + - Radar AI Inference + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AI Inference Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - ai + - inference + - summary + method: task + /radar/ai/inference/summary/{dimension}: + get: + description: Retrieves an aggregated summary of unique accounts using Workers AI inference grouped by the specified dimension. + operationId: radar-get-ai-inference-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - MODEL + - TASK + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workers AI inference distribution by dimension + tags: + - Radar AI Inference + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ai + - inference + method: summary_v2 + /radar/ai/inference/timeseries_groups/model: + get: + deprecated: true + description: Retrieves the distribution of unique accounts by model over time. + operationId: radar-get-ai-inference-timeseries-group-by-model + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workers AI models time series + tags: + - Radar AI Inference + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AI Inference Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - ai + - inference + - timeseries_groups + - summary + method: model + /radar/ai/inference/timeseries_groups/task: + get: + deprecated: true + description: Retrieves the distribution of unique accounts by task over time. + operationId: radar-get-ai-inference-timeseries-group-by-task + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workers AI tasks time series + tags: + - Radar AI Inference + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AI Inference Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - ai + - inference + - timeseries_groups + - summary + method: task + /radar/ai/inference/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of unique accounts using Workers AI inference, grouped by the specified dimension over time. + operationId: radar-get-ai-inference-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - MODEL + - TASK + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get time series distribution of Workers AI inference by dimension. + tags: + - Radar AI Inference + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ai + - inference + method: timeseries_groups_v2 + /radar/ai/markdown_for_agents/summary: + get: + description: Retrieves the overall median HTML-to-markdown reduction ratio for AI agent requests over the given date range. + operationId: radar-get-ai-markdown-for-agents-summary + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + value: + description: A numeric string that can include decimals and infinity values. + type: string + required: + - value + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AI markdown for agents reduction ratio summary + tags: + - Radar Markdown for Agents + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ai + - markdown_for_agents + method: summary + /radar/ai/markdown_for_agents/timeseries: + get: + description: Retrieves the median HTML-to-markdown reduction ratio over time for AI agent requests. + operationId: radar-get-ai-markdown-for-agents-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AI markdown for agents reduction ratio time series + tags: + - Radar Markdown for Agents + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ai + - markdown_for_agents + method: timeseries + /radar/annotations: + get: + description: Retrieves the latest annotations. + operationId: radar-get-annotations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by date range. + in: query + name: dateRange + schema: + description: Filters results by date range. + type: string + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Filters results by data source. + in: query + name: dataSource + schema: + description: Filters results by data source. + enum: + - ALL + - AI_BOTS + - AI_GATEWAY + - BGP + - BOTS + - CONNECTION_ANOMALY + - CT + - DNS + - DNS_MAGNITUDE + - DNS_AS112 + - DOS + - EMAIL_ROUTING + - EMAIL_SECURITY + - FW + - FW_PG + - HTTP + - HTTP_CONTROL + - HTTP_CRAWLER_REFERER + - HTTP_ORIGINS + - IQI + - LEAKED_CREDENTIALS + - NET + - ROBOTS_TXT + - SPEED + - WORKERS_AI + type: string + - description: Filters results by event type. + in: query + name: eventType + schema: + description: Filters results by event type. + enum: + - EVENT + - GENERAL + - OUTAGE + - PARTIAL_PROJECTION + - PIPELINE + - TRAFFIC_ANOMALY + type: string + - description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + type: integer + - description: Filters results by location. Specify an alpha-2 location code. + in: query + name: location + schema: + description: Filters results by location. Specify an alpha-2 location code. + maxLength: 2 + minLength: 2 + type: string + - description: Filters results by origin. + in: query + name: origin + schema: + description: Filters results by origin. + maxLength: 100 + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + annotations: + items: + properties: + asns: + items: + type: integer + type: array + asnsDetails: + items: + properties: + asn: + type: string + locations: + $ref: '#/components/schemas/unnamedSchemaRef16e559c45a31db5480e21fbe904b2e42' + name: + type: string + required: + - asn + - name + type: object + type: array + dataSource: + type: string + description: + type: string + endDate: + type: string + eventType: + type: string + id: + type: string + linkedUrl: + type: string + locations: + items: + type: string + type: array + locationsDetails: + items: + $ref: '#/components/schemas/unnamedSchemaRef16e559c45a31db5480e21fbe904b2e42' + type: array + origins: + items: + type: string + type: array + originsDetails: + items: + properties: + name: + type: string + origin: + type: string + required: + - origin + - name + type: object + type: array + outage: + properties: + outageCause: + type: string + outageType: + type: string + required: + - outageCause + - outageType + type: object + scope: + type: string + startDate: + type: string + required: + - id + - dataSource + - startDate + - asns + - asnsDetails + - locations + - locationsDetails + - origins + - originsDetails + - eventType + - outage + type: object + type: array + required: + - annotations + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get latest annotations + tags: + - Radar Annotations + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - annotations + method: list + /radar/annotations/outages: + get: + description: Retrieves the latest Internet outages and anomalies. + operationId: radar-get-annotations-outages + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by date range. + in: query + name: dateRange + schema: + description: Filters results by date range. + type: string + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + type: integer + - description: Filters results by location. Specify an alpha-2 location code. + in: query + name: location + schema: + description: Filters results by location. Specify an alpha-2 location code. + maxLength: 2 + minLength: 2 + type: string + - description: Filters results by origin. + in: query + name: origin + schema: + description: Filters results by origin. + maxLength: 100 + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + annotations: + items: + properties: + asns: + items: + type: integer + type: array + asnsDetails: + items: + properties: + asn: + type: string + locations: + $ref: '#/components/schemas/unnamedSchemaRef16e559c45a31db5480e21fbe904b2e42' + name: + type: string + required: + - asn + - name + type: object + type: array + dataSource: + type: string + description: + type: string + endDate: + format: date-time + type: string + eventType: + type: string + id: + type: string + linkedUrl: + type: string + locations: + items: + type: string + type: array + locationsDetails: + items: + $ref: '#/components/schemas/unnamedSchemaRef16e559c45a31db5480e21fbe904b2e42' + type: array + origins: + items: + type: string + type: array + originsDetails: + items: + properties: + name: + type: string + origin: + type: string + required: + - origin + - name + type: object + type: array + outage: + properties: + outageCause: + type: string + outageType: + type: string + required: + - outageCause + - outageType + type: object + scope: + type: string + startDate: + format: date-time + type: string + required: + - id + - dataSource + - startDate + - asns + - asnsDetails + - locations + - locationsDetails + - origins + - originsDetails + - eventType + - outage + type: object + type: array + required: + - annotations + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get latest Internet outages and anomalies + tags: + - Radar Annotations + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - annotations + - outages + method: get + /radar/annotations/outages/locations: + get: + description: Retrieves the number of outages by location. + operationId: radar-get-annotations-outages-top + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Filters results by date range. + in: query + name: dateRange + schema: + description: Filters results by date range. + type: string + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - annotations + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the number of outages by location + tags: + - Radar Annotations + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - annotations + - outages + method: locations + /radar/as112/summary/dnssec: + get: + deprecated: true + description: Retrieves the distribution of DNS queries to AS112 by DNSSEC (DNS Security Extensions) support. + operationId: radar-get-dns-as112-timeseries-by-dnssec + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NOT_SUPPORTED: + description: A numeric string. + type: string + SUPPORTED: + description: A numeric string. + type: string + required: + - SUPPORTED + - NOT_SUPPORTED + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by DNSSEC summary + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - summary + method: dnssec + /radar/as112/summary/edns: + get: + deprecated: true + description: Retrieves the distribution of DNS queries to AS112 by EDNS (Extension Mechanisms for DNS) support. + operationId: radar-get-dns-as112-timeseries-by-edns + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NOT_SUPPORTED: + description: A numeric string. + type: string + SUPPORTED: + description: A numeric string. + type: string + required: + - SUPPORTED + - NOT_SUPPORTED + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by EDNS summary + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - summary + method: edns + /radar/as112/summary/ip_version: + get: + deprecated: true + description: Retrieves the distribution of DNS queries to AS112 by IP version. + operationId: radar-get-dns-as112-timeseries-by-ip-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef8b383e904d9fb02521257ef9cc77d297' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by IP version summary + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - summary + method: ip_version + /radar/as112/summary/protocol: + get: + deprecated: true + description: Retrieves the distribution of DNS queries to AS112 by protocol. + operationId: radar-get-dns-as112-timeseries-by-protocol + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + HTTPS: + description: A numeric string. + type: string + TCP: + description: A numeric string. + type: string + TLS: + description: A numeric string. + type: string + UDP: + description: A numeric string. + type: string + required: + - UDP + - TLS + - HTTPS + - TCP + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by DNS protocol summary + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - summary + method: protocol + /radar/as112/summary/query_type: + get: + deprecated: true + description: Retrieves the distribution of DNS queries to AS112 by type. + operationId: radar-get-dns-as112-timeseries-by-query-type + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by type summary + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - summary + method: query_type + /radar/as112/summary/response_codes: + get: + deprecated: true + description: Retrieves the distribution of AS112 DNS requests classified by response code. + operationId: radar-get-dns-as112-timeseries-by-response-codes + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by response code summary + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - summary + method: response_codes + /radar/as112/summary/{dimension}: + get: + description: Retrieves the distribution of AS112 queries by the specified dimension. + operationId: radar-get-dns-as112-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - DNSSEC + - EDNS + - IP_VERSION + - PROTOCOL + - QUERY_TYPE + - RESPONSE_CODE + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 summary by dimension + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - as112 + method: summary_v2 + /radar/as112/timeseries: + get: + description: Retrieves the AS112 DNS queries over time. + operationId: radar-get-dns-as112-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries time series + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - as112 + method: timeseries + /radar/as112/timeseries_groups/dnssec: + get: + deprecated: true + description: Retrieves the distribution of AS112 DNS queries by DNSSEC (DNS Security Extensions) support over time. + operationId: radar-get-dns-as112-timeseries-group-by-dnssec + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NOT_SUPPORTED: + items: + description: A numeric string. + type: string + type: array + SUPPORTED: + items: + description: A numeric string. + type: string + type: array + required: + - SUPPORTED + - NOT_SUPPORTED + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by DNSSEC support time series + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - timeseries_groups + method: dnssec + /radar/as112/timeseries_groups/edns: + get: + deprecated: true + description: Retrieves the distribution of AS112 DNS queries by EDNS (Extension Mechanisms for DNS) support over time. + operationId: radar-get-dns-as112-timeseries-group-by-edns + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NOT_SUPPORTED: + items: + description: A numeric string. + type: string + type: array + SUPPORTED: + items: + description: A numeric string. + type: string + type: array + required: + - SUPPORTED + - NOT_SUPPORTED + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by EDNS support summary + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - timeseries_groups + method: edns + /radar/as112/timeseries_groups/ip_version: + get: + deprecated: true + description: Retrieves the distribution of AS112 DNS queries by IP version over time. + operationId: radar-get-dns-as112-timeseries-group-by-ip-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + IPv4: + items: + description: A numeric string. + type: string + type: array + IPv6: + items: + description: A numeric string. + type: string + type: array + required: + - IPv4 + - IPv6 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by IP version time series + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - timeseries_groups + method: ip_version + /radar/as112/timeseries_groups/protocol: + get: + deprecated: true + description: Retrieves the distribution of AS112 DNS requests classified by protocol over time. + operationId: radar-get-dns-as112-timeseries-group-by-protocol + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + HTTPS: + items: + description: A numeric string. + type: string + type: array + TCP: + items: + description: A numeric string. + type: string + type: array + TLS: + items: + description: A numeric string. + type: string + type: array + UDP: + items: + description: A numeric string. + type: string + type: array + required: + - UDP + - TLS + - HTTPS + - TCP + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by DNS protocol time series + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - timeseries_groups + method: protocol + /radar/as112/timeseries_groups/query_type: + get: + deprecated: true + description: Retrieves the distribution of AS112 DNS queries by type over time. + operationId: radar-get-dns-as112-timeseries-group-by-query-type + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by type time series + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - timeseries_groups + method: query_type + /radar/as112/timeseries_groups/response_codes: + get: + deprecated: true + description: Retrieves the distribution of AS112 DNS requests classified by response code over time. + operationId: radar-get-dns-as112-timeseries-group-by-response-codes + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 DNS queries by response code time series + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - timeseries_groups + method: response_codes + /radar/as112/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of AS112 queries grouped by dimension over time. + operationId: radar-get-dns-as112-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - DNSSEC + - EDNS + - IP_VERSION + - PROTOCOL + - QUERY_TYPE + - RESPONSE_CODE + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS112 time series grouped by dimension + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - as112 + method: timeseries_groups_v2 + /radar/as112/top/locations: + get: + description: Retrieves the top locations by AS112 DNS queries. + operationId: radar-get-dns-as112-top-locations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by AS112 DNS queries + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - top + method: locations + /radar/as112/top/locations/dnssec/{dnssec}: + get: + description: Retrieves the top locations of DNS queries to AS112 with DNSSEC (DNS Security Extensions) support. + operationId: radar-get-dns-as112-top-locations-by-dnssec + parameters: + - description: DNSSEC (DNS Security Extensions) status. + in: path + name: dnssec + schema: + description: DNSSEC (DNS Security Extensions) status. + enum: + - SUPPORTED + - NOT_SUPPORTED + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by AS112 DNS queries with DNSSEC support + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - top + method: dnssec + /radar/as112/top/locations/edns/{edns}: + get: + description: Retrieves the top locations of DNS queries to AS112 with EDNS (Extension Mechanisms for DNS) support. + operationId: radar-get-dns-as112-top-locations-by-edns + parameters: + - description: EDNS (Extension Mechanisms for DNS) status. + in: path + name: edns + schema: + description: EDNS (Extension Mechanisms for DNS) status. + enum: + - SUPPORTED + - NOT_SUPPORTED + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by AS112 DNS queries with EDNS support + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - top + method: edns + /radar/as112/top/locations/ip_version/{ip_version}: + get: + description: Retrieves the top locations of DNS queries to AS112 for an IP version. + operationId: radar-get-dns-as112-top-locations-by-ip-version + parameters: + - description: IP version. + in: path + name: ip_version + schema: + description: IP version. + enum: + - IPv4 + - IPv6 + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by AS112 DNS queries for an IP version + tags: + - Radar AS112 + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - as112 + - top + method: ip_version + /radar/attacks/layer3/summary/bitrate: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by bitrate. + operationId: radar-get-attacks-layer3-summary-by-bitrate + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + OVER_100_GBPS: + description: A numeric string. + type: string + UNDER_500_MBPS: + description: A numeric string. + type: string + _10_GBPS_TO_100_GBPS: + description: A numeric string. + type: string + x-stainless-naming: + python: + argument_name: ten_gbps_to_one_hundred_gbps + method_argument: ten_gbps_to_one_hundred_gbps + property_name: ten_gbps_to_one_hundred_gbps + go: + argument_name: TenGBPSToOneHundredGBPS + method_argument: TenGBPSToOneHundredGBPS + property_name: TenGBPSToOneHundredGBPS + _1_GBPS_TO_10_GBPS: + description: A numeric string. + type: string + x-stainless-naming: + python: + argument_name: one_gbps_to_ten_gbps + method_argument: one_gbps_to_ten_gbps + property_name: one_gbps_to_ten_gbps + go: + argument_name: OneGBPSToTenGBPS + method_argument: OneGBPSToTenGBPS + property_name: OneGBPSToTenGBPS + _500_MBPS_TO_1_GBPS: + description: A numeric string. + type: string + x-stainless-naming: + python: + argument_name: five_hundred_mbps_to_one_gbps + method_argument: five_hundred_mbps_to_one_gbps + property_name: five_hundred_mbps_to_one_gbps + go: + argument_name: FiveHundredMBPSToOneGBPS + method_argument: FiveHundredMBPSToOneGBPS + property_name: FiveHundredMBPSToOneGBPS + required: + - UNDER_500_MBPS + - OVER_100_GBPS + - _1_GBPS_TO_10_GBPS + - _500_MBPS_TO_1_GBPS + - _10_GBPS_TO_100_GBPS + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by bitrate summary + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - summary + method: bitrate + /radar/attacks/layer3/summary/duration: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by duration. + operationId: radar-get-attacks-layer3-summary-by-duration + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + OVER_3_HOURS: + description: A numeric string. + type: string + UNDER_10_MINS: + description: A numeric string. + type: string + _10_MINS_TO_20_MINS: + description: A numeric string. + type: string + x-stainless-naming: + python: + argument_name: ten_mins_to_twenty_mins + method_argument: ten_mins_to_twenty_mins + property_name: ten_mins_to_twenty_mins + go: + argument_name: TenMinsToTwentyMins + method_argument: TenMinsToTwentyMins + property_name: TenMinsToTwentyMins + _1_HOUR_TO_3_HOURS: + description: A numeric string. + type: string + x-stainless-naming: + python: + argument_name: one_hour_to_three_hours + method_argument: one_hour_to_three_hours + property_name: one_hour_to_three_hours + go: + argument_name: OneHourToThreeHours + method_argument: OneHourToThreeHours + property_name: OneHourToThreeHours + _20_MINS_TO_40_MINS: + description: A numeric string. + type: string + x-stainless-naming: + python: + argument_name: twenty_mins_to_forty_mins + method_argument: twenty_mins_to_forty_mins + property_name: twenty_mins_to_forty_mins + go: + argument_name: TwentyMinsToFortyMins + method_argument: TwentyMinsToFortyMins + property_name: TwentyMinsToFortyMins + _40_MINS_TO_1_HOUR: + description: A numeric string. + type: string + x-stainless-naming: + python: + argument_name: forty_mins_to_one_hour + method_argument: forty_mins_to_one_hour + property_name: forty_mins_to_one_hour + go: + argument_name: FortyMinsToOneHour + method_argument: FortyMinsToOneHour + property_name: FortyMinsToOneHour + required: + - UNDER_10_MINS + - _10_MINS_TO_20_MINS + - OVER_3_HOURS + - _1_HOUR_TO_3_HOURS + - _20_MINS_TO_40_MINS + - _40_MINS_TO_1_HOUR + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by duration summary + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - summary + method: duration + /radar/attacks/layer3/summary/industry: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by targeted industry. + operationId: radar-get-attacks-layer3-summary-by-industry + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by targeted industry summary + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - summary + method: industry + /radar/attacks/layer3/summary/ip_version: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by IP version. + operationId: radar-get-attacks-layer3-summary-by-ip-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef8b383e904d9fb02521257ef9cc77d297' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by IP version summary + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - summary + method: ip_version + /radar/attacks/layer3/summary/protocol: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by protocol. + operationId: radar-get-attacks-layer3-summary-by-protocol + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + GRE: + description: A numeric string. + type: string + ICMP: + description: A numeric string. + type: string + TCP: + description: A numeric string. + type: string + UDP: + description: A numeric string. + type: string + required: + - TCP + - UDP + - GRE + - ICMP + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by protocol summary + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - summary + method: protocol + /radar/attacks/layer3/summary/vector: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by vector. + operationId: radar-get-attacks-layer3-summary-by-vector + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by vector summary + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - summary + method: vector + /radar/attacks/layer3/summary/vertical: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by targeted vertical. + operationId: radar-get-attacks-layer3-summary-by-vertical + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by targeted vertical summary + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - summary + method: vertical + /radar/attacks/layer3/summary/{dimension}: + get: + description: Retrieves the distribution of layer 3 attacks by the specified dimension. + operationId: radar-get-attacks-layer3-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - PROTOCOL + - IP_VERSION + - VECTOR + - DURATION + - BITRATE + - VERTICAL + - INDUSTRY + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks summary by dimension + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + method: summary_v2 + /radar/attacks/layer3/timeseries: + get: + description: Retrieves layer 3 attacks over time. + operationId: radar-get-attacks-layer3-timeseries-by-bytes + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE_CHANGE + - MIN0_MAX + type: string + - description: Measurement units, eg. bytes. + in: query + name: metric + schema: + description: Measurement units, eg. bytes. + enum: + - BYTES + - BYTES_OLD + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by bytes time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + method: timeseries + /radar/attacks/layer3/timeseries_groups/bitrate: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by bitrate over time. + operationId: radar-get-attacks-layer3-timeseries-group-by-bitrate + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + OVER_100_GBPS: + items: + description: A numeric string. + type: string + type: array + UNDER_500_MBPS: + items: + description: A numeric string. + type: string + type: array + _10_GBPS_TO_100_GBPS: + items: + description: A numeric string. + type: string + type: array + x-stainless-naming: + python: + argument_name: ten_gbps_to_one_hundred_gbps + method_argument: ten_gbps_to_one_hundred_gbps + property_name: ten_gbps_to_one_hundred_gbps + go: + argument_name: TenGBPSToOneHundredGBPS + method_argument: TenGBPSToOneHundredGBPS + property_name: TenGBPSToOneHundredGBPS + _1_GBPS_TO_10_GBPS: + items: + description: A numeric string. + type: string + type: array + x-stainless-naming: + python: + argument_name: one_gbps_to_ten_gbps + method_argument: one_gbps_to_ten_gbps + property_name: one_gbps_to_ten_gbps + go: + argument_name: OneGBPSToTenGBPS + method_argument: OneGBPSToTenGBPS + property_name: OneGBPSToTenGBPS + _500_MBPS_TO_1_GBPS: + items: + description: A numeric string. + type: string + type: array + x-stainless-naming: + python: + argument_name: five_hundred_mbps_to_one_gbps + method_argument: five_hundred_mbps_to_one_gbps + property_name: five_hundred_mbps_to_one_gbps + go: + argument_name: FiveHundredMBPSToOneGBPS + method_argument: FiveHundredMBPSToOneGBPS + property_name: FiveHundredMBPSToOneGBPS + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - UNDER_500_MBPS + - OVER_100_GBPS + - _1_GBPS_TO_10_GBPS + - _500_MBPS_TO_1_GBPS + - _10_GBPS_TO_100_GBPS + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by bitrate time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - timeseries_groups + method: bitrate + /radar/attacks/layer3/timeseries_groups/duration: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by duration over time. + operationId: radar-get-attacks-layer3-timeseries-group-by-duration + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + OVER_3_HOURS: + items: + description: A numeric string. + type: string + type: array + UNDER_10_MINS: + items: + description: A numeric string. + type: string + type: array + _10_MINS_TO_20_MINS: + items: + description: A numeric string. + type: string + type: array + x-stainless-naming: + python: + argument_name: ten_mins_to_twenty_mins + method_argument: ten_mins_to_twenty_mins + property_name: ten_mins_to_twenty_mins + go: + argument_name: TenMinsToTwentyMins + method_argument: TenMinsToTwentyMins + property_name: TenMinsToTwentyMins + _1_HOUR_TO_3_HOURS: + items: + description: A numeric string. + type: string + type: array + x-stainless-naming: + python: + argument_name: one_hour_to_three_hours + method_argument: one_hour_to_three_hours + property_name: one_hour_to_three_hours + go: + argument_name: OneHourToThreeHours + method_argument: OneHourToThreeHours + property_name: OneHourToThreeHours + _20_MINS_TO_40_MINS: + items: + description: A numeric string. + type: string + type: array + x-stainless-naming: + python: + argument_name: twenty_mins_to_forty_mins + method_argument: twenty_mins_to_forty_mins + property_name: twenty_mins_to_forty_mins + go: + argument_name: TwentyMinsToFortyMins + method_argument: TwentyMinsToFortyMins + property_name: TwentyMinsToFortyMins + _40_MINS_TO_1_HOUR: + items: + description: A numeric string. + type: string + type: array + x-stainless-naming: + python: + argument_name: forty_mins_to_one_hour + method_argument: forty_mins_to_one_hour + property_name: forty_mins_to_one_hour + go: + argument_name: FortyMinsToOneHour + method_argument: FortyMinsToOneHour + property_name: FortyMinsToOneHour + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - UNDER_10_MINS + - _10_MINS_TO_20_MINS + - OVER_3_HOURS + - _1_HOUR_TO_3_HOURS + - _20_MINS_TO_40_MINS + - _40_MINS_TO_1_HOUR + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by duration time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - timeseries_groups + method: duration + /radar/attacks/layer3/timeseries_groups/industry: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by targeted industry over time. + operationId: radar-get-attacks-layer3-timeseries-group-by-industry + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by target industries time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - timeseries_groups + method: industry + /radar/attacks/layer3/timeseries_groups/ip_version: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by IP version over time. + operationId: radar-get-attacks-layer3-timeseries-group-by-ip-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef9002274ed7cb7f3dc567421e31529a3a' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by IP version time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - timeseries_groups + method: ip_version + /radar/attacks/layer3/timeseries_groups/protocol: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by protocol over time. + operationId: radar-get-attacks-layer3-timeseries-group-by-protocol + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + GRE: + items: + description: A numeric string. + type: string + type: array + ICMP: + items: + description: A numeric string. + type: string + type: array + TCP: + items: + description: A numeric string. + type: string + type: array + UDP: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - TCP + - UDP + - GRE + - ICMP + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by protocol time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - timeseries_groups + method: protocol + /radar/attacks/layer3/timeseries_groups/vector: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by vector over time. + operationId: radar-get-attacks-layer3-timeseries-group-by-vector + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by vector time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - timeseries_groups + method: vector + /radar/attacks/layer3/timeseries_groups/vertical: + get: + deprecated: true + description: Retrieves the distribution of layer 3 attacks by targeted vertical over time. + operationId: radar-get-attacks-layer3-timeseries-group-by-vertical + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks by vertical time series + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - timeseries_groups + method: vertical + /radar/attacks/layer3/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of layer 3 attacks grouped by dimension over time. + operationId: radar-get-attacks-layer3-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - PROTOCOL + - IP_VERSION + - VECTOR + - DURATION + - BITRATE + - VERTICAL + - INDUSTRY + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Specifies whether the `location` filter applies to the source or target location. + in: query + name: direction + schema: + default: ORIGIN + description: Specifies whether the `location` filter applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 3 attacks time series grouped by dimension + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + method: timeseries_groups_v2 + /radar/attacks/layer3/top/attacks: + get: + description: Retrieves the top layer 3 attacks from origin to target location. Values are a percentage out of the total layer 3 attacks (with billing country). You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location). + operationId: radar-get-attacks-layer3-top-attacks + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Specifies whether the `limitPerLocation` applies to the source or target location. + in: query + name: limitDirection + schema: + default: ORIGIN + description: Specifies whether the `limitPerLocation` applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. + in: query + name: limitPerLocation + schema: + description: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Orders results based on attack magnitude, defined by total mitigated bytes or total mitigated attacks. + in: query + name: magnitude + schema: + description: Orders results based on attack magnitude, defined by total mitigated bytes or total mitigated attacks. + enum: + - MITIGATED_BYTES + - MITIGATED_ATTACKS + type: string + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + originCountryAlpha2: + type: string + originCountryName: + type: string + value: + type: string + required: + - originCountryAlpha2 + - originCountryName + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top layer 3 attack pairs (origin and target locations) + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - top + method: attacks + /radar/attacks/layer3/top/industry: + get: + deprecated: true + description: This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint. + operationId: radar-get-attacks-layer3-top-industries + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top industries targeted by layer 3 attacks + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - top + method: industry + /radar/attacks/layer3/top/locations/origin: + get: + description: Retrieves the origin locations of layer 3 attacks. + operationId: radar-get-attacks-layer3-top-origin-locations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + originCountryAlpha2: + type: string + originCountryName: + type: string + rank: + type: number + value: + type: string + required: + - originCountryAlpha2 + - originCountryName + - value + - rank + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top origin locations of layer 3 attacks + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - top + - locations + method: origin + /radar/attacks/layer3/top/locations/target: + get: + description: Retrieves the target locations of layer 3 attacks. + operationId: radar-get-attacks-layer3-top-target-locations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + rank: + type: number + targetCountryAlpha2: + type: string + targetCountryName: + type: string + value: + type: string + required: + - targetCountryAlpha2 + - targetCountryName + - value + - rank + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top target locations of layer 3 attacks + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - top + - locations + method: target + /radar/attacks/layer3/top/vertical: + get: + deprecated: true + description: This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint. + operationId: radar-get-attacks-layer3-top-verticals + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters the results by layer 3/4 protocol. + in: query + name: protocol + schema: + description: Filters the results by layer 3/4 protocol. + items: + enum: + - UDP + - TCP + - ICMP + - GRE + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top verticals targeted by layer 3 attacks + tags: + - Radar Layer 3 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer3 + - top + method: vertical + /radar/attacks/layer7/summary/http_method: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by HTTP method. + operationId: radar-get-attacks-layer7-summary-by-http-method + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by HTTP method summary + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - summary + method: http_method + /radar/attacks/layer7/summary/http_version: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by HTTP version. + operationId: radar-get-attacks-layer7-summary-by-http-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + HTTP/1.x: + type: string + HTTP/2: + type: string + HTTP/3: + type: string + required: + - HTTP/2 + - HTTP/1.x + - HTTP/3 + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by HTTP version summary + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - summary + method: http_version + /radar/attacks/layer7/summary/industry: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by targeted industry. + operationId: radar-get-attacks-layer7-summary-by-industry + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by targeted industry summary + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - summary + method: industry + /radar/attacks/layer7/summary/ip_version: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by IP version. + operationId: radar-get-attacks-layer7-summary-by-ip-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + IPv4: + type: string + IPv6: + type: string + required: + - IPv4 + - IPv6 + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by IP version summary + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - summary + method: ip_version + /radar/attacks/layer7/summary/managed_rules: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by managed rules. + operationId: radar-get-attacks-layer7-summary-by-managed-rules + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by managed rules summary + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - summary + method: managed_rules + /radar/attacks/layer7/summary/mitigation_product: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by mitigation product. + operationId: radar-get-attacks-layer7-summary-by-mitigation-product + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by mitigation product summary + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - summary + method: mitigation_product + /radar/attacks/layer7/summary/vertical: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by targeted vertical. + operationId: radar-get-attacks-layer7-summary-by-vertical + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by targeted vertical summary + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - summary + method: vertical + /radar/attacks/layer7/summary/{dimension}: + get: + description: Retrieves the distribution of layer 7 attacks by the specified dimension. + operationId: radar-get-attacks-layer7-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - HTTP_METHOD + - HTTP_VERSION + - IP_VERSION + - MANAGED_RULES + - MITIGATION_PRODUCT + - VERTICAL + - INDUSTRY + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks summary by dimension + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + method: summary_v2 + /radar/attacks/layer7/timeseries: + get: + description: Retrieves layer 7 attacks over time. + operationId: radar-get-attacks-layer7-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE_CHANGE + - MIN0_MAX + type: string + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef75bae70cf28e6bcef364b9840db3bdeb' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + method: timeseries + /radar/attacks/layer7/timeseries_groups/http_method: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by HTTP method over time. + operationId: radar-get-attacks-layer7-timeseries-group-by-http-method + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by HTTP method time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - timeseries_groups + method: http_method + /radar/attacks/layer7/timeseries_groups/http_version: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by HTTP version over time. + operationId: radar-get-attacks-layer7-timeseries-group-by-http-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + HTTP/1.x: + items: + description: A numeric string. + type: string + type: array + HTTP/2: + items: + description: A numeric string. + type: string + type: array + HTTP/3: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - HTTP/1.x + - HTTP/2 + - HTTP/3 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by HTTP version time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - timeseries_groups + method: http_version + /radar/attacks/layer7/timeseries_groups/industry: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by targeted industry over time. + operationId: radar-get-attacks-layer7-timeseries-group-by-industry + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by target industries time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - timeseries_groups + method: industry + /radar/attacks/layer7/timeseries_groups/ip_version: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by IP version used over time. + operationId: radar-get-attacks-layer7-timeseries-group-by-ip-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef9002274ed7cb7f3dc567421e31529a3a' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by IP version time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - timeseries_groups + method: ip_version + /radar/attacks/layer7/timeseries_groups/managed_rules: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by managed rules over time. + operationId: radar-get-attacks-layer7-timeseries-group-by-managed-rules + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by managed rules time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - timeseries_groups + method: managed_rules + /radar/attacks/layer7/timeseries_groups/mitigation_product: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by mitigation product over time. + operationId: radar-get-attacks-layer7-timeseries-group-by-mitigation-product + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by mitigation product time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - timeseries_groups + method: mitigation_product + /radar/attacks/layer7/timeseries_groups/vertical: + get: + deprecated: true + description: Retrieves the distribution of layer 7 attacks by targeted vertical over time. + operationId: radar-get-attacks-layer7-timeseries-group-by-vertical + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks by vertical time series + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - timeseries_groups + method: vertical + /radar/attacks/layer7/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of layer 7 attacks grouped by dimension over time. + operationId: radar-get-attacks-layer7-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - HTTP_METHOD + - HTTP_VERSION + - IP_VERSION + - MANAGED_RULES + - MITIGATION_PRODUCT + - VERTICAL + - INDUSTRY + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get layer 7 attacks time series grouped by dimension + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + method: timeseries_groups_v2 + /radar/attacks/layer7/top/ases/origin: + get: + description: Retrieves the top origin autonomous systems of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin autonomous systems determined by the client IP address. + operationId: radar-get-attacks-layer7-top-origin-as + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + originAsn: + type: string + originAsnName: + type: string + rank: + type: number + value: + type: string + required: + - originAsnName + - originAsn + - value + - rank + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top origin ASes of layer 7 attacks + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - top + - ases + method: origin + /radar/attacks/layer7/top/attacks: + get: + description: Retrieves the top attacks from origin to target location. Values are percentages of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location). + operationId: radar-get-attacks-layer7-top-attacks + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Specifies whether the `limitPerLocation` applies to the source or target location. + in: query + name: limitDirection + schema: + default: ORIGIN + description: Specifies whether the `limitPerLocation` applies to the source or target location. + enum: + - ORIGIN + - TARGET + type: string + - description: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. + in: query + name: limitPerLocation + schema: + description: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + originCountryAlpha2: + type: string + originCountryName: + type: string + targetCountryAlpha2: + type: string + targetCountryName: + type: string + value: + type: string + required: + - originCountryAlpha2 + - originCountryName + - targetCountryAlpha2 + - targetCountryName + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top layer 7 attack pairs (origin and target locations) + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - top + method: attacks + /radar/attacks/layer7/top/industry: + get: + deprecated: true + description: This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint. + operationId: radar-get-attacks-layer7-top-industries + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top industries targeted by layer 7 attacks + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - top + method: industry + /radar/attacks/layer7/top/locations/origin: + get: + description: Retrieves the top origin locations of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin location determined by the client IP address. + operationId: radar-get-attacks-layer7-top-origin-location + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + originCountryAlpha2: + type: string + originCountryName: + type: string + rank: + type: number + value: + type: string + required: + - originCountryAlpha2 + - originCountryName + - value + - rank + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top origin locations of layer 7 attacks + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - top + - locations + method: origin + /radar/attacks/layer7/top/locations/target: + get: + description: Retrieves the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available. + operationId: radar-get-attacks-layer7-top-target-location + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + rank: + type: number + targetCountryAlpha2: + type: string + targetCountryName: + type: string + value: + type: string + required: + - targetCountryAlpha2 + - targetCountryName + - value + - rank + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top target locations of layer 7 attacks + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - top + - locations + method: target + /radar/attacks/layer7/top/vertical: + get: + deprecated: true + description: This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint. + operationId: radar-get-attacks-layer7-top-verticals + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by HTTP method. + in: query + name: httpMethod + schema: + description: Filters results by HTTP method. + items: + enum: + - GET + - POST + - DELETE + - PUT + - HEAD + - PURGE + - OPTIONS + - PROPFIND + - MKCOL + - PATCH + - ACL + - BCOPY + - BDELETE + - BMOVE + - BPROPFIND + - BPROPPATCH + - CHECKIN + - CHECKOUT + - CONNECT + - COPY + - LABEL + - LOCK + - MERGE + - MKACTIVITY + - MKWORKSPACE + - MOVE + - NOTIFY + - ORDERPATCH + - POLL + - PROPPATCH + - REPORT + - SEARCH + - SUBSCRIBE + - TRACE + - UNCHECKOUT + - UNLOCK + - UNSUBSCRIBE + - UPDATE + - VERSIONCONTROL + - BASELINECONTROL + - XMSENUMATTS + - RPC_OUT_DATA + - RPC_IN_DATA + - JSON + - COOK + - TRACK + type: string + type: array + explode: true + - description: Filters the results by layer 7 mitigation product. + in: query + name: mitigationProduct + schema: + description: Filters the results by layer 7 mitigation product. + items: + enum: + - DDOS + - WAF + - BOT_MANAGEMENT + - ACCESS_RULES + - IP_REPUTATION + - API_SHIELD + - DATA_LOSS_PREVENTION + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top verticals targeted by layer 7 attacks + tags: + - Radar Layer 7 Attacks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - attacks + - layer7 + - top + method: vertical + /radar/bgp/hijacks/events: + get: + description: Retrieves the BGP hijack events. + operationId: radar-get-bgp-hijacks-events + parameters: + - description: Current page number, starting from 1. + in: query + name: page + schema: + description: Current page number, starting from 1. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Number of entries per page. + in: query + name: per_page + schema: + description: Number of entries per page. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: The unique identifier of a event. + in: query + name: eventId + schema: + description: The unique identifier of a event. + type: integer + - description: The potential hijacker AS of a BGP hijack event. + in: query + name: hijackerAsn + schema: + description: The potential hijacker AS of a BGP hijack event. + type: integer + - description: The potential victim AS of a BGP hijack event. + in: query + name: victimAsn + schema: + description: The potential victim AS of a BGP hijack event. + type: integer + - description: The potential hijacker or victim AS of a BGP hijack event. + in: query + name: involvedAsn + schema: + description: The potential hijacker or victim AS of a BGP hijack event. + type: integer + - description: The country code of the potential hijacker or victim AS of a BGP hijack event. + in: query + name: involvedCountry + schema: + description: The country code of the potential hijacker or victim AS of a BGP hijack event. + maxLength: 2 + minLength: 2 + type: string + - in: query + name: prefix + schema: + type: string + - description: Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high). + in: query + name: minConfidence + schema: + description: Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high). + type: integer + - description: Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high). + in: query + name: maxConfidence + schema: + description: Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high). + type: integer + - description: Filters results by date range. + in: query + name: dateRange + schema: + description: Filters results by date range. + type: string + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Sorts results by the specified field. + in: query + name: sortBy + schema: + description: Sorts results by the specified field. + enum: + - ID + - TIME + - CONFIDENCE + type: string + - description: Sort order. + in: query + name: sortOrder + schema: + description: Sort order. + enum: + - ASC + - DESC + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asn_info: + items: + properties: + asn: + type: integer + country_code: + type: string + org_name: + type: string + required: + - asn + - org_name + - country_code + type: object + type: array + events: + items: + properties: + confidence_score: + type: integer + duration: + type: integer + event_type: + type: integer + hijack_msgs_count: + type: integer + hijacker_asn: + type: integer + hijacker_country: + type: string + id: + type: integer + is_stale: + type: boolean + max_hijack_ts: + type: string + max_msg_ts: + type: string + min_hijack_ts: + type: string + on_going_count: + type: integer + peer_asns: + items: + type: integer + type: array + peer_ip_count: + type: integer + prefixes: + items: + type: string + type: array + tags: + items: + properties: + name: + type: string + score: + type: integer + required: + - name + - score + type: object + type: array + victim_asns: + items: + type: integer + type: array + victim_countries: + items: + type: string + type: array + required: + - duration + - event_type + - hijack_msgs_count + - hijacker_asn + - hijacker_country + - victim_asns + - victim_countries + - id + - is_stale + - max_hijack_ts + - min_hijack_ts + - max_msg_ts + - on_going_count + - peer_asns + - peer_ip_count + - prefixes + - confidence_score + - tags + type: object + type: array + total_monitors: + type: integer + required: + - asn_info + - events + - total_monitors + type: object + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - total_count + - page + - per_page + type: object + success: + type: boolean + required: + - result + - result_info + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get BGP hijack events + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - hijacks + - events + method: list + /radar/bgp/ips/timeseries: + get: + description: Retrieves time series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN. + operationId: radar-get-bgp-ips-timeseries + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + items: + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Includes data delay meta information. + in: query + name: includeDelay + schema: + description: Includes data delay meta information. + type: boolean + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + delay: + properties: + asn_data: + properties: + delaySecs: + type: number + delayStr: + type: string + healthy: + type: boolean + latest: + properties: + entries_count: + type: number + path: + type: string + timestamp: + type: number + required: + - timestamp + - path + - entries_count + type: object + required: + - delaySecs + - delayStr + - healthy + - latest + type: object + country_data: + properties: + delaySecs: + type: number + delayStr: + type: string + healthy: + type: boolean + latest: + properties: + count: + type: number + timestamp: + type: number + required: + - timestamp + - count + type: object + required: + - delaySecs + - delayStr + - healthy + - latest + type: object + healthy: + type: boolean + nowTs: + type: number + required: + - nowTs + - healthy + - asn_data + - country_data + type: object + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + ipv4: + items: + description: A numeric string. + type: string + type: array + ipv6: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - ipv4 + - ipv6 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get announced IP address space time series + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - ips + method: timeseries + /radar/bgp/ips/top/ases: + get: + description: Returns the top-N autonomous systems by announced IP space at the nearest 8-hour RIB boundary at or before the requested date. The snapped boundary is returned as `anchor_ts`. + operationId: radar-get-bgp-ips-top-ases + parameters: + - description: Filters results by the specified datetime (ISO 8601). + in: query + name: date + schema: + description: Filters results by the specified datetime (ISO 8601). + format: date-time + type: string + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + default: 5 + description: Limits the number of objects returned in the response. + maximum: 50 + minimum: 1 + type: integer + - description: 'Ranking metric: IPv4 /24 count or IPv6 /48 count.' + in: query + name: metric + schema: + description: 'Ranking metric: IPv4 /24 count or IPv6 /48 count.' + enum: + - v4_24s + - v6_48s + type: string + - description: Optional ISO 3166-1 alpha-2 country filter. Omit for global top-N. + in: query + name: country + schema: + description: Optional ISO 3166-1 alpha-2 country filter. Omit for global top-N. + maxLength: 2 + minLength: 2 + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + anchorTs: + format: date-time + type: string + asns: + items: + properties: + asn: + type: integer + v4_24s: + type: integer + v6_48s: + type: integer + required: + - asn + - v4_24s + - v6_48s + type: object + type: array + country: + nullable: true + type: string + metric: + type: string + required: + - anchorTs + - metric + - country + - asns + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by announced IP space + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - ips + - top + method: ases + /radar/bgp/leaks/events: + get: + description: Retrieves the BGP route leak events. + operationId: radar-get-bgp-route-leak-events + parameters: + - description: Current page number, starting from 1. + in: query + name: page + schema: + description: Current page number, starting from 1. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Number of entries per page. + in: query + name: per_page + schema: + description: Number of entries per page. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: The unique identifier of a event. + in: query + name: eventId + schema: + description: The unique identifier of a event. + type: integer + - description: The leaking AS of a route leak event. + in: query + name: leakAsn + schema: + description: The leaking AS of a route leak event. + type: integer + - description: ASN that is causing or affected by a route leak event. + in: query + name: involvedAsn + schema: + description: ASN that is causing or affected by a route leak event. + type: integer + - description: Country code of a involved ASN in a route leak event. + in: query + name: involvedCountry + schema: + description: Country code of a involved ASN in a route leak event. + maxLength: 2 + minLength: 2 + type: string + - description: Filters results by date range. + in: query + name: dateRange + schema: + description: Filters results by date range. + type: string + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Sorts results by the specified field. + in: query + name: sortBy + schema: + description: Sorts results by the specified field. + enum: + - ID + - LEAKS + - PEERS + - PREFIXES + - ORIGINS + - TIME + type: string + - description: Sort order. + in: query + name: sortOrder + schema: + description: Sort order. + enum: + - ASC + - DESC + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asn_info: + items: + properties: + asn: + type: integer + country_code: + type: string + org_name: + type: string + required: + - asn + - org_name + - country_code + type: object + type: array + events: + items: + properties: + countries: + items: + type: string + type: array + detected_ts: + type: string + finished: + type: boolean + id: + type: integer + leak_asn: + type: integer + leak_count: + type: integer + leak_seg: + items: + type: integer + type: array + leak_type: + type: integer + max_ts: + type: string + min_ts: + type: string + origin_count: + type: integer + peer_count: + type: integer + prefix_count: + type: integer + required: + - detected_ts + - finished + - id + - leak_asn + - leak_count + - leak_seg + - leak_type + - max_ts + - min_ts + - origin_count + - peer_count + - prefix_count + - countries + type: object + type: array + required: + - asn_info + - events + type: object + result_info: + properties: + count: + type: integer + page: + type: integer + per_page: + type: integer + total_count: + type: integer + required: + - count + - total_count + - page + - per_page + type: object + success: + type: boolean + required: + - result + - result_info + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get BGP route leak events + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - leaks + - events + method: list + /radar/bgp/routes/ases: + get: + description: Retrieves all ASes in the current global routing tables with routing statistics. + operationId: radar-get-bgp-routes-asns + parameters: + - description: Filters results by location. Specify an alpha-2 location code. + in: query + name: location + schema: + description: Filters results by location. Specify an alpha-2 location code. + maxLength: 2 + minLength: 2 + type: string + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Sorts results by the specified field. + in: query + name: sortBy + schema: + description: Sorts results by the specified field. + enum: + - cone + - pfxs + - ipv4 + - ipv6 + - rpki_valid + - rpki_invalid + - rpki_unknown + type: string + - description: Sort order. + in: query + name: sortOrder + schema: + description: Sort order. + enum: + - ASC + - DESC + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asns: + items: + properties: + asn: + type: integer + coneSize: + description: AS's customer cone size. + type: integer + country: + description: Alpha-2 code for the AS's registration country. + type: string + ipv4Count: + description: Number of IPv4 addresses originated by the AS. + type: integer + ipv6Count: + description: Number of IPv6 addresses originated by the AS. + type: string + name: + description: Name of the AS. + type: string + pfxsCount: + description: Number of total IP prefixes originated by the AS. + type: integer + rpkiInvalid: + description: Number of RPKI invalid prefixes originated by the AS. + type: integer + rpkiUnknown: + description: Number of RPKI unknown prefixes originated by the AS. + type: integer + rpkiValid: + description: Number of RPKI valid prefixes originated by the AS. + type: integer + required: + - asn + - name + - coneSize + - country + - ipv4Count + - ipv6Count + - pfxsCount + - rpkiValid + - rpkiInvalid + - rpkiUnknown + type: object + type: array + meta: + properties: + dataTime: + description: The timestamp of when the data is generated. + type: string + queryTime: + description: The timestamp of the query. + type: string + totalPeers: + description: Total number of route collector peers used to generate this data. + type: integer + required: + - dataTime + - queryTime + - totalPeers + type: object + required: + - asns + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List ASes from global routing tables + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - routes + method: ases + /radar/bgp/routes/moas: + get: + description: Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables. + operationId: radar-get-bgp-pfx2as-moas + parameters: + - description: Lookup MOASes originated by the given ASN. + in: query + name: origin + schema: + description: Lookup MOASes originated by the given ASN. + type: integer + - in: query + name: prefix + schema: + type: string + - description: Lookup only RPKI invalid MOASes. + in: query + name: invalid_only + schema: + description: Lookup only RPKI invalid MOASes. + type: boolean + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + $ref: '#/components/schemas/unnamedSchemaRefC5858f1f916a921846e0b6159af470a7' + moas: + items: + properties: + origins: + items: + properties: + origin: + type: integer + peer_count: + type: integer + rpki_validation: + type: string + required: + - origin + - peer_count + - rpki_validation + type: object + type: array + prefix: + type: string + required: + - prefix + - origins + type: object + type: array + required: + - moas + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Multi-Origin AS (MOAS) prefixes + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - routes + method: moas + /radar/bgp/routes/pfx2as: + get: + description: Retrieves the prefix-to-ASN mapping from global routing tables. + operationId: radar-get-bgp-pfx2as + parameters: + - in: query + name: prefix + schema: + type: string + - description: Lookup prefixes originated by the given ASN. + in: query + name: origin + schema: + description: Lookup prefixes originated by the given ASN. + type: integer + - description: 'Return only results with matching rpki status: valid, invalid or unknown.' + in: query + name: rpkiStatus + schema: + description: 'Return only results with matching rpki status: valid, invalid or unknown.' + enum: + - VALID + - INVALID + - UNKNOWN + type: string + - description: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address. + in: query + name: longestPrefixMatch + schema: + description: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address. + type: boolean + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + $ref: '#/components/schemas/unnamedSchemaRefC5858f1f916a921846e0b6159af470a7' + prefix_origins: + items: + properties: + origin: + type: integer + peer_count: + type: integer + prefix: + type: string + rpki_validation: + type: string + required: + - origin + - peer_count + - prefix + - rpki_validation + type: object + type: array + required: + - prefix_origins + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get prefix-to-ASN mapping + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - routes + method: pfx2as + /radar/bgp/routes/realtime: + get: + description: Retrieves real-time BGP routes for a prefix, using public real-time data collectors (RouteViews and RIPE RIS). + operationId: radar-get-bgp-routes-realtime + parameters: + - in: query + name: prefix + schema: + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + asn_info: + items: + properties: + as_name: + description: Name of the autonomous system. + type: string + asn: + description: AS number. + type: integer + country_code: + description: Alpha-2 code for the AS's registration country. + type: string + org_id: + description: Organization ID. + type: string + org_name: + description: Organization name. + type: string + required: + - asn + - as_name + - country_code + - org_id + - org_name + type: object + type: array + collectors: + items: + properties: + collector: + description: Public route collector ID. + type: string + latest_realtime_ts: + description: Latest real-time stream timestamp for this collector. + type: string + latest_rib_ts: + description: Latest RIB dump MRT file timestamp for this collector. + type: string + latest_updates_ts: + description: Latest BGP updates MRT file timestamp for this collector. + type: string + peers_count: + description: Total number of collector peers used from this collector. + type: integer + peers_v4_count: + description: Total number of collector peers used from this collector for IPv4 prefixes. + type: integer + peers_v6_count: + description: Total number of collector peers used from this collector for IPv6 prefixes. + type: integer + required: + - collector + - latest_realtime_ts + - latest_updates_ts + - latest_rib_ts + - peers_count + - peers_v4_count + - peers_v6_count + type: object + type: array + data_time: + description: The most recent data timestamp for from the real-time sources. + type: string + prefix_origins: + items: + properties: + origin: + description: Origin ASN. + type: integer + prefix: + description: IP prefix of this query. + type: string + rpki_validation: + description: 'Prefix-origin RPKI validation: valid, invalid, unknown.' + type: string + total_peers: + description: Total number of peers. + type: integer + total_visible: + description: Total number of peers seeing this prefix. + type: integer + visibility: + description: Ratio of peers seeing this prefix to total number of peers. + type: number + required: + - origin + - prefix + - rpki_validation + - total_peers + - total_visible + - visibility + type: object + type: array + query_time: + description: The timestamp of this query. + type: string + required: + - collectors + - asn_info + - prefix_origins + - data_time + - query_time + type: object + routes: + items: + properties: + as_path: + description: AS-level path for this route, from collector to origin. + items: + type: integer + type: array + collector: + description: Public collector ID for this route. + type: string + communities: + description: BGP community values. + items: + type: string + type: array + prefix: + description: IP prefix of this query. + type: string + timestamp: + description: Latest timestamp of change for this route. + type: string + required: + - timestamp + - collector + - prefix + - as_path + - communities + type: object + type: array + required: + - routes + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get real-time BGP routes for a prefix + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - routes + method: realtime + /radar/bgp/routes/stats: + get: + description: Retrieves the BGP routing table stats. + operationId: radar-get-bgp-routes-stats + parameters: + - description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + type: integer + - description: Filters results by location. Specify an alpha-2 location code. + in: query + name: location + schema: + description: Filters results by location. Specify an alpha-2 location code. + maxLength: 2 + minLength: 2 + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + $ref: '#/components/schemas/unnamedSchemaRefC5858f1f916a921846e0b6159af470a7' + stats: + properties: + distinct_origins: + type: integer + distinct_origins_ipv4: + type: integer + distinct_origins_ipv6: + type: integer + distinct_prefixes: + type: integer + distinct_prefixes_ipv4: + type: integer + distinct_prefixes_ipv6: + type: integer + routes_invalid: + type: integer + routes_invalid_ipv4: + type: integer + routes_invalid_ipv6: + type: integer + routes_total: + type: integer + routes_total_ipv4: + type: integer + routes_total_ipv6: + type: integer + routes_unknown: + type: integer + routes_unknown_ipv4: + type: integer + routes_unknown_ipv6: + type: integer + routes_valid: + type: integer + routes_valid_ipv4: + type: integer + routes_valid_ipv6: + type: integer + required: + - distinct_origins + - distinct_origins_ipv4 + - distinct_origins_ipv6 + - distinct_prefixes + - distinct_prefixes_ipv4 + - distinct_prefixes_ipv6 + - routes_invalid + - routes_invalid_ipv4 + - routes_invalid_ipv6 + - routes_total + - routes_total_ipv4 + - routes_total_ipv6 + - routes_unknown + - routes_unknown_ipv4 + - routes_unknown_ipv6 + - routes_valid + - routes_valid_ipv4 + - routes_valid_ipv6 + type: object + required: + - stats + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get BGP routing table stats + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - routes + method: stats + /radar/bgp/rpki/aspa/changes: + get: + description: Retrieves ASPA (Autonomous System Provider Authorization) changes over time. Returns daily aggregated changes including additions, removals, and modifications of ASPA objects. + operationId: radar-get-bgp-rpki-aspa-changes + parameters: + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Filter changes involving this ASN (as customer or provider). + in: query + name: asn + schema: + description: Filter changes involving this ASN (as customer or provider). + type: integer + - description: Include ASN metadata (name, country) in response. + in: query + name: includeAsnInfo + schema: + description: Include ASN metadata (name, country) in response. + type: boolean + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asnInfo: + properties: + '13335': + properties: + asn: + description: ASN number. + type: integer + country: + description: Alpha-2 country code. + type: string + name: + description: AS name. + type: string + required: + - asn + - name + - country + type: object + required: + - '13335' + type: object + changes: + items: + properties: + customersAdded: + description: Number of new ASPA objects created. + type: integer + customersRemoved: + description: Number of ASPA objects deleted. + type: integer + date: + description: Date of the changes in ISO 8601 format. + format: date-time + type: string + entries: + items: + properties: + customerAsn: + description: The customer ASN affected. + type: integer + providers: + items: + description: Provider ASNs involved in the change. + type: integer + type: array + type: + enum: + - CustomerAdded + - CustomerRemoved + - ProvidersAdded + - ProvidersRemoved + type: string + required: + - type + - customerAsn + - providers + type: object + type: array + providersAdded: + description: Number of providers added to existing objects. + type: integer + providersRemoved: + description: Number of providers removed from existing objects. + type: integer + totalCount: + description: Running total of active ASPA objects after this day. + type: integer + required: + - date + - customersAdded + - customersRemoved + - providersAdded + - providersRemoved + - totalCount + - entries + type: object + type: array + meta: + properties: + dataTime: + description: Timestamp of the underlying data. + format: date-time + type: string + queryTime: + description: Timestamp when the query was executed. + format: date-time + type: string + required: + - dataTime + - queryTime + type: object + required: + - changes + - asnInfo + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get ASPA changes over time + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - rpki + - aspa + method: changes + /radar/bgp/rpki/aspa/snapshot: + get: + description: Retrieves current or historical ASPA (Autonomous System Provider Authorization) objects. ASPA objects define which ASNs are authorized upstream providers for a customer ASN. + operationId: radar-get-bgp-rpki-aspa-snapshot + parameters: + - description: Filter by customer ASN (the ASN publishing the ASPA object). + in: query + name: customerAsn + schema: + description: Filter by customer ASN (the ASN publishing the ASPA object). + type: integer + - description: Filter by provider ASN (an authorized upstream provider in ASPA objects). + in: query + name: providerAsn + schema: + description: Filter by provider ASN (an authorized upstream provider in ASPA objects). + type: integer + - description: Filters results by the specified datetime (ISO 8601). + in: query + name: date + schema: + description: Filters results by the specified datetime (ISO 8601). + format: date-time + type: string + - description: Include ASN metadata (name, country) in response. + in: query + name: includeAsnInfo + schema: + description: Include ASN metadata (name, country) in response. + type: boolean + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asnInfo: + properties: + '13335': + properties: + asn: + description: ASN number. + type: integer + country: + description: Alpha-2 country code. + type: string + name: + description: AS name. + type: string + required: + - asn + - name + - country + type: object + required: + - '13335' + type: object + aspaObjects: + items: + properties: + customerAsn: + description: The customer ASN publishing the ASPA object. + type: integer + providers: + items: + description: Authorized provider ASNs. + type: integer + type: array + required: + - customerAsn + - providers + type: object + type: array + meta: + properties: + dataTime: + description: Timestamp of the underlying data. + format: date-time + type: string + queryTime: + description: Timestamp when the query was executed. + format: date-time + type: string + totalCount: + description: Total number of ASPA objects. + type: integer + required: + - dataTime + - queryTime + - totalCount + type: object + required: + - aspaObjects + - asnInfo + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get ASPA objects snapshot + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - rpki + - aspa + method: snapshot + /radar/bgp/rpki/aspa/timeseries: + get: + description: Retrieves ASPA (Autonomous System Provider Authorization) object count over time. Supports filtering by RIR or location (country code) to generate multiple named series. If no RIR or location filter is specified, returns total count. + operationId: radar-get-bgp-rpki-aspa-timeseries + parameters: + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filter by Regional Internet Registry (RIR). Multiple RIRs generate multiple series. + in: query + name: rir + schema: + description: Filter by Regional Internet Registry (RIR). Multiple RIRs generate multiple series. + items: + enum: + - RIPE_NCC + - ARIN + - APNIC + - LACNIC + - AFRINIC + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + dataTime: + description: Timestamp of the underlying data. + format: date-time + type: string + queryTime: + description: Timestamp when the query was executed. + format: date-time + type: string + required: + - dataTime + - queryTime + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef75bae70cf28e6bcef364b9840db3bdeb' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get ASPA count time series + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - rpki + - aspa + method: timeseries + /radar/bgp/rpki/roas/timeseries: + get: + description: "Retrieves RPKI ROA (Route Origin Authorization) validation ratios over time. Returns the selected metric as a time series. Supports filtering by ASN or location (country code) \u2014 multiple values of the same filter type produce one series per value. If no ASN or location is specified, returns the global aggregate." + operationId: radar-get-bgp-rpki-roas-timeseries + parameters: + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - description: Which RPKI ROA validation metric to return. validPfxsRatio = ratio of RPKI-valid prefixes (IPv4+IPv6 combined). validPfxsV4Ratio / validPfxsV6Ratio = same, split by IP version. validIpsRatio = ratio of RPKI-valid address space (IPv4 /24s + IPv6 /48s). validIpsV4Ratio / validIpsV6Ratio = same, split by IP version. + in: query + name: metric + schema: + default: validPfxsRatio + description: Which RPKI ROA validation metric to return. validPfxsRatio = ratio of RPKI-valid prefixes (IPv4+IPv6 combined). validPfxsV4Ratio / validPfxsV6Ratio = same, split by IP version. validIpsRatio = ratio of RPKI-valid address space (IPv4 /24s + IPv6 /48s). validIpsV4Ratio / validIpsV6Ratio = same, split by IP version. + enum: + - validPfxsRatio + - validPfxsV4Ratio + - validPfxsV6Ratio + - validIpsRatio + - validIpsV4Ratio + - validIpsV6Ratio + type: string + - description: Filters results by Autonomous System Number. Specify one or more ASNs. Multiple values generate one series per ASN. + in: query + name: asn + schema: + description: Filters results by Autonomous System Number. Specify one or more ASNs. Multiple values generate one series per ASN. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + items: + type: string + type: array + explode: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + dataTime: + description: Timestamp of the underlying data. + format: date-time + type: string + queryTime: + description: Timestamp when the query was executed. + format: date-time + type: string + required: + - dataTime + - queryTime + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef75bae70cf28e6bcef364b9840db3bdeb' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get RPKI ROA deployment time series + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - rpki + - roas + method: timeseries + /radar/bgp/timeseries: + get: + description: Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned. + operationId: radar-get-bgp-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by BGP network prefix. + in: query + name: prefix + schema: + description: Filters results by BGP network prefix. + items: + type: string + type: array + explode: true + - description: Filters results by BGP update type. + in: query + name: updateType + schema: + description: Filters results by BGP update type. + items: + enum: + - ANNOUNCEMENT + - WITHDRAWAL + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + aggInterval: + enum: + - 15m + - 1h + - 1d + - 1w + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + format: date-time + type: string + required: + - confidenceInfo + - dateRange + - aggInterval + - lastUpdated + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef75bae70cf28e6bcef364b9840db3bdeb' + required: + - meta + - serie_0 + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get BGP time series + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + method: timeseries + /radar/bgp/top/ases: + get: + description: Retrieves the top autonomous systems by BGP updates (announcements only). + operationId: radar-get-bgp-top-ases + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by BGP network prefix. + in: query + name: prefix + schema: + description: Filters results by BGP network prefix. + items: + type: string + type: array + explode: true + - description: Filters results by BGP update type. + in: query + name: updateType + schema: + description: Filters results by BGP update type. + items: + enum: + - ANNOUNCEMENT + - WITHDRAWAL + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + required: + - dateRange + type: object + top_0: + items: + properties: + ASName: + type: string + asn: + type: integer + value: + description: Percentage of updates by this AS out of the total updates by all autonomous systems. + type: string + required: + - asn + - ASName + - value + type: object + type: array + required: + - meta + - top_0 + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by BGP updates + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - top + - ases + method: get + /radar/bgp/top/ases/prefixes: + get: + description: Retrieves the full list of autonomous systems on the global routing table ordered by announced prefixes count. The data comes from public BGP MRT data archives and updates every 2 hours. + operationId: radar-get-bgp-top-asns-by-prefixes + parameters: + - description: Alpha-2 country code. + in: query + name: country + schema: + description: Alpha-2 country code. + type: string + - description: Maximum number of ASes to return. + in: query + name: limit + schema: + description: Maximum number of ASes to return. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asns: + items: + properties: + asn: + type: integer + country: + type: string + name: + type: string + pfxs_count: + type: integer + required: + - asn + - country + - name + - pfxs_count + type: object + type: array + meta: + $ref: '#/components/schemas/unnamedSchemaRefC5858f1f916a921846e0b6159af470a7' + required: + - asns + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by prefix count + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - top + - ases + method: prefixes + /radar/bgp/top/prefixes: + get: + description: Retrieves the top network prefixes by BGP updates. + operationId: radar-get-bgp-top-prefixes + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by BGP update type. + in: query + name: updateType + schema: + description: Filters results by BGP update type. + items: + enum: + - ANNOUNCEMENT + - WITHDRAWAL + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + required: + - dateRange + type: object + top_0: + items: + properties: + prefix: + type: string + value: + description: A numeric string. + type: string + required: + - prefix + - value + type: object + type: array + required: + - meta + - top_0 + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top prefixes by BGP updates + tags: + - Radar BGP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bgp + - top + method: prefixes + /radar/bots: + get: + description: Retrieves a list of bots. + operationId: radar-get-bots + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by bot category. + in: query + name: botCategory + schema: + description: Filters results by bot category. + enum: + - SEARCH_ENGINE_CRAWLER + - SEARCH_ENGINE_OPTIMIZATION + - MONITORING_AND_ANALYTICS + - ADVERTISING_AND_MARKETING + - SOCIAL_MEDIA_MARKETING + - PAGE_PREVIEW + - ACADEMIC_RESEARCH + - SECURITY + - ACCESSIBILITY + - WEBHOOKS + - FEED_FETCHER + - AI_CRAWLER + - AGGREGATOR + - AI_ASSISTANT + - AI_SEARCH + - ARCHIVER + type: string + - description: Filters results by bot operator. + in: query + name: botOperator + schema: + description: Filters results by bot operator. + maxLength: 100 + type: string + - description: Filters results by bot kind. + in: query + name: kind + schema: + description: Filters results by bot kind. + enum: + - AGENT + - BOT + type: string + - description: Filters results by bot verification status. + in: query + name: botVerificationStatus + schema: + description: Filters results by bot verification status. + enum: + - VERIFIED + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + bots: + items: + properties: + category: + description: The category of the bot. + type: string + description: + description: A summary for the bot (e.g., purpose). + type: string + kind: + description: The kind of the bot. + type: string + name: + description: The name of the bot. + type: string + operator: + description: The organization that owns and operates the bot. + type: string + slug: + description: A kebab-case identifier derived from the bot name. + type: string + userAgentPatterns: + items: + description: User agent patterns that identify the bot in web traffic. + type: string + type: array + required: + - slug + - name + - description + - kind + - operator + - category + - userAgentPatterns + type: object + type: array + required: + - bots + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List bots + tags: + - Radar Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bots + method: list + /radar/bots/crawlers/summary/{dimension}: + get: + description: Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension. + operationId: radar-get-crawlers-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - CLIENT_TYPE + - USER_AGENT + - REFERER + - CRAWL_REFER_RATIO + - VERTICAL + - INDUSTRY + - RESPONSE_STATUS + - RESPONSE_STATUS_CATEGORY + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by bot operator. + in: query + name: botOperator + schema: + description: Filters results by bot operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by vertical. + in: query + name: vertical + schema: + description: Filters results by vertical. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by industry. + in: query + name: industry + schema: + description: Filters results by industry. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by agent type. + in: query + name: clientType + schema: + description: Filters results by agent type. + items: + description: The type of the client. + enum: + - HUMAN + - NON_AI_BOT + - AI_BOT + - MIXED_PURPOSE + type: string + type: array + explode: true + - description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + in: query + name: responseStatus + schema: + description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + items: + type: string + type: array + explode: true + - description: Filters results by HTTP response status code category. + in: query + name: responseStatusCategory + schema: + description: Filters results by HTTP response status code category. + items: + enum: + - INFORMATIONAL + - SUCCESS + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get crawler HTTP request distribution by dimension + tags: + - Radar Web Crawlers + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bots + - web_crawlers + method: summary + /radar/bots/crawlers/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of HTTP requests from crawlers, grouped by the specified dimension over time. + operationId: radar-get-crawlers-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - CLIENT_TYPE + - USER_AGENT + - REFERER + - CRAWL_REFER_RATIO + - VERTICAL + - INDUSTRY + - RESPONSE_STATUS + - RESPONSE_STATUS_CATEGORY + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by bot operator. + in: query + name: botOperator + schema: + description: Filters results by bot operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by vertical. + in: query + name: vertical + schema: + description: Filters results by vertical. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by industry. + in: query + name: industry + schema: + description: Filters results by industry. + items: + maxLength: 2000 + type: string + type: array + explode: true + - description: Filters results by agent type. + in: query + name: clientType + schema: + description: Filters results by agent type. + items: + description: The type of the client. + enum: + - HUMAN + - NON_AI_BOT + - AI_BOT + - MIXED_PURPOSE + type: string + type: array + explode: true + - description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + in: query + name: responseStatus + schema: + description: Filters results by HTTP response status code (e.g. 200, 403, 404). Only [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) are accepted. + items: + type: string + type: array + explode: true + - description: Filters results by HTTP response status code category. + in: query + name: responseStatusCategory + schema: + description: Filters results by HTTP response status code category. + items: + enum: + - INFORMATIONAL + - SUCCESS + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get time series of crawler HTTP request distribution by dimension + tags: + - Radar Web Crawlers + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bots + - web_crawlers + method: timeseries_groups + /radar/bots/summary/{dimension}: + get: + description: Retrieves an aggregated summary of bots HTTP requests grouped by the specified dimension. + operationId: radar-get-bots-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - BOT + - BOT_KIND + - BOT_OPERATOR + - BOT_CATEGORY + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by bot name. + in: query + name: bot + schema: + description: Filters results by bot name. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by bot operator. + in: query + name: botOperator + schema: + description: Filters results by bot operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by bot category. + in: query + name: botCategory + schema: + description: Filters results by bot category. + items: + description: The category of the bot. + enum: + - SEARCH_ENGINE_CRAWLER + - SEARCH_ENGINE_OPTIMIZATION + - MONITORING_AND_ANALYTICS + - ADVERTISING_AND_MARKETING + - SOCIAL_MEDIA_MARKETING + - PAGE_PREVIEW + - ACADEMIC_RESEARCH + - SECURITY + - ACCESSIBILITY + - WEBHOOKS + - FEED_FETCHER + - AI_CRAWLER + - AGGREGATOR + - AI_ASSISTANT + - AI_SEARCH + - ARCHIVER + type: string + type: array + explode: true + - description: Filters results by bot kind. + in: query + name: botKind + schema: + description: Filters results by bot kind. + items: + enum: + - AGENT + - BOT + type: string + type: array + explode: true + - description: Filters results by bot verification status (Verified vs. Unverified). + in: query + name: botVerificationStatus + schema: + description: Filters results by bot verification status (Verified vs. Unverified). + items: + description: The category of the bot. + enum: + - VERIFIED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get bots HTTP requests distribution by dimension + tags: + - Radar Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bots + method: summary + /radar/bots/timeseries: + get: + description: Retrieves bots HTTP request volume over time. + operationId: radar-get-bots-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by bot name. + in: query + name: bot + schema: + description: Filters results by bot name. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by bot operator. + in: query + name: botOperator + schema: + description: Filters results by bot operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by bot category. + in: query + name: botCategory + schema: + description: Filters results by bot category. + items: + description: The category of the bot. + enum: + - SEARCH_ENGINE_CRAWLER + - SEARCH_ENGINE_OPTIMIZATION + - MONITORING_AND_ANALYTICS + - ADVERTISING_AND_MARKETING + - SOCIAL_MEDIA_MARKETING + - PAGE_PREVIEW + - ACADEMIC_RESEARCH + - SECURITY + - ACCESSIBILITY + - WEBHOOKS + - FEED_FETCHER + - AI_CRAWLER + - AGGREGATOR + - AI_ASSISTANT + - AI_SEARCH + - ARCHIVER + type: string + type: array + explode: true + - description: Filters results by bot kind. + in: query + name: botKind + schema: + description: Filters results by bot kind. + items: + enum: + - AGENT + - BOT + type: string + type: array + explode: true + - description: Filters results by bot verification status (Verified vs. Unverified). + in: query + name: botVerificationStatus + schema: + description: Filters results by bot verification status (Verified vs. Unverified). + items: + description: The category of the bot. + enum: + - VERIFIED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get bots HTTP requests time series + tags: + - Radar Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bots + method: timeseries + /radar/bots/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of HTTP requests from bots, grouped by the specified dimension over time. + operationId: radar-get-bots-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - BOT + - BOT_KIND + - BOT_OPERATOR + - BOT_CATEGORY + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by bot name. + in: query + name: bot + schema: + description: Filters results by bot name. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by bot operator. + in: query + name: botOperator + schema: + description: Filters results by bot operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by bot category. + in: query + name: botCategory + schema: + description: Filters results by bot category. + items: + description: The category of the bot. + enum: + - SEARCH_ENGINE_CRAWLER + - SEARCH_ENGINE_OPTIMIZATION + - MONITORING_AND_ANALYTICS + - ADVERTISING_AND_MARKETING + - SOCIAL_MEDIA_MARKETING + - PAGE_PREVIEW + - ACADEMIC_RESEARCH + - SECURITY + - ACCESSIBILITY + - WEBHOOKS + - FEED_FETCHER + - AI_CRAWLER + - AGGREGATOR + - AI_ASSISTANT + - AI_SEARCH + - ARCHIVER + type: string + type: array + explode: true + - description: Filters results by bot kind. + in: query + name: botKind + schema: + description: Filters results by bot kind. + items: + enum: + - AGENT + - BOT + type: string + type: array + explode: true + - description: Filters results by bot verification status (Verified vs. Unverified). + in: query + name: botVerificationStatus + schema: + description: Filters results by bot verification status (Verified vs. Unverified). + items: + description: The category of the bot. + enum: + - VERIFIED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get time series distribution of bots HTTP requests by dimension. + tags: + - Radar Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bots + method: timeseries_groups + /radar/bots/{bot_slug}: + get: + description: Retrieves the requested bot information. + operationId: radar-get-bot-details + parameters: + - description: Bot slug. + in: path + name: bot_slug + schema: + description: Bot slug. + maxLength: 100 + type: string + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + bot: + properties: + category: + description: The category of the bot. + type: string + description: + description: A summary for the bot (e.g., purpose). + type: string + kind: + description: The kind of the bot. + type: string + name: + description: The name of the bot. + type: string + operator: + description: The organization that owns and operates the bot. + type: string + operatorUrl: + description: The link to the bot documentation. + type: string + signatureAgentUrl: + description: The URL of the agent's [Web Bot Auth](https://blog.cloudflare.com/web-bot-auth/) resource. Null for bots not verified via request signature. + nullable: true + type: string + slug: + description: A kebab-case identifier derived from the bot name. + type: string + userAgentPatterns: + items: + description: User agent patterns that identify the bot in web traffic. + type: string + type: array + userAgents: + items: + description: User agent strings used by this bot in HTTP requests. + type: string + type: array + required: + - slug + - name + - description + - kind + - operator + - operatorUrl + - category + - userAgents + - userAgentPatterns + type: object + required: + - bot + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get bot details + tags: + - Radar Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - bots + method: get + /radar/ct/authorities: + get: + description: Retrieves a list of certificate authorities. + operationId: radar-get-certificate-authorities + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + certificateAuthorities: + items: + properties: + certificateRecordType: + description: Specifies the type of certificate in the trust chain. + enum: + - ROOT_CERTIFICATE + - INTERMEDIATE_CERTIFICATE + type: string + country: + description: The two-letter ISO country code where the CA organization is based. + type: string + countryName: + description: The full country name corresponding to the country code. + type: string + name: + description: The full name of the certificate authority (CA). + type: string + owner: + description: The organization that owns and operates the CA. + type: string + parentName: + description: The name of the parent/root certificate authority that issued this intermediate certificate. + type: string + parentSha256Fingerprint: + description: The SHA-256 fingerprint of the parent certificate. + type: string + revocationStatus: + description: The current revocation status of a Certificate Authority (CA) certificate. + enum: + - NOT_REVOKED + - REVOKED + - PARENT_CERT_REVOKED + type: string + sha256Fingerprint: + description: The SHA-256 fingerprint of the intermediate certificate. + type: string + required: + - sha256Fingerprint + - name + - owner + - parentName + - parentSha256Fingerprint + - certificateRecordType + - country + - countryName + - revocationStatus + type: object + type: array + required: + - certificateAuthorities + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List certificate authorities + tags: + - Radar Certificate Transparency + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ct + - authorities + method: list + /radar/ct/authorities/{ca_slug}: + get: + description: Retrieves the requested CA information. + operationId: radar-get-certificate-authority-details + parameters: + - description: Certificate authority SHA256 fingerprint. + in: path + name: ca_slug + schema: + description: Certificate authority SHA256 fingerprint. + type: string + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + certificateAuthority: + properties: + appleStatus: + description: The inclusion status of a Certificate Authority (CA) in the trust store. + enum: + - INCLUDED + - NOT_YET_INCLUDED + - NOT_INCLUDED + - NOT_BEFORE + - REMOVED + - DISABLED + - BLOCKED + type: string + authorityKeyIdentifier: + description: The authorityKeyIdentifier value extracted from the certificate PEM. + type: string + certificateRecordType: + description: Specifies the type of certificate in the trust chain. + enum: + - ROOT_CERTIFICATE + - INTERMEDIATE_CERTIFICATE + type: string + chromeStatus: + description: The inclusion status of a Certificate Authority (CA) in the trust store. + enum: + - INCLUDED + - NOT_YET_INCLUDED + - NOT_INCLUDED + - NOT_BEFORE + - REMOVED + - DISABLED + - BLOCKED + type: string + country: + description: The two-letter ISO country code where the CA organization is based. + type: string + countryName: + description: The full country name corresponding to the country code. + type: string + microsoftStatus: + description: The inclusion status of a Certificate Authority (CA) in the trust store. + enum: + - INCLUDED + - NOT_YET_INCLUDED + - NOT_INCLUDED + - NOT_BEFORE + - REMOVED + - DISABLED + - BLOCKED + type: string + mozillaStatus: + description: The inclusion status of a Certificate Authority (CA) in the trust store. + enum: + - INCLUDED + - NOT_YET_INCLUDED + - NOT_INCLUDED + - NOT_BEFORE + - REMOVED + - DISABLED + - BLOCKED + type: string + name: + description: The full name of the certificate authority (CA). + type: string + owner: + description: The organization that owns and operates the CA. + type: string + parentName: + description: The name of the parent/root certificate authority that issued this intermediate certificate. + type: string + parentSha256Fingerprint: + description: The SHA-256 fingerprint of the parent certificate. + type: string + related: + description: CAs from the same owner. + items: + properties: + certificateRecordType: + description: Specifies the type of certificate in the trust chain. + enum: + - ROOT_CERTIFICATE + - INTERMEDIATE_CERTIFICATE + type: string + name: + description: The full name of the certificate authority (CA). + type: string + revocationStatus: + description: The current revocation status of a Certificate Authority (CA) certificate. + enum: + - NOT_REVOKED + - REVOKED + - PARENT_CERT_REVOKED + type: string + sha256Fingerprint: + description: The SHA-256 fingerprint of the intermediate certificate. + type: string + required: + - sha256Fingerprint + - name + - revocationStatus + - certificateRecordType + type: object + type: array + revocationStatus: + description: The current revocation status of a Certificate Authority (CA) certificate. + enum: + - NOT_REVOKED + - REVOKED + - PARENT_CERT_REVOKED + type: string + sha256Fingerprint: + description: The SHA-256 fingerprint of the intermediate certificate. + type: string + subjectKeyIdentifier: + description: The subjectKeyIdentifier value extracted from the certificate PEM. + type: string + validFrom: + description: "The start date of the certificate\u2019s validity period (ISO format)." + type: string + validTo: + description: "The end date of the certificate\u2019s validity period (ISO format)." + type: string + required: + - sha256Fingerprint + - name + - owner + - parentName + - parentSha256Fingerprint + - certificateRecordType + - country + - countryName + - chromeStatus + - appleStatus + - microsoftStatus + - mozillaStatus + - revocationStatus + - validFrom + - validTo + - authorityKeyIdentifier + - subjectKeyIdentifier + - related + type: object + required: + - certificateAuthority + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get certificate authority details + tags: + - Radar Certificate Transparency + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ct + - authorities + method: get + /radar/ct/logs: + get: + description: Retrieves a list of certificate logs. + operationId: radar-get-certificate-logs + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + certificateLogs: + items: + properties: + api: + description: The API standard that the certificate log follows. + enum: + - RFC6962 + - STATIC + type: string + description: + description: A brief description of the certificate log. + type: string + endExclusive: + description: The end date and time for when the log will stop accepting certificates. + format: date-time + type: string + operator: + description: The organization responsible for operating the certificate log. + type: string + slug: + description: A URL-friendly, kebab-case identifier for the certificate log. + type: string + startInclusive: + description: The start date and time for when the log starts accepting certificates. + format: date-time + type: string + state: + description: 'The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html' + enum: + - USABLE + - PENDING + - QUALIFIED + - READ_ONLY + - RETIRED + - REJECTED + type: string + stateTimestamp: + description: Timestamp of when the log state was last updated. + format: date-time + type: string + url: + description: The URL for the certificate log. + type: string + required: + - slug + - description + - operator + - api + - state + - stateTimestamp + - startInclusive + - endExclusive + - url + type: object + type: array + required: + - certificateLogs + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List certificate logs + tags: + - Radar Certificate Transparency + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ct + - logs + method: list + /radar/ct/logs/{log_slug}: + get: + description: Retrieves the requested certificate log information. + operationId: radar-get-certificate-log-details + parameters: + - description: Certificate log slug. + in: path + name: log_slug + schema: + description: Certificate log slug. + maxLength: 100 + type: string + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + certificateLog: + properties: + api: + description: The API standard that the certificate log follows. + enum: + - RFC6962 + - STATIC + type: string + avgThroughput: + description: The average throughput of the CT log, measured in certificates per hour (certs/hour). + type: number + description: + description: A brief description of the certificate log. + type: string + endExclusive: + description: The end date and time for when the log will stop accepting certificates. + format: date-time + type: string + lastUpdate: + description: Timestamp of the most recent update to the CT log. + format: date-time + type: string + operator: + description: The organization responsible for operating the certificate log. + type: string + performance: + description: Log performance metrics, including averages and per-endpoint details. + nullable: true + properties: + endpoints: + items: + properties: + endpoint: + description: The certificate log endpoint names used in performance metrics. + enum: + - add-chain (new) + - add-chain (old) + - add-pre-chain (new) + - add-pre-chain (old) + - get-entries + - get-roots + - get-sth + type: string + responseTime: + type: number + uptime: + type: number + required: + - endpoint + - responseTime + - uptime + type: object + type: array + responseTime: + type: number + uptime: + type: number + required: + - responseTime + - uptime + - endpoints + type: object + related: + description: Logs from the same operator. + items: + properties: + description: + description: A brief description of the certificate log. + type: string + endExclusive: + description: The end date and time for when the log will stop accepting certificates. + format: date-time + type: string + slug: + description: A URL-friendly, kebab-case identifier for the certificate log. + type: string + startInclusive: + description: The start date and time for when the log starts accepting certificates. + format: date-time + type: string + state: + description: 'The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html' + enum: + - USABLE + - PENDING + - QUALIFIED + - READ_ONLY + - RETIRED + - REJECTED + type: string + required: + - slug + - description + - state + - startInclusive + - endExclusive + type: object + type: array + slug: + description: A URL-friendly, kebab-case identifier for the certificate log. + type: string + startInclusive: + description: The start date and time for when the log starts accepting certificates. + format: date-time + type: string + state: + description: 'The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html' + enum: + - USABLE + - PENDING + - QUALIFIED + - READ_ONLY + - RETIRED + - REJECTED + type: string + stateTimestamp: + description: Timestamp of when the log state was last updated. + format: date-time + type: string + submittableCertCount: + description: Number of certificates that are eligible for inclusion to this log but have not been included yet. Based on certificates signed by trusted root CAs within the log's accepted date range. + nullable: true + type: string + submittedCertCount: + description: Number of certificates already included in this CT log. + nullable: true + type: string + url: + description: The URL for the certificate log. + type: string + required: + - slug + - description + - operator + - api + - state + - stateTimestamp + - startInclusive + - endExclusive + - url + - performance + - avgThroughput + - submittedCertCount + - submittableCertCount + - lastUpdate + - related + type: object + required: + - certificateLog + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get certificate log details + tags: + - Radar Certificate Transparency + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ct + - logs + method: get + /radar/ct/summary/{dimension}: + get: + description: Retrieves an aggregated summary of certificates grouped by the specified dimension. + operationId: radar-get-ct-summary + parameters: + - description: Specifies the certificate attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the certificate attribute by which to group the results. + enum: + - CA + - CA_OWNER + - DURATION + - ENTRY_TYPE + - EXPIRATION_STATUS + - HAS_IPS + - HAS_WILDCARDS + - LOG + - LOG_API + - LOG_OPERATOR + - PUBLIC_KEY_ALGORITHM + - SIGNATURE_ALGORITHM + - TLD + - VALIDATION_LEVEL + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by certificate authority. + in: query + name: ca + schema: + description: Filters results by certificate authority. + items: + type: string + type: array + explode: true + - description: Filters results by certificate authority owner. + in: query + name: caOwner + schema: + description: Filters results by certificate authority owner. + items: + type: string + type: array + explode: true + - description: Filters results by certificate duration. + in: query + name: duration + schema: + description: Filters results by certificate duration. + items: + enum: + - LTE_3D + - GT_3D_LTE_7D + - GT_7D_LTE_10D + - GT_10D_LTE_47D + - GT_47D_LTE_100D + - GT_100D_LTE_200D + - GT_200D + type: string + type: array + explode: true + - description: Filters results by entry type (certificate vs. pre-certificate). + in: query + name: entryType + schema: + description: Filters results by entry type (certificate vs. pre-certificate). + items: + enum: + - PRECERTIFICATE + - CERTIFICATE + type: string + type: array + explode: true + - description: Filters results by expiration status (expired vs. valid). + in: query + name: expirationStatus + schema: + description: Filters results by expiration status (expired vs. valid). + items: + enum: + - EXPIRED + - VALID + type: string + type: array + explode: true + - description: Filters results based on whether the certificates are bound to specific IP addresses. + in: query + name: hasIps + schema: + description: Filters results based on whether the certificates are bound to specific IP addresses. + items: + type: boolean + type: array + explode: true + - description: Filters results based on whether the certificates contain wildcard domains. + in: query + name: hasWildcards + schema: + description: Filters results based on whether the certificates contain wildcard domains. + items: + type: boolean + type: array + explode: true + - description: Filters results by certificate log. + in: query + name: log + schema: + description: Filters results by certificate log. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by certificate log API (RFC6962 vs. static). + in: query + name: logApi + schema: + description: Filters results by certificate log API (RFC6962 vs. static). + items: + enum: + - RFC6962 + - STATIC + type: string + type: array + explode: true + - description: Filters results by certificate log operator. + in: query + name: logOperator + schema: + description: Filters results by certificate log operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by public key algorithm. + in: query + name: publicKeyAlgorithm + schema: + description: Filters results by public key algorithm. + items: + enum: + - DSA + - ECDSA + - RSA + type: string + type: array + explode: true + - description: Filters results by signature algorithm. + in: query + name: signatureAlgorithm + schema: + description: Filters results by signature algorithm. + items: + enum: + - DSA_SHA_1 + - DSA_SHA_256 + - ECDSA_SHA_1 + - ECDSA_SHA_256 + - ECDSA_SHA_384 + - ECDSA_SHA_512 + - PSS_SHA_256 + - PSS_SHA_384 + - PSS_SHA_512 + - RSA_MD2 + - RSA_MD5 + - RSA_SHA_1 + - RSA_SHA_256 + - RSA_SHA_384 + - RSA_SHA_512 + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by validation level. + in: query + name: validationLevel + schema: + description: Filters results by validation level. + items: + enum: + - DOMAIN + - ORGANIZATION + - EXTENDED + type: string + type: array + explode: true + - description: Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only. + in: query + name: uniqueEntries + schema: + description: Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only. + items: + enum: + - 'true' + - 'false' + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: RAW_VALUES + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - RAW_VALUES + - PERCENTAGE + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + properties: + rfc6962: + type: string + static: + type: string + gt_121d: + type: string + gt_16d_lte_31d: + type: string + gt_31d_lte_91d: + type: string + gt_3d_lte_16d: + type: string + gt_91d_lte_121d: + type: string + lte_3d: + type: string + CERTIFICATE: + type: string + PRECERTIFICATE: + type: string + EXPIRED: + type: string + VALID: + type: string + NEGATIVE: + type: string + POSITIVE: + type: string + DSA: + type: string + ECDSA: + type: string + RSA: + type: string + domain: + type: string + extended: + type: string + organization: + type: string + unknown: + type: string + required: [] + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get certificate distribution by dimension + tags: + - Radar Certificate Transparency + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ct + method: summary + /radar/ct/timeseries: + get: + description: Retrieves certificate volume over time. + operationId: radar-get-ct-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by certificate authority. + in: query + name: ca + schema: + description: Filters results by certificate authority. + items: + type: string + type: array + explode: true + - description: Filters results by certificate authority owner. + in: query + name: caOwner + schema: + description: Filters results by certificate authority owner. + items: + type: string + type: array + explode: true + - description: Filters results by certificate duration. + in: query + name: duration + schema: + description: Filters results by certificate duration. + items: + enum: + - LTE_3D + - GT_3D_LTE_7D + - GT_7D_LTE_10D + - GT_10D_LTE_47D + - GT_47D_LTE_100D + - GT_100D_LTE_200D + - GT_200D + type: string + type: array + explode: true + - description: Filters results by entry type (certificate vs. pre-certificate). + in: query + name: entryType + schema: + description: Filters results by entry type (certificate vs. pre-certificate). + items: + enum: + - PRECERTIFICATE + - CERTIFICATE + type: string + type: array + explode: true + - description: Filters results by expiration status (expired vs. valid). + in: query + name: expirationStatus + schema: + description: Filters results by expiration status (expired vs. valid). + items: + enum: + - EXPIRED + - VALID + type: string + type: array + explode: true + - description: Filters results based on whether the certificates are bound to specific IP addresses. + in: query + name: hasIps + schema: + description: Filters results based on whether the certificates are bound to specific IP addresses. + items: + type: boolean + type: array + explode: true + - description: Filters results based on whether the certificates contain wildcard domains. + in: query + name: hasWildcards + schema: + description: Filters results based on whether the certificates contain wildcard domains. + items: + type: boolean + type: array + explode: true + - description: Filters results by certificate log. + in: query + name: log + schema: + description: Filters results by certificate log. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by certificate log API (RFC6962 vs. static). + in: query + name: logApi + schema: + description: Filters results by certificate log API (RFC6962 vs. static). + items: + enum: + - RFC6962 + - STATIC + type: string + type: array + explode: true + - description: Filters results by certificate log operator. + in: query + name: logOperator + schema: + description: Filters results by certificate log operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by public key algorithm. + in: query + name: publicKeyAlgorithm + schema: + description: Filters results by public key algorithm. + items: + enum: + - DSA + - ECDSA + - RSA + type: string + type: array + explode: true + - description: Filters results by signature algorithm. + in: query + name: signatureAlgorithm + schema: + description: Filters results by signature algorithm. + items: + enum: + - DSA_SHA_1 + - DSA_SHA_256 + - ECDSA_SHA_1 + - ECDSA_SHA_256 + - ECDSA_SHA_384 + - ECDSA_SHA_512 + - PSS_SHA_256 + - PSS_SHA_384 + - PSS_SHA_512 + - RSA_MD2 + - RSA_MD5 + - RSA_SHA_1 + - RSA_SHA_256 + - RSA_SHA_384 + - RSA_SHA_512 + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by validation level. + in: query + name: validationLevel + schema: + description: Filters results by validation level. + items: + enum: + - DOMAIN + - ORGANIZATION + - EXTENDED + type: string + type: array + explode: true + - description: Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only. + in: query + name: uniqueEntries + schema: + description: Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only. + items: + enum: + - 'true' + - 'false' + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get certificates time series + tags: + - Radar Certificate Transparency + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ct + method: timeseries + /radar/ct/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of certificates grouped by the specified dimension over time. + operationId: radar-get-ct-timeseries-group + parameters: + - description: Specifies the certificate attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the certificate attribute by which to group the results. + enum: + - CA + - CA_OWNER + - DURATION + - ENTRY_TYPE + - EXPIRATION_STATUS + - HAS_IPS + - HAS_WILDCARDS + - LOG + - LOG_API + - LOG_OPERATOR + - PUBLIC_KEY_ALGORITHM + - SIGNATURE_ALGORITHM + - TLD + - VALIDATION_LEVEL + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by certificate authority. + in: query + name: ca + schema: + description: Filters results by certificate authority. + items: + type: string + type: array + explode: true + - description: Filters results by certificate authority owner. + in: query + name: caOwner + schema: + description: Filters results by certificate authority owner. + items: + type: string + type: array + explode: true + - description: Filters results by certificate duration. + in: query + name: duration + schema: + description: Filters results by certificate duration. + items: + enum: + - LTE_3D + - GT_3D_LTE_7D + - GT_7D_LTE_10D + - GT_10D_LTE_47D + - GT_47D_LTE_100D + - GT_100D_LTE_200D + - GT_200D + type: string + type: array + explode: true + - description: Filters results by entry type (certificate vs. pre-certificate). + in: query + name: entryType + schema: + description: Filters results by entry type (certificate vs. pre-certificate). + items: + enum: + - PRECERTIFICATE + - CERTIFICATE + type: string + type: array + explode: true + - description: Filters results by expiration status (expired vs. valid). + in: query + name: expirationStatus + schema: + description: Filters results by expiration status (expired vs. valid). + items: + enum: + - EXPIRED + - VALID + type: string + type: array + explode: true + - description: Filters results based on whether the certificates are bound to specific IP addresses. + in: query + name: hasIps + schema: + description: Filters results based on whether the certificates are bound to specific IP addresses. + items: + type: boolean + type: array + explode: true + - description: Filters results based on whether the certificates contain wildcard domains. + in: query + name: hasWildcards + schema: + description: Filters results based on whether the certificates contain wildcard domains. + items: + type: boolean + type: array + explode: true + - description: Filters results by certificate log. + in: query + name: log + schema: + description: Filters results by certificate log. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by certificate log API (RFC6962 vs. static). + in: query + name: logApi + schema: + description: Filters results by certificate log API (RFC6962 vs. static). + items: + enum: + - RFC6962 + - STATIC + type: string + type: array + explode: true + - description: Filters results by certificate log operator. + in: query + name: logOperator + schema: + description: Filters results by certificate log operator. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by public key algorithm. + in: query + name: publicKeyAlgorithm + schema: + description: Filters results by public key algorithm. + items: + enum: + - DSA + - ECDSA + - RSA + type: string + type: array + explode: true + - description: Filters results by signature algorithm. + in: query + name: signatureAlgorithm + schema: + description: Filters results by signature algorithm. + items: + enum: + - DSA_SHA_1 + - DSA_SHA_256 + - ECDSA_SHA_1 + - ECDSA_SHA_256 + - ECDSA_SHA_384 + - ECDSA_SHA_512 + - PSS_SHA_256 + - PSS_SHA_384 + - PSS_SHA_512 + - RSA_MD2 + - RSA_MD5 + - RSA_SHA_1 + - RSA_SHA_256 + - RSA_SHA_384 + - RSA_SHA_512 + type: string + type: array + explode: true + - description: Filters results by validation level. + in: query + name: validationLevel + schema: + description: Filters results by validation level. + items: + enum: + - DOMAIN + - ORGANIZATION + - EXTENDED + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: RAW_VALUES + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - RAW_VALUES + - PERCENTAGE + type: string + - description: Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only. + in: query + name: uniqueEntries + schema: + description: Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only. + items: + enum: + - 'true' + - 'false' + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + type: object + properties: + timestamps: + items: + format: date-time + type: string + type: array + rfc6962: + items: + type: string + type: array + static: + items: + type: string + type: array + gt_121d: + items: + type: string + type: array + gt_16d_lte_31d: + items: + type: string + type: array + gt_31d_lte_91d: + items: + type: string + type: array + gt_3d_lte_16d: + items: + type: string + type: array + gt_91d_lte_121d: + items: + type: string + type: array + lte_3d: + items: + type: string + type: array + CERTIFICATE: + items: + type: string + type: array + PRECERTIFICATE: + items: + type: string + type: array + EXPIRED: + items: + type: string + type: array + VALID: + items: + type: string + type: array + NEGATIVE: + items: + type: string + type: array + POSITIVE: + items: + type: string + type: array + DSA: + items: + type: string + type: array + ECDSA: + items: + type: string + type: array + RSA: + items: + type: string + type: array + domain: + items: + type: string + type: array + extended: + items: + type: string + type: array + organization: + items: + type: string + type: array + unknown: + items: + type: string + type: array + required: [] + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get time series of certificate distribution by dimension + tags: + - Radar Certificate Transparency + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ct + method: timeseries_groups + /radar/datasets: + get: + description: Retrieves a list of datasets. + operationId: radar-get-reports-datasets + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by dataset type. + in: query + name: datasetType + schema: + default: RANKING_BUCKET + description: Filters results by dataset type. + enum: + - RANKING_BUCKET + - REPORT + type: string + - description: Filters results by the specified date. + in: query + name: date + schema: + description: Filters results by the specified date. + format: date + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + datasets: + items: + properties: + description: + type: string + id: + type: integer + meta: + type: object + tags: + items: + type: string + type: array + title: + type: string + type: + type: string + required: + - id + - title + - description + - type + - tags + - meta + type: object + type: array + required: + - datasets + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List datasets + tags: + - Radar Datasets + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - datasets + method: list + /radar/datasets/download: + post: + description: Retrieves an URL to download a single dataset. + operationId: radar-post-reports-dataset-download-url + parameters: + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + requestBody: + content: + application/json: + schema: + properties: + datasetId: + type: integer + x-auditable: true + required: + - datasetId + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + dataset: + properties: + url: + type: string + required: + - url + type: object + required: + - dataset + type: object + required: + - result + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get dataset download URL + tags: + - Radar Datasets + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - datasets + method: download + /radar/datasets/{alias}: + get: + description: Retrieves the CSV content of a given dataset by alias or ID. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date. + operationId: radar-get-reports-dataset-download + parameters: + - description: Dataset alias or ID. + in: path + name: alias + schema: + description: Dataset alias or ID. + type: string + required: true + responses: + '200': + content: + text/csv: + schema: + type: object + properties: + contents: + type: string + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get dataset CSV stream + tags: + - Radar Datasets + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - datasets + method: get + /radar/dns/summary/cache_hit: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by cache status. + operationId: radar-get-dns-summary-by-cache-hit-status + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NEGATIVE: + description: A numeric string. + type: string + POSITIVE: + description: A numeric string. + type: string + required: + - POSITIVE + - NEGATIVE + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by cache status summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: cache_hit + /radar/dns/summary/dnssec: + get: + deprecated: true + description: Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support. + operationId: radar-get-dns-summary-by-dnssec + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + INSECURE: + description: A numeric string. + type: string + INVALID: + description: A numeric string. + type: string + OTHER: + description: A numeric string. + type: string + SECURE: + description: A numeric string. + type: string + required: + - INSECURE + - SECURE + - INVALID + - OTHER + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by DNSSEC support summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: dnssec + /radar/dns/summary/dnssec_aware: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness. + operationId: radar-get-dns-summary-by-dnssec-awareness + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NOT_SUPPORTED: + description: A numeric string. + type: string + SUPPORTED: + description: A numeric string. + type: string + required: + - NOT_SUPPORTED + - SUPPORTED + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by DNSSEC awareness summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: dnssec_aware + /radar/dns/summary/dnssec_e2e: + get: + deprecated: true + description: Retrieves the distribution of DNSSEC-validated answers by end-to-end security status. + operationId: radar-get-dns-summary-by-dnssec-e2e-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NEGATIVE: + description: A numeric string. + type: string + POSITIVE: + description: A numeric string. + type: string + required: + - NEGATIVE + - POSITIVE + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by DNSSEC end-to-end summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: dnssec_e2e + /radar/dns/summary/ip_version: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by IP version. + operationId: radar-get-dns-summary-by-ip-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef8b383e904d9fb02521257ef9cc77d297' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by IP version summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: ip_version + /radar/dns/summary/matching_answer: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by matching answers. + operationId: radar-get-dns-summary-by-matching-answer-status + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NEGATIVE: + description: A numeric string. + type: string + POSITIVE: + description: A numeric string. + type: string + required: + - POSITIVE + - NEGATIVE + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by matching answer summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: matching_answer + /radar/dns/summary/protocol: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by DNS transport protocol. + operationId: radar-get-dns-summary-by-protocol + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + HTTPS: + description: A numeric string. + type: string + TCP: + description: A numeric string. + type: string + TLS: + description: A numeric string. + type: string + UDP: + description: A numeric string. + type: string + required: + - UDP + - TLS + - HTTPS + - TCP + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by protocol summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: protocol + /radar/dns/summary/query_type: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by type. + operationId: radar-get-dns-summary-by-query-type + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by type summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: query_type + /radar/dns/summary/response_code: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by response code. + operationId: radar-get-dns-summary-by-response-code + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by response code summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: response_code + /radar/dns/summary/response_ttl: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by minimum response TTL. + operationId: radar-get-dns-summary-by-response-ttl + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + gt_15m_lte_1h: + description: A numeric string. + type: string + gt_1d_lte_1w: + description: A numeric string. + type: string + gt_1h_lte_1d: + description: A numeric string. + type: string + gt_1m_lte_5m: + description: A numeric string. + type: string + gt_1w: + description: A numeric string. + type: string + gt_5m_lte_15m: + description: A numeric string. + type: string + lte_1m: + description: A numeric string. + type: string + required: + - lte_1m + - gt_1m_lte_5m + - gt_5m_lte_15m + - gt_15m_lte_1h + - gt_1h_lte_1d + - gt_1d_lte_1w + - gt_1w + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by response TTL summary + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - summary + method: response_ttl + /radar/dns/summary/{dimension}: + get: + description: Retrieves the distribution of DNS queries by the specified dimension. + operationId: radar-get-dns-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - AS + - CACHE_HIT + - DNSSEC + - DNSSEC_AWARE + - DNSSEC_E2E + - IP_VERSION + - LOCATION + - MATCHING_ANSWER + - PROTOCOL + - QUERY_TYPE + - RESPONSE_CODE + - RESPONSE_TTL + - TLD + - TLD_DNS_MAGNITUDE + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results based on cache status. + in: query + name: cacheHit + schema: + description: Filters results based on cache status. + items: + type: boolean + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Filters results by DNS response TTL. + in: query + name: responseTtl + schema: + description: Filters results by DNS response TTL. + items: + enum: + - LTE_1M + - GT_1M_LTE_5M + - GT_5M_LTE_15M + - GT_15M_LTE_1H + - GT_1H_LTE_1D + - GT_1D_LTE_1W + - GT_1W + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) support. + in: query + name: dnssec + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) support. + items: + enum: + - INVALID + - INSECURE + - SECURE + - OTHER + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + in: query + name: dnssecAware + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + items: + enum: + - SUPPORTED + - NOT_SUPPORTED + type: string + type: array + explode: true + - description: Filters results based on DNSSEC-validated answers by end-to-end security status. + in: query + name: dnssecE2e + schema: + description: Filters results based on DNSSEC-validated answers by end-to-end security status. + items: + type: boolean + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results based on whether the queries have a matching answer. + in: query + name: matchingAnswer + schema: + description: Filters results based on whether the queries have a matching answer. + items: + type: boolean + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS summary by dimension + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - dns + method: summary_v2 + /radar/dns/timeseries: + get: + description: Retrieves normalized query volume to the 1.1.1.1 DNS resolver over time. + operationId: radar-get-dns-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results based on cache status. + in: query + name: cacheHit + schema: + description: Filters results based on cache status. + items: + type: boolean + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Filters results by DNS response TTL. + in: query + name: responseTtl + schema: + description: Filters results by DNS response TTL. + items: + enum: + - LTE_1M + - GT_1M_LTE_5M + - GT_5M_LTE_15M + - GT_15M_LTE_1H + - GT_1H_LTE_1D + - GT_1D_LTE_1W + - GT_1W + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) support. + in: query + name: dnssec + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) support. + items: + enum: + - INVALID + - INSECURE + - SECURE + - OTHER + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + in: query + name: dnssecAware + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + items: + enum: + - SUPPORTED + - NOT_SUPPORTED + type: string + type: array + explode: true + - description: Filters results based on DNSSEC-validated answers by end-to-end security status. + in: query + name: dnssecE2e + schema: + description: Filters results based on DNSSEC-validated answers by end-to-end security status. + items: + type: boolean + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results based on whether the queries have a matching answer. + in: query + name: matchingAnswer + schema: + description: Filters results based on whether the queries have a matching answer. + items: + type: boolean + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - dns + method: timeseries + /radar/dns/timeseries_groups/cache_hit: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by cache status over time. + operationId: radar-get-dns-timeseries-group-by-cache-hit-status + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NEGATIVE: + items: + description: A numeric string. + type: string + type: array + POSITIVE: + items: + description: A numeric string. + type: string + type: array + required: + - POSITIVE + - NEGATIVE + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by cache status time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: cache_hit + /radar/dns/timeseries_groups/dnssec: + get: + deprecated: true + description: Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support over time. + operationId: radar-get-dns-timeseries-group-by-dnssec + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + INSECURE: + items: + description: A numeric string. + type: string + type: array + INVALID: + items: + description: A numeric string. + type: string + type: array + OTHER: + items: + description: A numeric string. + type: string + type: array + SECURE: + items: + description: A numeric string. + type: string + type: array + required: + - INSECURE + - SECURE + - INVALID + - OTHER + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by DNSSEC support time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: dnssec + /radar/dns/timeseries_groups/dnssec_aware: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness over time. + operationId: radar-get-dns-timeseries-group-by-dnssec-awareness + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NOT_SUPPORTED: + items: + description: A numeric string. + type: string + type: array + SUPPORTED: + items: + description: A numeric string. + type: string + type: array + required: + - NOT_SUPPORTED + - SUPPORTED + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by DNSSEC awareness time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: dnssec_aware + /radar/dns/timeseries_groups/dnssec_e2e: + get: + deprecated: true + description: Retrieves the distribution of DNSSEC-validated answers by end-to-end security status over time. + operationId: radar-get-dns-timeseries-group-by-dnssec-e2e-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NEGATIVE: + items: + description: A numeric string. + type: string + type: array + POSITIVE: + items: + description: A numeric string. + type: string + type: array + required: + - NEGATIVE + - POSITIVE + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by DNSSEC end-to-end time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: dnssec_e2e + /radar/dns/timeseries_groups/ip_version: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by IP version over time. + operationId: radar-get-dns-timeseries-group-by-ip-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + IPv4: + items: + description: A numeric string. + type: string + type: array + IPv6: + items: + description: A numeric string. + type: string + type: array + required: + - IPv4 + - IPv6 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by IP version time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: ip_version + /radar/dns/timeseries_groups/matching_answer: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by matching answers over time. + operationId: radar-get-dns-timeseries-group-by-matching-answer-status + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NEGATIVE: + items: + description: A numeric string. + type: string + type: array + POSITIVE: + items: + description: A numeric string. + type: string + type: array + required: + - POSITIVE + - NEGATIVE + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by matching answer time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: matching_answer + /radar/dns/timeseries_groups/protocol: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by DNS transport protocol over time. + operationId: radar-get-dns-timeseries-group-by-protocol + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + HTTPS: + items: + description: A numeric string. + type: string + type: array + TCP: + items: + description: A numeric string. + type: string + type: array + TLS: + items: + description: A numeric string. + type: string + type: array + UDP: + items: + description: A numeric string. + type: string + type: array + required: + - UDP + - TLS + - HTTPS + - TCP + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by protocol time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: protocol + /radar/dns/timeseries_groups/query_type: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by type over time. + operationId: radar-get-dns-timeseries-group-by-query-type + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by type time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: query_type + /radar/dns/timeseries_groups/response_code: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by response code over time. + operationId: radar-get-dns-timeseries-group-by-response-code + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by response code time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: response_code + /radar/dns/timeseries_groups/response_ttl: + get: + deprecated: true + description: Retrieves the distribution of DNS queries by minimum answer TTL over time. + operationId: radar-get-dns-timeseries-group-by-response-ttl + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + gt_15m_lte_1h: + items: + description: A numeric string. + type: string + type: array + gt_1d_lte_1w: + items: + description: A numeric string. + type: string + type: array + gt_1h_lte_1d: + items: + description: A numeric string. + type: string + type: array + gt_1m_lte_5m: + items: + description: A numeric string. + type: string + type: array + gt_1w: + items: + description: A numeric string. + type: string + type: array + gt_5m_lte_15m: + items: + description: A numeric string. + type: string + type: array + lte_1m: + items: + description: A numeric string. + type: string + type: array + required: + - lte_1m + - gt_1m_lte_5m + - gt_5m_lte_15m + - gt_15m_lte_1h + - gt_1h_lte_1d + - gt_1d_lte_1w + - gt_1w + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS queries by response TTL time series + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - dns + - timeseries_groups + method: response_ttl + /radar/dns/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of DNS queries grouped by dimension over time. + operationId: radar-get-dns-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - AS + - CACHE_HIT + - DNSSEC + - DNSSEC_AWARE + - DNSSEC_E2E + - IP_VERSION + - LOCATION + - MATCHING_ANSWER + - PROTOCOL + - QUERY_TYPE + - RESPONSE_CODE + - RESPONSE_TTL + - TLD + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results based on cache status. + in: query + name: cacheHit + schema: + description: Filters results based on cache status. + items: + type: boolean + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Filters results by DNS response TTL. + in: query + name: responseTtl + schema: + description: Filters results by DNS response TTL. + items: + enum: + - LTE_1M + - GT_1M_LTE_5M + - GT_5M_LTE_15M + - GT_15M_LTE_1H + - GT_1H_LTE_1D + - GT_1D_LTE_1W + - GT_1W + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) support. + in: query + name: dnssec + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) support. + items: + enum: + - INVALID + - INSECURE + - SECURE + - OTHER + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + in: query + name: dnssecAware + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + items: + enum: + - SUPPORTED + - NOT_SUPPORTED + type: string + type: array + explode: true + - description: Filters results based on DNSSEC-validated answers by end-to-end security status. + in: query + name: dnssecE2e + schema: + description: Filters results based on DNSSEC-validated answers by end-to-end security status. + items: + type: boolean + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results based on whether the queries have a matching answer. + in: query + name: matchingAnswer + schema: + description: Filters results based on whether the queries have a matching answer. + items: + type: boolean + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DNS time series grouped by dimension + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - dns + method: timeseries_groups_v2 + /radar/dns/top/ases: + get: + description: Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS resolver. + operationId: radar-get-dns-top-ases + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by domain name. + in: query + name: domain + schema: + description: Filters results by domain name. + items: + maxLength: 253 + minLength: 1 + type: string + type: array + explode: true + - description: Filters results based on cache status. + in: query + name: cacheHit + schema: + description: Filters results based on cache status. + items: + type: boolean + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Filters results by DNS response TTL. + in: query + name: responseTtl + schema: + description: Filters results by DNS response TTL. + items: + enum: + - LTE_1M + - GT_1M_LTE_5M + - GT_5M_LTE_15M + - GT_15M_LTE_1H + - GT_1H_LTE_1D + - GT_1D_LTE_1W + - GT_1W + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) support. + in: query + name: dnssec + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) support. + items: + enum: + - INVALID + - INSECURE + - SECURE + - OTHER + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + in: query + name: dnssecAware + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + items: + enum: + - SUPPORTED + - NOT_SUPPORTED + type: string + type: array + explode: true + - description: Filters results based on DNSSEC-validated answers by end-to-end security status. + in: query + name: dnssecE2e + schema: + description: Filters results based on DNSSEC-validated answers by end-to-end security status. + items: + type: boolean + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results based on whether the queries have a matching answer. + in: query + name: matchingAnswer + schema: + description: Filters results based on whether the queries have a matching answer. + items: + type: boolean + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by DNS queries + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - dns + - top + method: ases + /radar/dns/top/locations: + get: + description: Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver. + operationId: radar-get-dns-top-locations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by domain name. + in: query + name: domain + schema: + description: Filters results by domain name. + items: + maxLength: 253 + minLength: 1 + type: string + type: array + explode: true + - description: Filters results based on cache status. + in: query + name: cacheHit + schema: + description: Filters results based on cache status. + items: + type: boolean + type: array + explode: true + - description: Specifies whether the response includes empty DNS responses (NODATA). + in: query + name: nodata + schema: + description: Specifies whether the response includes empty DNS responses (NODATA). + items: + type: boolean + type: array + explode: true + - description: Filters results by DNS transport protocol. + in: query + name: protocol + schema: + description: Filters results by DNS transport protocol. + items: + enum: + - UDP + - TCP + - HTTPS + - TLS + type: string + type: array + explode: true + - description: Filters results by DNS query type. + in: query + name: queryType + schema: + description: Filters results by DNS query type. + items: + enum: + - A + - AAAA + - A6 + - AFSDB + - ANY + - APL + - ATMA + - AXFR + - CAA + - CDNSKEY + - CDS + - CERT + - CNAME + - CSYNC + - DHCID + - DLV + - DNAME + - DNSKEY + - DOA + - DS + - EID + - EUI48 + - EUI64 + - GPOS + - GID + - HINFO + - HIP + - HTTPS + - IPSECKEY + - ISDN + - IXFR + - KEY + - KX + - L32 + - L64 + - LOC + - LP + - MAILA + - MAILB + - MB + - MD + - MF + - MG + - MINFO + - MR + - MX + - NAPTR + - NB + - NBSTAT + - NID + - NIMLOC + - NINFO + - NS + - NSAP + - NSEC + - NSEC3 + - NSEC3PARAM + - 'NULL' + - NXT + - OPENPGPKEY + - OPT + - PTR + - PX + - RKEY + - RP + - RRSIG + - RT + - SIG + - SINK + - SMIMEA + - SOA + - SPF + - SRV + - SSHFP + - SVCB + - TA + - TALINK + - TKEY + - TLSA + - TSIG + - TXT + - UINFO + - UID + - UNSPEC + - URI + - WKS + - X25 + - ZONEMD + nullable: true + type: string + type: array + explode: true + - description: Filters results by DNS response code. + in: query + name: responseCode + schema: + description: Filters results by DNS response code. + items: + enum: + - NOERROR + - FORMERR + - SERVFAIL + - NXDOMAIN + - NOTIMP + - REFUSED + - YXDOMAIN + - YXRRSET + - NXRRSET + - NOTAUTH + - NOTZONE + - BADSIG + - BADKEY + - BADTIME + - BADMODE + - BADNAME + - BADALG + - BADTRUNC + - BADCOOKIE + type: string + type: array + explode: true + - description: Filters results by DNS response TTL. + in: query + name: responseTtl + schema: + description: Filters results by DNS response TTL. + items: + enum: + - LTE_1M + - GT_1M_LTE_5M + - GT_5M_LTE_15M + - GT_15M_LTE_1H + - GT_1H_LTE_1D + - GT_1D_LTE_1W + - GT_1W + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) support. + in: query + name: dnssec + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) support. + items: + enum: + - INVALID + - INSECURE + - SECURE + - OTHER + type: string + type: array + explode: true + - description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + in: query + name: dnssecAware + schema: + description: Filters results based on DNSSEC (DNS Security Extensions) client awareness. + items: + enum: + - SUPPORTED + - NOT_SUPPORTED + type: string + type: array + explode: true + - description: Filters results based on DNSSEC-validated answers by end-to-end security status. + in: query + name: dnssecE2e + schema: + description: Filters results based on DNSSEC-validated answers by end-to-end security status. + items: + type: boolean + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results based on whether the queries have a matching answer. + in: query + name: matchingAnswer + schema: + description: Filters results based on whether the queries have a matching answer. + items: + type: boolean + type: array + explode: true + - description: Filters results by top-level domain. + in: query + name: tld + schema: + description: Filters results by top-level domain. + items: + maxLength: 63 + minLength: 2 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by DNS queries + tags: + - Radar DNS + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - dns + - top + method: locations + /radar/email/routing/summary/arc: + get: + deprecated: true + description: Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation. + operationId: radar-get-email-routing-summary-by-arc + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email ARC validation summary + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - summary + method: arc + /radar/email/routing/summary/dkim: + get: + deprecated: true + description: Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation. + operationId: radar-get-email-routing-summary-by-dkim + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DKIM validation summary + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - summary + method: dkim + /radar/email/routing/summary/dmarc: + get: + deprecated: true + description: Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation. + operationId: radar-get-email-routing-summary-by-dmarc + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DMARC validation summary + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - summary + method: dmarc + /radar/email/routing/summary/encrypted: + get: + deprecated: true + description: Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted). + operationId: radar-get-email-routing-summary-by-encrypted + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + ENCRYPTED: + description: A numeric string. + type: string + NOT_ENCRYPTED: + description: A numeric string. + type: string + required: + - ENCRYPTED + - NOT_ENCRYPTED + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email encryption status summary + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - summary + method: encrypted + /radar/email/routing/summary/ip_version: + get: + deprecated: true + description: Retrieves the distribution of emails by IP version. + operationId: radar-get-email-routing-summary-by-ip-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef8b383e904d9fb02521257ef9cc77d297' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email IP version summary + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - summary + method: ip_version + /radar/email/routing/summary/spf: + get: + deprecated: true + description: Retrieves the distribution of emails by SPF (Sender Policy Framework) validation. + operationId: radar-get-email-routing-summary-by-spf + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email SPF validation summary + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - summary + method: spf + /radar/email/routing/summary/{dimension}: + get: + description: Retrieves the distribution of email routing metrics by the specified dimension. + operationId: radar-get-email-routing-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - IP_VERSION + - ENCRYPTED + - ARC + - DKIM + - DMARC + - SPF + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email routing summary by dimension + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + method: summary_v2 + /radar/email/routing/timeseries_groups/arc: + get: + deprecated: true + description: Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time. + operationId: radar-get-email-routing-timeseries-group-by-arc + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email ARC validation time series + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - timeseries_groups + method: arc + /radar/email/routing/timeseries_groups/dkim: + get: + deprecated: true + description: Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time. + operationId: radar-get-email-routing-timeseries-group-by-dkim + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DKIM validation time series + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - timeseries_groups + method: dkim + /radar/email/routing/timeseries_groups/dmarc: + get: + deprecated: true + description: Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time. + operationId: radar-get-email-routing-timeseries-group-by-dmarc + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DMARC validation time series + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - timeseries_groups + method: dmarc + /radar/email/routing/timeseries_groups/encrypted: + get: + deprecated: true + description: Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted) over time. + operationId: radar-get-email-routing-timeseries-group-by-encrypted + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + ENCRYPTED: + items: + description: A numeric string. + type: string + type: array + NOT_ENCRYPTED: + items: + description: A numeric string. + type: string + type: array + required: + - ENCRYPTED + - NOT_ENCRYPTED + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email encryption status time series + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - timeseries_groups + method: encrypted + /radar/email/routing/timeseries_groups/ip_version: + get: + deprecated: true + description: Retrieves the distribution of emails by IP version over time. + operationId: radar-get-email-routing-timeseries-group-by-ip-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + IPv4: + items: + description: A numeric string. + type: string + type: array + IPv6: + items: + description: A numeric string. + type: string + type: array + required: + - IPv4 + - IPv6 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email IP version time series + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - timeseries_groups + method: ip_version + /radar/email/routing/timeseries_groups/spf: + get: + deprecated: true + description: Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time. + operationId: radar-get-email-routing-timeseries-group-by-spf + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email SPF validation time series + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + - timeseries_groups + method: spf + /radar/email/routing/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of email routing metrics grouped by dimension over time. + operationId: radar-get-email-routing-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - IP_VERSION + - ENCRYPTED + - ARC + - DKIM + - DMARC + - SPF + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by encryption status (encrypted vs. not-encrypted). + in: query + name: encrypted + schema: + description: Filters results by encryption status (encrypted vs. not-encrypted). + items: + enum: + - ENCRYPTED + - NOT_ENCRYPTED + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email routing time series grouped by dimension + tags: + - Radar Email Routing + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - routing + method: timeseries_groups_v2 + /radar/email/security/summary/arc: + get: + deprecated: true + description: Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation. + operationId: radar-get-email-security-summary-by-arc + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email ARC validation summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: arc + /radar/email/security/summary/dkim: + get: + deprecated: true + description: Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation. + operationId: radar-get-email-security-summary-by-dkim + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DKIM validation summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: dkim + /radar/email/security/summary/dmarc: + get: + deprecated: true + description: Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation. + operationId: radar-get-email-security-summary-by-dmarc + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DMARC validation summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: dmarc + /radar/email/security/summary/malicious: + get: + deprecated: true + description: Retrieves the distribution of emails by malicious classification. + operationId: radar-get-email-security-summary-by-malicious + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + MALICIOUS: + description: A numeric string. + type: string + NOT_MALICIOUS: + description: A numeric string. + type: string + required: + - MALICIOUS + - NOT_MALICIOUS + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email malicious classification summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: malicious + /radar/email/security/summary/spam: + get: + deprecated: true + description: Retrieves the proportion of emails by spam classification (spam vs. non-spam). + operationId: radar-get-email-security-summary-by-spam + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NOT_SPAM: + description: A numeric string. + type: string + SPAM: + description: A numeric string. + type: string + required: + - SPAM + - NOT_SPAM + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email spam classification summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: spam + /radar/email/security/summary/spf: + get: + deprecated: true + description: Retrieves the distribution of emails by SPF (Sender Policy Framework) validation. + operationId: radar-get-email-security-summary-by-spf + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef853c157ad369010995e35be614e0343f' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email SPF validation summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: spf + /radar/email/security/summary/spoof: + get: + deprecated: true + description: Retrieves the proportion of emails by spoof classification (spoof vs. non-spoof). + operationId: radar-get-email-security-summary-by-spoof + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NOT_SPOOF: + description: A numeric string. + type: string + SPOOF: + description: A numeric string. + type: string + required: + - SPOOF + - NOT_SPOOF + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email spoof classification summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: spoof + /radar/email/security/summary/threat_category: + get: + deprecated: true + description: Retrieves the distribution of emails by threat categories. + operationId: radar-get-email-security-summary-by-threat-category + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + BrandImpersonation: + description: A numeric string. + type: string + CredentialHarvester: + description: A numeric string. + type: string + IdentityDeception: + description: A numeric string. + type: string + Link: + description: A numeric string. + type: string + required: + - IdentityDeception + - Link + - BrandImpersonation + - CredentialHarvester + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email threat category summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: threat_category + /radar/email/security/summary/tls_version: + get: + deprecated: true + description: Retrieves the distribution of emails by TLS version. + operationId: radar-get-email-security-summary-by-tls-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + TLS 1.0: + description: A numeric string. + type: string + TLS 1.1: + description: A numeric string. + type: string + TLS 1.2: + description: A numeric string. + type: string + TLS 1.3: + description: A numeric string. + type: string + required: + - TLS 1.0 + - TLS 1.1 + - TLS 1.2 + - TLS 1.3 + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email TLS version summary + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - summary + method: tls_version + /radar/email/security/summary/{dimension}: + get: + description: Retrieves the distribution of email security metrics by the specified dimension. + operationId: radar-get-email-security-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - SPAM + - MALICIOUS + - SPOOF + - THREAT_CATEGORY + - ARC + - DKIM + - DMARC + - SPF + - TLS_VERSION + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email security summary by dimension + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + method: summary_v2 + /radar/email/security/timeseries_groups/arc: + get: + deprecated: true + description: Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time. + operationId: radar-get-email-security-timeseries-group-by-arc + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email ARC validation time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: arc + /radar/email/security/timeseries_groups/dkim: + get: + deprecated: true + description: Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time. + operationId: radar-get-email-security-timeseries-group-by-dkim + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DKIM validation time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: dkim + /radar/email/security/timeseries_groups/dmarc: + get: + deprecated: true + description: Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time. + operationId: radar-get-email-security-timeseries-group-by-dmarc + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email DMARC validation time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: dmarc + /radar/email/security/timeseries_groups/malicious: + get: + deprecated: true + description: Retrieves the distribution of emails by malicious classification over time. + operationId: radar-get-email-security-timeseries-group-by-malicious + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + MALICIOUS: + items: + description: A numeric string. + type: string + type: array + NOT_MALICIOUS: + items: + description: A numeric string. + type: string + type: array + required: + - MALICIOUS + - NOT_MALICIOUS + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email malicious classification time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: malicious + /radar/email/security/timeseries_groups/spam: + get: + deprecated: true + description: Retrieves the distribution of emails by spam classification (spam vs. non-spam) over time. + operationId: radar-get-email-security-timeseries-group-by-spam + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NOT_SPAM: + items: + description: A numeric string. + type: string + type: array + SPAM: + items: + description: A numeric string. + type: string + type: array + required: + - SPAM + - NOT_SPAM + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email spam classification time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: spam + /radar/email/security/timeseries_groups/spf: + get: + deprecated: true + description: Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time. + operationId: radar-get-email-security-timeseries-group-by-spf + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef67c73d4742566cab0909f71b1822e88c' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email SPF validation time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: spf + /radar/email/security/timeseries_groups/spoof: + get: + deprecated: true + description: Retrieves the distribution of emails by spoof classification (spoof vs. non-spoof) over time. + operationId: radar-get-email-security-timeseries-group-by-spoof + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NOT_SPOOF: + items: + description: A numeric string. + type: string + type: array + SPOOF: + items: + description: A numeric string. + type: string + type: array + required: + - SPOOF + - NOT_SPOOF + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email spoof classification time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: spoof + /radar/email/security/timeseries_groups/threat_category: + get: + deprecated: true + description: Retrieves the distribution of emails by threat category over time. + operationId: radar-get-email-security-timeseries-group-by-threat-category + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + BrandImpersonation: + items: + description: A numeric string. + type: string + type: array + CredentialHarvester: + items: + description: A numeric string. + type: string + type: array + IdentityDeception: + items: + description: A numeric string. + type: string + type: array + Link: + items: + description: A numeric string. + type: string + type: array + required: + - IdentityDeception + - Link + - BrandImpersonation + - CredentialHarvester + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email threat category time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: threat_category + /radar/email/security/timeseries_groups/tls_version: + get: + deprecated: true + description: Retrieves the distribution of emails by TLS version over time. + operationId: radar-get-email-security-timeseries-group-by-tls-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + TLS 1.0: + items: + description: A numeric string. + type: string + type: array + TLS 1.1: + items: + description: A numeric string. + type: string + type: array + TLS 1.2: + items: + description: A numeric string. + type: string + type: array + TLS 1.3: + items: + description: A numeric string. + type: string + type: array + required: + - TLS 1.0 + - TLS 1.1 + - TLS 1.2 + - TLS 1.3 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email TLS version time series + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - timeseries_groups + method: tls_version + /radar/email/security/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of email security metrics grouped by dimension over time. + operationId: radar-get-email-security-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - SPAM + - MALICIOUS + - SPOOF + - THREAT_CATEGORY + - ARC + - DKIM + - DMARC + - SPF + - TLS_VERSION + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get email security time series grouped by dimension + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + method: timeseries_groups_v2 + /radar/email/security/top/tlds: + get: + description: Retrieves the top TLDs by number of email messages. + operationId: radar-get-email-security-top-tlds-by-messages + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Filters results by TLD category. + in: query + name: tldCategory + schema: + description: Filters results by TLD category. + enum: + - CLASSIC + - COUNTRY + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + description: A numeric string. + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top TLDs by email message volume + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - top + - tlds + method: get + /radar/email/security/top/tlds/malicious/{malicious}: + get: + description: Retrieves the top TLDs by emails classified as malicious or not. + operationId: radar-get-email-security-top-tlds-by-malicious + parameters: + - description: Malicious classification. + in: path + name: malicious + schema: + description: Malicious classification. + enum: + - MALICIOUS + - NOT_MALICIOUS + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Filters results by TLD category. + in: query + name: tldCategory + schema: + description: Filters results by TLD category. + enum: + - CLASSIC + - COUNTRY + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + description: A numeric string. + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top TLDs by email malicious classification + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - top + - tlds + - malicious + method: get + /radar/email/security/top/tlds/spam/{spam}: + get: + description: Retrieves the top TLDs by emails classified as spam or not. + operationId: radar-get-email-security-top-tlds-by-spam + parameters: + - description: Spam classification. + in: path + name: spam + schema: + description: Spam classification. + enum: + - SPAM + - NOT_SPAM + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Filters results by TLD category. + in: query + name: tldCategory + schema: + description: Filters results by TLD category. + enum: + - CLASSIC + - COUNTRY + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + description: A numeric string. + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top TLDs by email spam classification + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - top + - tlds + - spam + method: get + /radar/email/security/top/tlds/spoof/{spoof}: + get: + description: Retrieves the top TLDs by emails classified as spoof or not. + operationId: radar-get-email-security-top-tlds-by-spoof + parameters: + - description: Spoof classification. + in: path + name: spoof + schema: + description: Spoof classification. + enum: + - SPOOF + - NOT_SPOOF + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by ARC (Authenticated Received Chain) validation. + in: query + name: arc + schema: + description: Filters results by ARC (Authenticated Received Chain) validation. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + in: query + name: dkim + schema: + description: Filters results by DKIM (DomainKeys Identified Mail) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + in: query + name: dmarc + schema: + description: Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by SPF (Sender Policy Framework) validation status. + in: query + name: spf + schema: + description: Filters results by SPF (Sender Policy Framework) validation status. + items: + enum: + - PASS + - NONE + - FAIL + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + type: string + type: array + explode: true + - description: Filters results by TLD category. + in: query + name: tldCategory + schema: + description: Filters results by TLD category. + enum: + - CLASSIC + - COUNTRY + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + description: A numeric string. + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top TLDs by email spoof classification + tags: + - Radar Email Security + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - email + - security + - top + - tlds + - spoof + method: get + /radar/entities/asns: + get: + description: Retrieves a list of autonomous systems. + operationId: radar-get-entities-asn-list + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. + type: string + - description: Filters results by location. Specify an alpha-2 location code. + in: query + name: location + schema: + description: Filters results by location. Specify an alpha-2 location code. + maxLength: 2 + minLength: 2 + type: string + - description: Specifies the metric to order the ASNs by. + in: query + name: orderBy + schema: + default: ASN + description: Specifies the metric to order the ASNs by. + enum: + - ASN + - POPULATION + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asns: + items: + properties: + aka: + type: string + asn: + type: integer + country: + type: string + countryName: + type: string + name: + type: string + orgName: + type: string + website: + type: string + required: + - name + - asn + - country + - countryName + type: object + type: array + required: + - asns + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List autonomous systems + tags: + - Radar Autonomous Systems + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - asns + method: list + /radar/entities/asns/botnet_threat_feed: + get: + description: Retrieves a ranked list of Autonomous Systems based on their presence in the Cloudflare Botnet Threat Feed. Rankings can be sorted by offense count or number of bad IPs. Optionally compare to a previous date to see rank changes. + operationId: radar-get-as-botnet-threat-feed + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Metric to rank ASNs by. + in: query + name: metric + schema: + default: NUMBER_OF_OFFENDING_IPS + description: Metric to rank ASNs by. + enum: + - OFFENSE_COUNT + - NUMBER_OF_OFFENDING_IPS + type: string + - description: 'The date to retrieve (YYYY-MM-DD format). If not specified, returns the most recent available data. Note: This is the date the report was generated. The report is generated from information collected from the previous day (e.g., the 2026-02-23 entry contains data from 2026-02-22).' + in: query + name: date + schema: + description: 'The date to retrieve (YYYY-MM-DD format). If not specified, returns the most recent available data. Note: This is the date the report was generated. The report is generated from information collected from the previous day (e.g., the 2026-02-23 entry contains data from 2026-02-22).' + format: date + type: string + - description: Relative date range for rank change comparison (e.g., "1d", "7d", "30d"). + in: query + name: compareDateRange + schema: + description: Relative date range for rank change comparison (e.g., "1d", "7d", "30d"). + type: string + - description: Filters results by location. Specify an alpha-2 location code. + in: query + name: location + schema: + description: Filters results by location. Specify an alpha-2 location code. + maxLength: 2 + minLength: 2 + type: string + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Sort order. + in: query + name: sortOrder + schema: + description: Sort order. + enum: + - ASC + - DESC + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ases: + items: + properties: + asn: + type: integer + country: + type: string + name: + type: string + rank: + type: integer + rankChange: + type: integer + required: + - asn + - name + - country + - rank + type: object + type: array + meta: + properties: + compareDate: + type: string + date: + type: string + total: + type: integer + required: + - date + - total + type: object + required: + - ases + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS rankings by botnet threat feed activity + tags: + - Radar Autonomous Systems + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - asns + method: botnet_threat_feed + /radar/entities/asns/ip: + get: + description: Retrieves the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). + operationId: radar-get-entities-asn-by-ip + parameters: + - description: IP address. + in: query + name: ip + schema: + description: IP address. + format: ip + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asn: + properties: + aka: + type: string + asn: + type: integer + country: + type: string + countryName: + type: string + estimatedUsers: + properties: + estimatedUsers: + description: Total estimated users. + type: integer + locations: + items: + properties: + estimatedUsers: + description: Estimated users per location. + type: integer + locationAlpha2: + type: string + locationName: + type: string + required: + - locationName + - locationAlpha2 + type: object + type: array + required: + - locations + type: object + name: + type: string + orgName: + type: string + related: + items: + properties: + aka: + type: string + asn: + type: integer + estimatedUsers: + description: Total estimated users. + type: integer + name: + type: string + required: + - name + - asn + type: object + type: array + source: + description: Regional Internet Registry. + type: string + website: + type: string + required: + - name + - country + - countryName + - related + - asn + - website + - orgName + - source + - estimatedUsers + type: object + required: + - asn + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS details by IP address + tags: + - Radar Autonomous Systems + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - asns + method: ip + /radar/entities/asns/{asn}: + get: + description: Retrieves the requested autonomous system information. (A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). + operationId: radar-get-entities-asn-by-id + parameters: + - description: Single Autonomous System Number (ASN) as integer. + in: path + name: asn + schema: + description: Single Autonomous System Number (ASN) as integer. + type: integer + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + asn: + properties: + aka: + type: string + asn: + type: integer + confidenceLevel: + type: integer + country: + type: string + countryName: + type: string + estimatedUsers: + properties: + estimatedUsers: + description: Total estimated users. + type: integer + locations: + items: + properties: + estimatedUsers: + description: Estimated users per location. + type: integer + locationAlpha2: + type: string + locationName: + type: string + required: + - locationName + - locationAlpha2 + type: object + type: array + required: + - locations + type: object + name: + type: string + orgName: + type: string + related: + items: + properties: + aka: + type: string + asn: + type: integer + estimatedUsers: + description: Total estimated users. + type: integer + name: + type: string + required: + - name + - asn + type: object + type: array + source: + description: Regional Internet Registry. + type: string + website: + type: string + required: + - name + - country + - countryName + - confidenceLevel + - related + - source + - asn + - website + - orgName + - estimatedUsers + type: object + required: + - asn + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS details by ASN + tags: + - Radar Autonomous Systems + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - asns + method: get + /radar/entities/asns/{asn}/as_set: + get: + description: Retrieves Internet Routing Registry AS-SETs that an AS is a member of. + operationId: radar-get-asns-as-set + parameters: + - description: Retrieves all AS-SETs that the given AS is a member of. + in: path + name: asn + schema: + description: Retrieves all AS-SETs that the given AS is a member of. + type: integer + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + as_sets: + items: + properties: + as_members_count: + description: The number of AS members in the AS-SET + type: integer + as_set_members_count: + description: The number of AS-SET members in the AS-SET + type: integer + as_set_upstreams_count: + description: The number of recursive upstream AS-SETs + type: integer + asn_cone_size: + description: The number of unique ASNs in the AS-SETs recursive downstream + type: integer + hierarchical_asn: + description: The AS number following hierarchical AS-SET name + type: integer + inferred_asn: + description: The inferred AS number of the AS-SET + type: integer + irr_sources: + description: The IRR sources of the AS-SET + items: + type: string + type: array + name: + description: The name of the AS-SET + type: string + peeringdb_asn: + description: The AS number matching PeeringDB record + type: integer + required: + - name + - as_members_count + - as_set_members_count + - irr_sources + - asn_cone_size + - as_set_upstreams_count + type: object + type: array + paths: + description: Paths from the AS-SET that include the given AS to its upstreams recursively + items: + items: + type: string + type: array + type: array + required: + - as_sets + - paths + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get IRR AS-SETs that an AS is a member of + tags: + - Radar Autonomous Systems + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - asns + method: as_set + /radar/entities/asns/{asn}/rel: + get: + description: Retrieves AS-level relationship for given networks. + operationId: radar-get-asns-rel + parameters: + - description: Retrieves all ASNs with provider-customer or peering relationships with the given ASN. + in: path + name: asn + schema: + description: Retrieves all ASNs with provider-customer or peering relationships with the given ASN. + type: integer + required: true + - description: Retrieves the AS relationship of ASN2 with respect to the given ASN. + in: query + name: asn2 + schema: + description: Retrieves the AS relationship of ASN2 with respect to the given ASN. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + $ref: '#/components/schemas/unnamedSchemaRefC5858f1f916a921846e0b6159af470a7' + rels: + items: + properties: + asn1: + type: integer + asn1_country: + type: string + asn1_name: + type: string + asn2: + type: integer + asn2_country: + type: string + asn2_name: + type: string + rel: + type: string + required: + - asn1 + - asn1_country + - asn1_name + - asn2 + - asn2_country + - asn2_name + - rel + type: object + type: array + required: + - rels + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get AS-level relationships by ASN + tags: + - Radar Autonomous Systems + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - asns + method: rel + /radar/entities/ip: + get: + description: Retrieves IP address information. + operationId: radar-get-entities-ip + parameters: + - description: IP address. + in: query + name: ip + schema: + description: IP address. + format: ip + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + ip: + properties: + asn: + type: string + asnLocation: + type: string + asnName: + type: string + asnOrgName: + type: string + ip: + type: string + ipVersion: + type: string + location: + type: string + locationName: + type: string + required: + - ip + - ipVersion + - location + - locationName + - asn + - asnName + - asnLocation + - asnOrgName + type: object + required: + - ip + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get IP address details + tags: + - Radar IP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + method: get + /radar/entities/locations: + get: + description: Retrieves a list of locations. + operationId: radar-get-entities-locations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + type: string + - description: Filters results by region. + in: query + name: region + schema: + description: Filters results by region. + maxLength: 100 + type: string + - description: Filters results by subregion. + in: query + name: subregion + schema: + description: Filters results by subregion. + maxLength: 100 + type: string + - description: Filters results by continent code. + in: query + name: continent + schema: + description: Filters results by continent code. + enum: + - AF + - AS + - EU + - NA + - OC + - SA + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + locations: + items: + properties: + alpha2: + type: string + continent: + type: string + latitude: + description: A numeric string. + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + region: + type: string + subregion: + type: string + required: + - name + - region + - subregion + - continent + - latitude + - longitude + - alpha2 + type: object + type: array + required: + - locations + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List locations + tags: + - Radar Locations + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - locations + method: list + /radar/entities/locations/{location}: + get: + description: Retrieves the requested location information. (A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location). + operationId: radar-get-entities-location-by-alpha2 + parameters: + - description: Location alpha-2 code. + in: path + name: location + schema: + description: Location alpha-2 code. + maxLength: 2 + minLength: 2 + type: string + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + location: + properties: + alpha2: + type: string + confidenceLevel: + type: integer + continent: + type: string + latitude: + description: A numeric string. + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + region: + type: string + subregion: + type: string + required: + - name + - region + - subregion + - continent + - latitude + - longitude + - alpha2 + - confidenceLevel + type: object + required: + - location + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get location details + tags: + - Radar Locations + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - entities + - locations + method: get + /radar/geolocations: + get: + description: 'Retrieves a list of geolocations. Geolocation names can be localized by sending an `Accept-Language` HTTP header with a BCP 47 language tag (e.g., `Accept-Language: pt-PT`). The full quality-value chain is supported (e.g., `pt-PT,pt;q=0.9,en;q=0.8`).' + operationId: radar-get-geolocations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by geolocation. Specify a comma-separated list of GeoNames IDs. + in: query + name: geoId + schema: + description: Filters results by geolocation. Specify a comma-separated list of GeoNames IDs. + type: string + - description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + geolocations: + items: + properties: + code: + type: string + geoId: + type: string + latitude: + description: A numeric string. + type: string + locale: + description: BCP 47 locale code used for the geolocation name translation + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + parent: + properties: + code: + type: string + geoId: + type: string + latitude: + description: A numeric string. + type: string + locale: + description: BCP 47 locale code used for the geolocation name translation + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + parent: + properties: + code: + type: string + geoId: + type: string + latitude: + description: A numeric string. + type: string + locale: + description: BCP 47 locale code used for the geolocation name translation + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + type: + description: The type of the geolocation. + enum: + - CONTINENT + - COUNTRY + - ADM1 + type: string + required: + - geoId + - name + - type + - latitude + - longitude + type: object + type: + description: The type of the geolocation. + enum: + - CONTINENT + - COUNTRY + - ADM1 + type: string + required: + - geoId + - name + - type + - latitude + - longitude + - parent + type: object + type: + description: The type of the geolocation. + enum: + - CONTINENT + - COUNTRY + - ADM1 + type: string + required: + - geoId + - name + - type + - latitude + - longitude + - parent + type: object + type: array + required: + - geolocations + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Geolocations + tags: + - Radar Geolocations + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - geolocations + method: list + /radar/geolocations/{geo_id}: + get: + description: 'Retrieves the requested Geolocation information. Geolocation names can be localized by sending an `Accept-Language` HTTP header with a BCP 47 language tag (e.g., `Accept-Language: pt-PT`). The full quality-value chain is supported (e.g., `pt-PT,pt;q=0.9,en;q=0.8`).' + operationId: radar-get-geolocation-details + parameters: + - description: Geolocation ID. Refer to [GeoNames](https://download.geonames.org/export/dump/readme.txt) + in: path + name: geo_id + schema: + description: Geolocation ID. Refer to [GeoNames](https://download.geonames.org/export/dump/readme.txt) + maxLength: 100 + type: string + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + geolocation: + properties: + code: + type: string + geoId: + type: string + latitude: + description: A numeric string. + type: string + locale: + description: BCP 47 locale code used for the geolocation name translation + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + parent: + properties: + code: + type: string + geoId: + type: string + latitude: + description: A numeric string. + type: string + locale: + description: BCP 47 locale code used for the geolocation name translation + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + parent: + properties: + code: + type: string + geoId: + type: string + latitude: + description: A numeric string. + type: string + locale: + description: BCP 47 locale code used for the geolocation name translation + type: string + longitude: + description: A numeric string. + type: string + name: + type: string + type: + description: The type of the geolocation. + enum: + - CONTINENT + - COUNTRY + - ADM1 + type: string + required: + - geoId + - name + - type + - latitude + - longitude + type: object + type: + description: The type of the geolocation. + enum: + - CONTINENT + - COUNTRY + - ADM1 + type: string + required: + - geoId + - name + - type + - latitude + - longitude + - parent + type: object + type: + description: The type of the geolocation. + enum: + - CONTINENT + - COUNTRY + - ADM1 + type: string + required: + - geoId + - name + - type + - latitude + - longitude + - parent + type: object + required: + - geolocation + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Geolocation details + tags: + - Radar Geolocations + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - geolocations + method: get + /radar/http/summary/bot_class: + get: + deprecated: true + description: Retrieves the distribution of bot-generated HTTP requests to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information. + operationId: radar-get-http-summary-by-bot-class + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + bot: + description: A numeric string. + type: string + human: + description: A numeric string. + type: string + required: + - human + - bot + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by bot class summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: bot_class + /radar/http/summary/device_type: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests generated by mobile, desktop, and other types of devices. + operationId: radar-get-http-summary-by-device-type + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + desktop: + description: A numeric string. + type: string + mobile: + description: A numeric string. + type: string + other: + description: A numeric string. + type: string + required: + - desktop + - mobile + - other + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by device type summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: device_type + /radar/http/summary/http_protocol: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS). + operationId: radar-get-http-summary-by-http-protocol + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + http: + description: A numeric string. + type: string + https: + description: A numeric string. + type: string + required: + - http + - https + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by HTTP/HTTPS summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: http_protocol + /radar/http/summary/http_version: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by HTTP version. + operationId: radar-get-http-summary-by-http-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + HTTP/1.x: + description: A numeric string. + type: string + HTTP/2: + description: A numeric string. + type: string + HTTP/3: + description: A numeric string. + type: string + required: + - HTTP/1.x + - HTTP/2 + - HTTP/3 + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by HTTP version summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: http_version + /radar/http/summary/ip_version: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by IP version. + operationId: radar-get-http-summary-by-ip-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + $ref: '#/components/schemas/unnamedSchemaRef8b383e904d9fb02521257ef9cc77d297' + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by IP version summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: ip_version + /radar/http/summary/os: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by operating system (Windows, macOS, Android, iOS, and others). + operationId: radar-get-http-summary-by-operating-system + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + ANDROID: + description: A numeric string. + type: string + IOS: + description: A numeric string. + type: string + required: + - ANDROID + - IOS + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by OS summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: os + /radar/http/summary/post_quantum: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by post-quantum support. + operationId: radar-get-http-summary-by-post-quantum + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + NOT_SUPPORTED: + description: A numeric string. + type: string + SUPPORTED: + description: A numeric string. + type: string + required: + - SUPPORTED + - NOT_SUPPORTED + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by post-quantum support summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: post_quantum + /radar/http/summary/tls_version: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by TLS version. + operationId: radar-get-http-summary-by-tls-version + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + TLS 1.0: + description: A numeric string. + type: string + TLS 1.1: + description: A numeric string. + type: string + TLS 1.2: + description: A numeric string. + type: string + TLS 1.3: + description: A numeric string. + type: string + TLS QUIC: + description: A numeric string. + type: string + required: + - TLS 1.0 + - TLS 1.1 + - TLS 1.2 + - TLS 1.3 + - TLS QUIC + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by TLS version summary + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - summary + method: tls_version + /radar/http/summary/{dimension}: + get: + description: Retrieves the distribution of HTTP requests by the specified dimension. + operationId: radar-get-http-summary + parameters: + - description: Specifies the HTTP attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the HTTP attribute by which to group the results. + enum: + - ADM1 + - AS + - BOT_CLASS + - BROWSER + - BROWSER_FAMILY + - DEVICE_TYPE + - HTTP_PROTOCOL + - HTTP_VERSION + - IP_VERSION + - LOCATION + - OS + - POST_QUANTUM + - TLS_VERSION + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests summary by dimension + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + method: summary_v2 + /radar/http/timeseries: + get: + description: Retrieves the HTTP requests over time. + operationId: radar-get-http-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE_CHANGE + - MIN0_MAX + type: string + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + method: timeseries + /radar/http/timeseries_groups/bot_class: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests classified as automated or human over time. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information. + operationId: radar-get-http-timeseries-group-by-bot-class + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + bot: + items: + description: A numeric string. + type: string + type: array + human: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - human + - bot + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by bot class time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: bot_class + /radar/http/timeseries_groups/browser: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by user agent over time. + operationId: radar-get-http-timeseries-group-by-browsers + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by user agent time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: browser + /radar/http/timeseries_groups/browser_family: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by user agent family over time. + operationId: radar-get-http-timeseries-group-by-browser-families + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by user agent family time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: browser_family + /radar/http/timeseries_groups/device_type: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by device type over time. + operationId: radar-get-http-timeseries-group-by-device-type + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + desktop: + items: + description: A numeric string. + type: string + type: array + mobile: + items: + description: A numeric string. + type: string + type: array + other: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - desktop + - mobile + - other + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by device type time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: device_type + /radar/http/timeseries_groups/http_protocol: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS) over time. + operationId: radar-get-http-timeseries-group-by-http-protocol + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + http: + items: + description: A numeric string. + type: string + type: array + https: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - http + - https + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by HTTP/HTTPS time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: http_protocol + /radar/http/timeseries_groups/http_version: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by HTTP version over time. + operationId: radar-get-http-timeseries-group-by-http-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + HTTP/1.x: + items: + description: A numeric string. + type: string + type: array + HTTP/2: + items: + description: A numeric string. + type: string + type: array + HTTP/3: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - HTTP/1.x + - HTTP/2 + - HTTP/3 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by HTTP version time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: http_version + /radar/http/timeseries_groups/ip_version: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by IP version over time. + operationId: radar-get-http-timeseries-group-by-ip-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef9002274ed7cb7f3dc567421e31529a3a' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by IP version time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: ip_version + /radar/http/timeseries_groups/os: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by operating system over time. + operationId: radar-get-http-timeseries-group-by-operating-system + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by OS time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: os + /radar/http/timeseries_groups/post_quantum: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by post-quantum support over time. + operationId: radar-get-http-timeseries-group-by-post-quantum + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + NOT_SUPPORTED: + items: + description: A numeric string. + type: string + type: array + SUPPORTED: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - SUPPORTED + - NOT_SUPPORTED + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by post-quantum support time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: post_quantum + /radar/http/timeseries_groups/tls_version: + get: + deprecated: true + description: Retrieves the distribution of HTTP requests by TLS version over time. + operationId: radar-get-http-timeseries-group-by-tls-version + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + TLS 1.0: + items: + description: A numeric string. + type: string + type: array + TLS 1.1: + items: + description: A numeric string. + type: string + type: array + TLS 1.2: + items: + description: A numeric string. + type: string + type: array + TLS 1.3: + items: + description: A numeric string. + type: string + type: array + TLS QUIC: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - TLS 1.0 + - TLS 1.1 + - TLS 1.2 + - TLS 1.3 + - TLS QUIC + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests by TLS version time series + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - timeseries_groups + method: tls_version + /radar/http/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of HTTP requests grouped by dimension. + operationId: radar-get-http-timeseries-group + parameters: + - description: Specifies the HTTP attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the HTTP attribute by which to group the results. + enum: + - ADM1 + - AS + - BOT_CLASS + - BROWSER + - BROWSER_FAMILY + - DEVICE_TYPE + - HTTP_PROTOCOL + - HTTP_VERSION + - IP_VERSION + - LOCATION + - OS + - POST_QUANTUM + - TLS_VERSION + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP requests time series grouped by dimension + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + method: timeseries_groups_v2 + /radar/http/top/ases: + get: + description: Retrieves the top autonomous systems by HTTP requests. + operationId: radar-get-http-top-ases-by-http-requests + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + method: get + /radar/http/top/ases/bot_class/{bot_class}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested bot class. + operationId: radar-get-http-top-ases-by-bot-class + parameters: + - description: Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: path + name: bot_class + schema: + description: Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for a bot class + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - bot_class + method: get + /radar/http/top/ases/browser_family/{browser_family}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested browser family. + operationId: radar-get-http-top-ases-by-browser-family + parameters: + - description: Browser family. + in: path + name: browser_family + schema: + description: Browser family. + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for a browser family + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - browser_family + method: get + /radar/http/top/ases/device_type/{device_type}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested device type. + operationId: radar-get-http-top-ases-by-device-type + parameters: + - description: Device type. + in: path + name: device_type + schema: + description: Device type. + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for a device type + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - device_type + method: get + /radar/http/top/ases/http_protocol/{http_protocol}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP protocol. + operationId: radar-get-http-top-ases-by-http-protocol + parameters: + - description: HTTP protocol (HTTP vs. HTTPS). + in: path + name: http_protocol + schema: + description: HTTP protocol (HTTP vs. HTTPS). + enum: + - HTTP + - HTTPS + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for an HTTP protocol + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - http_protocol + method: get + /radar/http/top/ases/http_version/{http_version}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP version. + operationId: radar-get-http-top-ases-by-http-version + parameters: + - description: HTTP version. + in: path + name: http_version + schema: + description: HTTP version. + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for an HTTP version + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - http_method + method: get + /radar/http/top/ases/ip_version/{ip_version}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested IP version. + operationId: radar-get-http-top-ases-by-ip-version + parameters: + - description: IP version. + in: path + name: ip_version + schema: + description: IP version. + enum: + - IPv4 + - IPv6 + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for an IP version + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - ip_version + method: get + /radar/http/top/ases/os/{os}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested operating system. + operationId: radar-get-http-top-ases-by-operating-system + parameters: + - description: Operating system. + in: path + name: os + schema: + description: Operating system. + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for an OS + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - os + method: get + /radar/http/top/ases/tls_version/{tls_version}: + get: + description: Retrieves the top autonomous systems, by HTTP requests, of the requested TLS protocol version. + operationId: radar-get-http-top-ases-by-tls-version + parameters: + - description: TLS version. + in: path + name: tls_version + schema: + description: TLS version. + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef4124a22436f90127c7fa2c4543219752' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by HTTP requests for a TLS version + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - ases + - tls_version + method: get + /radar/http/top/browser: + get: + deprecated: true + description: Retrieves the top user agents by HTTP requests. + operationId: radar-get-http-top-browsers + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top user agents by HTTP requests + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - top + method: browser + /radar/http/top/browser_family: + get: + deprecated: true + description: Retrieves the top user agents, aggregated in families, by HTTP requests. + operationId: radar-get-http-top-browser-families + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top user agent families by HTTP requests + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - http + - top + method: browser_family + /radar/http/top/locations: + get: + description: Retrieves the top locations by HTTP requests. + operationId: radar-get-http-top-locations-by-http-requests + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + method: get + /radar/http/top/locations/bot_class/{bot_class}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested bot class. + operationId: radar-get-http-top-locations-by-bot-class + parameters: + - description: Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: path + name: bot_class + schema: + description: Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for a bot class + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - bot_class + method: get + /radar/http/top/locations/browser_family/{browser_family}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested browser family. + operationId: radar-get-http-top-locations-by-browser-family + parameters: + - description: Browser family. + in: path + name: browser_family + schema: + description: Browser family. + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for a browser family + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - browser_family + method: get + /radar/http/top/locations/device_type/{device_type}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested device type. + operationId: radar-get-http-top-locations-by-device-type + parameters: + - description: Device type. + in: path + name: device_type + schema: + description: Device type. + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for a device type + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - device_type + method: get + /radar/http/top/locations/http_protocol/{http_protocol}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested HTTP protocol. + operationId: radar-get-http-top-locations-by-http-protocol + parameters: + - description: HTTP protocol (HTTP vs. HTTPS). + in: path + name: http_protocol + schema: + description: HTTP protocol (HTTP vs. HTTPS). + enum: + - HTTP + - HTTPS + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for an HTTP protocol + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - http_protocol + method: get + /radar/http/top/locations/http_version/{http_version}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested HTTP version. + operationId: radar-get-http-top-locations-by-http-version + parameters: + - description: HTTP version. + in: path + name: http_version + schema: + description: HTTP version. + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for an HTTP version + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - http_method + method: get + /radar/http/top/locations/ip_version/{ip_version}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested IP version. + operationId: radar-get-http-top-locations-by-ip-version + parameters: + - description: IP version. + in: path + name: ip_version + schema: + description: IP version. + enum: + - IPv4 + - IPv6 + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for an IP version + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - ip_version + method: get + /radar/http/top/locations/os/{os}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested operating system. + operationId: radar-get-http-top-locations-by-operating-system + parameters: + - description: Operating system. + in: path + name: os + schema: + description: Operating system. + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by TLS version. + in: query + name: tlsVersion + schema: + description: Filters results by TLS version. + items: + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for an OS + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - os + method: get + /radar/http/top/locations/tls_version/{tls_version}: + get: + description: Retrieves the top locations, by HTTP requests, of the requested TLS protocol version. + operationId: radar-get-http-top-locations-by-tls-version + parameters: + - description: TLS version. + in: path + name: tls_version + schema: + description: TLS version. + enum: + - TLSv1_0 + - TLSv1_1 + - TLSv1_2 + - TLSv1_3 + - TLSvQUIC + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by device type. + in: query + name: deviceType + schema: + description: Filters results by device type. + items: + enum: + - DESKTOP + - MOBILE + - OTHER + type: string + type: array + explode: true + - description: Filters results by HTTP protocol (HTTP vs. HTTPS). + in: query + name: httpProtocol + schema: + description: Filters results by HTTP protocol (HTTP vs. HTTPS). + items: + enum: + - HTTP + - HTTPS + type: string + type: array + explode: true + - description: Filters results by HTTP version. + in: query + name: httpVersion + schema: + description: Filters results by HTTP version. + items: + enum: + - HTTPv1 + - HTTPv2 + - HTTPv3 + type: string + type: array + explode: true + - description: Filters results by IP version (Ipv4 vs. IPv6). + in: query + name: ipVersion + schema: + description: Filters results by IP version (Ipv4 vs. IPv6). + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + explode: true + - description: Filters results by operating system. + in: query + name: os + schema: + description: Filters results by operating system. + items: + enum: + - WINDOWS + - MACOSX + - IOS + - ANDROID + - CHROMEOS + - LINUX + - SMART_TV + type: string + type: array + explode: true + - description: Filters results by browser family. + in: query + name: browserFamily + schema: + description: Filters results by browser family. + items: + enum: + - CHROME + - EDGE + - FIREFOX + - SAFARI + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by HTTP requests for a TLS version + tags: + - Radar HTTP + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - http + - locations + - tls_version + method: get + /radar/leaked_credential_checks/summary/bot_class: + get: + deprecated: true + description: Retrieves the distribution of HTTP authentication requests by bot class. + operationId: radar-get-leaked-credential-checks-summary-by-bot-class + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by compromised credential status (clean vs. compromised). + in: query + name: compromised + schema: + description: Filters results by compromised credential status (clean vs. compromised). + items: + enum: + - CLEAN + - COMPROMISED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + bot: + description: A numeric string. + type: string + human: + description: A numeric string. + type: string + required: + - human + - bot + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP authentication requests by bot class summary + tags: + - Radar Leaked Credential Checks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Leaked Credentials Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - leaked_credentials + - summary + method: bot_class + /radar/leaked_credential_checks/summary/compromised: + get: + deprecated: true + description: Retrieves the distribution of HTTP authentication requests by compromised credential status. + operationId: radar-get-leaked-credential-checks-summary-by-compromised + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + CLEAN: + description: A numeric string. + type: string + COMPROMISED: + description: A numeric string. + type: string + required: + - COMPROMISED + - CLEAN + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP authentication requests by compromised credential status summary + tags: + - Radar Leaked Credential Checks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Leaked Credentials Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - leaked_credentials + - summary + method: compromised + /radar/leaked_credential_checks/summary/{dimension}: + get: + description: Retrieves an aggregated summary of HTTP authentication requests grouped by the specified dimension. + operationId: radar-get-leaked-credential-checks-summary + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - COMPROMISED + - BOT_CLASS + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by compromised credential status (clean vs. compromised). + in: query + name: compromised + schema: + description: Filters results by compromised credential status (clean vs. compromised). + items: + enum: + - CLEAN + - COMPROMISED + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP authentication requests distribution by dimension + tags: + - Radar Leaked Credential Checks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - leaked_credentials + method: summary_v2 + /radar/leaked_credential_checks/timeseries_groups/bot_class: + get: + deprecated: true + description: Retrieves the distribution of HTTP authentication requests by bot class over time. + operationId: radar-get-leaked-credential-checks-timeseries-group-by-bot-class + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by compromised credential status (clean vs. compromised). + in: query + name: compromised + schema: + description: Filters results by compromised credential status (clean vs. compromised). + items: + enum: + - CLEAN + - COMPROMISED + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + bot: + items: + description: A numeric string. + type: string + type: array + human: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - human + - bot + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP authentication requests by bot class time series + tags: + - Radar Leaked Credential Checks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Leaked Credentials Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - leaked_credentials + - timeseries_groups + method: bot_class + /radar/leaked_credential_checks/timeseries_groups/compromised: + get: + deprecated: true + description: Retrieves the distribution of HTTP authentication requests by compromised credential status over time. + operationId: radar-get-leaked-credential-checks-timeseries-group-by-compromised + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + CLEAN: + items: + description: A numeric string. + type: string + type: array + COMPROMISED: + items: + description: A numeric string. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - CLEAN + - COMPROMISED + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get HTTP authentication requests by compromised credential status time series + tags: + - Radar Leaked Credential Checks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Leaked Credentials Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/timeseries_groups_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - leaked_credentials + - timeseries_groups + method: compromised + /radar/leaked_credential_checks/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of HTTP authentication requests, grouped by the specified dimension over time. + operationId: radar-get-leaked-credential-checks-timeseries-group + parameters: + - description: Specifies the attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the attribute by which to group the results. + enum: + - COMPROMISED + - BOT_CLASS + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + in: query + name: botClass + schema: + description: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). + items: + enum: + - LIKELY_AUTOMATED + - LIKELY_HUMAN + type: string + type: array + explode: true + - description: Filters results by compromised credential status (clean vs. compromised). + in: query + name: compromised + schema: + description: Filters results by compromised credential status (clean vs. compromised). + items: + enum: + - CLEAN + - COMPROMISED + type: string + type: array + explode: true + - description: Filters results by leaked credential check result. + in: query + name: checkResult + schema: + description: Filters results by leaked credential check result. + items: + enum: + - CLEAN + - USERNAME_LEAKED + - USERNAME_PASSWORD_SIMILAR + - USERNAME_AND_PASSWORD_LEAKED + - PASSWORD_LEAKED + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE_CHANGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get time series distribution of HTTP authentication requests by dimension. + tags: + - Radar Leaked Credential Checks + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - leaked_credentials + method: timeseries_groups_v2 + /radar/netflows/summary: + get: + deprecated: true + description: Retrieves the distribution of network traffic (NetFlows) by HTTP vs other protocols. + operationId: radar-get-netflows-summary-deprecated + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + HTTP: + description: A numeric string. + type: string + OTHER: + description: A numeric string. + type: string + required: + - HTTP + - OTHER + type: object + required: + - meta + - summary_0 + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get network traffic summary + tags: + - Radar NetFlows + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Get Network Traffic Distribution By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/netflows/methods/summary_v2/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - netflows + method: summary + /radar/netflows/summary/{dimension}: + get: + description: Retrieves the distribution of network traffic (NetFlows) by the specified dimension. + operationId: radar-get-netflows-summary + parameters: + - description: Specifies the NetFlows attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the NetFlows attribute by which to group the results. + enum: + - ADM1 + - AS + - LOCATION + - PRODUCT + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Filters the results by network traffic product types. + in: query + name: product + schema: + description: Filters the results by network traffic product types. + items: + enum: + - HTTP + - ALL + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get network traffic distribution by dimension + tags: + - Radar NetFlows + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - netflows + method: summary_v2 + /radar/netflows/timeseries: + get: + description: Retrieves network traffic (NetFlows) over time. + operationId: radar-get-netflows-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters the results by network traffic product types. + in: query + name: product + schema: + description: Filters the results by network traffic product types. + items: + enum: + - HTTP + - ALL + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE_CHANGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef75bae70cf28e6bcef364b9840db3bdeb' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get network traffic time series + tags: + - Radar NetFlows + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - netflows + method: timeseries + /radar/netflows/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of NetFlows traffic, grouped by the specified dimension over time. + operationId: radar-get-netflows-timeseries-group + parameters: + - description: Specifies the NetFlows attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the NetFlows attribute by which to group the results. + enum: + - ADM1 + - AS + - LOCATION + - PRODUCT + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Filters the results by network traffic product types. + in: query + name: product + schema: + description: Filters the results by network traffic product types. + items: + enum: + - HTTP + - ALL + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get time series distribution of network traffic by dimension + tags: + - Radar NetFlows + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - netflows + method: timeseries_groups + /radar/netflows/top/ases: + get: + description: Retrieves the top autonomous systems by network traffic (NetFlows). + operationId: radar-get-netflows-top-ases + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + clientASN: + type: number + clientASName: + type: string + value: + description: A numeric string. + type: string + required: + - clientASN + - clientASName + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by network traffic + tags: + - Radar NetFlows + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - netflows + - top + method: ases + /radar/netflows/top/locations: + get: + description: Retrieves the top locations by network traffic (NetFlows). + operationId: radar-get-netflows-top-locations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + in: query + name: geoId + schema: + description: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York). + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + clientCountryAlpha2: + type: string + clientCountryName: + type: string + value: + description: A numeric string. + type: string + required: + - clientCountryName + - clientCountryAlpha2 + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by network traffic + tags: + - Radar NetFlows + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - netflows + - top + method: locations + /radar/origins: + get: + description: Retrieves a list of origins with their regions. + operationId: radar-get-origins + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + origins: + items: + properties: + regions: + items: + properties: + region: + description: The region code. + type: string + required: + - region + type: object + type: array + slug: + description: The origin slug. + type: string + required: + - slug + - regions + type: object + type: array + required: + - origins + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Origins + tags: + - Radar Origins + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /radar/origins/summary/{dimension}: + get: + description: Retrieves an aggregated summary of origin metrics grouped by the specified dimension. + operationId: radar-get-origins-summary + parameters: + - description: Specifies the origin attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the origin attribute by which to group the results. + enum: + - ORIGIN + - REGION + - SUCCESS_RATE + - PERCENTILE + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by origin. Required for all dimensions except ORIGIN. + in: query + name: origin + schema: + description: Filters results by origin. Required for all dimensions except ORIGIN. + items: + description: Origins. + enum: + - AMAZON + - GOOGLE + - MICROSOFT + - ORACLE + type: string + type: array + explode: true + - description: Specifies the metric to retrieve. + in: query + name: metric + schema: + description: Specifies the metric to retrieve. + enum: + - CONNECTION_FAILURES + - REQUESTS + - RESPONSE_HEADER_RECEIVE_DURATION + - TCP_HANDSHAKE_DURATION + - TCP_RTT + - TLS_HANDSHAKE_DURATION + type: string + - description: Filters results by origin region. + in: query + name: region + schema: + description: Filters results by origin region. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get origin metrics distribution by dimension + tags: + - Radar Origins + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /radar/origins/timeseries: + get: + description: Retrieves the time series of origin metrics for the specified origin. + operationId: radar-get-origins-timeseries + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by origin. + in: query + name: origin + schema: + description: Filters results by origin. + items: + description: Origins. + enum: + - AMAZON + - GOOGLE + - MICROSOFT + - ORACLE + type: string + type: array + explode: true + - description: Specifies the metric to retrieve. + in: query + name: metric + schema: + description: Specifies the metric to retrieve. + enum: + - CONNECTION_FAILURES + - REQUESTS + - RESPONSE_HEADER_RECEIVE_DURATION + - TCP_HANDSHAKE_DURATION + - TCP_RTT + - TLS_HANDSHAKE_DURATION + type: string + - description: Filters results by origin region. + in: query + name: region + schema: + description: Filters results by origin region. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + required: + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get origin metrics time series + tags: + - Radar Origins + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /radar/origins/timeseries_groups/{dimension}: + get: + description: Retrieves the distribution of origin metrics grouped by the specified dimension over time. + operationId: radar-get-origins-timeseries-group + parameters: + - description: Specifies the origin attribute by which to group the results. + in: path + name: dimension + schema: + description: Specifies the origin attribute by which to group the results. + enum: + - ORIGIN + - REGION + - SUCCESS_RATE + - PERCENTILE + type: string + required: true + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. + type: integer + - description: Filters results by origin. Required for all dimensions except ORIGIN. + in: query + name: origin + schema: + description: Filters results by origin. Required for all dimensions except ORIGIN. + items: + description: Origins. + enum: + - AMAZON + - GOOGLE + - MICROSOFT + - ORACLE + type: string + type: array + explode: true + - description: Specifies the metric to retrieve. + in: query + name: metric + schema: + description: Specifies the metric to retrieve. + enum: + - CONNECTION_FAILURES + - REQUESTS + - RESPONSE_HEADER_RECEIVE_DURATION + - TCP_HANDSHAKE_DURATION + - TCP_RTT + - TLS_HANDSHAKE_DURATION + type: string + - description: Filters results by origin region. + in: query + name: region + schema: + description: Filters results by origin region. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + in: query + name: normalization + schema: + default: PERCENTAGE + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get origin metrics time series grouped by dimension + tags: + - Radar Origins + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /radar/origins/{slug}: + get: + description: Retrieves the requested origin information with its regions. + operationId: radar-get-origin-details + parameters: + - description: Origin slug. + in: path + name: slug + schema: + description: Origin slug. + enum: + - AMAZON + - GOOGLE + - MICROSOFT + - ORACLE + type: string + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + origin: + properties: + regions: + items: + properties: + region: + description: The region code. + type: string + required: + - region + type: object + type: array + slug: + description: The origin slug. + type: string + required: + - slug + - regions + type: object + required: + - origin + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Origin details + tags: + - Radar Origins + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /radar/post_quantum/origin/summary/{dimension}: + get: + description: Returns a summary of origin post-quantum data grouped by the specified dimension. + operationId: radar-get-origin-post-quantum-summary + parameters: + - description: Specifies the origin post-quantum data dimension by which to group the results. + in: path + name: dimension + schema: + description: Specifies the origin post-quantum data dimension by which to group the results. + enum: + - KEY_AGREEMENT + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Origin Post-Quantum Data Summary + tags: + - Radar Post-Quantum + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - post_quantum + - origin + method: summary + /radar/post_quantum/origin/timeseries_groups/{dimension}: + get: + description: Returns a timeseries of origin post-quantum data grouped by the specified dimension. + operationId: radar-get-origin-post-quantum-timeseries-groups + parameters: + - description: Specifies the origin post-quantum data dimension by which to group the results. + in: path + name: dimension + schema: + description: Specifies the origin post-quantum data dimension by which to group the results. + enum: + - KEY_AGREEMENT + type: string + required: true + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + $ref: '#/components/schemas/unnamedSchemaRef7826220e105d84352ba1108d9ed88e55' + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Origin Post-Quantum Data Over Time + tags: + - Radar Post-Quantum + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - post_quantum + - origin + method: timeseries_groups + /radar/post_quantum/tls/support: + get: + description: Tests whether a hostname or IP address supports Post-Quantum (PQ) TLS key exchange. Returns information about the negotiated key exchange algorithm and whether it uses PQ cryptography. + operationId: radar-get-post-quantum-tls-support + parameters: + - description: Hostname or IP address to test for Post-Quantum TLS support, optionally with port (defaults to 443). + in: query + name: host + schema: + description: Hostname or IP address to test for Post-Quantum TLS support, optionally with port (defaults to 443). + minLength: 1 + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + host: + description: The host that was tested + type: string + kex: + description: TLS CurveID of the negotiated key exchange + type: number + kexName: + description: Human-readable name of the key exchange algorithm + type: string + pq: + description: Whether the negotiated key exchange uses Post-Quantum cryptography + type: boolean + required: + - kex + - kexName + - pq + - host + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Check Post-Quantum TLS support + tags: + - Radar Post-Quantum + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - post_quantum + - tls + method: support + /radar/quality/iqi/summary: + get: + description: Retrieves a summary (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI). + operationId: radar-get-quality-index-summary + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Defines which metric to return (bandwidth, latency, or DNS response time). + in: query + name: metric + schema: + description: Defines which metric to return (bandwidth, latency, or DNS response time). + enum: + - BANDWIDTH + - DNS + - LATENCY + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + p25: + type: string + p50: + type: string + p75: + type: string + required: + - p75 + - p50 + - p25 + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Internet Quality Index (IQI) summary + tags: + - Radar Quality + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - quality + - iqi + method: summary + /radar/quality/iqi/timeseries_groups: + get: + description: Retrieves a time series (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI). + operationId: radar-get-quality-index-timeseries-group + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Enables interpolation for all series (using the average). + in: query + name: interpolation + schema: + description: Enables interpolation for all series (using the average). + type: boolean + - description: Defines which metric to return (bandwidth, latency, or DNS response time). + in: query + name: metric + schema: + description: Defines which metric to return (bandwidth, latency, or DNS response time). + enum: + - BANDWIDTH + - DNS + - LATENCY + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + p25: + items: + type: string + type: array + p50: + items: + type: string + type: array + p75: + items: + type: string + type: array + timestamps: + items: + type: string + type: array + required: + - timestamps + - p75 + - p50 + - p25 + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Internet Quality Index (IQI) time series + tags: + - Radar Quality + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - quality + - iqi + method: timeseries_groups + /radar/quality/speed/histogram: + get: + description: Retrieves a histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms), or jitter (ms) buckets. + operationId: radar-get-quality-speed-histogram + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Specifies the width for every bucket in the histogram. + in: query + name: bucketSize + schema: + description: Specifies the width for every bucket in the histogram. + type: integer + - description: Metrics to be returned. + in: query + name: metricGroup + schema: + description: Metrics to be returned. + enum: + - BANDWIDTH + - LATENCY + - JITTER + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + histogram_0: + properties: + bandwidthDownload: + items: + type: string + type: array + bandwidthUpload: + items: + type: string + type: array + bucketMin: + items: + type: string + type: array + required: + - bandwidthUpload + - bandwidthDownload + - bucketMin + type: object + meta: + description: Metadata for the results. + properties: + bucketSize: + description: The width for every bucket in the histogram. + type: integer + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + totalTests: + items: + type: integer + type: array + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - bucketSize + - totalTests + type: object + required: + - histogram_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get speed tests histogram + tags: + - Radar Quality + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - quality + - speed + method: histogram + /radar/quality/speed/summary: + get: + description: Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the previous 90 days of Cloudflare Speed Test data. + operationId: radar-get-quality-speed-summary + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + bandwidthDownload: + type: string + bandwidthUpload: + type: string + jitterIdle: + type: string + jitterLoaded: + type: string + latencyIdle: + type: string + latencyLoaded: + type: string + packetLoss: + type: string + required: + - bandwidthDownload + - bandwidthUpload + - latencyIdle + - latencyLoaded + - jitterIdle + - jitterLoaded + - packetLoss + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get speed tests summary + tags: + - Radar Quality + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - quality + - speed + method: summary + /radar/quality/speed/top/ases: + get: + description: Retrieves the top autonomous systems by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data. + operationId: radar-get-quality-speed-top-ases + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Specifies the metric to order the results by. + in: query + name: orderBy + schema: + default: BANDWIDTH_DOWNLOAD + description: Specifies the metric to order the results by. + enum: + - BANDWIDTH_DOWNLOAD + - BANDWIDTH_UPLOAD + - LATENCY_IDLE + - LATENCY_LOADED + - JITTER_IDLE + - JITTER_LOADED + type: string + - description: Reverses the order of results. + in: query + name: reverse + schema: + description: Reverses the order of results. + type: boolean + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + bandwidthDownload: + type: string + bandwidthUpload: + type: string + clientASN: + type: number + clientASName: + type: string + jitterIdle: + type: string + jitterLoaded: + type: string + latencyIdle: + type: string + latencyLoaded: + type: string + numTests: + type: number + rankPower: + type: number + required: + - clientASN + - clientASName + - bandwidthDownload + - bandwidthUpload + - latencyIdle + - latencyLoaded + - jitterIdle + - jitterLoaded + - numTests + - rankPower + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top ASes by speed test results + tags: + - Radar Quality + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - quality + - speed + - top + method: ases + /radar/quality/speed/top/locations: + get: + description: Retrieves the top locations by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data. + operationId: radar-get-quality-speed-top-locations + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Specifies the metric to order the results by. + in: query + name: orderBy + schema: + default: BANDWIDTH_DOWNLOAD + description: Specifies the metric to order the results by. + enum: + - BANDWIDTH_DOWNLOAD + - BANDWIDTH_UPLOAD + - LATENCY_IDLE + - LATENCY_LOADED + - JITTER_IDLE + - JITTER_LOADED + type: string + - description: Reverses the order of results. + in: query + name: reverse + schema: + description: Reverses the order of results. + type: boolean + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + bandwidthDownload: + type: string + bandwidthUpload: + type: string + clientCountryAlpha2: + type: string + clientCountryName: + type: string + jitterIdle: + type: string + jitterLoaded: + type: string + latencyIdle: + type: string + latencyLoaded: + type: string + numTests: + type: number + rankPower: + type: number + required: + - clientCountryAlpha2 + - clientCountryName + - bandwidthDownload + - bandwidthUpload + - latencyIdle + - latencyLoaded + - jitterIdle + - jitterLoaded + - numTests + - rankPower + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by speed test results + tags: + - Radar Quality + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - quality + - speed + - top + method: locations + /radar/ranking/domain/{domain}: + get: + description: Retrieves domain rank details. Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints. + operationId: radar-get-ranking-domain-details + parameters: + - description: Domain name. + in: path + name: domain + schema: + description: Domain name. + type: string + required: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: The ranking type. + in: query + name: rankingType + schema: + default: POPULAR + description: The ranking type. + enum: + - POPULAR + - TRENDING_RISE + - TRENDING_STEADY + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Includes top locations in the response. + in: query + name: includeTopLocations + schema: + description: Includes top locations in the response. + type: boolean + - description: Filters results by the specified array of dates. + in: query + name: date + schema: + description: Filters results by the specified array of dates. + items: + format: date + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + details_0: + properties: + bucket: + description: Only available in POPULAR ranking for the most recent ranking. + type: string + categories: + items: + properties: + id: + type: integer + name: + type: string + superCategoryId: + type: integer + required: + - superCategoryId + - name + - id + type: object + type: array + rank: + type: integer + top_locations: + items: + properties: + locationCode: + type: string + locationName: + type: string + rank: + type: integer + required: + - rank + - locationName + - locationCode + type: object + type: array + required: + - categories + type: object + meta: + properties: + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + required: + - dateRange + type: object + required: + - details_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get domain rank details + tags: + - Radar Domains Ranking + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ranking + - domain + method: get + /radar/ranking/internet_services/categories: + get: + description: Retrieves the list of Internet services categories. + operationId: radar-get-ranking-internet-services-categories + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by the specified array of dates. + in: query + name: date + schema: + description: Filters results by the specified array of dates. + items: + format: date + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + categories_0: + items: + properties: + name: + type: string + required: + - name + type: object + type: array + required: + - categories_0 + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Internet services categories + tags: + - Radar Internet Services Ranking + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ranking + - internet_services + method: categories + /radar/ranking/internet_services/timeseries_groups: + get: + description: Retrieves Internet Services rank update changes over time. + operationId: radar-get-ranking-internet-services-timeseries + parameters: + - description: Filters results by Internet service category. + in: query + name: serviceCategory + schema: + description: Filters results by Internet service category. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Internet services rank time series + tags: + - Radar Internet Services Ranking + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ranking + - internet_services + method: timeseries_groups + /radar/ranking/internet_services/top: + get: + description: Retrieves top Internet services based on their rank. + operationId: radar-get-ranking-top-internet-services + parameters: + - description: Filters results by Internet service category. + in: query + name: serviceCategory + schema: + description: Filters results by Internet service category. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by the specified array of dates. + in: query + name: date + schema: + description: Filters results by the specified array of dates. + items: + format: date + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + rank: + type: integer + service: + type: string + required: + - rank + - service + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top Internet services + tags: + - Radar Internet Services Ranking + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ranking + - internet_services + method: top + /radar/ranking/timeseries_groups: + get: + description: Retrieves domains rank over time. + operationId: radar-get-ranking-domain-timeseries + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: The ranking type. + in: query + name: rankingType + schema: + default: POPULAR + description: The ranking type. + enum: + - POPULAR + - TRENDING_RISE + - TRENDING_STEADY + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + items: + type: string + type: array + explode: true + - description: Filters results by domain name. Specify a comma-separated list of domain names. + in: query + name: domains + schema: + description: Filters results by domain name. Specify a comma-separated list of domain names. + items: + maxLength: 253 + minLength: 1 + type: string + type: array + explode: true + - description: Filters results by domain category. + in: query + name: domainCategory + schema: + description: Filters results by domain category. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get domains rank time series + tags: + - Radar Domains Ranking + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ranking + method: timeseries_groups + /radar/ranking/top: + get: + description: Retrieves the top or trending domains based on their rank. Popular domains are domains of broad appeal based on how people use the Internet. Trending domains are domains that are generating a surge in interest. For more information on top domains, see https://blog.cloudflare.com/radar-domain-rankings/. + operationId: radar-get-ranking-top-domains + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 location codes. + items: + type: string + type: array + explode: true + - description: Filters results by domain category. + in: query + name: domainCategory + schema: + description: Filters results by domain category. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by the specified array of dates. + in: query + name: date + schema: + description: Filters results by the specified array of dates. + items: + format: date + type: string + type: array + explode: true + - description: The ranking type. + in: query + name: rankingType + schema: + default: POPULAR + description: The ranking type. + enum: + - POPULAR + - TRENDING_RISE + - TRENDING_STEADY + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + categories: + items: + properties: + id: + type: number + name: + type: string + superCategoryId: + type: number + required: + - superCategoryId + - name + - id + type: object + type: array + domain: + type: string + pctRankChange: + description: Only available in TRENDING rankings. + type: number + rank: + type: integer + required: + - rank + - domain + - categories + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top or trending domains + tags: + - Radar Domains Ranking + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - ranking + method: top + /radar/robots_txt/top/domain_categories: + get: + description: Retrieves the top domain categories by the number of robots.txt files parsed. + operationId: radar-get-robots-txt-top-domain-categories-by-files-parsed + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by user agent category. + in: query + name: userAgentCategory + schema: + default: AI + description: Filters results by user agent category. + enum: + - AI + type: string + - description: Filters results by the specified array of dates. + in: query + name: date + schema: + description: Filters results by the specified array of dates. + items: + format: date + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + name: + type: string + value: + type: integer + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top domain categories by robots.txt files parsed + tags: + - Radar Robots.txt + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - robots_txt + - top + method: domain_categories + /radar/robots_txt/top/user_agents/directive: + get: + description: Retrieves the top user agents on robots.txt files. + operationId: radar-get-robots-txt-top-user-agents-by-directive + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by user agent category. + in: query + name: userAgentCategory + schema: + default: AI + description: Filters results by user agent category. + enum: + - AI + type: string + - description: Filters results by the specified array of dates. + in: query + name: date + schema: + description: Filters results by the specified array of dates. + items: + format: date + type: string + type: array + explode: true + - description: Filters results by domain category. + in: query + name: domainCategory + schema: + description: Filters results by domain category. + items: + maxLength: 100 + type: string + type: array + explode: true + - description: Filters results by robots.txt directive. + in: query + name: directive + schema: + description: Filters results by robots.txt directive. + enum: + - ALLOW + - DISALLOW + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + fully: + type: integer + name: + type: string + partially: + type: integer + value: + type: integer + required: + - name + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top user agents on robots.txt files + tags: + - Radar Robots.txt + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - robots_txt + - top + - user_agents + method: directive + /radar/search/global: + get: + description: 'Searches for locations, autonomous systems, reports, bots, certificate logs, certificate authorities, industries and verticals. Location names can be localized by sending an `Accept-Language` HTTP header with a BCP 47 language tag (e.g., `Accept-Language: pt-PT`). The full quality-value chain is supported (e.g., `pt-PT,pt;q=0.9,en;q=0.8`).' + operationId: radar-get-search-global + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Limits the number of objects per search category. + in: query + name: limitPerGroup + schema: + description: Limits the number of objects per search category. + type: number + - description: String used to perform the search operation. + in: query + name: query + schema: + description: String used to perform the search operation. + type: string + - description: Search types included in results. + in: query + name: include + schema: + description: Search types included in results. + items: + enum: + - ADM1S + - ASNS + - BOTS + - CERTIFICATE_AUTHORITIES + - CERTIFICATE_LOGS + - ORIGINS + - ORIGIN_REGIONS + - INDUSTRIES + - LOCATIONS + - NOTEBOOKS + - TLDS + - VERTICALS + type: string + type: array + explode: true + - description: Search types excluded from results. + in: query + name: exclude + schema: + description: Search types excluded from results. + items: + enum: + - ADM1S + - ASNS + - BOTS + - CERTIFICATE_AUTHORITIES + - CERTIFICATE_LOGS + - ORIGINS + - ORIGIN_REGIONS + - INDUSTRIES + - LOCATIONS + - NOTEBOOKS + - TLDS + - VERTICALS + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + search: + items: + properties: + code: + type: string + name: + type: string + type: + type: string + required: + - code + - name + - type + type: object + type: array + required: + - search + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search for locations, ASes, reports, and more + tags: + - Radar Search + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - search + method: global_ + /radar/tcp_resets_timeouts/summary: + get: + description: Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout. + operationId: radar-get-tcp-resets-timeouts-summary + parameters: + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + summary_0: + properties: + later_in_flow: + description: Connection resets within the first 10 packets from the client, but after the server has received multiple data packets. + type: string + no_match: + description: All other connections. + type: string + post_ack: + description: Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established. + type: string + post_psh: + description: Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment. + type: string + post_syn: + description: Connection resets or timeouts after the server received only a single SYN packet. + type: string + required: + - no_match + - post_syn + - post_ack + - post_psh + - later_in_flow + type: object + required: + - summary_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get TCP resets and timeouts summary + tags: + - Radar TCP Resets and Timeouts + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - tcp_resets_timeouts + method: summary + /radar/tcp_resets_timeouts/timeseries_groups: + get: + description: Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout over time. + operationId: radar-get-tcp-resets-timeouts-timeseries-group + parameters: + - description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + in: query + name: aggInterval + schema: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - 15m + - 1h + - 1d + - 1w + type: string + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + aggInterval: + description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + type: string + confidenceInfo: + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + - aggInterval + type: object + serie_0: + properties: + later_in_flow: + items: + description: Connection resets within the first 10 packets from the client, but after the server has received multiple data packets. + type: string + type: array + no_match: + items: + description: All other connections. + type: string + type: array + post_ack: + items: + description: Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established. + type: string + type: array + post_psh: + items: + description: Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment. + type: string + type: array + post_syn: + items: + description: Connection resets or timeouts after the server received only a single SYN packet. + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - no_match + - post_syn + - post_ack + - post_psh + - later_in_flow + type: object + required: + - serie_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get TCP resets and timeouts time series + tags: + - Radar TCP Resets and Timeouts + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - tcp_resets_timeouts + method: timeseries_groups + /radar/tlds: + get: + description: Retrieves a list of TLDs. + operationId: radar-get-tlds + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by TLD manager. + in: query + name: tldManager + schema: + description: Filters results by TLD manager. + maxLength: 100 + type: string + - description: Filters results by TLD type. + in: query + name: tldType + schema: + description: Filters results by TLD type. + enum: + - GENERIC + - COUNTRY_CODE + - GENERIC_RESTRICTED + - INFRASTRUCTURE + - SPONSORED + type: string + - description: Filters results by top-level domain. Specify a comma-separated list of TLDs. + in: query + name: tld + schema: + description: Filters results by top-level domain. Specify a comma-separated list of TLDs. + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + tlds: + items: + properties: + manager: + description: The organization that manages the TLD. + type: string + tld: + description: The actual TLD. + type: string + type: + description: The type of TLD. + type: string + required: + - tld + - type + - manager + type: object + type: array + required: + - tlds + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List TLDs + tags: + - Radar Top-Level Domains + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /radar/tlds/{tld}: + get: + description: Retrieves the requested TLD information. + operationId: radar-get-tld-details + parameters: + - description: Top-level domain. + in: path + name: tld + schema: + description: Top-level domain. + maxLength: 63 + minLength: 2 + type: string + required: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + tld: + properties: + manager: + description: The organization that manages the TLD. + type: string + tld: + description: The actual TLD. + type: string + type: + description: The type of TLD. + type: string + required: + - tld + - type + - manager + type: object + required: + - tld + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get TLD details + tags: + - Radar Top-Level Domains + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /radar/traffic_anomalies: + get: + description: Retrieves the latest Internet traffic anomalies, which are signals that might indicate an outage. These alerts are automatically detected by Radar and manually verified by our team. + operationId: radar-get-traffic-anomalies + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Skips the specified number of objects before fetching the results. + in: query + name: offset + schema: + description: Skips the specified number of objects before fetching the results. + minimum: 0 + type: integer + - description: Filters results by date range. + in: query + name: dateRange + schema: + description: Filters results by date range. + type: string + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - in: query + name: status + schema: + enum: + - VERIFIED + - UNVERIFIED + type: string + - description: Filters results by entity type (LOCATION, AS, or ORIGIN). + in: query + name: type + schema: + description: Filters results by entity type (LOCATION, AS, or ORIGIN). + items: + enum: + - LOCATION + - AS + - ORIGIN + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer. + type: integer + - description: Filters results by location. Specify an alpha-2 location code. + in: query + name: location + schema: + description: Filters results by location. Specify an alpha-2 location code. + maxLength: 2 + minLength: 2 + type: string + - description: Filters results by origin. + in: query + name: origin + schema: + description: Filters results by origin. + maxLength: 100 + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + trafficAnomalies: + items: + properties: + asnDetails: + properties: + asn: + type: string + locations: + $ref: '#/components/schemas/unnamedSchemaRef16e559c45a31db5480e21fbe904b2e42' + name: + type: string + required: + - asn + - name + type: object + endDate: + format: date-time + type: string + locationDetails: + $ref: '#/components/schemas/unnamedSchemaRef16e559c45a31db5480e21fbe904b2e42' + originDetails: + properties: + name: + type: string + origin: + type: string + required: + - origin + - name + type: object + startDate: + type: string + status: + type: string + type: + type: string + uuid: + type: string + visibleInDataSources: + items: + type: string + type: array + required: + - uuid + - type + - status + - startDate + type: object + type: array + required: + - trafficAnomalies + type: object + success: + type: boolean + required: + - result + - success + type: object + description: List of Internet traffic anomalies. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get latest Internet traffic anomalies + tags: + - Radar Traffic Anomalies + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - traffic_anomalies + method: get + /radar/traffic_anomalies/locations: + get: + description: Retrieves the sum of Internet traffic anomalies, grouped by location. These anomalies are signals that might indicate an outage, automatically detected by Radar and manually verified by our team. + operationId: radar-get-traffic-anomalies-top + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Filters results by date range. + in: query + name: dateRange + schema: + description: Filters results by date range. + type: string + - description: Start of the date range (inclusive). + in: query + name: dateStart + schema: + description: Start of the date range (inclusive). + format: date-time + type: string + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + format: date-time + type: string + - in: query + name: status + schema: + enum: + - VERIFIED + - UNVERIFIED + type: string + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + trafficAnomalies: + items: + $ref: '#/components/schemas/unnamedSchemaRef83a14d589e799bc901b9ccc870251d09' + type: array + required: + - trafficAnomalies + type: object + success: + type: boolean + required: + - result + - success + type: object + description: List of locations with number of traffic anomalies. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top locations by total traffic anomalies + tags: + - Radar Traffic Anomalies + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: radar + resource_chain: + - traffic_anomalies + - locations + method: get + /radar/verified_bots/top/bots: + get: + deprecated: true + description: Retrieves the top verified bots by HTTP requests, with owner and category. + operationId: radar-get-verified-bots-top-by-http-requests + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + botCategory: + type: string + botName: + type: string + botOwner: + type: string + value: + description: A numeric string. + type: string + required: + - botName + - botCategory + - botOwner + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top verified bots by HTTP requests + tags: + - Radar Verified Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - verified_bots + - top + method: bots + /radar/verified_bots/top/categories: + get: + deprecated: true + description: Retrieves the top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests. + operationId: radar-get-verified-bots-top-categories-by-http-requests + parameters: + - description: Limits the number of objects returned in the response. + in: query + name: limit + schema: + description: Limits the number of objects returned in the response. + exclusiveMinimum: true + minimum: 0 + type: integer + - description: Array of names used to label the series in the response. + in: query + name: name + schema: + description: Array of names used to label the series in the response. + items: + type: string + type: array + explode: true + - description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + in: query + name: dateRange + schema: + description: Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). + items: + type: string + type: array + explode: true + - description: Start of the date range. + in: query + name: dateStart + schema: + description: Start of the date range. + items: + format: date-time + type: string + type: array + explode: true + - description: End of the date range (inclusive). + in: query + name: dateEnd + schema: + description: End of the date range (inclusive). + items: + format: date-time + type: string + type: array + explode: true + - description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + in: query + name: asn + schema: + description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. + items: + type: string + type: array + explode: true + - description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + in: query + name: location + schema: + description: Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. + items: + type: string + type: array + explode: true + - description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + in: query + name: continent + schema: + description: Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. + items: + type: string + type: array + explode: true + - description: Format in which results will be returned. + in: query + name: format + schema: + description: Format in which results will be returned. + enum: + - JSON + - CSV + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + meta: + description: Metadata for the results. + properties: + confidenceInfo: + nullable: true + properties: + annotations: + items: + $ref: '#/components/schemas/unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1' + type: array + level: + description: Provides an indication of how much confidence Cloudflare has in the data. + type: integer + required: + - level + - annotations + type: object + dateRange: + items: + $ref: '#/components/schemas/unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5' + type: array + lastUpdated: + description: Timestamp of the last dataset update. + format: date-time + type: string + normalization: + description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). + enum: + - PERCENTAGE + - MIN0_MAX + - MIN_MAX + - RAW_VALUES + - PERCENTAGE_CHANGE + - ROLLING_AVERAGE + - OVERLAPPED_PERCENTAGE + - RATIO + type: string + units: + description: Measurement units for the results. + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + required: + - dateRange + - confidenceInfo + - normalization + - lastUpdated + - units + type: object + top_0: + items: + properties: + botCategory: + type: string + value: + description: A numeric string. + type: string + required: + - botCategory + - value + type: object + type: array + required: + - top_0 + - meta + type: object + success: + type: boolean + required: + - result + - success + type: object + description: Successful response. + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51' + description: Not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get top verified bot categories by HTTP requests + tags: + - Radar Verified Bots + x-api-token-group: + - User Details Write + - User Details Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead. + x-stackql-sdk: + service: radar + resource_chain: + - verified_bots + - top + method: categories +components: + schemas: + unnamedSchemaRef16e559c45a31db5480e21fbe904b2e42: + properties: + code: + example: US + type: string + name: + example: United States + type: string + required: + - code + - name + type: object + unnamedSchemaRef4124a22436f90127c7fa2c4543219752: + properties: + clientASN: + example: 3243 + type: integer + clientASName: + example: MEO + type: string + value: + description: A numeric string. + example: '10' + type: string + required: + - clientASN + - clientASName + - value + type: object + unnamedSchemaRef67c73d4742566cab0909f71b1822e88c: + properties: + FAIL: + items: + description: A numeric string. + example: '10' + type: string + type: array + NONE: + items: + description: A numeric string. + example: '10' + type: string + type: array + PASS: + items: + description: A numeric string. + example: '10' + type: string + type: array + required: + - NONE + - PASS + - FAIL + type: object + unnamedSchemaRef73de8b634bb48667e28a6c6c56080c51: + properties: + error: + example: Not Found. + type: string + required: + - error + type: object + unnamedSchemaRef75bae70cf28e6bcef364b9840db3bdeb: + properties: + timestamps: + items: + format: date-time + type: string + type: array + values: + items: + description: A numeric string. + example: '10' + type: string + type: array + required: + - timestamps + - values + type: object + unnamedSchemaRef7826220e105d84352ba1108d9ed88e55: + example: + ANDROID: + - '97.28898' + timestamps: + - '2023-08-08T10:15:00Z' + properties: + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + type: object + unnamedSchemaRef83a14d589e799bc901b9ccc870251d09: + properties: + clientCountryAlpha2: + example: PT + type: string + clientCountryName: + example: Portugal + type: string + value: + description: A numeric string. + example: '10' + type: string + required: + - clientCountryAlpha2 + - clientCountryName + - value + type: object + unnamedSchemaRef853c157ad369010995e35be614e0343f: + properties: + FAIL: + description: A numeric string. + example: '10' + type: string + NONE: + description: A numeric string. + example: '10' + type: string + PASS: + description: A numeric string. + example: '10' + type: string + required: + - NONE + - PASS + - FAIL + type: object + unnamedSchemaRef8b383e904d9fb02521257ef9cc77d297: + properties: + IPv4: + description: A numeric string. + example: '10' + type: string + IPv6: + description: A numeric string. + example: '10' + type: string + required: + - IPv4 + - IPv6 + type: object + unnamedSchemaRef9002274ed7cb7f3dc567421e31529a3a: + properties: + IPv4: + items: + description: A numeric string. + example: '10' + type: string + type: array + IPv6: + items: + description: A numeric string. + example: '10' + type: string + type: array + timestamps: + items: + format: date-time + type: string + type: array + required: + - timestamps + - IPv4 + - IPv6 + type: object + unnamedSchemaRefB5f3bd1840490bc487ffef84567807b1: + description: Annotation associated with the result (e.g. outage or other type of event). + properties: + dataSource: + description: Data source for annotations. + enum: + - ALL + - AI_BOTS + - AI_GATEWAY + - BGP + - BOTS + - CONNECTION_ANOMALY + - CT + - DNS + - DNS_MAGNITUDE + - DNS_AS112 + - DOS + - EMAIL_ROUTING + - EMAIL_SECURITY + - FW + - FW_PG + - HTTP + - HTTP_CONTROL + - HTTP_CRAWLER_REFERER + - HTTP_ORIGINS + - IQI + - LEAKED_CREDENTIALS + - NET + - ROBOTS_TXT + - SPEED + - WORKERS_AI + type: string + description: + example: Cable cut in Tonga + type: string + endDate: + format: date-time + type: string + eventType: + description: Event type for annotations. + enum: + - EVENT + - GENERAL + - OUTAGE + - PARTIAL_PROJECTION + - PIPELINE + - TRAFFIC_ANOMALY + type: string + isInstantaneous: + description: Whether event is a single point in time or a time range. + type: boolean + linkedUrl: + format: uri + type: string + startDate: + format: date-time + type: string + required: + - dataSource + - eventType + - description + - startDate + - endDate + - linkedUrl + - isInstantaneous + type: object + unnamedSchemaRefBaac9d7da12de53e99142f8ecd3982e5: + properties: + endTime: + description: Adjusted end of date range. + example: '2022-09-17T10:22:57.555Z' + format: date-time + type: string + startTime: + description: Adjusted start of date range. + example: '2022-09-16T10:22:57.555Z' + format: date-time + type: string + required: + - startTime + - endTime + type: object + unnamedSchemaRefC5858f1f916a921846e0b6159af470a7: + properties: + data_time: + type: string + query_time: + type: string + total_peers: + type: integer + required: + - data_time + - query_time + - total_peers + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + agent_readiness: + id: cloudflare.radar.agent_readiness + name: agent_readiness + title: Agent Readiness + methods: + get: + operation: + $ref: '#/paths/~1radar~1agent_readiness~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/agent_readiness/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + bots_summary_user_agent: + id: cloudflare.radar.bots_summary_user_agent + name: bots_summary_user_agent + title: Bots Summary User Agent + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1bots~1summary~1user_agent/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots_summary_user_agent/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bots_summary_dimension_7adba9: + id: cloudflare.radar.bots_summary_dimension_7adba9 + name: bots_summary_dimension_7adba9 + title: Bots Summary Dimension 7adba9 + methods: + get: + operation: + $ref: '#/paths/~1radar~1ai~1bots~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots_summary_dimension_7adba9/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ai_bots_timeseries: + id: cloudflare.radar.ai_bots_timeseries + name: ai_bots_timeseries + title: Ai Bots Timeseries + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1bots~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ai_bots_timeseries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bots_timeseries_groups_user_agent: + id: cloudflare.radar.bots_timeseries_groups_user_agent + name: bots_timeseries_groups_user_agent + title: Bots Timeseries Groups User Agent + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1bots~1timeseries_groups~1user_agent/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots_timeseries_groups_user_agent/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bots_timeseries_groups_dimension_5dbf28: + id: cloudflare.radar.bots_timeseries_groups_dimension_5dbf28 + name: bots_timeseries_groups_dimension_5dbf28 + title: Bots Timeseries Groups Dimension 5dbf28 + methods: + get: + operation: + $ref: '#/paths/~1radar~1ai~1bots~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots_timeseries_groups_dimension_5dbf28/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + inference_summary_model: + id: cloudflare.radar.inference_summary_model + name: inference_summary_model + title: Inference Summary Model + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1inference~1summary~1model/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/inference_summary_model/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + inference_summary_task: + id: cloudflare.radar.inference_summary_task + name: inference_summary_task + title: Inference Summary Task + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1inference~1summary~1task/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/inference_summary_task/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + inference_summary: + id: cloudflare.radar.inference_summary + name: inference_summary + title: Inference Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1ai~1inference~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/inference_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + inference_timeseries_groups_model: + id: cloudflare.radar.inference_timeseries_groups_model + name: inference_timeseries_groups_model + title: Inference Timeseries Groups Model + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1inference~1timeseries_groups~1model/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/inference_timeseries_groups_model/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + inference_timeseries_groups_task: + id: cloudflare.radar.inference_timeseries_groups_task + name: inference_timeseries_groups_task + title: Inference Timeseries Groups Task + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1inference~1timeseries_groups~1task/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/inference_timeseries_groups_task/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + inference_timeseries_groups: + id: cloudflare.radar.inference_timeseries_groups + name: inference_timeseries_groups + title: Inference Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1ai~1inference~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/inference_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + markdown_for_agents_summary: + id: cloudflare.radar.markdown_for_agents_summary + name: markdown_for_agents_summary + title: Markdown For Agents Summary + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1markdown_for_agents~1summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/markdown_for_agents_summary/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + markdown_for_agents_timeseries: + id: cloudflare.radar.markdown_for_agents_timeseries + name: markdown_for_agents_timeseries + title: Markdown For Agents Timeseries + methods: + list: + operation: + $ref: '#/paths/~1radar~1ai~1markdown_for_agents~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/markdown_for_agents_timeseries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + annotations: + id: cloudflare.radar.annotations + name: annotations + title: Annotations + methods: + list: + operation: + $ref: '#/paths/~1radar~1annotations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.annotations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/annotations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + annotations_outages: + id: cloudflare.radar.annotations_outages + name: annotations_outages + title: Annotations Outages + methods: + list: + operation: + $ref: '#/paths/~1radar~1annotations~1outages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.annotations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/annotations_outages/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + outages_locations: + id: cloudflare.radar.outages_locations + name: outages_locations + title: Outages Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1annotations~1outages~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.annotations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/outages_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_summary_dnssec: + id: cloudflare.radar.as112_summary_dnssec + name: as112_summary_dnssec + title: As112 Summary Dnssec + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1summary~1dnssec/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_summary_dnssec/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_summary_edns: + id: cloudflare.radar.as112_summary_edns + name: as112_summary_edns + title: As112 Summary Edns + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1summary~1edns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_summary_edns/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_summary_ip_version: + id: cloudflare.radar.as112_summary_ip_version + name: as112_summary_ip_version + title: As112 Summary Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1summary~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_summary_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_summary_protocol: + id: cloudflare.radar.as112_summary_protocol + name: as112_summary_protocol + title: As112 Summary Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1summary~1protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_summary_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_summary_query_type: + id: cloudflare.radar.as112_summary_query_type + name: as112_summary_query_type + title: As112 Summary Query Type + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1summary~1query_type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_summary_query_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_summary_response_codes: + id: cloudflare.radar.as112_summary_response_codes + name: as112_summary_response_codes + title: As112 Summary Response Codes + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1summary~1response_codes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_summary_response_codes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_summary: + id: cloudflare.radar.as112_summary + name: as112_summary + title: As112 Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1as112~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + as112: + id: cloudflare.radar.as112 + name: as112 + title: As112 + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_timeseries_groups_dnssec: + id: cloudflare.radar.as112_timeseries_groups_dnssec + name: as112_timeseries_groups_dnssec + title: As112 Timeseries Groups Dnssec + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries_groups~1dnssec/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_timeseries_groups_dnssec/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_timeseries_groups_edns: + id: cloudflare.radar.as112_timeseries_groups_edns + name: as112_timeseries_groups_edns + title: As112 Timeseries Groups Edns + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries_groups~1edns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_timeseries_groups_edns/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_timeseries_groups_ip_version: + id: cloudflare.radar.as112_timeseries_groups_ip_version + name: as112_timeseries_groups_ip_version + title: As112 Timeseries Groups Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries_groups~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_timeseries_groups_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_timeseries_groups_protocol: + id: cloudflare.radar.as112_timeseries_groups_protocol + name: as112_timeseries_groups_protocol + title: As112 Timeseries Groups Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries_groups~1protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_timeseries_groups_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_timeseries_groups_query_type: + id: cloudflare.radar.as112_timeseries_groups_query_type + name: as112_timeseries_groups_query_type + title: As112 Timeseries Groups Query Type + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries_groups~1query_type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_timeseries_groups_query_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_timeseries_groups_response_codes: + id: cloudflare.radar.as112_timeseries_groups_response_codes + name: as112_timeseries_groups_response_codes + title: As112 Timeseries Groups Response Codes + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries_groups~1response_codes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_timeseries_groups_response_codes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + as112_timeseries_groups: + id: cloudflare.radar.as112_timeseries_groups + name: as112_timeseries_groups + title: As112 Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1as112~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + as112_top_locations: + id: cloudflare.radar.as112_top_locations + name: as112_top_locations + title: As112 Top Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1as112~1top~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_top_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + locations_dnssec: + id: cloudflare.radar.locations_dnssec + name: locations_dnssec + title: Locations Dnssec + methods: + get_by_radar: + operation: + $ref: '#/paths/~1radar~1as112~1top~1locations~1dnssec~1{dnssec}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_dnssec/methods/get_by_radar' + insert: [] + update: [] + delete: [] + replace: [] + locations_edns: + id: cloudflare.radar.locations_edns + name: locations_edns + title: Locations Edns + methods: + get_by_radar: + operation: + $ref: '#/paths/~1radar~1as112~1top~1locations~1edns~1{edns}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_edns/methods/get_by_radar' + insert: [] + update: [] + delete: [] + replace: [] + as112_top_locations_ip_version: + id: cloudflare.radar.as112_top_locations_ip_version + name: as112_top_locations_ip_version + title: As112 Top Locations Ip Version + methods: + get_by_radar: + operation: + $ref: '#/paths/~1radar~1as112~1top~1locations~1ip_version~1{ip_version}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/as112_top_locations_ip_version/methods/get_by_radar' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary_bitrate: + id: cloudflare.radar.layer3_summary_bitrate + name: layer3_summary_bitrate + title: Layer3 Summary Bitrate + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1bitrate/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary_bitrate/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary_duration: + id: cloudflare.radar.layer3_summary_duration + name: layer3_summary_duration + title: Layer3 Summary Duration + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1duration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary_duration/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary_industry: + id: cloudflare.radar.layer3_summary_industry + name: layer3_summary_industry + title: Layer3 Summary Industry + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1industry/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary_industry/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary_ip_version: + id: cloudflare.radar.layer3_summary_ip_version + name: layer3_summary_ip_version + title: Layer3 Summary Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary_protocol: + id: cloudflare.radar.layer3_summary_protocol + name: layer3_summary_protocol + title: Layer3 Summary Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary_vector: + id: cloudflare.radar.layer3_summary_vector + name: layer3_summary_vector + title: Layer3 Summary Vector + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1vector/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary_vector/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary_vertical: + id: cloudflare.radar.layer3_summary_vertical + name: layer3_summary_vertical + title: Layer3 Summary Vertical + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1vertical/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary_vertical/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_summary: + id: cloudflare.radar.layer3_summary + name: layer3_summary + title: Layer3 Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + layer3: + id: cloudflare.radar.layer3 + name: layer3 + title: Layer3 + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups_bitrate: + id: cloudflare.radar.layer3_timeseries_groups_bitrate + name: layer3_timeseries_groups_bitrate + title: Layer3 Timeseries Groups Bitrate + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1bitrate/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups_bitrate/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups_duration: + id: cloudflare.radar.layer3_timeseries_groups_duration + name: layer3_timeseries_groups_duration + title: Layer3 Timeseries Groups Duration + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1duration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups_duration/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups_industry: + id: cloudflare.radar.layer3_timeseries_groups_industry + name: layer3_timeseries_groups_industry + title: Layer3 Timeseries Groups Industry + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1industry/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups_industry/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups_ip_version: + id: cloudflare.radar.layer3_timeseries_groups_ip_version + name: layer3_timeseries_groups_ip_version + title: Layer3 Timeseries Groups Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups_protocol: + id: cloudflare.radar.layer3_timeseries_groups_protocol + name: layer3_timeseries_groups_protocol + title: Layer3 Timeseries Groups Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups_vector: + id: cloudflare.radar.layer3_timeseries_groups_vector + name: layer3_timeseries_groups_vector + title: Layer3 Timeseries Groups Vector + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1vector/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups_vector/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups_vertical: + id: cloudflare.radar.layer3_timeseries_groups_vertical + name: layer3_timeseries_groups_vertical + title: Layer3 Timeseries Groups Vertical + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1vertical/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups_vertical/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_timeseries_groups: + id: cloudflare.radar.layer3_timeseries_groups + name: layer3_timeseries_groups + title: Layer3 Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + layer3_top_attacks: + id: cloudflare.radar.layer3_top_attacks + name: layer3_top_attacks + title: Layer3 Top Attacks + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1top~1attacks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_top_attacks/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_top_industry: + id: cloudflare.radar.layer3_top_industry + name: layer3_top_industry + title: Layer3 Top Industry + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1top~1industry/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_top_industry/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_top_locations_origin: + id: cloudflare.radar.layer3_top_locations_origin + name: layer3_top_locations_origin + title: Layer3 Top Locations Origin + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1top~1locations~1origin/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_top_locations_origin/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_top_locations_target: + id: cloudflare.radar.layer3_top_locations_target + name: layer3_top_locations_target + title: Layer3 Top Locations Target + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1top~1locations~1target/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_top_locations_target/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer3_top_vertical: + id: cloudflare.radar.layer3_top_vertical + name: layer3_top_vertical + title: Layer3 Top Vertical + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer3~1top~1vertical/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer3_top_vertical/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary_http_method: + id: cloudflare.radar.layer7_summary_http_method + name: layer7_summary_http_method + title: Layer7 Summary Http Method + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1http_method/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary_http_method/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary_http_version: + id: cloudflare.radar.layer7_summary_http_version + name: layer7_summary_http_version + title: Layer7 Summary Http Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1http_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary_http_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary_industry: + id: cloudflare.radar.layer7_summary_industry + name: layer7_summary_industry + title: Layer7 Summary Industry + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1industry/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary_industry/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary_ip_version: + id: cloudflare.radar.layer7_summary_ip_version + name: layer7_summary_ip_version + title: Layer7 Summary Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary_managed_rules: + id: cloudflare.radar.layer7_summary_managed_rules + name: layer7_summary_managed_rules + title: Layer7 Summary Managed Rules + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1managed_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary_managed_rules/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary_mitigation_product: + id: cloudflare.radar.layer7_summary_mitigation_product + name: layer7_summary_mitigation_product + title: Layer7 Summary Mitigation Product + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1mitigation_product/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary_mitigation_product/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary_vertical: + id: cloudflare.radar.layer7_summary_vertical + name: layer7_summary_vertical + title: Layer7 Summary Vertical + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1vertical/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary_vertical/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_summary: + id: cloudflare.radar.layer7_summary + name: layer7_summary + title: Layer7 Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + layer7: + id: cloudflare.radar.layer7 + name: layer7 + title: Layer7 + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups_http_method: + id: cloudflare.radar.layer7_timeseries_groups_http_method + name: layer7_timeseries_groups_http_method + title: Layer7 Timeseries Groups Http Method + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1http_method/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups_http_method/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups_http_version: + id: cloudflare.radar.layer7_timeseries_groups_http_version + name: layer7_timeseries_groups_http_version + title: Layer7 Timeseries Groups Http Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1http_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups_http_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups_industry: + id: cloudflare.radar.layer7_timeseries_groups_industry + name: layer7_timeseries_groups_industry + title: Layer7 Timeseries Groups Industry + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1industry/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups_industry/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups_ip_version: + id: cloudflare.radar.layer7_timeseries_groups_ip_version + name: layer7_timeseries_groups_ip_version + title: Layer7 Timeseries Groups Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups_managed_rules: + id: cloudflare.radar.layer7_timeseries_groups_managed_rules + name: layer7_timeseries_groups_managed_rules + title: Layer7 Timeseries Groups Managed Rules + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1managed_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups_managed_rules/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups_mitigation_product: + id: cloudflare.radar.layer7_timeseries_groups_mitigation_product + name: layer7_timeseries_groups_mitigation_product + title: Layer7 Timeseries Groups Mitigation Product + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1mitigation_product/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups_mitigation_product/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups_vertical: + id: cloudflare.radar.layer7_timeseries_groups_vertical + name: layer7_timeseries_groups_vertical + title: Layer7 Timeseries Groups Vertical + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1vertical/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups_vertical/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_timeseries_groups: + id: cloudflare.radar.layer7_timeseries_groups + name: layer7_timeseries_groups + title: Layer7 Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + top_ases_origin: + id: cloudflare.radar.top_ases_origin + name: top_ases_origin + title: Top Ases Origin + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1top~1ases~1origin/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/top_ases_origin/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_top_attacks: + id: cloudflare.radar.layer7_top_attacks + name: layer7_top_attacks + title: Layer7 Top Attacks + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1top~1attacks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_top_attacks/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_top_industry: + id: cloudflare.radar.layer7_top_industry + name: layer7_top_industry + title: Layer7 Top Industry + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1top~1industry/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_top_industry/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_top_locations_origin: + id: cloudflare.radar.layer7_top_locations_origin + name: layer7_top_locations_origin + title: Layer7 Top Locations Origin + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1top~1locations~1origin/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_top_locations_origin/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_top_locations_target: + id: cloudflare.radar.layer7_top_locations_target + name: layer7_top_locations_target + title: Layer7 Top Locations Target + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1top~1locations~1target/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_top_locations_target/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + layer7_top_vertical: + id: cloudflare.radar.layer7_top_vertical + name: layer7_top_vertical + title: Layer7 Top Vertical + methods: + list: + operation: + $ref: '#/paths/~1radar~1attacks~1layer7~1top~1vertical/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/layer7_top_vertical/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + hijacks_events: + id: cloudflare.radar.hijacks_events + name: hijacks_events + title: Hijacks Events + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1hijacks~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hijacks_events/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ips: + id: cloudflare.radar.ips + name: ips + title: Ips + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1ips~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ips/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ips_top_ases: + id: cloudflare.radar.ips_top_ases + name: ips_top_ases + title: Ips Top Ases + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1ips~1top~1ases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ips_top_ases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + leaks_events: + id: cloudflare.radar.leaks_events + name: leaks_events + title: Leaks Events + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1leaks~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leaks_events/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routes_ases: + id: cloudflare.radar.routes_ases + name: routes_ases + title: Routes Ases + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1routes~1ases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes_ases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routes_moas: + id: cloudflare.radar.routes_moas + name: routes_moas + title: Routes Moas + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1routes~1moas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes_moas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routes_pfx2as: + id: cloudflare.radar.routes_pfx2as + name: routes_pfx2as + title: Routes Pfx2as + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1routes~1pfx2as/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes_pfx2as/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routes_realtime: + id: cloudflare.radar.routes_realtime + name: routes_realtime + title: Routes Realtime + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1routes~1realtime/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes_realtime/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routes_stats: + id: cloudflare.radar.routes_stats + name: routes_stats + title: Routes Stats + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1routes~1stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes_stats/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + aspa_changes: + id: cloudflare.radar.aspa_changes + name: aspa_changes + title: Aspa Changes + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1rpki~1aspa~1changes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/aspa_changes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + aspa_snapshot: + id: cloudflare.radar.aspa_snapshot + name: aspa_snapshot + title: Aspa Snapshot + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1rpki~1aspa~1snapshot/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/aspa_snapshot/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + aspa_timeseries: + id: cloudflare.radar.aspa_timeseries + name: aspa_timeseries + title: Aspa Timeseries + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1rpki~1aspa~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/aspa_timeseries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + roas: + id: cloudflare.radar.roas + name: roas + title: Roas + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1rpki~1roas~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/roas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bgp: + id: cloudflare.radar.bgp + name: bgp + title: Bgp + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bgp/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bgp_top_ases: + id: cloudflare.radar.bgp_top_ases + name: bgp_top_ases + title: Bgp Top Ases + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1top~1ases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bgp_top_ases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + top_ases_prefixes: + id: cloudflare.radar.top_ases_prefixes + name: top_ases_prefixes + title: Top Ases Prefixes + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1top~1ases~1prefixes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/top_ases_prefixes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bgp_top_prefixes: + id: cloudflare.radar.bgp_top_prefixes + name: bgp_top_prefixes + title: Bgp Top Prefixes + methods: + list: + operation: + $ref: '#/paths/~1radar~1bgp~1top~1prefixes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bgp_top_prefixes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + radar_bots: + id: cloudflare.radar.radar_bots + name: radar_bots + title: Radar Bots + methods: + list: + operation: + $ref: '#/paths/~1radar~1bots/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.bots + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/radar_bots/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + crawlers_summary: + id: cloudflare.radar.crawlers_summary + name: crawlers_summary + title: Crawlers Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1bots~1crawlers~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/crawlers_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + crawlers_timeseries_groups: + id: cloudflare.radar.crawlers_timeseries_groups + name: crawlers_timeseries_groups + title: Crawlers Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1bots~1crawlers~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/crawlers_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + bots_summary_dimension_f85b26: + id: cloudflare.radar.bots_summary_dimension_f85b26 + name: bots_summary_dimension_f85b26 + title: Bots Summary Dimension F85b26 + methods: + get: + operation: + $ref: '#/paths/~1radar~1bots~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots_summary_dimension_f85b26/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + bots_timeseries: + id: cloudflare.radar.bots_timeseries + name: bots_timeseries + title: Bots Timeseries + methods: + list: + operation: + $ref: '#/paths/~1radar~1bots~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots_timeseries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bots_timeseries_groups_dimension_42beed: + id: cloudflare.radar.bots_timeseries_groups_dimension_42beed + name: bots_timeseries_groups_dimension_42beed + title: Bots Timeseries Groups Dimension 42beed + methods: + get: + operation: + $ref: '#/paths/~1radar~1bots~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots_timeseries_groups_dimension_42beed/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + bots: + id: cloudflare.radar.bots + name: bots + title: Bots + methods: + get: + operation: + $ref: '#/paths/~1radar~1bots~1{bot_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bots/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + authorities: + id: cloudflare.radar.authorities + name: authorities + title: Authorities + methods: + list: + operation: + $ref: '#/paths/~1radar~1ct~1authorities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.certificateAuthorities + get: + operation: + $ref: '#/paths/~1radar~1ct~1authorities~1{ca_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/authorities/methods/get' + - $ref: '#/components/x-stackQL-resources/authorities/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + logs: + id: cloudflare.radar.logs + name: logs + title: Logs + methods: + list: + operation: + $ref: '#/paths/~1radar~1ct~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.certificateLogs + get: + operation: + $ref: '#/paths/~1radar~1ct~1logs~1{log_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/get' + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ct_summary: + id: cloudflare.radar.ct_summary + name: ct_summary + title: Ct Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1ct~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ct_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ct: + id: cloudflare.radar.ct + name: ct + title: Ct + methods: + list: + operation: + $ref: '#/paths/~1radar~1ct~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ct/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ct_timeseries_groups: + id: cloudflare.radar.ct_timeseries_groups + name: ct_timeseries_groups + title: Ct Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1ct~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ct_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + datasets: + id: cloudflare.radar.datasets + name: datasets + title: Datasets + methods: + list: + operation: + $ref: '#/paths/~1radar~1datasets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.datasets + download: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1radar~1datasets~1download/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1radar~1datasets~1{alias}/get' + response: + mediaType: text/csv + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/datasets/methods/get' + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/download' + update: [] + delete: [] + replace: [] + dns_summary_cache_hit: + id: cloudflare.radar.dns_summary_cache_hit + name: dns_summary_cache_hit + title: Dns Summary Cache Hit + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1cache_hit/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_cache_hit/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_dnssec: + id: cloudflare.radar.dns_summary_dnssec + name: dns_summary_dnssec + title: Dns Summary Dnssec + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1dnssec/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_dnssec/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_dnssec_aware: + id: cloudflare.radar.dns_summary_dnssec_aware + name: dns_summary_dnssec_aware + title: Dns Summary Dnssec Aware + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1dnssec_aware/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_dnssec_aware/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_dnssec_e2e: + id: cloudflare.radar.dns_summary_dnssec_e2e + name: dns_summary_dnssec_e2e + title: Dns Summary Dnssec E2e + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1dnssec_e2e/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_dnssec_e2e/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_ip_version: + id: cloudflare.radar.dns_summary_ip_version + name: dns_summary_ip_version + title: Dns Summary Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_matching_answer: + id: cloudflare.radar.dns_summary_matching_answer + name: dns_summary_matching_answer + title: Dns Summary Matching Answer + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1matching_answer/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_matching_answer/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_protocol: + id: cloudflare.radar.dns_summary_protocol + name: dns_summary_protocol + title: Dns Summary Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_query_type: + id: cloudflare.radar.dns_summary_query_type + name: dns_summary_query_type + title: Dns Summary Query Type + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1query_type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_query_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_response_code: + id: cloudflare.radar.dns_summary_response_code + name: dns_summary_response_code + title: Dns Summary Response Code + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1response_code/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_response_code/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary_response_ttl: + id: cloudflare.radar.dns_summary_response_ttl + name: dns_summary_response_ttl + title: Dns Summary Response Ttl + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1response_ttl/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary_response_ttl/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_summary: + id: cloudflare.radar.dns_summary + name: dns_summary + title: Dns Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1dns~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + dns: + id: cloudflare.radar.dns + name: dns + title: Dns + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_cache_hit: + id: cloudflare.radar.dns_timeseries_groups_cache_hit + name: dns_timeseries_groups_cache_hit + title: Dns Timeseries Groups Cache Hit + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1cache_hit/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_cache_hit/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_dnssec: + id: cloudflare.radar.dns_timeseries_groups_dnssec + name: dns_timeseries_groups_dnssec + title: Dns Timeseries Groups Dnssec + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1dnssec/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_dnssec/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_dnssec_aware: + id: cloudflare.radar.dns_timeseries_groups_dnssec_aware + name: dns_timeseries_groups_dnssec_aware + title: Dns Timeseries Groups Dnssec Aware + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1dnssec_aware/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_dnssec_aware/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_dnssec_e2e: + id: cloudflare.radar.dns_timeseries_groups_dnssec_e2e + name: dns_timeseries_groups_dnssec_e2e + title: Dns Timeseries Groups Dnssec E2e + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1dnssec_e2e/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_dnssec_e2e/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_ip_version: + id: cloudflare.radar.dns_timeseries_groups_ip_version + name: dns_timeseries_groups_ip_version + title: Dns Timeseries Groups Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_matching_answer: + id: cloudflare.radar.dns_timeseries_groups_matching_answer + name: dns_timeseries_groups_matching_answer + title: Dns Timeseries Groups Matching Answer + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1matching_answer/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_matching_answer/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_protocol: + id: cloudflare.radar.dns_timeseries_groups_protocol + name: dns_timeseries_groups_protocol + title: Dns Timeseries Groups Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_query_type: + id: cloudflare.radar.dns_timeseries_groups_query_type + name: dns_timeseries_groups_query_type + title: Dns Timeseries Groups Query Type + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1query_type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_query_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_response_code: + id: cloudflare.radar.dns_timeseries_groups_response_code + name: dns_timeseries_groups_response_code + title: Dns Timeseries Groups Response Code + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1response_code/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_response_code/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups_response_ttl: + id: cloudflare.radar.dns_timeseries_groups_response_ttl + name: dns_timeseries_groups_response_ttl + title: Dns Timeseries Groups Response Ttl + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1response_ttl/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups_response_ttl/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_timeseries_groups: + id: cloudflare.radar.dns_timeseries_groups + name: dns_timeseries_groups + title: Dns Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1dns~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + dns_top_ases: + id: cloudflare.radar.dns_top_ases + name: dns_top_ases + title: Dns Top Ases + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1top~1ases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_top_ases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dns_top_locations: + id: cloudflare.radar.dns_top_locations + name: dns_top_locations + title: Dns Top Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1dns~1top~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_top_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_summary_arc: + id: cloudflare.radar.routing_summary_arc + name: routing_summary_arc + title: Routing Summary Arc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1summary~1arc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_summary_arc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_summary_dkim: + id: cloudflare.radar.routing_summary_dkim + name: routing_summary_dkim + title: Routing Summary Dkim + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1summary~1dkim/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_summary_dkim/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_summary_dmarc: + id: cloudflare.radar.routing_summary_dmarc + name: routing_summary_dmarc + title: Routing Summary Dmarc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1summary~1dmarc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_summary_dmarc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_summary_encrypted: + id: cloudflare.radar.routing_summary_encrypted + name: routing_summary_encrypted + title: Routing Summary Encrypted + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1summary~1encrypted/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_summary_encrypted/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_summary_ip_version: + id: cloudflare.radar.routing_summary_ip_version + name: routing_summary_ip_version + title: Routing Summary Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1summary~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_summary_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_summary_spf: + id: cloudflare.radar.routing_summary_spf + name: routing_summary_spf + title: Routing Summary Spf + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1summary~1spf/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_summary_spf/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_summary: + id: cloudflare.radar.routing_summary + name: routing_summary + title: Routing Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1email~1routing~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + routing_timeseries_groups_arc: + id: cloudflare.radar.routing_timeseries_groups_arc + name: routing_timeseries_groups_arc + title: Routing Timeseries Groups Arc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1timeseries_groups~1arc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_timeseries_groups_arc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_timeseries_groups_dkim: + id: cloudflare.radar.routing_timeseries_groups_dkim + name: routing_timeseries_groups_dkim + title: Routing Timeseries Groups Dkim + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1timeseries_groups~1dkim/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_timeseries_groups_dkim/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_timeseries_groups_dmarc: + id: cloudflare.radar.routing_timeseries_groups_dmarc + name: routing_timeseries_groups_dmarc + title: Routing Timeseries Groups Dmarc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1timeseries_groups~1dmarc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_timeseries_groups_dmarc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_timeseries_groups_encrypted: + id: cloudflare.radar.routing_timeseries_groups_encrypted + name: routing_timeseries_groups_encrypted + title: Routing Timeseries Groups Encrypted + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1timeseries_groups~1encrypted/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_timeseries_groups_encrypted/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_timeseries_groups_ip_version: + id: cloudflare.radar.routing_timeseries_groups_ip_version + name: routing_timeseries_groups_ip_version + title: Routing Timeseries Groups Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1timeseries_groups~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_timeseries_groups_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_timeseries_groups_spf: + id: cloudflare.radar.routing_timeseries_groups_spf + name: routing_timeseries_groups_spf + title: Routing Timeseries Groups Spf + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1routing~1timeseries_groups~1spf/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_timeseries_groups_spf/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + routing_timeseries_groups: + id: cloudflare.radar.routing_timeseries_groups + name: routing_timeseries_groups + title: Routing Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1email~1routing~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_arc: + id: cloudflare.radar.security_summary_arc + name: security_summary_arc + title: Security Summary Arc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1arc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_arc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_dkim: + id: cloudflare.radar.security_summary_dkim + name: security_summary_dkim + title: Security Summary Dkim + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1dkim/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_dkim/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_dmarc: + id: cloudflare.radar.security_summary_dmarc + name: security_summary_dmarc + title: Security Summary Dmarc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1dmarc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_dmarc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_malicious: + id: cloudflare.radar.security_summary_malicious + name: security_summary_malicious + title: Security Summary Malicious + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1malicious/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_malicious/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_spam: + id: cloudflare.radar.security_summary_spam + name: security_summary_spam + title: Security Summary Spam + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1spam/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_spam/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_spf: + id: cloudflare.radar.security_summary_spf + name: security_summary_spf + title: Security Summary Spf + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1spf/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_spf/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_spoof: + id: cloudflare.radar.security_summary_spoof + name: security_summary_spoof + title: Security Summary Spoof + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1spoof/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_spoof/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_threat_category: + id: cloudflare.radar.security_summary_threat_category + name: security_summary_threat_category + title: Security Summary Threat Category + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1threat_category/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_threat_category/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary_tls_version: + id: cloudflare.radar.security_summary_tls_version + name: security_summary_tls_version + title: Security Summary Tls Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1tls_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary_tls_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_summary: + id: cloudflare.radar.security_summary + name: security_summary + title: Security Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1email~1security~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_arc: + id: cloudflare.radar.security_timeseries_groups_arc + name: security_timeseries_groups_arc + title: Security Timeseries Groups Arc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1arc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_arc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_dkim: + id: cloudflare.radar.security_timeseries_groups_dkim + name: security_timeseries_groups_dkim + title: Security Timeseries Groups Dkim + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1dkim/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_dkim/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_dmarc: + id: cloudflare.radar.security_timeseries_groups_dmarc + name: security_timeseries_groups_dmarc + title: Security Timeseries Groups Dmarc + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1dmarc/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_dmarc/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_malicious: + id: cloudflare.radar.security_timeseries_groups_malicious + name: security_timeseries_groups_malicious + title: Security Timeseries Groups Malicious + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1malicious/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_malicious/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_spam: + id: cloudflare.radar.security_timeseries_groups_spam + name: security_timeseries_groups_spam + title: Security Timeseries Groups Spam + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1spam/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_spam/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_spf: + id: cloudflare.radar.security_timeseries_groups_spf + name: security_timeseries_groups_spf + title: Security Timeseries Groups Spf + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1spf/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_spf/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_spoof: + id: cloudflare.radar.security_timeseries_groups_spoof + name: security_timeseries_groups_spoof + title: Security Timeseries Groups Spoof + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1spoof/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_spoof/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_threat_category: + id: cloudflare.radar.security_timeseries_groups_threat_category + name: security_timeseries_groups_threat_category + title: Security Timeseries Groups Threat Category + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1threat_category/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_threat_category/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups_tls_version: + id: cloudflare.radar.security_timeseries_groups_tls_version + name: security_timeseries_groups_tls_version + title: Security Timeseries Groups Tls Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1tls_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups_tls_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + security_timeseries_groups: + id: cloudflare.radar.security_timeseries_groups + name: security_timeseries_groups + title: Security Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1email~1security~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + top_tlds: + id: cloudflare.radar.top_tlds + name: top_tlds + title: Top Tlds + methods: + list: + operation: + $ref: '#/paths/~1radar~1email~1security~1top~1tlds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/top_tlds/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + malicious: + id: cloudflare.radar.malicious + name: malicious + title: Malicious + methods: + get: + operation: + $ref: '#/paths/~1radar~1email~1security~1top~1tlds~1malicious~1{malicious}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/malicious/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + spam: + id: cloudflare.radar.spam + name: spam + title: Spam + methods: + get: + operation: + $ref: '#/paths/~1radar~1email~1security~1top~1tlds~1spam~1{spam}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/spam/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + spoof: + id: cloudflare.radar.spoof + name: spoof + title: Spoof + methods: + get: + operation: + $ref: '#/paths/~1radar~1email~1security~1top~1tlds~1spoof~1{spoof}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/spoof/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + entities_asns: + id: cloudflare.radar.entities_asns + name: entities_asns + title: Entities Asns + methods: + list: + operation: + $ref: '#/paths/~1radar~1entities~1asns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.asns + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/entities_asns/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + asns_botnet_threat_feed: + id: cloudflare.radar.asns_botnet_threat_feed + name: asns_botnet_threat_feed + title: Asns Botnet Threat Feed + methods: + list: + operation: + $ref: '#/paths/~1radar~1entities~1asns~1botnet_threat_feed/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asns_botnet_threat_feed/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + asns_ip: + id: cloudflare.radar.asns_ip + name: asns_ip + title: Asns Ip + methods: + list: + operation: + $ref: '#/paths/~1radar~1entities~1asns~1ip/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asns_ip/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + asns: + id: cloudflare.radar.asns + name: asns + title: Asns + methods: + get: + operation: + $ref: '#/paths/~1radar~1entities~1asns~1{asn}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asns/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + asns_as_set: + id: cloudflare.radar.asns_as_set + name: asns_as_set + title: Asns As Set + methods: + list: + operation: + $ref: '#/paths/~1radar~1entities~1asns~1{asn}~1as_set/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asns_as_set/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + asns_rel: + id: cloudflare.radar.asns_rel + name: asns_rel + title: Asns Rel + methods: + list: + operation: + $ref: '#/paths/~1radar~1entities~1asns~1{asn}~1rel/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/asns_rel/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + entities: + id: cloudflare.radar.entities + name: entities + title: Entities + methods: + list: + operation: + $ref: '#/paths/~1radar~1entities~1ip/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/entities/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + radar_entities_locations: + id: cloudflare.radar.radar_entities_locations + name: radar_entities_locations + title: Radar Entities Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1entities~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.locations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/radar_entities_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + locations: + id: cloudflare.radar.locations + name: locations + title: Locations + methods: + get: + operation: + $ref: '#/paths/~1radar~1entities~1locations~1{location}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + geolocations: + id: cloudflare.radar.geolocations + name: geolocations + title: Geolocations + methods: + list: + operation: + $ref: '#/paths/~1radar~1geolocations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.geolocations + get: + operation: + $ref: '#/paths/~1radar~1geolocations~1{geo_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/geolocations/methods/get' + - $ref: '#/components/x-stackQL-resources/geolocations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_bot_class: + id: cloudflare.radar.http_summary_bot_class + name: http_summary_bot_class + title: Http Summary Bot Class + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1bot_class/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_bot_class/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_device_type: + id: cloudflare.radar.http_summary_device_type + name: http_summary_device_type + title: Http Summary Device Type + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1device_type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_device_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_http_protocol: + id: cloudflare.radar.http_summary_http_protocol + name: http_summary_http_protocol + title: Http Summary Http Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1http_protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_http_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_http_version: + id: cloudflare.radar.http_summary_http_version + name: http_summary_http_version + title: Http Summary Http Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1http_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_http_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_ip_version: + id: cloudflare.radar.http_summary_ip_version + name: http_summary_ip_version + title: Http Summary Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_os: + id: cloudflare.radar.http_summary_os + name: http_summary_os + title: Http Summary Os + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1os/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_os/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_post_quantum: + id: cloudflare.radar.http_summary_post_quantum + name: http_summary_post_quantum + title: Http Summary Post Quantum + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1post_quantum/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_post_quantum/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary_tls_version: + id: cloudflare.radar.http_summary_tls_version + name: http_summary_tls_version + title: Http Summary Tls Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1summary~1tls_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary_tls_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_summary: + id: cloudflare.radar.http_summary + name: http_summary + title: Http Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + http: + id: cloudflare.radar.http + name: http + title: Http + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_bot_class: + id: cloudflare.radar.http_timeseries_groups_bot_class + name: http_timeseries_groups_bot_class + title: Http Timeseries Groups Bot Class + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1bot_class/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_bot_class/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_browser: + id: cloudflare.radar.http_timeseries_groups_browser + name: http_timeseries_groups_browser + title: Http Timeseries Groups Browser + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1browser/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_browser/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_browser_family: + id: cloudflare.radar.http_timeseries_groups_browser_family + name: http_timeseries_groups_browser_family + title: Http Timeseries Groups Browser Family + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1browser_family/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_browser_family/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_device_type: + id: cloudflare.radar.http_timeseries_groups_device_type + name: http_timeseries_groups_device_type + title: Http Timeseries Groups Device Type + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1device_type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_device_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_http_protocol: + id: cloudflare.radar.http_timeseries_groups_http_protocol + name: http_timeseries_groups_http_protocol + title: Http Timeseries Groups Http Protocol + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1http_protocol/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_http_protocol/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_http_version: + id: cloudflare.radar.http_timeseries_groups_http_version + name: http_timeseries_groups_http_version + title: Http Timeseries Groups Http Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1http_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_http_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_ip_version: + id: cloudflare.radar.http_timeseries_groups_ip_version + name: http_timeseries_groups_ip_version + title: Http Timeseries Groups Ip Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1ip_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_ip_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_os: + id: cloudflare.radar.http_timeseries_groups_os + name: http_timeseries_groups_os + title: Http Timeseries Groups Os + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1os/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_os/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_post_quantum: + id: cloudflare.radar.http_timeseries_groups_post_quantum + name: http_timeseries_groups_post_quantum + title: Http Timeseries Groups Post Quantum + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1post_quantum/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_post_quantum/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups_tls_version: + id: cloudflare.radar.http_timeseries_groups_tls_version + name: http_timeseries_groups_tls_version + title: Http Timeseries Groups Tls Version + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1tls_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups_tls_version/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_timeseries_groups: + id: cloudflare.radar.http_timeseries_groups + name: http_timeseries_groups + title: Http Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + http_top_ases: + id: cloudflare.radar.http_top_ases + name: http_top_ases + title: Http Top Ases + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_top_ases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ases_bot_class: + id: cloudflare.radar.ases_bot_class + name: ases_bot_class + title: Ases Bot Class + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1bot_class~1{bot_class}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_bot_class/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ases_browser_family: + id: cloudflare.radar.ases_browser_family + name: ases_browser_family + title: Ases Browser Family + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1browser_family~1{browser_family}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_browser_family/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ases_device_type: + id: cloudflare.radar.ases_device_type + name: ases_device_type + title: Ases Device Type + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1device_type~1{device_type}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_device_type/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ases_http_protocol: + id: cloudflare.radar.ases_http_protocol + name: ases_http_protocol + title: Ases Http Protocol + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1http_protocol~1{http_protocol}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_http_protocol/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ases_http_version: + id: cloudflare.radar.ases_http_version + name: ases_http_version + title: Ases Http Version + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1http_version~1{http_version}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_http_version/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ases_ip_version: + id: cloudflare.radar.ases_ip_version + name: ases_ip_version + title: Ases Ip Version + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1ip_version~1{ip_version}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_ip_version/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ases_os: + id: cloudflare.radar.ases_os + name: ases_os + title: Ases Os + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1os~1{os}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_os/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ases_tls_version: + id: cloudflare.radar.ases_tls_version + name: ases_tls_version + title: Ases Tls Version + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1ases~1tls_version~1{tls_version}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ases_tls_version/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + http_top_browser: + id: cloudflare.radar.http_top_browser + name: http_top_browser + title: Http Top Browser + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1top~1browser/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_top_browser/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_top_browser_family: + id: cloudflare.radar.http_top_browser_family + name: http_top_browser_family + title: Http Top Browser Family + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1top~1browser_family/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_top_browser_family/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + radar_http_top_locations: + id: cloudflare.radar.radar_http_top_locations + name: radar_http_top_locations + title: Radar Http Top Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/radar_http_top_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + locations_bot_class: + id: cloudflare.radar.locations_bot_class + name: locations_bot_class + title: Locations Bot Class + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1bot_class~1{bot_class}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_bot_class/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + locations_browser_family: + id: cloudflare.radar.locations_browser_family + name: locations_browser_family + title: Locations Browser Family + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1browser_family~1{browser_family}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_browser_family/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + locations_device_type: + id: cloudflare.radar.locations_device_type + name: locations_device_type + title: Locations Device Type + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1device_type~1{device_type}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_device_type/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + locations_http_protocol: + id: cloudflare.radar.locations_http_protocol + name: locations_http_protocol + title: Locations Http Protocol + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1http_protocol~1{http_protocol}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_http_protocol/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + locations_http_version: + id: cloudflare.radar.locations_http_version + name: locations_http_version + title: Locations Http Version + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1http_version~1{http_version}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_http_version/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + http_top_locations_ip_version: + id: cloudflare.radar.http_top_locations_ip_version + name: http_top_locations_ip_version + title: Http Top Locations Ip Version + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1ip_version~1{ip_version}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_top_locations_ip_version/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + locations_os: + id: cloudflare.radar.locations_os + name: locations_os + title: Locations Os + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1os~1{os}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_os/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + locations_tls_version: + id: cloudflare.radar.locations_tls_version + name: locations_tls_version + title: Locations Tls Version + methods: + get: + operation: + $ref: '#/paths/~1radar~1http~1top~1locations~1tls_version~1{tls_version}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations_tls_version/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + leaked_credential_checks_summary_bot_class: + id: cloudflare.radar.leaked_credential_checks_summary_bot_class + name: leaked_credential_checks_summary_bot_class + title: Leaked Credential Checks Summary Bot Class + methods: + list: + operation: + $ref: '#/paths/~1radar~1leaked_credential_checks~1summary~1bot_class/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leaked_credential_checks_summary_bot_class/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + leaked_credential_checks_summary_compromised: + id: cloudflare.radar.leaked_credential_checks_summary_compromised + name: leaked_credential_checks_summary_compromised + title: Leaked Credential Checks Summary Compromised + methods: + list: + operation: + $ref: '#/paths/~1radar~1leaked_credential_checks~1summary~1compromised/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leaked_credential_checks_summary_compromised/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + leaked_credential_checks_summary: + id: cloudflare.radar.leaked_credential_checks_summary + name: leaked_credential_checks_summary + title: Leaked Credential Checks Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1leaked_credential_checks~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leaked_credential_checks_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + leaked_credential_checks_timeseries_groups_bot_class: + id: cloudflare.radar.leaked_credential_checks_timeseries_groups_bot_class + name: leaked_credential_checks_timeseries_groups_bot_class + title: Leaked Credential Checks Timeseries Groups Bot Class + methods: + list: + operation: + $ref: '#/paths/~1radar~1leaked_credential_checks~1timeseries_groups~1bot_class/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leaked_credential_checks_timeseries_groups_bot_class/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + leaked_credential_checks_timeseries_groups_compromised: + id: cloudflare.radar.leaked_credential_checks_timeseries_groups_compromised + name: leaked_credential_checks_timeseries_groups_compromised + title: Leaked Credential Checks Timeseries Groups Compromised + methods: + list: + operation: + $ref: '#/paths/~1radar~1leaked_credential_checks~1timeseries_groups~1compromised/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leaked_credential_checks_timeseries_groups_compromised/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + leaked_credential_checks_timeseries_groups: + id: cloudflare.radar.leaked_credential_checks_timeseries_groups + name: leaked_credential_checks_timeseries_groups + title: Leaked Credential Checks Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1leaked_credential_checks~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/leaked_credential_checks_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + netflows_summary: + id: cloudflare.radar.netflows_summary + name: netflows_summary + title: Netflows Summary + methods: + list: + operation: + $ref: '#/paths/~1radar~1netflows~1summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1radar~1netflows~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/netflows_summary/methods/get' + - $ref: '#/components/x-stackQL-resources/netflows_summary/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + netflows_timeseries: + id: cloudflare.radar.netflows_timeseries + name: netflows_timeseries + title: Netflows Timeseries + methods: + list: + operation: + $ref: '#/paths/~1radar~1netflows~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/netflows_timeseries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + netflows_timeseries_groups: + id: cloudflare.radar.netflows_timeseries_groups + name: netflows_timeseries_groups + title: Netflows Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1netflows~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/netflows_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + netflows_top_ases: + id: cloudflare.radar.netflows_top_ases + name: netflows_top_ases + title: Netflows Top Ases + methods: + list: + operation: + $ref: '#/paths/~1radar~1netflows~1top~1ases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/netflows_top_ases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + netflows_top_locations: + id: cloudflare.radar.netflows_top_locations + name: netflows_top_locations + title: Netflows Top Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1netflows~1top~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/netflows_top_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + origins: + id: cloudflare.radar.origins + name: origins + title: Origins + methods: + list: + operation: + $ref: '#/paths/~1radar~1origins/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.origins + get: + operation: + $ref: '#/paths/~1radar~1origins~1{slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/origins/methods/get' + - $ref: '#/components/x-stackQL-resources/origins/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + summary: + id: cloudflare.radar.summary + name: summary + title: Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1origins~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + timeseries: + id: cloudflare.radar.timeseries + name: timeseries + title: Timeseries + methods: + list: + operation: + $ref: '#/paths/~1radar~1origins~1timeseries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/timeseries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + origins_timeseries_groups: + id: cloudflare.radar.origins_timeseries_groups + name: origins_timeseries_groups + title: Origins Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1origins~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/origins_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + origin_summary: + id: cloudflare.radar.origin_summary + name: origin_summary + title: Origin Summary + methods: + get: + operation: + $ref: '#/paths/~1radar~1post_quantum~1origin~1summary~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/origin_summary/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + origin_timeseries_groups: + id: cloudflare.radar.origin_timeseries_groups + name: origin_timeseries_groups + title: Origin Timeseries Groups + methods: + get: + operation: + $ref: '#/paths/~1radar~1post_quantum~1origin~1timeseries_groups~1{dimension}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/origin_timeseries_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + tls: + id: cloudflare.radar.tls + name: tls + title: Tls + methods: + list: + operation: + $ref: '#/paths/~1radar~1post_quantum~1tls~1support/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tls/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + iqi_summary: + id: cloudflare.radar.iqi_summary + name: iqi_summary + title: Iqi Summary + methods: + list: + operation: + $ref: '#/paths/~1radar~1quality~1iqi~1summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/iqi_summary/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + iqi_timeseries_groups: + id: cloudflare.radar.iqi_timeseries_groups + name: iqi_timeseries_groups + title: Iqi Timeseries Groups + methods: + list: + operation: + $ref: '#/paths/~1radar~1quality~1iqi~1timeseries_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/iqi_timeseries_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + speed_histogram: + id: cloudflare.radar.speed_histogram + name: speed_histogram + title: Speed Histogram + methods: + list: + operation: + $ref: '#/paths/~1radar~1quality~1speed~1histogram/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/speed_histogram/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + speed_summary: + id: cloudflare.radar.speed_summary + name: speed_summary + title: Speed Summary + methods: + list: + operation: + $ref: '#/paths/~1radar~1quality~1speed~1summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/speed_summary/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + speed_top_ases: + id: cloudflare.radar.speed_top_ases + name: speed_top_ases + title: Speed Top Ases + methods: + list: + operation: + $ref: '#/paths/~1radar~1quality~1speed~1top~1ases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/speed_top_ases/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + speed_top_locations: + id: cloudflare.radar.speed_top_locations + name: speed_top_locations + title: Speed Top Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1quality~1speed~1top~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/speed_top_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + domain: + id: cloudflare.radar.domain + name: domain + title: Domain + methods: + get: + operation: + $ref: '#/paths/~1radar~1ranking~1domain~1{domain}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domain/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + internet_services_categories: + id: cloudflare.radar.internet_services_categories + name: internet_services_categories + title: Internet Services Categories + methods: + list: + operation: + $ref: '#/paths/~1radar~1ranking~1internet_services~1categories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.categories_0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/internet_services_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + internet_services_timeseries_groups: + id: cloudflare.radar.internet_services_timeseries_groups + name: internet_services_timeseries_groups + title: Internet Services Timeseries Groups + methods: + list: + operation: + $ref: '#/paths/~1radar~1ranking~1internet_services~1timeseries_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/internet_services_timeseries_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + internet_services_top: + id: cloudflare.radar.internet_services_top + name: internet_services_top + title: Internet Services Top + methods: + list: + operation: + $ref: '#/paths/~1radar~1ranking~1internet_services~1top/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/internet_services_top/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ranking_timeseries_groups: + id: cloudflare.radar.ranking_timeseries_groups + name: ranking_timeseries_groups + title: Ranking Timeseries Groups + methods: + list: + operation: + $ref: '#/paths/~1radar~1ranking~1timeseries_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ranking_timeseries_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ranking_top: + id: cloudflare.radar.ranking_top + name: ranking_top + title: Ranking Top + methods: + list: + operation: + $ref: '#/paths/~1radar~1ranking~1top/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ranking_top/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + robots_txt_top_domain_categories: + id: cloudflare.radar.robots_txt_top_domain_categories + name: robots_txt_top_domain_categories + title: Robots Txt Top Domain Categories + methods: + list: + operation: + $ref: '#/paths/~1radar~1robots_txt~1top~1domain_categories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/robots_txt_top_domain_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + user_agents: + id: cloudflare.radar.user_agents + name: user_agents + title: User Agents + methods: + list: + operation: + $ref: '#/paths/~1radar~1robots_txt~1top~1user_agents~1directive/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_agents/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + search: + id: cloudflare.radar.search + name: search + title: Search + methods: + list: + operation: + $ref: '#/paths/~1radar~1search~1global/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.search + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/search/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tcp_resets_timeouts_summary: + id: cloudflare.radar.tcp_resets_timeouts_summary + name: tcp_resets_timeouts_summary + title: Tcp Resets Timeouts Summary + methods: + list: + operation: + $ref: '#/paths/~1radar~1tcp_resets_timeouts~1summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tcp_resets_timeouts_summary/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tcp_resets_timeouts_timeseries_groups: + id: cloudflare.radar.tcp_resets_timeouts_timeseries_groups + name: tcp_resets_timeouts_timeseries_groups + title: Tcp Resets Timeouts Timeseries Groups + methods: + list: + operation: + $ref: '#/paths/~1radar~1tcp_resets_timeouts~1timeseries_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tcp_resets_timeouts_timeseries_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + radar_tlds: + id: cloudflare.radar.radar_tlds + name: radar_tlds + title: Radar Tlds + methods: + list: + operation: + $ref: '#/paths/~1radar~1tlds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.tlds + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/radar_tlds/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tlds: + id: cloudflare.radar.tlds + name: tlds + title: Tlds + methods: + get: + operation: + $ref: '#/paths/~1radar~1tlds~1{tld}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tlds/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + traffic_anomalies: + id: cloudflare.radar.traffic_anomalies + name: traffic_anomalies + title: Traffic Anomalies + methods: + list: + operation: + $ref: '#/paths/~1radar~1traffic_anomalies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.trafficAnomalies + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/traffic_anomalies/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + radar_traffic_anomalies_locations: + id: cloudflare.radar.radar_traffic_anomalies_locations + name: radar_traffic_anomalies_locations + title: Radar Traffic Anomalies Locations + methods: + list: + operation: + $ref: '#/paths/~1radar~1traffic_anomalies~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.trafficAnomalies + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/radar_traffic_anomalies_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + verified_bots_top_bots: + id: cloudflare.radar.verified_bots_top_bots + name: verified_bots_top_bots + title: Verified Bots Top Bots + methods: + list: + operation: + $ref: '#/paths/~1radar~1verified_bots~1top~1bots/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/verified_bots_top_bots/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + verified_bots_top_categories: + id: cloudflare.radar.verified_bots_top_categories + name: verified_bots_top_categories + title: Verified Bots Top Categories + methods: + list: + operation: + $ref: '#/paths/~1radar~1verified_bots~1top~1categories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/verified_bots_top_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/railgun.yaml b/providers/src/cloudflare/v00.00.00000/services/railgun.yaml deleted file mode 100644 index 15093e67..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/railgun.yaml +++ /dev/null @@ -1,2133 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Account Railguns - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - railgun - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - railgun_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/railgun' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - railgun: - properties: - activated_on: - $ref: '#/components/schemas/activated_on' - activation_key: - $ref: '#/components/schemas/activation_key' - build: - $ref: '#/components/schemas/build' - created_on: - $ref: '#/components/schemas/railgun_components-schemas-created_on' - enabled: - $ref: '#/components/schemas/railgun_components-schemas-enabled' - id: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - modified_on: - $ref: '#/components/schemas/railgun_components-schemas-modified_on' - name: - $ref: '#/components/schemas/railgun_components-schemas-name' - revision: - $ref: '#/components/schemas/revision' - status: - $ref: '#/components/schemas/railgun_components-schemas-status' - upgrade_info: - $ref: '#/components/schemas/upgrade_info' - version: - $ref: '#/components/schemas/railgun_components-schemas-version' - zones_connected: - $ref: '#/components/schemas/zones_connected' - required: - - id - - name - - status - - enabled - - zones_connected - - build - - version - - revision - - activation_key - - activated_on - - created_on - - modified_on - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - activated_on: - description: When the Railgun was activated. - example: '2014-01-02T02:20:00Z' - format: date-time - readOnly: true - type: string - activation_key: - example: e4edc00281cb56ebac22c81be9bac8f3 - maxLength: 32 - readOnly: true - type: string - build: - description: The build identifier for the Railgun receiver. - example: b1234 - readOnly: true - type: string - railgun_components-schemas-created_on: - description: When the Railgun was created. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - railgun_components-schemas-enabled: - default: false - description: Flag to determine if the Railgun is accepting connections. - example: true - type: boolean - railgun_components-schemas-identifier: - description: Railgun identifier tag. - example: e928d310693a83094309acf9ead50448 - maxLength: 32 - readOnly: true - type: string - railgun_components-schemas-modified_on: - description: When the Railgun was last modified. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - railgun_components-schemas-name: - description: Readable identifier of the Railgun. - example: My Railgun. - maxLength: 160 - type: string - revision: - description: The revision of the Railgun receiver. - example: '123' - readOnly: true - type: string - railgun_components-schemas-status: - description: Status of the Railgun. - enum: - - initializing - - active - example: active - readOnly: true - type: string - upgrade_info: - description: Defined when the Railgun version is out of date from the latest release from Cloudflare. - properties: - download_link: - description: An HTTP link to download the latest Railgun binary. - example: 'https://www.cloudflare.com/downloads/railgun' - type: string - latest_version: - description: Latest version of the Railgun receiver available to install. - example: 1.0.0 - type: string - type: object - railgun_components-schemas-version: - description: The version of the Railgun receiver. - example: '2.1' - readOnly: true - type: string - zones_connected: - description: The number of zones using this Railgun. - example: 2 - readOnly: true - type: number - railgun_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - railgun_response_single_id: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - schemas-railgun: - properties: - activation: - $ref: '#/components/schemas/activation' - created_on: - $ref: '#/components/schemas/railgun_components-schemas-created_on' - enabled: - $ref: '#/components/schemas/railgun_components-schemas-enabled' - id: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - modified_on: - $ref: '#/components/schemas/railgun_components-schemas-modified_on' - name: - $ref: '#/components/schemas/railgun_components-schemas-name' - status: - $ref: '#/components/schemas/railgun_components-schemas-status' - upgrade_info: - $ref: '#/components/schemas/upgrade_info' - zones_connected: - $ref: '#/components/schemas/zones_connected' - required: - - id - - name - - status - - enabled - - zones_connected - - activation - type: object - activation: - properties: - activated_on: - $ref: '#/components/schemas/activated_on' - key: - $ref: '#/components/schemas/activation_key' - version: - properties: - build: - $ref: '#/components/schemas/build' - number: - $ref: '#/components/schemas/railgun_components-schemas-version' - revision: - $ref: '#/components/schemas/revision' - required: - - number - type: object - readOnly: true - required: - - key - type: object - components-schemas-zone: - properties: - activated_on: - description: |- - The last time proof of ownership was detected and the zone was made - active - example: '2014-01-02T00:01:00.12345Z' - format: date-time - nullable: true - readOnly: true - type: string - created_on: - description: When the zone was created - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - development_mode: - description: |- - The interval (in seconds) from when development mode expires - (positive integer) or last expired (negative integer) for the - domain. If development mode has never been enabled, this value is 0. - example: 7200 - readOnly: true - type: number - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - modified_on: - description: When the zone was last modified - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - name: - description: The domain name - example: example.com - maxLength: 253 - pattern: '^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$' - readOnly: true - type: string - original_dnshost: - description: DNS host at the time of switching to Cloudflare - example: NameCheap - maxLength: 50 - nullable: true - readOnly: true - type: string - original_name_servers: - description: |- - Original name servers before moving to Cloudflare - Notes: Is this only available for full zones? - example: - - ns1.originaldnshost.com - - ns2.originaldnshost.com - items: - format: hostname - type: string - nullable: true - readOnly: true - type: array - original_registrar: - description: Registrar for the domain at the time of switching to Cloudflare - example: GoDaddy - nullable: true - readOnly: true - type: string - required: - - id - - name - - development_mode - - owner - - account - - meta - - original_name_servers - - original_registrar - - original_dnshost - - created_on - - modified_on - - activated_on - type: object - connection_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-connection' - type: array - schemas-connection: - properties: - created_on: - $ref: '#/components/schemas/connection_components-schemas-created_on' - enabled: - $ref: '#/components/schemas/connection_components-schemas-enabled' - id: - $ref: '#/components/schemas/connection_components-schemas-identifier' - modified_on: - $ref: '#/components/schemas/connection_components-schemas-modified_on' - zone: - $ref: '#/components/schemas/connection_components-schemas-zone' - required: - - id - - zone - - enabled - type: object - connection_components-schemas-created_on: - description: When the connection was created. - example: '2017-06-14T00:00:00Z' - format: date-time - readOnly: true - type: string - connection_components-schemas-enabled: - default: false - description: A value indicating whether the connection is enabled or not. - example: true - type: boolean - connection_components-schemas-identifier: - description: Connection identifier tag. - example: c4a7362d577a6c3019a474fd6f485821 - maxLength: 32 - readOnly: true - type: string - connection_components-schemas-modified_on: - description: When the connection was last modified. - example: '2017-06-14T05:20:00Z' - format: date-time - readOnly: true - type: string - connection_components-schemas-zone: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/properties-name' - type: object - properties-name: - description: The domain name - example: example.com - maxLength: 253 - pattern: '^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$' - readOnly: true - type: string - connection_single_request: - properties: - enabled: - $ref: '#/components/schemas/connection_components-schemas-enabled' - zone: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - zone - type: object - connection_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - connection_single_id_response: - allOf: - - $ref: '#/components/schemas/connection_single_response' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/connection_components-schemas-identifier' - schemas-railgun_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - type: object - type: array - railgun_components-schemas-identifier-2: - description: Railgun connection identifier tag. - example: e928d310693a83094309acf9ead50448 - maxLength: 32 - readOnly: true - type: string - connected: - default: false - description: A flag indicating whether the given zone is connected to the Railgun. - example: true - type: boolean - test_connection_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/test_connection_properties' - test_connection_properties: - properties: - body_hash: - description: Hash version of body. - example: be27f2429421e12f200cab1da43ba301bdc70e1d - type: string - body_size: - description: Size of the body in bytes. - example: 63910 bytes - type: string - cf-cache-status: - description: Lists any `cf-cache-status` present. - type: string - cf-ray: - description: Lists any `cf-ray` present. - example: 1ddd7570575207d9-LAX - type: string - cf-wan-error: - description: Lists any `cf-wan-error` present. - type: string - cloudflare: - description: Whether Cloudflare is enabled on the host. - example: 'on' - type: string - connection_close: - default: true - description: Connection closed or open. - example: false - type: boolean - elapsed_time: - description: Amount of seconds that the test lasted. - example: 0.239013s - type: string - host_name: - description: The hostname queried. - example: www.example.com - type: string - http_status: - description: The HTTP status response code. - example: 200 - type: number - method: - description: HTTP Method used to test the connection. - enum: - - GET - - POST - example: GET - missing_headers: - description: What headers are missing. - example: No Content-Length or Transfer-Encoding. - type: string - protocol: - description: Protocol used to test the connection. - example: HTTP/1.1 - type: string - railgun: - description: Indicates if Railgun is enabled on the queried hostname. - example: 'on' - type: string - response_status: - description: HTTP Status code. - example: 200 OK - type: string - url: - description: Url of the domain you can compare the connection to. - example: 'https://www.cloudflare.com' - type: string - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_railguns: - id: cloudflare.railgun.accounts_railguns - name: accounts_railguns - title: Accounts Railguns - methods: - account_railguns_list_railguns: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_railguns_list_railguns: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_railguns_create_railgun: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns/post' - response: - mediaType: application/json - openAPIDocKey: '200' - account_railguns_delete_a_railgun: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_railguns_railgun_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_railguns_railgun_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_railguns_update_railgun: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_railguns/methods/account_railguns_list_railguns' - - $ref: '#/components/x-stackQL-resources/accounts_railguns/methods/account_railguns_railgun_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_railguns/methods/account_railguns_create_railgun' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_railguns/methods/account_railguns_delete_a_railgun' - organizations_railguns: - id: cloudflare.railgun.organizations_railguns - name: organizations_railguns - title: Organizations Railguns - methods: - organization_railgun_list_railguns: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _organization_railgun_list_railguns: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organization_railgun_create_railgun: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organization_railgun_delete_railgun: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - organization_railgun_railgun_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _organization_railgun_railgun_details: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organization_railgun_enable_or_disable_a_railgun: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/organizations_railguns/methods/organization_railgun_list_railguns' - - $ref: '#/components/x-stackQL-resources/organizations_railguns/methods/organization_railgun_railgun_details' - insert: - - $ref: '#/components/x-stackQL-resources/organizations_railguns/methods/organization_railgun_create_railgun' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/organizations_railguns/methods/organization_railgun_delete_railgun' - organizations_railguns_zones: - id: cloudflare.railgun.organizations_railguns_zones - name: organizations_railguns_zones - title: Organizations Railguns Zones - methods: - organization_railgun_get_railgun_zones: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns~1{identifier}~1zones/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _organization_railgun_get_railgun_zones: - operation: - $ref: '#/paths/~1organizations~1{organization_identifier}~1railguns~1{identifier}~1zones/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/organizations_railguns_zones/methods/organization_railgun_get_railgun_zones' - insert: [] - update: [] - delete: [] - railguns: - id: cloudflare.railgun.railguns - name: railguns - title: Railguns - methods: - list_railguns: - operation: - $ref: '#/paths/~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_railguns: - operation: - $ref: '#/paths/~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create_railgun: - operation: - $ref: '#/paths/~1railguns/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_a_railgun: - operation: - $ref: '#/paths/~1railguns~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - railgun_details: - operation: - $ref: '#/paths/~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _railgun_details: - operation: - $ref: '#/paths/~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - enable_or_disable_a_railgun: - operation: - $ref: '#/paths/~1railguns~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/railguns/methods/list_railguns' - - $ref: '#/components/x-stackQL-resources/railguns/methods/railgun_details' - insert: - - $ref: '#/components/x-stackQL-resources/railguns/methods/create_railgun' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/railguns/methods/delete_a_railgun' - railguns_zones: - id: cloudflare.railgun.railguns_zones - name: railguns_zones - title: Railguns Zones - methods: - list_railgun_zones: - operation: - $ref: '#/paths/~1railguns~1{identifier}~1zones/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_railgun_zones: - operation: - $ref: '#/paths/~1railguns~1{identifier}~1zones/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/railguns_zones/methods/list_railgun_zones' - insert: [] - update: [] - delete: [] - accounts_railguns_connections: - id: cloudflare.railgun.accounts_railguns_connections - name: accounts_railguns_connections - title: Accounts Railguns Connections - methods: - connections_list_connections: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{railgun_identifier}~1connections/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _connections_list_connections: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{railgun_identifier}~1connections/get' - response: - mediaType: application/json - openAPIDocKey: '200' - connections_create_connection: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{railgun_identifier}~1connections/post' - response: - mediaType: application/json - openAPIDocKey: '200' - connections_delete_connection: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{railgun_identifier}~1connections~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - connections_connection_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{railgun_identifier}~1connections~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _connections_connection_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{railgun_identifier}~1connections~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - connections_update_connection: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1railguns~1{railgun_identifier}~1connections~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_railguns_connections/methods/connections_list_connections' - - $ref: '#/components/x-stackQL-resources/accounts_railguns_connections/methods/connections_connection_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_railguns_connections/methods/connections_create_connection' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_railguns_connections/methods/connections_delete_connection' - zones_railguns: - id: cloudflare.railgun.zones_railguns - name: zones_railguns - title: Zones Railguns - methods: - connections_for_a_zone_list_available_railguns: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _connections_for_a_zone_list_available_railguns: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1railguns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - connections_for_a_zone_railgun_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _connections_for_a_zone_railgun_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1railguns~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - connections_for_a_zone_connect_or_disconnect_a_railgun: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1railguns~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - connections_for_a_zone_test_railgun_connection: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1railguns~1{identifier}~1diagnose/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _connections_for_a_zone_test_railgun_connection: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1railguns~1{identifier}~1diagnose/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_railguns/methods/connections_for_a_zone_list_available_railguns' - - $ref: '#/components/x-stackQL-resources/zones_railguns/methods/connections_for_a_zone_railgun_details' - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/railguns': - get: - description: 'List, search, sort and filter your Railguns.' - operationId: account-railguns-list-railguns - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_collection' - description: List Railguns response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Railguns response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Railguns - tags: - - Account Railguns - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - post: - operationId: account-railguns-create-railgun - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/railgun_components-schemas-name' - required: - - name - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Create Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Railgun - tags: - - Account Railguns - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/railguns/{identifier}': - delete: - description: Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones. - operationId: account-railguns-delete-a-railgun - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single_id' - description: Delete a Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single_id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a Railgun - tags: - - Account Railguns - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - get: - operationId: account-railguns-railgun-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Railgun details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Railgun details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Railgun details - tags: - - Account Railguns - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - put: - description: Update a Railgun. - operationId: account-railguns-update-railgun - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-railgun' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Update Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Railgun - tags: - - Account Railguns - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/railguns': - get: - deprecated: true - description: 'List, search, sort and filter your Railguns.' - operationId: organization-railgun-list-railguns - parameters: - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_collection' - description: List Railguns response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Railguns response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Railguns - tags: - - Organization Railgun - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - post: - deprecated: true - operationId: organization-railgun-create-railgun - parameters: - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/railgun_components-schemas-name' - required: - - name - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Create Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Railgun - tags: - - Organization Railgun - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/railguns/{identifier}': - delete: - deprecated: true - description: Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones. - operationId: organization-railgun-delete-railgun - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single_id' - description: Delete Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single_id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Railgun - tags: - - Organization Railgun - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - get: - deprecated: true - operationId: organization-railgun-railgun-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Railgun details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Railgun details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Railgun details - tags: - - Organization Railgun - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - patch: - deprecated: true - description: Enable or disable a Railgun for all zones connected to it. - operationId: organization-railgun-enable-or-disable-a-railgun - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - enabled: - $ref: '#/components/schemas/railgun_components-schemas-enabled' - required: - - enabled - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Enable or disable a Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Enable or disable a Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Enable or disable a Railgun - tags: - - Organization Railgun - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/organizations/{organization_identifier}/railguns/{identifier}/zones': - get: - deprecated: true - description: Lists the zones that are currently using this Railgun. - operationId: organization-railgun-get-railgun-zones - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: organization_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-zone' - type: array - description: Get Railgun zones response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-zone' - type: array - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Railgun zones response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Railgun zones - tags: - - Organization Railgun - x-cfDeprecation: - $ref: ../organization.json#/components/schemas/organization/x-cfDeprecations/org_deprecation - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - /railguns: - get: - description: 'List, search, sort and filter your Railguns.' - operationId: railgun-list-railguns - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_collection' - description: List Railguns response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Railguns response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Railguns - tags: - - Railgun - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - post: - operationId: railgun-create-railgun - requestBody: - content: - application/json: - schema: - properties: - name: - $ref: '#/components/schemas/railgun_components-schemas-name' - required: - - name - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Create Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Railgun - tags: - - Railgun - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/railguns/{identifier}': - delete: - description: Disable and delete a Railgun. This will immediately disable that Railgun for any connected zones. - operationId: railgun-delete-a-railgun - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single_id' - description: Delete a Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single_id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a Railgun - tags: - - Railgun - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - get: - operationId: railgun-railgun-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Railgun details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Railgun details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Railgun details - tags: - - Railgun - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - patch: - description: Enable or disable a Railgun for all zones connected to it. - operationId: railgun-enable-or-disable-a-railgun - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - enabled: - $ref: '#/components/schemas/railgun_components-schemas-enabled' - required: - - enabled - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Enable or disable a Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Enable or disable a Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Enable or disable a Railgun - tags: - - Railgun - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/railguns/{identifier}/zones': - get: - description: List the zones that are currently using this Railgun. - operationId: railgun-list-railgun-zones - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-zone' - type: array - description: List Railgun zones response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-zone' - type: array - - $ref: '#/components/schemas/api-response-common-failure' - description: List Railgun zones response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Railgun zones - tags: - - Railgun - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/railguns/{railgun_identifier}/connections': - get: - description: List connections associated with the Railgun. - operationId: railgun-connections-list-connections - parameters: - - in: path - name: railgun_identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/connection_collection_response' - description: List Connections response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/connection_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Connections response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Connections - tags: - - Railgun Connections - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - post: - description: Associates a zone to the Railgun. - operationId: railgun-connections-create-connection - parameters: - - in: path - name: railgun_identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/connection_single_request' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/connection_single_response' - description: Create connection response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/connection_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create connection response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create connection - tags: - - Railgun Connections - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/accounts/{account_identifier}/railguns/{railgun_identifier}/connections/{identifier}': - delete: - description: Disable and remove the connection to a zone. - operationId: railgun-connections-delete-connection - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/connection_components-schemas-identifier' - - in: path - name: railgun_identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/connection_single_id_response' - description: Delete connection response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/connection_single_id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete connection response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete connection - tags: - - Railgun Connections - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - get: - description: Get a connection by ID. - operationId: railgun-connections-connection-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/connection_components-schemas-identifier' - - in: path - name: railgun_identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/connection_single_response' - description: Connection details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/connection_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Connection details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Connection details - tags: - - Railgun Connections - x-cfPermissionsRequired: - enum: - - '#organization:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - put: - description: Enable or disable a connection. - operationId: railgun-connections-update-connection - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/connection_components-schemas-identifier' - - in: path - name: railgun_identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-connection' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/connection_single_response' - description: Update connection response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/connection_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update connection response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update connection - tags: - - Railgun Connections - x-cfPermissionsRequired: - enum: - - '#organization:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/railguns': - get: - description: A list of available Railguns the zone can use. - operationId: railgun-connections-for-a-zone-list-available-railguns - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-railgun_response_collection' - description: List available Railguns response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-railgun_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List available Railguns response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List available Railguns - tags: - - Railgun Connections for a Zone - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/railguns/{identifier}': - get: - description: Lists details about a specific Railgun. - operationId: railgun-connections-for-a-zone-railgun-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier-2' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Railgun details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Railgun details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Railgun details - tags: - - Railgun Connections for a Zone - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - patch: - description: Connect or disconnect a Railgun. - operationId: railgun-connections-for-a-zone-connect-or-disconnect-a-railgun - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier-2' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - connected: - $ref: '#/components/schemas/connected' - required: - - connected - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/railgun_response_single' - description: Connect or disconnect a Railgun response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/railgun_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Connect or disconnect a Railgun response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Connect or disconnect a Railgun - tags: - - Railgun Connections for a Zone - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/railguns/{identifier}/diagnose': - get: - description: Tests the Railgun connection to the zone. - operationId: railgun-connections-for-a-zone-test-railgun-connection - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/railgun_components-schemas-identifier-2' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/test_connection_response' - description: Test Railgun connection response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/test_connection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Test Railgun connection response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Test Railgun connection - tags: - - Railgun Connections for a Zone - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false diff --git a/providers/src/cloudflare/v00.00.00000/services/rate_limits.yaml b/providers/src/cloudflare/v00.00.00000/services/rate_limits.yaml new file mode 100644 index 00000000..d4a4b967 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/rate_limits.yaml @@ -0,0 +1,984 @@ +openapi: 3.0.3 +info: + title: rate_limits API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/rate_limits: + get: + deprecated: true + description: Fetches the rate limits for a zone. + operationId: rate-limits-for-a-zone-list-rate-limits + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Defines the page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: >- + Defines the maximum number of results per page. You can only set + the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or + `20`. + maximum: 1000 + minimum: 1 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRatelimitResponseCollection' + description: List rate limits response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallRateLimits' + nullable: true + type: array + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List rate limits response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List rate limits + tags: + - Rate limits for a zone + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rate_limits + resource_chain: [] + method: list + post: + deprecated: true + description: >- + Creates a new rate limit for a zone. Refer to the object definition for + a list of required attributes. + operationId: rate-limits-for-a-zone-create-a-rate-limit + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + $ref: '#/components/schemas/firewallAction' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + required: + - match + - threshold + - period + - action + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRatelimitResponseSingle' + description: Create a rate limit response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallAction' + bypass: + $ref: '#/components/schemas/firewallBypass' + description: + $ref: '#/components/schemas/firewallDescription' + disabled: + $ref: '#/components/schemas/firewallDisabled' + id: + $ref: '#/components/schemas/firewallId' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create a rate limit response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a rate limit + tags: + - Rate limits for a zone + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rate_limits + resource_chain: [] + method: create + /zones/{zone_id}/rate_limits/{rate_limit_id}: + delete: + deprecated: true + description: Deletes an existing rate limit. + operationId: rate-limits-for-a-zone-delete-a-rate-limit + parameters: + - in: path + name: rate_limit_id + schema: + $ref: '#/components/schemas/firewallRateLimitId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallAction' + bypass: + $ref: '#/components/schemas/firewallBypass' + description: + $ref: '#/components/schemas/firewallDescription' + disabled: + $ref: '#/components/schemas/firewallDisabled' + id: + $ref: '#/components/schemas/firewallId' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + success: + description: Defines whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Delete a rate limit response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallAction' + bypass: + $ref: '#/components/schemas/firewallBypass' + description: + $ref: '#/components/schemas/firewallDescription' + disabled: + $ref: '#/components/schemas/firewallDisabled' + id: + $ref: '#/components/schemas/firewallId' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a rate limit response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a rate limit + tags: + - Rate limits for a zone + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rate_limits + resource_chain: [] + method: delete + get: + deprecated: true + description: Fetches the details of a rate limit. + operationId: rate-limits-for-a-zone-get-a-rate-limit + parameters: + - in: path + name: rate_limit_id + schema: + $ref: '#/components/schemas/firewallRateLimitId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRatelimitResponseSingle' + description: Get a rate limit response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallAction' + bypass: + $ref: '#/components/schemas/firewallBypass' + description: + $ref: '#/components/schemas/firewallDescription' + disabled: + $ref: '#/components/schemas/firewallDisabled' + id: + $ref: '#/components/schemas/firewallId' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get a rate limit response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a rate limit + tags: + - Rate limits for a zone + x-api-token-group: + - Firewall Services Write + - Firewall Services Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rate_limits + resource_chain: [] + method: get + put: + deprecated: true + description: Updates an existing rate limit. + operationId: rate-limits-for-a-zone-update-a-rate-limit + parameters: + - in: path + name: rate_limit_id + schema: + $ref: '#/components/schemas/firewallRateLimitId' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + $ref: '#/components/schemas/firewallAction' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + required: + - match + - threshold + - period + - action + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/firewallRatelimitResponseSingle' + description: Update a rate limit response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + type: object + properties: + action: + $ref: '#/components/schemas/firewallAction' + bypass: + $ref: '#/components/schemas/firewallBypass' + description: + $ref: '#/components/schemas/firewallDescription' + disabled: + $ref: '#/components/schemas/firewallDisabled' + id: + $ref: '#/components/schemas/firewallId' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a rate limit response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a rate limit + tags: + - Rate limits for a zone + x-api-token-group: + - Firewall Services Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rate_limits + resource_chain: [] + method: edit +components: + schemas: + firewallAction: + description: >- + The action to perform when the threshold of matched traffic within the + configured period is exceeded. + type: object + properties: + mode: + $ref: '#/components/schemas/firewallMode' + response: + $ref: '#/components/schemas/firewallCustomResponse' + timeout: + $ref: '#/components/schemas/firewallTimeout' + firewallBody: + description: >- + The response body to return. The value must conform to the configured + content type. + example: This request has been rate-limited. + maxLength: 10240 + type: string + firewallBypass: + description: >- + Criteria specifying when the current rate limit should be bypassed. You + can specify that the rate limit should not apply to one or more URLs. + items: + properties: + name: + enum: + - url + example: url + type: string + value: + description: The URL to bypass. + example: api.example.com/* + type: string + type: object + type: array + firewallContentType: + description: >- + The content type of the body. Must be one of the following: + `text/plain`, `text/xml`, or `application/json`. + example: text/xml + maxLength: 50 + type: string + x-auditable: true + firewallCustomResponse: + description: >- + A custom content type and reponse to return when the threshold is + exceeded. The custom response configured in this object will override + the custom error for the zone. This object is optional. Notes: If you + omit this object, Cloudflare will use the default HTML error page. If + "mode" is "challenge", "managed_challenge", or "js_challenge", + Cloudflare will use the zone challenge pages and you should not provide + the "response" object. + type: object + properties: + body: + $ref: '#/components/schemas/firewallBody' + content_type: + $ref: '#/components/schemas/firewallContentType' + firewallDescription: + description: >- + An informative summary of the rule. This value is sanitized and any tags + will be removed. + example: Prevent multiple login failures to mitigate brute force attacks + maxLength: 1024 + type: string + x-auditable: true + firewallDisabled: + description: When true, indicates that the rate limit is currently disabled. + example: false + type: boolean + x-auditable: true + firewallHeaderName: + description: The name of the response header to match. + example: Cf-Cache-Status + type: string + x-auditable: true + firewallHeaderOp: + description: >- + The operator used when matching: `eq` means "equal" and `ne` means "not + equal". + enum: + - eq + - ne + example: ne + type: string + x-auditable: true + firewallHeaderValue: + description: The value of the response header, which must match exactly. + example: HIT + type: string + x-auditable: true + firewallId: + description: The unique identifier of the rate limit. + example: 372e67954025e0ba6aaa6d586b9e0b59 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + firewallMatch: + description: Determines which traffic the rate limit counts towards the threshold. + type: object + properties: + headers: + items: + properties: + name: + $ref: '#/components/schemas/firewallHeaderName' + op: + $ref: '#/components/schemas/firewallHeaderOp' + value: + $ref: '#/components/schemas/firewallHeaderValue' + type: object + type: array + request: + properties: + methods: + $ref: '#/components/schemas/firewallMethods' + schemes: + $ref: '#/components/schemas/firewallSchemes' + url: + $ref: '#/components/schemas/firewallUrl' + type: object + response: + properties: + origin_traffic: + $ref: '#/components/schemas/firewallOriginTraffic' + type: object + firewallMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + firewallMethods: + description: >- + The HTTP methods to match. You can specify a subset (for example, + `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional + when creating a rate limit. + example: + - GET + - POST + items: + description: An HTTP method or `_ALL_` to indicate all methods. + enum: + - GET + - POST + - PUT + - DELETE + - PATCH + - HEAD + - _ALL_ + example: GET + type: string + x-auditable: true + type: array + firewallMode: + description: The action to perform. + enum: + - simulate + - ban + - challenge + - js_challenge + - managed_challenge + example: challenge + type: string + x-auditable: true + firewallOriginTraffic: + description: >- + When true, only the uncached traffic served from your origin servers + will count towards rate limiting. In this case, any cached traffic + served by Cloudflare will not count towards rate limiting. This field is + optional. Notes: This field is deprecated. Instead, use response headers + and set "origin_traffic" to "false" to avoid legacy behaviour + interacting with the "response_headers" property. + type: boolean + x-auditable: true + firewallPeriod: + description: >- + The time in seconds (an integer value) to count matching traffic. If the + count exceeds the configured threshold within this period, Cloudflare + will perform the configured action. + example: 900 + maximum: 86400 + minimum: 10 + type: number + x-auditable: true + firewallRateLimitId: + description: Defines the unique identifier of the rate limit. + example: 372e67954025e0ba6aaa6d586b9e0b59 + maxLength: 32 + readOnly: true + type: string + firewallRateLimits: + type: object + $ref: '#/components/schemas/firewallRatelimit' + firewallRatelimit: + properties: + action: + $ref: '#/components/schemas/firewallAction' + bypass: + $ref: '#/components/schemas/firewallBypass' + description: + $ref: '#/components/schemas/firewallDescription' + disabled: + $ref: '#/components/schemas/firewallDisabled' + id: + $ref: '#/components/schemas/firewallId' + match: + $ref: '#/components/schemas/firewallMatch' + period: + $ref: '#/components/schemas/firewallPeriod' + threshold: + $ref: '#/components/schemas/firewallThreshold' + type: object + firewallRatelimitResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + items: + type: object + $ref: '#/components/schemas/firewallRateLimits' + nullable: true + type: array + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/firewallResultInfo' + required: + - success + - errors + - messages + - result + firewallRatelimitResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/firewallMessages' + messages: + $ref: '#/components/schemas/firewallMessages' + result: + $ref: '#/components/schemas/firewallRateLimits' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + firewallResultInfo: + properties: + count: + description: Defines the total number of results for the requested service. + example: 1 + type: number + page: + description: Defines the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Defines the number of results per page of results. + example: 20 + type: number + total_count: + description: Defines the total results available without any search parameters. + example: 2000 + type: number + type: object + firewallSchemes: + description: >- + The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), + both schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This + field is optional. + example: + - HTTP + - HTTPS + items: + description: An HTTP scheme or `_ALL_` to indicate all schemes. + example: HTTPS + type: string + type: array + x-auditable: true + firewallThreshold: + description: >- + The threshold that will trigger the configured mitigation action. + Configure this value along with the `period` property to establish a + threshold per period. + example: 60 + minimum: 1 + type: number + x-auditable: true + firewallTimeout: + description: >- + The time in seconds during which Cloudflare will perform the mitigation + action. Must be an integer value greater than or equal to the period. + Notes: If "mode" is "challenge", "managed_challenge", or "js_challenge", + Cloudflare will use the zone's Challenge Passage time and you should not + provide this value. + example: 86400 + maximum: 86400 + minimum: 1 + type: number + x-auditable: true + firewallUrl: + description: >- + The URL pattern to match, composed of a host and a path such as + `example.org/path*`. Normalization is applied before the pattern is + matched. `*` wildcards are expanded to match applicable traffic. Query + strings are not matched. Set the value to `*` to match all traffic to + your zone. + example: '*.example.org/path*' + maxLength: 1024 + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + rate_limits: + id: cloudflare.rate_limits.rate_limits + name: rate_limits + title: Rate Limits + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rate_limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rate_limits/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rate_limits~1{rate_limit_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rate_limits~1{rate_limit_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rate_limits~1{rate_limit_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rate_limits/methods/get' + - $ref: '#/components/x-stackQL-resources/rate_limits/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rate_limits/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rate_limits/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/rate_limits/methods/edit' diff --git a/providers/src/cloudflare/v00.00.00000/services/realtime_kit.yaml b/providers/src/cloudflare/v00.00.00000/services/realtime_kit.yaml new file mode 100644 index 00000000..b1c6f82c --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/realtime_kit.yaml @@ -0,0 +1,11143 @@ +openapi: 3.0.3 +info: + title: realtime_kit API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/moq/relays: + get: + description: >- + Lists all MoQ relays for the account. Returns only metadata. Config, + status, and tokens are omitted. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + success: + type: boolean + result: + items: + $ref: '#/components/schemas/moqRelayListItem' + type: array + result_info: + $ref: '#/components/schemas/moqResultInfo' + required: + - success + - errors + - messages + type: object + description: Relay list retrieved successfully. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21006: Unexpected server error.' + security: + - api_token: [] + summary: List relays + tags: + - MoQ Relays + operationId: get_accounts_account_id_moq_relays + post: + description: >- + Provisions a new MoQ relay instance. Auto-creates a publish+subscribe + token and a subscribe-only token. Token values are included in the + response (shown once). Config is set to defaults (lingering subscribe + enabled, 30s ceiling, origin fallback off). Use PUT to modify. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + description: Human-readable name for the relay. + type: string + required: + - name + type: object + responses: + '201': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/moqRelayCreateResponse' + required: + - success + - errors + - messages + type: object + description: Relay created successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: >- + Bad request. Possible errors: - 21002: Request body too small (empty + or missing name) - 21004: Failed to decode body (invalid JSON) + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21008: Relay limit exceeded for this account.' + '413': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21001: Request body too large.' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21006: Unexpected server error.' + security: + - api_token: [] + summary: Create a relay + tags: + - MoQ Relays + operationId: post_accounts_account_id_moq_relays + /accounts/{account_id}/moq/relays/{relay_id}: + delete: + description: Soft-deletes a MoQ relay. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Relay unique identifier (32 hex characters). + in: path + name: relay_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + success: + type: boolean + result: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Relay deleted successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21003: Relay ID should be 32 hex characters.' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21007: Relay not found.' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21006: Unexpected server error.' + security: + - api_token: [] + summary: Delete a relay + tags: + - MoQ Relays + operationId: delete_accounts_account_id_moq_relays_relay_id + get: + description: >- + Retrieves a single MoQ relay including config and status. Tokens are NOT + included. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Relay unique identifier (32 hex characters). + in: path + name: relay_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/moqRelay' + required: + - success + - errors + - messages + type: object + description: Relay retrieved successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21003: Relay ID should be 32 hex characters.' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21007: Relay not found.' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21006: Unexpected server error.' + security: + - api_token: [] + summary: Get a relay + tags: + - MoQ Relays + operationId: get_accounts_account_id_moq_relays_relay_id + put: + description: >- + Updates a relay's name and/or configuration. Partial updates: omitted + fields are preserved. Config sub-objects replace as whole objects when + present. origin_fallback and lingering_subscribe are mutually exclusive. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Relay unique identifier (32 hex characters). + in: path + name: relay_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + config: + $ref: '#/components/schemas/moqRelayConfig' + name: + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/moqRelay' + required: + - success + - errors + - messages + type: object + description: Relay updated successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: >- + Bad request. Possible errors: 21003 (relay ID should be 32 hex + characters), 21004 (failed to decode body, invalid JSON), 21009 + (origin_fallback and lingering_subscribe are mutually exclusive), + 21011 (name must not be empty). + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21007: Relay not found.' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21006: Unexpected server error.' + security: + - api_token: [] + summary: Update a relay + tags: + - MoQ Relays + operationId: put_accounts_account_id_moq_relays_relay_id + /accounts/{account_id}/moq/relays/{relay_id}/tokens/rotate: + post: + description: >- + Generates a new token for the specified type. The old token is + immediately invalidated. Token value is shown once in the response. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Relay unique identifier (32 hex characters). + in: path + name: relay_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + type: + description: Which token type to rotate. + enum: + - publish_subscribe + - subscribe + type: string + required: + - type + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + success: + type: boolean + result: + $ref: '#/components/schemas/moqRotateTokenResponse' + required: + - success + - errors + - messages + type: object + description: Token rotated successfully. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: >- + Bad request. Possible errors: 21003 (relay ID should be 32 hex + characters), 21004 (failed to decode body, invalid JSON), 21010 + (invalid token type). + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21007: Relay not found.' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/moqApiResponseError' + description: 'Error 21006: Unexpected server error.' + security: + - api_token: [] + summary: Rotate a token + tags: + - MoQ Relays + operationId: post_accounts_account_id_moq_relays_relay_id_tokens_rotate + /accounts/{account_id}/realtime/kit/apps: + get: + description: Fetch all apps for your account + operationId: get_apps + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + items: + properties: + created_at: + type: string + readOnly: true + id: + type: string + name: + type: string + type: object + type: array + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch all apps + tags: + - Apps + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - apps + method: get + post: + description: Create new app for your account + operationId: create_app + requestBody: + content: + application/json: + schema: + properties: + name: + type: string + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + app: + properties: + created_at: + type: string + readOnly: true + id: + type: string + name: + type: string + type: object + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Create App + tags: + - Apps + x-api-token-group: + - Realtime Admin + - Realtime + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: realtime_kit + resource_chain: + - apps + method: post + /accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise: + get: + description: >- + Returns day-wise session and recording analytics data of an App for the + specified time range start_date to end_date. If start_date and end_date + are not provided, the default time range is set from 30 days ago to the + current date. + operationId: get-org-analytics + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: start date in YYYY-MM-DD format + in: query + name: start_date + schema: + type: string + - description: end date in YYYY-MM-DD format + in: query + name: end_date + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + recording_stats: + description: >- + Recording statistics of an App during the range + specified + properties: + day_stats: + description: Day wise recording stats + items: + properties: + day: + type: string + total_recording_minutes: + description: Total recording minutes for a specific day + type: integer + total_recordings: + description: >- + Total number of recordings for a specific + day + type: integer + type: object + type: array + recording_count: + description: >- + Total number of recordings during the range + specified + type: integer + recording_minutes_consumed: + description: Total recording minutes during the range specified + type: number + type: object + session_stats: + description: >- + Session statistics of an App during the range + specified + properties: + day_stats: + description: Day wise session stats + items: + properties: + day: + type: string + total_session_minutes: + description: Total session minutes for a specific day + type: number + total_sessions: + description: Total number of sessions for a specific day + type: integer + type: object + type: array + sessions_count: + description: >- + Total number of sessions during the range + specified + type: integer + sessions_minutes_consumed: + description: Total session minutes during the range specified + type: number + type: object + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch day-wise session and recording analytics data for an App + tags: + - Analytics + - Organizations + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - analytics + method: get_org_analytics + /accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall: + get: + description: Returns livestream analytics for the specified time range. + operationId: get-livestream-analytics-complete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: >- + Specify the start time range in ISO format to access the livestream + analytics. + in: query + name: start_time + schema: + format: date-time + type: string + - description: >- + Specify the end time range in ISO format to access the livestream + analytics. + in: query + name: end_time + schema: + format: date-time + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + count: + description: Count of total livestreams. + type: integer + total_ingest_seconds: + description: >- + Total time duration for which the input was given or + the meeting was streamed. + type: integer + total_viewer_seconds: + description: >- + Total view time for which the viewers watched the + stream. + type: integer + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch complete analytics data for your livestreams + tags: + - Live streams + - LivestreamAnalytics + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: get_livestream_analytics_complete + /accounts/{account_id}/realtime/kit/{app_id}/livestreams: + get: + description: >- + Returns details of livestreams associated with the given App ID. It + includes livestreams created by your App and RealtimeKit meetings that + are livestreamed by your App. If you only want details of livestreams + created by your App and not RealtimeKit meetings, you can use the + `exclude_meetings` query parameter. + operationId: fetch_all_livestreams + parameters: + - description: Exclude the RealtimeKit meetings that are livestreamed. + in: query + name: exclude_meetings + schema: + default: false + type: boolean + - description: Number of results per page. + in: query + name: per_page + schema: + type: integer + - description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + type: integer + - description: Specifies the status of the operation. + in: query + name: status + schema: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + - description: >- + Specify the start time range in ISO format to access the live + stream. + in: query + name: start_time + schema: + format: date-time + type: string + - description: Specify the end time range in ISO format to access the live stream. + in: query + name: end_time + schema: + format: date-time + type: string + - description: Specifies the sorting order for the results. + in: query + name: sort_order + schema: + enum: + - ASC + - DSC + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + disabled: + description: Specifies if the livestream was disabled. + type: string + id: + description: The ID of the livestream. + format: uuid + type: string + ingest_server: + description: >- + The server URL to which the RTMP encoder sends the + video and audio data. + type: string + meeting_id: + description: ID of the meeting. + type: string + name: + description: Name of the livestream. + type: string + paging: + properties: + end_offset: + type: integer + start_offset: + type: integer + total_count: + type: integer + type: object + playback_url: + description: >- + The web address that viewers can use to watch the + livestream. + type: string + status: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + stream_key: + description: Unique key for accessing each livestream. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch all livestreams + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: get_all_livestreams + post: + description: >- + Creates a livestream for the given App ID and returns ingest server, + stream key, and playback URL. You can pass custom input to the ingest + server and stream key, and freely distribute the content using the + playback URL on any player that supports HLS/LHLS. + requestBody: + content: + application/json: + schema: + properties: + name: + description: Name of the livestream + nullable: true + type: string + type: object + responses: + '201': + content: + application/json: + schema: + properties: + data: + properties: + disabled: + description: Specifies if the livestream was disabled. + type: boolean + id: + description: The livestream ID. + type: string + ingest_server: + description: >- + The server URL to which the RTMP encoder should send + the video and audio data. + type: string + meeting_id: + nullable: true + type: string + name: + type: string + playback_url: + description: >- + The web address that viewers can use to watch the + livestream. + type: string + status: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + stream_key: + description: Unique key for accessing each livestream. + type: string + type: object + success: + type: boolean + type: object + description: Successful response + security: + - api_token: [] + summary: Create an independent livestream + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: create_independent_livestream + operationId: post_accounts_account_id_realtime_kit_app_id_livestreams + /accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream_session_id}: + get: + description: >- + Returns livestream session details for the given livestream session ID. + Retrieve the `livestream_session_id`using the `Fetch livestream session + details using a session ID` API. + operationId: get-v2-livestreams-livestream-session-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - in: path + name: livestream_session_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + err_message: + description: >- + The server URL to which the RTMP encoder sends the + video and audio data. + type: string + id: + description: The livestream ID. + type: string + ingest_seconds: + description: Name of the livestream. + type: integer + livestream_id: + type: string + started_time: + description: Unique key for accessing each livestream. + type: string + stopped_time: + description: >- + The web address that viewers can use to watch the + livestream. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + type: string + readOnly: true + viewer_seconds: + description: Specifies if the livestream was disabled. + type: integer + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch livestream session details using livestream session ID + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: get_livestream_session_details_for_session_id + /accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}: + get: + description: >- + Returns details of a livestream with sessions for the given livestream + ID. Retreive the livestream ID using the `Start livestreaming a meeting` + API. + operationId: get-v2-livestream-session-livestream-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + type: integer + - in: path + name: livestream_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + livestream: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + type: string + readOnly: true + disabled: + description: Specifies if the livestream was disabled. + type: string + id: + description: ID of the livestream. + type: string + ingest_server: + description: >- + The server URL to which the RTMP encoder sends the + video and audio data. + type: string + meeting_id: + description: The ID of the meeting. + type: string + name: + description: Name of the livestream. + type: string + playback_url: + description: >- + The web address that viewers can use to watch the + livestream. + type: string + status: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + stream_key: + description: Unique key for accessing each livestream. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + type: string + readOnly: true + type: object + paging: + properties: + end_offset: + type: integer + start_offset: + type: integer + total_count: + type: integer + type: object + session: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + err_message: + type: string + id: + description: ID of the session. + type: string + ingest_seconds: + description: >- + The time duration for which the input was given or + the meeting was streamed. + type: number + invoked_time: + description: >- + Timestamp the object was invoked. The time is + returned in ISO format. + format: date-time + type: string + livestream_id: + type: string + started_time: + description: >- + Timestamp the object was started. The time is + returned in ISO format. + format: date-time + type: string + stopped_time: + description: >- + Timestamp the object was stopped. The time is + returned in ISO format. + format: date-time + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + viewer_seconds: + description: >- + The total view time for which the viewers watched + the stream. + type: number + type: object + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch livestream details using livestream ID + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: get_livestream_session_for_livestream_id + /accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session: + get: + description: >- + Returns details of all active livestreams for the given livestream ID. + Retreive the livestream ID using the `Start livestreaming a meeting` + API. + operationId: get-v2-active-livestream-session-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - in: path + name: livestream_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + livestream: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + disabled: + description: Specifies if the livestream was disabled. + type: string + id: + type: string + ingest_server: + description: >- + The server URL to which the RTMP encoder sends the + video and audio data. + type: string + meeting_id: + description: ID of the meeting. + type: string + name: + description: Name of the livestream. + type: string + playback_url: + description: >- + The web address that viewers can use to watch the + livestream. + type: string + status: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + stream_key: + description: Unique key for accessing each livestream. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + type: object + session: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + err_message: + type: string + id: + type: string + ingest_seconds: + description: >- + The time duration for which the input was given or + the meeting was streamed. + type: string + invoked_time: + description: >- + Timestamp the object was invoked. The time is + returned in ISO format. + format: date-time + type: string + livestream_id: + type: string + started_time: + description: >- + Timestamp the object was started. The time is + returned in ISO format. + format: date-time + type: string + stopped_time: + description: >- + Timestamp the object was stopped. The time is + returned in ISO format. + format: date-time + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + viewer_seconds: + description: >- + The total view time for which the viewers watched + the stream. + type: string + type: object + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch active livestream session details + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: get_active_livestreams_for_livestream_id + /accounts/{account_id}/realtime/kit/{app_id}/meetings: + get: + description: Returns all meetings for the given App ID. + operationId: get_all_meetings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - allowEmptyValue: true + description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + minimum: 0 + type: number + - allowEmptyValue: true + description: Number of results per page + in: query + name: per_page + schema: + minimum: 0 + type: number + - description: >- + The start time range for which you want to retrieve the meetings. + The time must be specified in ISO format. + in: query + name: start_time + schema: + format: date-time + type: string + - description: >- + The end time range for which you want to retrieve the meetings. The + time must be specified in ISO format. + in: query + name: end_time + schema: + format: date-time + type: string + - description: >- + The search query string. You can search using the meeting ID or + title. + in: query + name: search + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + items: + type: object + $ref: '#/components/schemas/realtimekitMeeting' + type: array + paging: + properties: + end_offset: + type: number + start_offset: + type: number + total_count: + minimum: 0 + type: number + required: + - total_count + - start_offset + - end_offset + type: object + success: + type: boolean + required: + - success + - data + - paging + title: PagingResponse + type: object + description: Success response + security: + - api_token: [] + summary: Fetch all meetings for an App + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: get + post: + description: Create a meeting for the given App ID. + operationId: create_meeting + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_config: + $ref: '#/components/schemas/realtimekitAIConfig' + live_stream_on_start: + default: false + description: >- + Specifies if the meeting should start getting livestreamed + on start. + nullable: true + type: boolean + persist_chat: + default: false + description: >- + If a meeting is set to persist_chat, meeting chat would + remain for a week within the meeting space. + type: boolean + record_on_start: + default: false + description: >- + Specifies if the meeting should start getting recorded as + soon as someone joins the meeting. + nullable: true + type: boolean + recording_config: + $ref: '#/components/schemas/realtimekitRecordingConfig' + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, after + the last participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + summarize_on_end: + default: false + description: >- + Automatically generate summary of meetings using + transcripts. Requires Transcriptions to be enabled, and can + be retrieved via Webhooks or summary API. + type: boolean + title: + description: Title of the meeting + nullable: true + type: string + type: object + description: Create meeting body + responses: + '201': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + id: + description: ID of the meeting. + format: uuid + readOnly: true + type: string + live_stream_on_start: + description: >- + Specifies if the meeting should start getting + livestreamed on start. + type: boolean + persist_chat: + description: >- + Specifies if Chat within a meeting should persist for + a week. + type: boolean + record_on_start: + description: >- + Specifies if the meeting should start getting recorded + as soon as someone joins the meeting. + type: boolean + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, + after the last participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + status: + description: >- + Whether the meeting is `ACTIVE` or `INACTIVE`. Users + will not be able to join an `INACTIVE` meeting. + enum: + - ACTIVE + - INACTIVE + type: string + summarize_on_end: + description: >- + Automatically generate summary of meetings using + transcripts. Requires Transcriptions to be enabled, + and can be retrieved via Webhooks or summary API. + type: boolean + title: + description: Title of the meeting. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + recording_config: + $ref: '#/components/schemas/realtimekitRecordingConfig' + ai_config: + $ref: '#/components/schemas/realtimekitAIConfig' + required: + - id + - created_at + - updated_at + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success Response + security: + - api_token: [] + summary: Create a meeting + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: create + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}: + get: + description: Returns a meeting details in an App for the given meeting ID. + operationId: get_meeting + parameters: + - in: query + name: name + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + id: + description: ID of the meeting. + format: uuid + readOnly: true + type: string + live_stream_on_start: + description: >- + Specifies if the meeting should start getting + livestreamed on start. + type: boolean + persist_chat: + description: >- + Specifies if Chat within a meeting should persist for + a week. + type: boolean + record_on_start: + description: >- + Specifies if the meeting should start getting recorded + as soon as someone joins the meeting. + type: boolean + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, + after the last participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + status: + description: >- + Whether the meeting is `ACTIVE` or `INACTIVE`. Users + will not be able to join an `INACTIVE` meeting. + enum: + - ACTIVE + - INACTIVE + type: string + summarize_on_end: + description: >- + Automatically generate summary of meetings using + transcripts. Requires Transcriptions to be enabled, + and can be retrieved via Webhooks or summary API. + type: boolean + title: + description: Title of the meeting. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + recording_config: + $ref: '#/components/schemas/realtimekitRecordingConfig' + ai_config: + $ref: '#/components/schemas/realtimekitAIConfig' + required: + - id + - created_at + - updated_at + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success Response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Fetch a meeting for an App + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: get_meeting_by_id + patch: + description: Updates a meeting in an App for the given meeting ID. + operationId: update_meeting + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_config: + $ref: '#/components/schemas/realtimekitAIConfig' + live_stream_on_start: + default: false + description: >- + Specifies if the meeting should start getting livestreamed + on start. + type: boolean + persist_chat: + default: false + description: >- + If a meeting is updated to persist_chat, meeting chat would + remain for a week within the meeting space. + type: boolean + record_on_start: + default: false + description: >- + Specifies if the meeting should start getting recorded as + soon as someone joins the meeting. + type: boolean + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, after + the last participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + status: + description: >- + Whether the meeting is `ACTIVE` or `INACTIVE`. Users will + not be able to join an `INACTIVE` meeting. + enum: + - ACTIVE + - INACTIVE + type: string + summarize_on_end: + default: false + description: >- + Automatically generate summary of meetings using + transcripts. Requires Transcriptions to be enabled, and can + be retrieved via Webhooks or summary API. + type: boolean + title: + description: Title of the meeting + type: string + type: object + description: Create meeting body + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + id: + description: ID of the meeting. + format: uuid + readOnly: true + type: string + live_stream_on_start: + description: >- + Specifies if the meeting should start getting + livestreamed on start. + type: boolean + persist_chat: + description: >- + Specifies if Chat within a meeting should persist for + a week. + type: boolean + record_on_start: + description: >- + Specifies if the meeting should start getting recorded + as soon as someone joins the meeting. + type: boolean + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, + after the last participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + status: + description: >- + Whether the meeting is `ACTIVE` or `INACTIVE`. Users + will not be able to join an `INACTIVE` meeting. + enum: + - ACTIVE + - INACTIVE + type: string + summarize_on_end: + description: >- + Automatically generate summary of meetings using + transcripts. Requires Transcriptions to be enabled, + and can be retrieved via Webhooks or summary API. + type: boolean + title: + description: Title of the meeting. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + recording_config: + $ref: '#/components/schemas/realtimekitRecordingConfig' + ai_config: + $ref: '#/components/schemas/realtimekitAIConfig' + required: + - id + - created_at + - updated_at + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success Response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Update a meeting + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: update_meeting_by_id + put: + description: Replaces all the details for the given meeting ID. + operationId: replace_meeting + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ai_config: + $ref: '#/components/schemas/realtimekitAIConfig' + live_stream_on_start: + default: false + description: >- + Specifies if the meeting should start getting livestreamed + on start. + nullable: true + type: boolean + persist_chat: + default: false + description: >- + If a meeting is set to persist_chat, meeting chat would + remain for a week within the meeting space. + type: boolean + record_on_start: + default: false + description: >- + Specifies if the meeting should start getting recorded as + soon as someone joins the meeting. + nullable: true + type: boolean + recording_config: + $ref: '#/components/schemas/realtimekitRecordingConfig' + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, after + the last participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + summarize_on_end: + default: false + description: >- + Automatically generate summary of meetings using + transcripts. Requires Transcriptions to be enabled, and can + be retrieved via Webhooks or summary API. + type: boolean + title: + description: Title of the meeting + nullable: true + type: string + type: object + description: Create meeting body + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + id: + description: ID of the meeting. + format: uuid + readOnly: true + type: string + live_stream_on_start: + description: >- + Specifies if the meeting should start getting + livestreamed on start. + type: boolean + persist_chat: + description: >- + Specifies if Chat within a meeting should persist for + a week. + type: boolean + record_on_start: + description: >- + Specifies if the meeting should start getting recorded + as soon as someone joins the meeting. + type: boolean + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, + after the last participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + status: + description: >- + Whether the meeting is `ACTIVE` or `INACTIVE`. Users + will not be able to join an `INACTIVE` meeting. + enum: + - ACTIVE + - INACTIVE + type: string + summarize_on_end: + description: >- + Automatically generate summary of meetings using + transcripts. Requires Transcriptions to be enabled, + and can be retrieved via Webhooks or summary API. + type: boolean + title: + description: Title of the meeting. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + readOnly: true + type: string + recording_config: + $ref: '#/components/schemas/realtimekitRecordingConfig' + ai_config: + $ref: '#/components/schemas/realtimekitAIConfig' + required: + - id + - created_at + - updated_at + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success Response + security: + - api_token: [] + summary: Replace a meeting + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: replace_meeting_by_id + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream: + get: + description: Returns details of all active livestreams for the given meeting ID. + operationId: get-v2-meetings-meetingId-active-livestream + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + disabled: + description: Specifies if the livestream was disabled. + type: string + id: + description: The livestream ID. + type: string + ingest_server: + description: >- + The server URL to which the RTMP encoder sends the + video and audio data. + type: string + meeting_id: + type: string + name: + description: Name of the livestream. + nullable: true + type: string + playback_url: + description: >- + The web address that viewers can use to watch the + livestream. + type: string + status: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + stream_key: + description: Unique key for accessing each livestream. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch active livestreams for a meeting + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: get_meeting_active_livestreams + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop: + post: + description: >- + Stops the active livestream of a meeting associated with the given + meeting ID. Retreive the meeting ID using the `Create a meeting` API. + operationId: stop_livestreaming + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: {} + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + message: + type: string + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Stop livestreaming a meeting + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: stop_livestreaming_a_meeting + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session: + get: + description: Returns details of an ongoing active session for the given meeting ID. + operationId: GetActiveSession + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + $ref: '#/components/schemas/realtimekitActiveSession' + success: + type: boolean + type: object + description: Active Session Success response + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Active Session is not found for the given meetingId + security: + - api_token: [] + summary: Fetch details of an active session + tags: + - Active session + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - active_session + method: get_active_session + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick: + post: + description: >- + Kicks one or more participants from an active session using user ID or + custom participant ID. + operationId: KickPartcipants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + custom_participant_ids: + items: + type: string + type: array + participant_ids: + items: + type: string + type: array + required: + - participant_ids + - custom_participant_ids + type: object + description: >- + Request body for kicking participants from an active session. Only one + of `participant_id` or `custom_participant_id` is required. + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + action: + type: string + participants: + items: + $ref: '#/components/schemas/realtimekitSessionParticipant' + type: array + type: object + success: + type: boolean + type: object + description: Kick participants success response + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: >- + No participant found for the given `participant_id` or + `custom_participant_id` + security: + - api_token: [] + summary: Kick participants from an active session + tags: + - Active session + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - active_session + method: kick_participants + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick-all: + post: + description: Kicks all participants from an active session for the given meeting ID. + operationId: KickAllParticipants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + action: + type: string + kicked_participants_count: + type: number + type: object + success: + type: boolean + type: object + description: Kick all participants from a meeting + security: + - api_token: [] + summary: Kick all participants + tags: + - Active session + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - active_session + method: kick_all_participants + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute: + post: + description: >- + Mutes one or more participants from an active session using user ID or + custom participant ID. + operationId: MuteParticipants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + custom_participant_ids: + items: + type: string + type: array + participant_ids: + items: + type: string + type: array + required: + - participant_ids + - custom_participant_ids + type: object + description: >- + Request body for kicking participants from an active session. Only one + of `participant_id` or `custom_participant_id` is required. + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + action: + type: string + participants: + items: + $ref: '#/components/schemas/realtimekitSessionParticipant' + type: array + type: object + success: + type: boolean + type: object + description: Mute one or more participants of a meeting + security: + - api_token: [] + summary: Mute participants of an active session + tags: + - Active session + x-api-token-group: + - Realtime Admin + - Realtime + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute-all: + post: + description: Mutes all participants of an active session for the given meeting ID. + operationId: MuteAllParticipants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_unmute: + description: >- + if false, participants won't be able to unmute themselves + after they are muted + type: boolean + required: + - allow_unmute + type: object + description: Request body for muting all participants in an active session. + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + action: + type: string + muted_participants_count: + type: number + type: object + success: + type: boolean + type: object + description: Mute all participants of a meeting + security: + - api_token: [] + summary: Mute all participants + tags: + - Active session + x-api-token-group: + - Realtime Admin + - Realtime + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll: + post: + description: Creates a new poll in an active session for the given meeting ID. + operationId: CreatePoll + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + anonymous: + description: if voters on a poll are anonymous + type: boolean + hide_votes: + description: if votes on an option are visible before a person votes + type: boolean + options: + description: Different options for the question + items: + type: string + type: array + question: + description: Question of the poll + type: string + required: + - question + - options + type: object + description: Request body for creating a new poll + responses: + '201': + content: + application/json: + schema: + properties: + data: + properties: + action: + type: string + poll: + $ref: '#/components/schemas/realtimekitPoll' + type: object + success: + type: boolean + type: object + description: response for creating a poll + '400': + description: Bad Request + security: + - api_token: [] + summary: Create a poll + tags: + - Active session + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - active_session + method: create_poll + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestream: + get: + description: >- + Returns livestream session details for the given meeting ID. Retreive + the meeting ID using the `Create a meeting` API. + operationId: livestream-session-details + parameters: + - description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + type: integer + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + livestreams: + items: + properties: + created_at: + description: >- + The timestamp at which the livestream was + created. The time is returned in ISO format. + format: date-time + type: string + readOnly: true + disabled: + description: Specifies if the livestream was disabled. + type: boolean + id: + description: The livestream ID. + type: string + ingest_server: + description: >- + The server URL to which the RTMP encoder sends + the video and audio data. + type: string + meeting_id: + description: The ID of the meeting that was livestreamed. + type: string + name: + description: Name of the livestream. + nullable: true + type: string + playback_url: + description: >- + The web address that viewers can use to watch + the livestream. + type: string + status: + enum: + - LIVE + - INVOKED + - ERRORED + - IDLE + type: string + stream_key: + description: Unique key for accessing each livestream. + type: string + updated_at: + description: >- + The timestamp at which the livestream was + updated. The time is returned in ISO format. + format: date-time + type: string + readOnly: true + type: object + type: array + paging: + properties: + end_offset: + type: integer + start_offset: + type: integer + total_count: + type: integer + type: object + sessions: + properties: + created_at: + description: >- + The timestamp at which the livestream was created. + The time is returned in ISO format. + format: date-time + type: string + readOnly: true + err_message: + type: string + id: + description: The ID of the livestream session. + type: string + ingest_seconds: + description: >- + The time duration for which the input was given or + the meeting was streamed. + type: string + invoked_time: + description: The time at which the livestream was invoked. + format: date-time + type: string + livestream_id: + description: The ID of the livestream. + type: string + started_time: + description: The time at which the livestream was started. + format: date-time + type: string + stopped_time: + description: The time at which the livestream was stopped. + format: date-time + type: string + updated_at: + description: >- + The timestamp at which the livestream was updated. + The time is returned in ISO format. + format: date-time + type: string + readOnly: true + type: object + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch livestream session details for a meeting + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams: + post: + description: >- + Starts livestream of a meeting associated with the given meeting ID. + Retreive the meeting ID using the `Create a meeting` API. + operationId: start-livestreaming + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + nullable: true + type: string + video_config: + properties: + height: + description: Height of the livestreaming video in pixels + type: integer + width: + description: Width of the livestreaming video in pixels + type: integer + type: object + type: object + responses: + '201': + content: + application/json: + schema: + properties: + data: + properties: + id: + description: The livestream ID. + type: string + ingest_server: + description: >- + The server URL to which the RTMP encoder sends the + video and audio data. + type: string + playback_url: + description: >- + The web address that viewers can use to watch the + livestream. + type: string + status: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + stream_key: + description: Unique key for accessing each livestream. + type: string + type: object + success: + type: boolean + type: object + description: Created + security: + - api_token: [] + summary: Start livestreaming a meeting + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - livestreams + method: start_livestreaming_a_meeting + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants: + get: + description: Returns all participants detail for the given meeting ID. + operationId: get_meeting_participants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - allowEmptyValue: true + description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + minimum: 0 + type: number + - allowEmptyValue: true + description: Number of results per page + in: query + name: per_page + schema: + minimum: 0 + type: number + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + items: + type: object + $ref: '#/components/schemas/realtimekitParticipant' + type: array + paging: + properties: + end_offset: + type: number + start_offset: + type: number + total_count: + minimum: 0 + type: number + required: + - total_count + - start_offset + - end_offset + type: object + success: + type: boolean + required: + - success + - data + - paging + title: PagingResponse + type: object + description: Success response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Fetch all participants of a meeting + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: get_meeting_participants + post: + description: Adds a participant to the given meeting ID. + operationId: add_participant + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + custom_participant_id: + description: >- + A unique participant ID. You must specify a unique ID for + the participant, for example, UUID, email address, and so + on. + type: string + name: + description: (Optional) Name of the participant. + nullable: true + type: string + picture: + description: >- + (Optional) A URL to a picture to be used for the + participant. + format: uri + nullable: true + type: string + preset_name: + default: group_call_host + description: Name of the preset to apply to this participant. + type: string + required: + - preset_name + - custom_participant_id + type: object + responses: + '201': + content: + application/json: + schema: + properties: + data: + description: Represents a participant. + type: object + properties: + created_at: + description: >- + When this object was created. The time is returned in + ISO format. + format: date-time + type: string + readOnly: true + custom_participant_id: + description: A unique participant ID generated by the client. + type: string + id: + description: ID of the participant. + format: uuid + type: string + name: + description: Name of the participant. + nullable: true + type: string + picture: + description: URL to a picture of the participant. + format: uri + nullable: true + type: string + preset_name: + description: Preset applied to the participant. + type: string + updated_at: + description: >- + When this object was updated. The time is returned in + ISO format. + format: date-time + type: string + readOnly: true + token: + description: >- + The participant's auth token that can be used for + joining a meeting from the client side. + type: string + required: + - id + - custom_participant_id + - preset_name + - created_at + - updated_at + - token + title: Participant + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Add a participant + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: add_participant + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}: + delete: + description: Deletes a participant for the given meeting and participant ID. + operationId: delete_meeting_participant + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - description: >- + ID of the participant. You can fetch the participant ID using the + add a participant API. + in: path + name: participant_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + created_at: + description: >- + Timestamp this object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + custom_participant_id: + description: A unique participant ID generated by the client. + type: string + preset_id: + description: ID of the preset applied to this participant. + format: uuid + type: string + updated_at: + description: >- + Timestamp this object was updated at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + required: + - custom_participant_id + - preset_id + - created_at + - updated_at + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Delete a participant + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: delete_meeting_participant + get: + description: Returns a participant details for the given meeting and participant ID. + operationId: get_meeting_participant + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - description: >- + ID of the participant. You can fetch the participant ID using the + add a participant API. + in: path + name: participant_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + $ref: '#/components/schemas/realtimekitParticipant' + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + - data + title: GenericSuccessResponse + type: object + description: Success response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Fetch a participant's detail + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: get_meeting_participant + patch: + description: >- + Updates a participant's details for the given meeting and participant + ID. + operationId: edit_participant + parameters: + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - description: >- + ID of the participant. You can fetch the participant ID using the + add a participant API. + in: path + name: participant_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + description: (Optional) Name of the participant. + nullable: true + type: string + picture: + description: >- + (Optional) A URL to a picture to be used for the + participant. + format: uri + nullable: true + type: string + preset_name: + description: (Optional) Name of the preset to apply to this participant. + nullable: true + type: string + type: object + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Represents a participant. + type: object + properties: + created_at: + description: >- + When this object was created. The time is returned in + ISO format. + format: date-time + type: string + readOnly: true + custom_participant_id: + description: A unique participant ID generated by the client. + type: string + id: + description: ID of the participant. + format: uuid + type: string + name: + description: Name of the participant. + nullable: true + type: string + picture: + description: URL to a picture of the participant. + format: uri + nullable: true + type: string + preset_name: + description: Preset applied to the participant. + type: string + updated_at: + description: >- + When this object was updated. The time is returned in + ISO format. + format: date-time + type: string + readOnly: true + token: + description: >- + The participant's auth token that can be used for + joining a meeting from the client side. + type: string + required: + - id + - custom_participant_id + - preset_name + - created_at + - updated_at + - token + title: Participant + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Edit a participant's detail + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: edit_participant + /accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}/token: + post: + description: >- + Regenerates participant's authentication token for the given meeting and + participant ID. + operationId: regenerate_token + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + - description: >- + ID of the participant. You can fetch the participant ID using the + add a participant API. + in: path + name: participant_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + token: + description: Regenerated participant's authentication token. + type: string + required: + - token + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + - data + title: GenericSuccessResponse + type: object + description: Example response + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Refresh participant's authentication token + tags: + - Meetings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - meetings + method: refresh_participant_token + /accounts/{account_id}/realtime/kit/{app_id}/presets: + get: + description: Fetches all the presets belonging to an App. + operationId: get-presets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - allowEmptyValue: true + description: Number of results per page + in: query + name: per_page + schema: + minimum: 0 + type: number + - allowEmptyValue: true + description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + minimum: 0 + type: number + responses: + '200': + content: + application/json: + schema: + properties: + data: + items: + type: object + $ref: '#/components/schemas/realtimekitPresetListItem' + type: array + paging: + properties: + end_offset: + type: number + start_offset: + type: number + total_count: + minimum: 0 + type: number + required: + - total_count + - start_offset + - end_offset + type: object + success: + type: boolean + required: + - success + - data + - paging + title: PagingResponse + type: object + description: Example response + security: + - api_token: [] + summary: Fetch all presets + tags: + - Presets + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - presets + method: get + post: + description: Creates a preset belonging to the current App + operationId: post-presets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitPreset' + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + id: + description: ID of the preset + format: uuid + type: string + config: + properties: + max_screenshare_count: + description: >- + Maximum number of screen shares that can be active + at a given time + type: integer + max_video_streams: + description: >- + Maximum number of streams that are visible on a + device + properties: + desktop: + description: >- + Maximum number of video streams visible on + desktop devices + type: integer + mobile: + description: >- + Maximum number of streams visible on mobile + devices + type: integer + required: + - mobile + - desktop + type: object + media: + description: 'Media configuration options. eg: Video quality' + properties: + audio: + description: Control options for Audio quality. + properties: + enable_high_bitrate: + default: false + description: >- + Enable High Quality Audio for your + meetings + type: boolean + enable_stereo: + default: false + description: Enable Stereo for your meetings + type: boolean + type: object + screenshare: + description: >- + Configuration options for participant screen + shares + properties: + frame_rate: + description: Frame rate of screen share + type: integer + quality: + description: Quality of screen share + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + video: + description: Configuration options for participant videos + properties: + frame_rate: + description: Frame rate of participants' video + maximum: 30 + type: integer + quality: + description: Video quality of participants + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + required: + - video + - screenshare + type: object + view_type: + description: Type of the meeting + enum: + - GROUP_CALL + - WEBINAR + - AUDIO_ROOM + type: string + required: + - view_type + - max_video_streams + - max_screenshare_count + - media + type: object + name: + description: Name of the preset + type: string + permissions: + properties: + accept_waiting_requests: + description: >- + Whether this participant can accept waiting + requests + type: boolean + can_accept_production_requests: + type: boolean + can_change_participant_permissions: + type: boolean + can_edit_display_name: + type: boolean + can_livestream: + type: boolean + can_record: + type: boolean + can_spotlight: + type: boolean + chat: + description: Chat permissions + properties: + private: + properties: + can_receive: + type: boolean + can_send: + type: boolean + files: + type: boolean + text: + type: boolean + required: + - can_send + - can_receive + - text + - files + type: object + public: + properties: + can_send: + description: Can send messages in general + type: boolean + files: + description: Can send file messages + type: boolean + text: + description: Can send text messages + type: boolean + required: + - can_send + - text + - files + type: object + required: + - public + - private + type: object + connected_meetings: + properties: + can_alter_connected_meetings: + type: boolean + can_switch_connected_meetings: + type: boolean + can_switch_to_parent_meeting: + type: boolean + required: + - can_alter_connected_meetings + - can_switch_connected_meetings + - can_switch_to_parent_meeting + type: object + disable_participant_audio: + type: boolean + disable_participant_screensharing: + type: boolean + disable_participant_video: + type: boolean + hidden_participant: + description: >- + Whether this participant is visible to others or + not + type: boolean + is_recorder: + default: false + type: boolean + kick_participant: + type: boolean + media: + description: Media permissions + properties: + audio: + description: Audio permissions + properties: + can_produce: + description: Can produce audio + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + screenshare: + description: Screenshare permissions + properties: + can_produce: + description: Can produce screen share video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + video: + description: Video permissions + properties: + can_produce: + description: Can produce video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + required: + - video + - audio + - screenshare + type: object + pin_participant: + type: boolean + plugins: + description: Plugin permissions + properties: + can_close: + description: Can close plugins that are already open + type: boolean + can_edit_config: + description: Can edit plugin config + type: boolean + can_start: + description: Can start plugins + type: boolean + config: + type: string + format: uuid + properties: + access_control: + enum: + - FULL_ACCESS + - VIEW_ONLY + type: string + handles_view_only: + type: boolean + required: + - access_control + - handles_view_only + required: + - can_close + - can_start + - can_edit_config + - config + type: object + polls: + description: Poll permissions + properties: + can_create: + description: Can create polls + type: boolean + can_view: + description: Can view polls + type: boolean + can_vote: + description: Can vote on polls + type: boolean + required: + - can_create + - can_vote + - can_view + type: object + recorder_type: + default: NONE + description: Type of the recording peer + enum: + - RECORDER + - LIVESTREAMER + - NONE + type: string + show_participant_list: + type: boolean + waiting_room_type: + description: Waiting room type + enum: + - SKIP + - ON_PRIVILEGED_USER_ENTRY + - SKIP_ON_ACCEPT + type: string + required: + - accept_waiting_requests + - can_accept_production_requests + - can_edit_display_name + - can_spotlight + - recorder_type + - disable_participant_audio + - disable_participant_screensharing + - disable_participant_video + - kick_participant + - pin_participant + - can_record + - can_livestream + - waiting_room_type + - plugins + - connected_meetings + - polls + - media + - chat + - hidden_participant + - show_participant_list + - can_change_participant_permissions + type: object + ui: + properties: + config_diff: + type: object + design_tokens: + properties: + border_radius: + enum: + - rounded + type: string + border_width: + enum: + - thin + type: string + colors: + properties: + background: + properties: + '600': + default: '#222222' + type: string + '700': + default: '#1f1f1f' + type: string + '800': + default: '#1b1b1b' + type: string + '900': + default: '#181818' + type: string + '1000': + default: '#141414' + type: string + required: + - '600' + - '700' + - '800' + - '900' + - '1000' + type: object + brand: + properties: + '300': + default: '#844d1c' + type: string + '400': + default: '#9d5b22' + type: string + '500': + default: '#b56927' + type: string + '600': + default: '#d37c30' + type: string + '700': + default: '#d9904f' + type: string + required: + - '300' + - '400' + - '500' + - '600' + - '700' + type: object + danger: + default: '#FF2D2D' + type: string + success: + default: '#62A504' + type: string + text: + default: '#EEEEEE' + type: string + text_on_brand: + default: '#EEEEEE' + type: string + video_bg: + default: '#191919' + type: string + warning: + default: '#FFCD07' + type: string + required: + - brand + - background + - danger + - text + - text_on_brand + - success + - video_bg + - warning + type: object + logo: + type: string + spacing_base: + default: 4 + type: number + theme: + enum: + - dark + type: string + required: + - border_radius + - border_width + - spacing_base + - theme + - colors + - logo + type: object + required: + - design_tokens + type: object + required: + - id + - name + - config + - ui + title: Preset + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + - data + title: GenericSuccessResponse + type: object + description: Success response + security: + - api_token: [] + summary: Create a preset + tags: + - Presets + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - presets + method: create + /accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}: + delete: + description: Deletes a preset using the provided preset ID + operationId: delete-presets-preset_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the preset to fetch + in: path + name: preset_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + id: + description: ID of the preset + format: uuid + type: string + config: + properties: + max_screenshare_count: + description: >- + Maximum number of screen shares that can be active + at a given time + type: integer + max_video_streams: + description: >- + Maximum number of streams that are visible on a + device + properties: + desktop: + description: >- + Maximum number of video streams visible on + desktop devices + type: integer + mobile: + description: >- + Maximum number of streams visible on mobile + devices + type: integer + required: + - mobile + - desktop + type: object + media: + description: 'Media configuration options. eg: Video quality' + properties: + audio: + description: Control options for Audio quality. + properties: + enable_high_bitrate: + default: false + description: >- + Enable High Quality Audio for your + meetings + type: boolean + enable_stereo: + default: false + description: Enable Stereo for your meetings + type: boolean + type: object + screenshare: + description: >- + Configuration options for participant screen + shares + properties: + frame_rate: + description: Frame rate of screen share + type: integer + quality: + description: Quality of screen share + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + video: + description: Configuration options for participant videos + properties: + frame_rate: + description: Frame rate of participants' video + maximum: 30 + type: integer + quality: + description: Video quality of participants + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + required: + - video + - screenshare + type: object + view_type: + description: Type of the meeting + enum: + - GROUP_CALL + - WEBINAR + - AUDIO_ROOM + type: string + required: + - view_type + - max_video_streams + - max_screenshare_count + - media + type: object + name: + description: Name of the preset + type: string + permissions: + properties: + accept_waiting_requests: + description: >- + Whether this participant can accept waiting + requests + type: boolean + can_accept_production_requests: + type: boolean + can_change_participant_permissions: + type: boolean + can_edit_display_name: + type: boolean + can_livestream: + type: boolean + can_record: + type: boolean + can_spotlight: + type: boolean + chat: + description: Chat permissions + properties: + private: + properties: + can_receive: + type: boolean + can_send: + type: boolean + files: + type: boolean + text: + type: boolean + required: + - can_send + - can_receive + - text + - files + type: object + public: + properties: + can_send: + description: Can send messages in general + type: boolean + files: + description: Can send file messages + type: boolean + text: + description: Can send text messages + type: boolean + required: + - can_send + - text + - files + type: object + required: + - public + - private + type: object + connected_meetings: + properties: + can_alter_connected_meetings: + type: boolean + can_switch_connected_meetings: + type: boolean + can_switch_to_parent_meeting: + type: boolean + required: + - can_alter_connected_meetings + - can_switch_connected_meetings + - can_switch_to_parent_meeting + type: object + disable_participant_audio: + type: boolean + disable_participant_screensharing: + type: boolean + disable_participant_video: + type: boolean + hidden_participant: + description: >- + Whether this participant is visible to others or + not + type: boolean + is_recorder: + default: false + type: boolean + kick_participant: + type: boolean + media: + description: Media permissions + properties: + audio: + description: Audio permissions + properties: + can_produce: + description: Can produce audio + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + screenshare: + description: Screenshare permissions + properties: + can_produce: + description: Can produce screen share video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + video: + description: Video permissions + properties: + can_produce: + description: Can produce video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + required: + - video + - audio + - screenshare + type: object + pin_participant: + type: boolean + plugins: + description: Plugin permissions + properties: + can_close: + description: Can close plugins that are already open + type: boolean + can_edit_config: + description: Can edit plugin config + type: boolean + can_start: + description: Can start plugins + type: boolean + config: + type: string + format: uuid + properties: + access_control: + enum: + - FULL_ACCESS + - VIEW_ONLY + type: string + handles_view_only: + type: boolean + required: + - access_control + - handles_view_only + required: + - can_close + - can_start + - can_edit_config + - config + type: object + polls: + description: Poll permissions + properties: + can_create: + description: Can create polls + type: boolean + can_view: + description: Can view polls + type: boolean + can_vote: + description: Can vote on polls + type: boolean + required: + - can_create + - can_vote + - can_view + type: object + recorder_type: + default: NONE + description: Type of the recording peer + enum: + - RECORDER + - LIVESTREAMER + - NONE + type: string + show_participant_list: + type: boolean + waiting_room_type: + description: Waiting room type + enum: + - SKIP + - ON_PRIVILEGED_USER_ENTRY + - SKIP_ON_ACCEPT + type: string + required: + - accept_waiting_requests + - can_accept_production_requests + - can_edit_display_name + - can_spotlight + - recorder_type + - disable_participant_audio + - disable_participant_screensharing + - disable_participant_video + - kick_participant + - pin_participant + - can_record + - can_livestream + - waiting_room_type + - plugins + - connected_meetings + - polls + - media + - chat + - hidden_participant + - show_participant_list + - can_change_participant_permissions + type: object + ui: + properties: + config_diff: + type: object + design_tokens: + properties: + border_radius: + enum: + - rounded + type: string + border_width: + enum: + - thin + type: string + colors: + properties: + background: + properties: + '600': + default: '#222222' + type: string + '700': + default: '#1f1f1f' + type: string + '800': + default: '#1b1b1b' + type: string + '900': + default: '#181818' + type: string + '1000': + default: '#141414' + type: string + required: + - '600' + - '700' + - '800' + - '900' + - '1000' + type: object + brand: + properties: + '300': + default: '#844d1c' + type: string + '400': + default: '#9d5b22' + type: string + '500': + default: '#b56927' + type: string + '600': + default: '#d37c30' + type: string + '700': + default: '#d9904f' + type: string + required: + - '300' + - '400' + - '500' + - '600' + - '700' + type: object + danger: + default: '#FF2D2D' + type: string + success: + default: '#62A504' + type: string + text: + default: '#EEEEEE' + type: string + text_on_brand: + default: '#EEEEEE' + type: string + video_bg: + default: '#191919' + type: string + warning: + default: '#FFCD07' + type: string + required: + - brand + - background + - danger + - text + - text_on_brand + - success + - video_bg + - warning + type: object + logo: + type: string + spacing_base: + default: 4 + type: number + theme: + enum: + - dark + type: string + required: + - border_radius + - border_width + - spacing_base + - theme + - colors + - logo + type: object + required: + - design_tokens + type: object + required: + - id + - name + - config + - ui + title: Preset + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + - data + title: GenericSuccessResponse + type: object + description: Success response + security: + - api_token: [] + summary: Delete a preset + tags: + - Presets + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - presets + method: delete + get: + description: Fetches details of a preset using the provided preset ID + operationId: get-presets-preset_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the preset to fetch + in: path + name: preset_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + id: + description: ID of the preset + format: uuid + type: string + config: + properties: + max_screenshare_count: + description: >- + Maximum number of screen shares that can be active + at a given time + type: integer + max_video_streams: + description: >- + Maximum number of streams that are visible on a + device + properties: + desktop: + description: >- + Maximum number of video streams visible on + desktop devices + type: integer + mobile: + description: >- + Maximum number of streams visible on mobile + devices + type: integer + required: + - mobile + - desktop + type: object + media: + description: 'Media configuration options. eg: Video quality' + properties: + audio: + description: Control options for Audio quality. + properties: + enable_high_bitrate: + default: false + description: >- + Enable High Quality Audio for your + meetings + type: boolean + enable_stereo: + default: false + description: Enable Stereo for your meetings + type: boolean + type: object + screenshare: + description: >- + Configuration options for participant screen + shares + properties: + frame_rate: + description: Frame rate of screen share + type: integer + quality: + description: Quality of screen share + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + video: + description: Configuration options for participant videos + properties: + frame_rate: + description: Frame rate of participants' video + maximum: 30 + type: integer + quality: + description: Video quality of participants + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + required: + - video + - screenshare + type: object + view_type: + description: Type of the meeting + enum: + - GROUP_CALL + - WEBINAR + - AUDIO_ROOM + type: string + required: + - view_type + - max_video_streams + - max_screenshare_count + - media + type: object + name: + description: Name of the preset + type: string + permissions: + properties: + accept_waiting_requests: + description: >- + Whether this participant can accept waiting + requests + type: boolean + can_accept_production_requests: + type: boolean + can_change_participant_permissions: + type: boolean + can_edit_display_name: + type: boolean + can_livestream: + type: boolean + can_record: + type: boolean + can_spotlight: + type: boolean + chat: + description: Chat permissions + properties: + private: + properties: + can_receive: + type: boolean + can_send: + type: boolean + files: + type: boolean + text: + type: boolean + required: + - can_send + - can_receive + - text + - files + type: object + public: + properties: + can_send: + description: Can send messages in general + type: boolean + files: + description: Can send file messages + type: boolean + text: + description: Can send text messages + type: boolean + required: + - can_send + - text + - files + type: object + required: + - public + - private + type: object + connected_meetings: + properties: + can_alter_connected_meetings: + type: boolean + can_switch_connected_meetings: + type: boolean + can_switch_to_parent_meeting: + type: boolean + required: + - can_alter_connected_meetings + - can_switch_connected_meetings + - can_switch_to_parent_meeting + type: object + disable_participant_audio: + type: boolean + disable_participant_screensharing: + type: boolean + disable_participant_video: + type: boolean + hidden_participant: + description: >- + Whether this participant is visible to others or + not + type: boolean + is_recorder: + default: false + type: boolean + kick_participant: + type: boolean + media: + description: Media permissions + properties: + audio: + description: Audio permissions + properties: + can_produce: + description: Can produce audio + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + screenshare: + description: Screenshare permissions + properties: + can_produce: + description: Can produce screen share video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + video: + description: Video permissions + properties: + can_produce: + description: Can produce video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + required: + - video + - audio + - screenshare + type: object + pin_participant: + type: boolean + plugins: + description: Plugin permissions + properties: + can_close: + description: Can close plugins that are already open + type: boolean + can_edit_config: + description: Can edit plugin config + type: boolean + can_start: + description: Can start plugins + type: boolean + config: + type: string + format: uuid + properties: + access_control: + enum: + - FULL_ACCESS + - VIEW_ONLY + type: string + handles_view_only: + type: boolean + required: + - access_control + - handles_view_only + required: + - can_close + - can_start + - can_edit_config + - config + type: object + polls: + description: Poll permissions + properties: + can_create: + description: Can create polls + type: boolean + can_view: + description: Can view polls + type: boolean + can_vote: + description: Can vote on polls + type: boolean + required: + - can_create + - can_vote + - can_view + type: object + recorder_type: + default: NONE + description: Type of the recording peer + enum: + - RECORDER + - LIVESTREAMER + - NONE + type: string + show_participant_list: + type: boolean + waiting_room_type: + description: Waiting room type + enum: + - SKIP + - ON_PRIVILEGED_USER_ENTRY + - SKIP_ON_ACCEPT + type: string + required: + - accept_waiting_requests + - can_accept_production_requests + - can_edit_display_name + - can_spotlight + - recorder_type + - disable_participant_audio + - disable_participant_screensharing + - disable_participant_video + - kick_participant + - pin_participant + - can_record + - can_livestream + - waiting_room_type + - plugins + - connected_meetings + - polls + - media + - chat + - hidden_participant + - show_participant_list + - can_change_participant_permissions + type: object + ui: + properties: + config_diff: + type: object + design_tokens: + properties: + border_radius: + enum: + - rounded + type: string + border_width: + enum: + - thin + type: string + colors: + properties: + background: + properties: + '600': + default: '#222222' + type: string + '700': + default: '#1f1f1f' + type: string + '800': + default: '#1b1b1b' + type: string + '900': + default: '#181818' + type: string + '1000': + default: '#141414' + type: string + required: + - '600' + - '700' + - '800' + - '900' + - '1000' + type: object + brand: + properties: + '300': + default: '#844d1c' + type: string + '400': + default: '#9d5b22' + type: string + '500': + default: '#b56927' + type: string + '600': + default: '#d37c30' + type: string + '700': + default: '#d9904f' + type: string + required: + - '300' + - '400' + - '500' + - '600' + - '700' + type: object + danger: + default: '#FF2D2D' + type: string + success: + default: '#62A504' + type: string + text: + default: '#EEEEEE' + type: string + text_on_brand: + default: '#EEEEEE' + type: string + video_bg: + default: '#191919' + type: string + warning: + default: '#FFCD07' + type: string + required: + - brand + - background + - danger + - text + - text_on_brand + - success + - video_bg + - warning + type: object + logo: + type: string + spacing_base: + default: 4 + type: number + theme: + enum: + - dark + type: string + required: + - border_radius + - border_width + - spacing_base + - theme + - colors + - logo + type: object + required: + - design_tokens + type: object + required: + - id + - name + - config + - ui + title: Preset + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + - data + title: GenericSuccessResponse + type: object + description: Success response + security: + - api_token: [] + summary: Fetch details of a preset + tags: + - Presets + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - presets + method: get_preset_by_id + patch: + description: Update a preset by the provided preset ID + operationId: patch-presets-preset_id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the preset to fetch + in: path + name: preset_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitUpdatePreset' + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + id: + description: ID of the preset + format: uuid + type: string + config: + properties: + max_screenshare_count: + description: >- + Maximum number of screen shares that can be active + at a given time + type: integer + max_video_streams: + description: >- + Maximum number of streams that are visible on a + device + properties: + desktop: + description: >- + Maximum number of video streams visible on + desktop devices + type: integer + mobile: + description: >- + Maximum number of streams visible on mobile + devices + type: integer + required: + - mobile + - desktop + type: object + media: + description: 'Media configuration options. eg: Video quality' + properties: + audio: + description: Control options for Audio quality. + properties: + enable_high_bitrate: + default: false + description: >- + Enable High Quality Audio for your + meetings + type: boolean + enable_stereo: + default: false + description: Enable Stereo for your meetings + type: boolean + type: object + screenshare: + description: >- + Configuration options for participant screen + shares + properties: + frame_rate: + description: Frame rate of screen share + type: integer + quality: + description: Quality of screen share + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + video: + description: Configuration options for participant videos + properties: + frame_rate: + description: Frame rate of participants' video + maximum: 30 + type: integer + quality: + description: Video quality of participants + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + required: + - video + - screenshare + type: object + view_type: + description: Type of the meeting + enum: + - GROUP_CALL + - WEBINAR + - AUDIO_ROOM + type: string + required: + - view_type + - max_video_streams + - max_screenshare_count + - media + type: object + name: + description: Name of the preset + type: string + permissions: + properties: + accept_waiting_requests: + description: >- + Whether this participant can accept waiting + requests + type: boolean + can_accept_production_requests: + type: boolean + can_change_participant_permissions: + type: boolean + can_edit_display_name: + type: boolean + can_livestream: + type: boolean + can_record: + type: boolean + can_spotlight: + type: boolean + chat: + description: Chat permissions + properties: + private: + properties: + can_receive: + type: boolean + can_send: + type: boolean + files: + type: boolean + text: + type: boolean + required: + - can_send + - can_receive + - text + - files + type: object + public: + properties: + can_send: + description: Can send messages in general + type: boolean + files: + description: Can send file messages + type: boolean + text: + description: Can send text messages + type: boolean + required: + - can_send + - text + - files + type: object + required: + - public + - private + type: object + connected_meetings: + properties: + can_alter_connected_meetings: + type: boolean + can_switch_connected_meetings: + type: boolean + can_switch_to_parent_meeting: + type: boolean + required: + - can_alter_connected_meetings + - can_switch_connected_meetings + - can_switch_to_parent_meeting + type: object + disable_participant_audio: + type: boolean + disable_participant_screensharing: + type: boolean + disable_participant_video: + type: boolean + hidden_participant: + description: >- + Whether this participant is visible to others or + not + type: boolean + is_recorder: + default: false + type: boolean + kick_participant: + type: boolean + media: + description: Media permissions + properties: + audio: + description: Audio permissions + properties: + can_produce: + description: Can produce audio + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + screenshare: + description: Screenshare permissions + properties: + can_produce: + description: Can produce screen share video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + video: + description: Video permissions + properties: + can_produce: + description: Can produce video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + required: + - video + - audio + - screenshare + type: object + pin_participant: + type: boolean + plugins: + description: Plugin permissions + properties: + can_close: + description: Can close plugins that are already open + type: boolean + can_edit_config: + description: Can edit plugin config + type: boolean + can_start: + description: Can start plugins + type: boolean + config: + type: string + format: uuid + properties: + access_control: + enum: + - FULL_ACCESS + - VIEW_ONLY + type: string + handles_view_only: + type: boolean + required: + - access_control + - handles_view_only + required: + - can_close + - can_start + - can_edit_config + - config + type: object + polls: + description: Poll permissions + properties: + can_create: + description: Can create polls + type: boolean + can_view: + description: Can view polls + type: boolean + can_vote: + description: Can vote on polls + type: boolean + required: + - can_create + - can_vote + - can_view + type: object + recorder_type: + default: NONE + description: Type of the recording peer + enum: + - RECORDER + - LIVESTREAMER + - NONE + type: string + show_participant_list: + type: boolean + waiting_room_type: + description: Waiting room type + enum: + - SKIP + - ON_PRIVILEGED_USER_ENTRY + - SKIP_ON_ACCEPT + type: string + required: + - accept_waiting_requests + - can_accept_production_requests + - can_edit_display_name + - can_spotlight + - recorder_type + - disable_participant_audio + - disable_participant_screensharing + - disable_participant_video + - kick_participant + - pin_participant + - can_record + - can_livestream + - waiting_room_type + - plugins + - connected_meetings + - polls + - media + - chat + - hidden_participant + - show_participant_list + - can_change_participant_permissions + type: object + ui: + properties: + config_diff: + type: object + design_tokens: + properties: + border_radius: + enum: + - rounded + type: string + border_width: + enum: + - thin + type: string + colors: + properties: + background: + properties: + '600': + default: '#222222' + type: string + '700': + default: '#1f1f1f' + type: string + '800': + default: '#1b1b1b' + type: string + '900': + default: '#181818' + type: string + '1000': + default: '#141414' + type: string + required: + - '600' + - '700' + - '800' + - '900' + - '1000' + type: object + brand: + properties: + '300': + default: '#844d1c' + type: string + '400': + default: '#9d5b22' + type: string + '500': + default: '#b56927' + type: string + '600': + default: '#d37c30' + type: string + '700': + default: '#d9904f' + type: string + required: + - '300' + - '400' + - '500' + - '600' + - '700' + type: object + danger: + default: '#FF2D2D' + type: string + success: + default: '#62A504' + type: string + text: + default: '#EEEEEE' + type: string + text_on_brand: + default: '#EEEEEE' + type: string + video_bg: + default: '#191919' + type: string + warning: + default: '#FFCD07' + type: string + required: + - brand + - background + - danger + - text + - text_on_brand + - success + - video_bg + - warning + type: object + logo: + type: string + spacing_base: + default: 4 + type: number + theme: + enum: + - dark + type: string + required: + - border_radius + - border_width + - spacing_base + - theme + - colors + - logo + type: object + required: + - design_tokens + type: object + required: + - id + - name + - config + - ui + title: Preset + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + - data + title: GenericSuccessResponse + type: object + description: Success response + security: + - api_token: [] + summary: Update a preset + tags: + - Presets + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - presets + method: update + /accounts/{account_id}/realtime/kit/{app_id}/recordings: + get: + description: >- + Returns all recordings for an App. If the `meeting_id` parameter is + passed, returns all recordings for the given meeting ID. + operationId: get_all_recordings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: >- + ID of a meeting. Optional. Will limit results to only this meeting + if passed. + in: query + name: meeting_id + schema: + format: uuid + type: string + - allowEmptyValue: true + description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + minimum: 0 + type: number + - allowEmptyValue: true + description: Number of results per page + in: query + name: per_page + schema: + minimum: 0 + type: number + - description: >- + If passed, only shows expired/non-expired recordings on + RealtimeKit's bucket + in: query + name: expired + schema: + type: boolean + - description: >- + The search query string. You can search using the meeting ID or + title. + in: query + name: search + schema: + type: string + - in: query + name: sort_by + schema: + enum: + - invokedTime + type: string + - in: query + name: sort_order + schema: + enum: + - ASC + - DESC + type: string + - description: >- + The start time range for which you want to retrieve the meetings. + The time must be specified in ISO format. + in: query + name: start_time + schema: + format: date-time + type: string + - description: >- + The end time range for which you want to retrieve the meetings. The + time must be specified in ISO format. + in: query + name: end_time + schema: + format: date-time + type: string + - description: Filter by one or more recording status + explode: false + in: query + name: status + schema: + items: + enum: + - INVOKED + - RECORDING + - UPLOADING + - UPLOADED + type: string + type: array + responses: + '200': + content: + application/json: + schema: + properties: + data: + items: + type: object + properties: + audio_download_url: + description: >- + If the audio_config is passed, the URL for + downloading the audio recording is returned. + format: uri + nullable: true + readOnly: true + type: string + download_url: + description: URL where the recording can be downloaded. + format: uri + nullable: true + readOnly: true + type: string + download_url_expiry: + description: Timestamp when the download URL expires. + format: date-time + nullable: true + readOnly: true + type: string + file_size: + description: File size of the recording, in bytes. + nullable: true + readOnly: true + type: number + id: + description: ID of the recording + format: uuid + readOnly: true + type: string + invoked_time: + description: Timestamp when this recording was invoked. + format: date-time + type: string + output_file_name: + description: File name of the recording. + type: string + recording_duration: + description: Total recording time in seconds. + type: integer + session_id: + description: ID of the meeting session this recording is for. + format: uuid + nullable: true + readOnly: true + type: string + started_time: + description: >- + Timestamp when this recording actually started after + being invoked. Usually a few seconds after + `invoked_time`. + format: date-time + nullable: true + type: string + status: + description: Current status of the recording. + enum: + - INVOKED + - RECORDING + - UPLOADING + - UPLOADED + - ERRORED + - PAUSED + type: string + stopped_time: + description: >- + Timestamp when this recording was stopped. Optional; + is present only when the recording has actually been + stopped. + format: date-time + nullable: true + type: string + storage_config: + $ref: '#/components/schemas/realtimekitStorageConfig' + meeting: + $ref: '#/components/schemas/realtimekitMeeting' + required: + - id + - download_url + - download_url_expiry + - audio_download_url + - file_size + - session_id + - output_file_name + - status + - invoked_time + - started_time + - stopped_time + title: Recording + type: array + paging: + properties: + end_offset: + type: number + start_offset: + type: number + total_count: + minimum: 0 + type: number + required: + - total_count + - start_offset + - end_offset + type: object + success: + type: boolean + required: + - success + - data + - paging + title: PagingResponse + type: object + description: Success response + '201': + description: Created + security: + - api_token: [] + summary: Fetch all recordings for an App + tags: + - Recordings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - recordings + method: get_recordings + post: + description: >- + Starts recording a meeting. The meeting can be started by an App admin + directly, or a participant with permissions to start a recording, based + on the type of authorization used. + operationId: start_recording + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_multiple_recordings: + default: false + description: >- + By default, a meeting allows only one recording to run at a + time. Enabling the `allow_multiple_recordings` parameter to + true allows you to initiate multiple recordings concurrently + in the same meeting. This allows you to record separate + videos of the same meeting with different configurations, + such as portrait mode or landscape mode. + type: boolean + audio_config: + $ref: '#/components/schemas/realtimekitAudioConfig' + file_name_prefix: + description: Update the recording file name. + type: string + interactive_config: + $ref: '#/components/schemas/realtimekitInteractiveConfig' + max_seconds: + description: >- + Specifies the maximum duration for recording in seconds, + ranging from a minimum of 60 seconds to a maximum of 24 + hours. + maximum: 86400 + minimum: 60 + type: integer + meeting_id: + description: ID of the meeting to record. + format: uuid + type: string + realtimekit_bucket_config: + $ref: '#/components/schemas/realtimekitRealtimekitBucketConfig' + rtmp_out_config: + $ref: '#/components/schemas/realtimekitLivestreamingConfig' + storage_config: + $ref: '#/components/schemas/realtimekitStorageConfig' + url: + description: Pass a custom url to record arbitary screen + format: uri + type: string + video_config: + $ref: '#/components/schemas/realtimekitVideoConfig' + type: object + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + audio_download_url: + description: >- + If the audio_config is passed, the URL for downloading + the audio recording is returned. + format: uri + nullable: true + readOnly: true + type: string + download_url: + description: URL where the recording can be downloaded. + format: uri + nullable: true + readOnly: true + type: string + download_url_expiry: + description: Timestamp when the download URL expires. + format: date-time + nullable: true + readOnly: true + type: string + file_size: + description: File size of the recording, in bytes. + nullable: true + readOnly: true + type: number + id: + description: ID of the recording + format: uuid + readOnly: true + type: string + invoked_time: + description: Timestamp when this recording was invoked. + format: date-time + type: string + output_file_name: + description: File name of the recording. + type: string + recording_duration: + description: Total recording time in seconds. + type: integer + session_id: + description: ID of the meeting session this recording is for. + format: uuid + nullable: true + readOnly: true + type: string + started_time: + description: >- + Timestamp when this recording actually started after + being invoked. Usually a few seconds after + `invoked_time`. + format: date-time + nullable: true + type: string + status: + description: Current status of the recording. + enum: + - INVOKED + - RECORDING + - UPLOADING + - UPLOADED + - ERRORED + - PAUSED + type: string + stopped_time: + description: >- + Timestamp when this recording was stopped. Optional; + is present only when the recording has actually been + stopped. + format: date-time + nullable: true + type: string + start_reason: + $ref: '#/components/schemas/realtimekitStartReason' + stop_reason: + $ref: '#/components/schemas/realtimekitStopReason' + storage_config: + $ref: '#/components/schemas/realtimekitStorageConfig' + required: + - id + - download_url + - download_url_expiry + - audio_download_url + - file_size + - session_id + - output_file_name + - status + - invoked_time + - started_time + - stopped_time + title: Recording + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success response + security: + - api_token: [] + summary: Start recording a meeting + tags: + - Recordings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - recordings + method: start_recordings + /accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id}: + get: + description: Returns the active recording details for the given meeting ID. + operationId: get_active_recording + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: meeting_id + in: path + required: true + description: The Realtime Kit meeting ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + $ref: '#/components/schemas/realtimekitRecording' + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + - data + title: GenericSuccessResponse + type: object + description: Success response + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitGenericErrorResponse' + description: Failure response + security: + - api_token: [] + summary: Fetch active recording + tags: + - Recordings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - recordings + method: get_active_recordings + /accounts/{account_id}/realtime/kit/{app_id}/recordings/track: + post: + description: >- + Starts a track recording in a meeting. Track recordings consist of + "layers". Layers are used to map audio/video tracks in a meeting to + output destinations. More information about track recordings is + available in the [Track Recordings Guide + Page](https://docs.realtime.cloudflare.com/guides/capabilities/recording/recording-overview). + operationId: startTrackRecordingForAMeeting + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + layers: + type: object + max_seconds: + description: Maximum seconds this recording should be active for (beta) + type: number + meeting_id: + description: ID of the meeting to record. + type: string + required: + - meeting_id + - layers + type: object + description: For now only "default" layer key is supported. + responses: + '200': + description: OK + security: + - api_token: [] + summary: Start recording audio and video tracks + tags: + - Recordings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - recordings + method: start_track_recording + /accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}: + get: + description: Returns details of a recording for the given recording ID. + operationId: get_one_recording + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the recording + in: path + name: recording_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + audio_download_url: + description: >- + If the audio_config is passed, the URL for downloading + the audio recording is returned. + format: uri + nullable: true + readOnly: true + type: string + download_url: + description: URL where the recording can be downloaded. + format: uri + nullable: true + readOnly: true + type: string + download_url_expiry: + description: Timestamp when the download URL expires. + format: date-time + nullable: true + readOnly: true + type: string + file_size: + description: File size of the recording, in bytes. + nullable: true + readOnly: true + type: number + id: + description: ID of the recording + format: uuid + readOnly: true + type: string + invoked_time: + description: Timestamp when this recording was invoked. + format: date-time + type: string + output_file_name: + description: File name of the recording. + type: string + recording_duration: + description: Total recording time in seconds. + type: integer + session_id: + description: ID of the meeting session this recording is for. + format: uuid + nullable: true + readOnly: true + type: string + started_time: + description: >- + Timestamp when this recording actually started after + being invoked. Usually a few seconds after + `invoked_time`. + format: date-time + nullable: true + type: string + status: + description: Current status of the recording. + enum: + - INVOKED + - RECORDING + - UPLOADING + - UPLOADED + - ERRORED + - PAUSED + type: string + stopped_time: + description: >- + Timestamp when this recording was stopped. Optional; + is present only when the recording has actually been + stopped. + format: date-time + nullable: true + type: string + start_reason: + $ref: '#/components/schemas/realtimekitStartReason' + stop_reason: + $ref: '#/components/schemas/realtimekitStopReason' + storage_config: + $ref: '#/components/schemas/realtimekitStorageConfig' + required: + - id + - download_url + - download_url_expiry + - audio_download_url + - file_size + - session_id + - output_file_name + - status + - invoked_time + - started_time + - stopped_time + title: Recording + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success response + security: + - api_token: [] + summary: Fetch details of a recording + tags: + - Recordings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - recordings + method: get_one_recording + put: + description: Pause/Resume/Stop a given recording ID. + operationId: pause_resume_stop_recording + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the recording + in: path + name: recording_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + action: + enum: + - stop + - pause + - resume + type: string + required: + - action + type: object + responses: + '200': + content: + application/json: + schema: + properties: + data: + description: Data returned by the operation + type: object + properties: + audio_download_url: + description: >- + If the audio_config is passed, the URL for downloading + the audio recording is returned. + format: uri + nullable: true + readOnly: true + type: string + download_url: + description: URL where the recording can be downloaded. + format: uri + nullable: true + readOnly: true + type: string + download_url_expiry: + description: Timestamp when the download URL expires. + format: date-time + nullable: true + readOnly: true + type: string + file_size: + description: File size of the recording, in bytes. + nullable: true + readOnly: true + type: number + id: + description: ID of the recording + format: uuid + readOnly: true + type: string + invoked_time: + description: Timestamp when this recording was invoked. + format: date-time + type: string + output_file_name: + description: File name of the recording. + type: string + recording_duration: + description: Total recording time in seconds. + type: integer + session_id: + description: ID of the meeting session this recording is for. + format: uuid + nullable: true + readOnly: true + type: string + started_time: + description: >- + Timestamp when this recording actually started after + being invoked. Usually a few seconds after + `invoked_time`. + format: date-time + nullable: true + type: string + status: + description: Current status of the recording. + enum: + - INVOKED + - RECORDING + - UPLOADING + - UPLOADED + - ERRORED + - PAUSED + type: string + stopped_time: + description: >- + Timestamp when this recording was stopped. Optional; + is present only when the recording has actually been + stopped. + format: date-time + nullable: true + type: string + start_reason: + $ref: '#/components/schemas/realtimekitStartReason' + stop_reason: + $ref: '#/components/schemas/realtimekitStopReason' + storage_config: + $ref: '#/components/schemas/realtimekitStorageConfig' + required: + - id + - download_url + - download_url_expiry + - audio_download_url + - file_size + - session_id + - output_file_name + - status + - invoked_time + - started_time + - stopped_time + title: Recording + success: + default: true + description: Success status of the operation + type: boolean + required: + - success + title: GenericSuccessResponse + type: object + description: Success response + security: + - api_token: [] + summary: Pause/Resume/Stop recording + tags: + - Recordings + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - recordings + method: pause_resume_stop_recording + /accounts/{account_id}/realtime/kit/{app_id}/sessions: + get: + description: Returns details of all sessions of an App. + operationId: GetSessions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - allowEmptyValue: true + description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + minimum: 0 + type: number + - allowEmptyValue: true + description: Number of results per page + in: query + name: per_page + schema: + minimum: 0 + type: number + - in: query + name: sort_by + schema: + enum: + - minutesConsumed + - createdAt + type: string + - in: query + name: sort_order + schema: + enum: + - ASC + - DESC + type: string + - description: >- + The start time range for which you want to retrieve the meetings. + The time must be specified in ISO format. + in: query + name: start_time + schema: + format: date-time + type: string + - description: >- + The end time range for which you want to retrieve the meetings. The + time must be specified in ISO format. + in: query + name: end_time + schema: + format: date-time + type: string + - in: query + name: participants + schema: + type: string + - in: query + name: status + schema: + enum: + - LIVE + - ENDED + type: string + - description: >- + Search string that matches sessions based on meeting title, meeting + ID, and session ID + in: query + name: search + schema: + type: string + - description: ID of the meeting that sessions should be associated with + in: query + name: associated_id + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + sessions: + items: + $ref: '#/components/schemas/realtimekitActiveSession' + type: array + type: object + success: + type: boolean + type: object + description: Get all sessions success response + security: + - api_token: [] + summary: Fetch all sessions of an App + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_sessions + /accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}: + get: + description: >- + Returns details of the given peer ID along with call statistics for the + given session ID. + operationId: GetParticipantDataFromPeerId + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: >- + Comma separated list of filters to apply. Note that there must be no + spaces between the filters. + in: query + name: filters + schema: + enum: + - device_info + - ip_information + - precall_network_information + - events + - quality_stats + type: string + - description: ID of the peer + in: path + name: peer_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + participant: + properties: + created_at: + type: string + readOnly: true + custom_participant_id: + type: string + display_name: + type: string + duration: + type: number + id: + type: string + joined_at: + type: string + left_at: + type: string + peer_report: + properties: + metadata: + properties: + audio_devices_updates: + items: + type: object + type: array + browser_metadata: + properties: + browser: + type: string + browser_version: + type: string + engine: + type: string + user_agent: + type: string + webgl_support: + type: string + type: object + candidate_pairs: + properties: + consuming_transport: + items: + type: object + type: array + producing_transport: + items: + properties: + available_outgoing_bitrate: + type: integer + bytes_discarded_on_send: + type: integer + bytes_received: + type: integer + bytes_sent: + type: integer + current_round_trip_time: + type: number + last_packet_received_timestamp: + type: integer + last_packet_sent_timestamp: + type: integer + local_candidate_address: + type: string + local_candidate_id: + type: string + local_candidate_network_type: + type: string + local_candidate_port: + type: integer + local_candidate_protocol: + type: string + local_candidate_related_address: + type: string + local_candidate_related_port: + type: integer + local_candidate_type: + type: string + nominated: + type: boolean + packets_discarded_on_send: + type: integer + packets_received: + type: integer + packets_sent: + type: integer + remote_candidate_address: + type: string + remote_candidate_id: + type: string + remote_candidate_port: + type: integer + remote_candidate_protocol: + type: string + remote_candidate_type: + type: string + total_round_trip_time: + type: number + type: object + type: array + type: object + device_info: + properties: + cpus: + type: integer + is_mobile: + type: boolean + os: + type: string + os_version: + type: string + type: object + events: + items: + properties: + name: + type: string + timestamp: + type: string + type: object + type: array + ip_information: + properties: + asn: + properties: + asn: + type: string + type: object + city: + type: string + country: + type: string + ipv4: + type: string + region: + type: string + timezone: + type: string + type: object + pc_metadata: + items: + properties: + effective_network_type: + type: string + reflexive_connectivity: + type: boolean + relay_connectivity: + type: boolean + timestamp: + type: string + turn_connectivity: + type: boolean + type: object + type: array + room_view_type: + type: string + sdk_name: + type: string + sdk_version: + type: string + selected_device_updates: + items: + type: object + type: array + speaker_devices_updates: + items: + type: object + type: array + video_devices_updates: + items: + type: object + type: array + type: object + quality: + properties: + audio_consumer: + items: + type: object + type: array + audio_consumer_cumulative: + type: object + audio_producer: + items: + properties: + bytes_sent: + type: integer + jitter: + type: integer + mid: + type: string + mos_quality: + type: integer + packets_lost: + type: integer + packets_sent: + type: integer + producer_id: + type: string + rtt: + type: number + ssrc: + type: integer + timestamp: + type: string + type: object + type: array + audio_producer_cumulative: + properties: + packet_loss: + properties: + 10_or_greater_event_fraction: + type: integer + 25_or_greater_event_fraction: + type: integer + 50_or_greater_event_fraction: + type: integer + 5_or_greater_event_fraction: + type: integer + avg: + type: integer + type: object + quality_mos: + properties: + avg: + type: integer + p50: + type: integer + p75: + type: integer + p90: + type: integer + type: object + rtt: + properties: + 100ms_or_greater_event_fraction: + type: number + 250ms_or_greater_event_fraction: + type: number + 500ms_or_greater_event_fraction: + type: number + avg: + type: number + type: object + type: object + screenshare_audio_consumer: + items: + type: object + type: array + screenshare_audio_consumer_cumulative: + type: object + screenshare_audio_producer: + items: + type: object + type: array + screenshare_audio_producer_cumulative: + type: object + screenshare_video_consumer: + items: + type: object + type: array + screenshare_video_consumer_cumulative: + type: object + screenshare_video_producer: + items: + type: object + type: array + screenshare_video_producer_cumulative: + type: object + video_consumer: + items: + type: object + type: array + video_consumer_cumulative: + type: object + video_producer: + items: + type: object + type: array + video_producer_cumulative: + type: object + type: object + type: object + peer_stats: + properties: + device_info: + properties: + browser: + type: string + browser_version: + type: string + cpus: + type: integer + engine: + type: string + is_mobile: + type: boolean + os: + type: string + os_version: + type: string + sdk_name: + type: string + sdk_version: + type: string + user_agent: + type: string + webgl_support: + type: string + type: object + events: + items: + properties: + metadata: + properties: + connection_info: + properties: + backend_r_t_t: + type: number + connectivity: + properties: + host: + type: boolean + reflexive: + type: boolean + relay: + type: boolean + type: object + effective_network_type: + type: string + fractional_loss: + type: integer + ip_details: + properties: + asn: + properties: + asn: + type: string + type: object + city: + type: string + country: + type: string + ip: + type: string + loc: + type: string + postal: + type: string + region: + type: string + timezone: + type: string + type: object + jitter: + type: integer + location: + properties: + coords: + properties: + latitude: + type: number + longitude: + type: number + type: object + type: object + r_t_t: + type: number + throughput: + type: integer + turn_connectivity: + type: boolean + type: object + type: object + timestamp: + type: string + type: + type: string + type: object + type: array + ip_information: + properties: + asn: + properties: + asn: + type: string + type: object + city: + type: string + country: + type: string + ip_location: + type: string + ipv4: + type: string + org: + type: string + region: + type: string + timezone: + type: string + type: object + precall_network_information: + properties: + backend_rtt: + type: number + effective_networktype: + type: string + fractional_loss: + type: integer + jitter: + type: integer + reflexive_connectivity: + type: boolean + relay_connectivity: + type: boolean + rtt: + type: number + throughput: + type: integer + turn_connectivity: + type: boolean + type: object + type: object + quality_stats: + properties: + audio_bandwidth: + type: integer + audio_stats: + items: + type: object + type: array + average_quality: + type: integer + end: + nullable: true + type: string + first_audio_packet_received: + type: string + first_video_packet_received: + type: string + last_audio_packet_received: + type: string + last_video_packet_received: + type: string + peer_ids: + items: + type: string + type: array + start: + nullable: true + type: string + total_audio_packets: + type: integer + total_audio_packets_lost: + type: integer + total_video_packets: + type: integer + total_video_packets_lost: + type: integer + video_bandwidth: + type: integer + video_stats: + items: + type: object + type: array + type: object + role: + type: string + updated_at: + type: string + readOnly: true + user_id: + type: string + type: object + type: object + success: + type: boolean + type: object + description: >- + Returns details of a participant (using peer id) along with + callstats data. + security: + - api_token: [] + summary: Fetch details of peer + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_participant_data_from_peer_id + /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}: + get: + description: Returns data of the given session ID including recording details. + operationId: GetSessionDetails + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: List all breakout rooms + in: query + name: include_breakout_rooms + schema: + default: false + type: boolean + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + session: + $ref: '#/components/schemas/realtimekitActiveSession' + type: object + success: + type: boolean + type: object + description: Get details about a particular session + security: + - api_token: [] + summary: Fetch details of a session + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_session_details + /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat: + get: + description: >- + Returns a URL to download all chat messages of the session ID in CSV + format. + operationId: GetSessionChat + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + $ref: '#/components/schemas/realtimekitChatMessage' + success: + type: boolean + type: object + description: Returns all chat messages of a session. + security: + - api_token: [] + summary: Fetch all chat messages of a session + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_session_chat + /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/livestream-sessions: + get: + description: >- + Returns livestream session details for the given session ID. Retreive + the session ID using the `Fetch all sessions of an App` API. + operationId: get-v2-livestreamsession-session-meetingId-active-livestream + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: Number of results per page. + in: query + name: per_page + schema: + type: number + - description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + type: number + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + err_message: + enum: + - LIVE + - IDLE + - ERRORED + - INVOKED + type: string + id: + description: The livestream session ID. + type: string + ingest_seconds: + description: >- + The time duration for which the input was given or the + meeting was streamed. + type: number + invoked_time: + description: Name of the livestream. + nullable: true + type: string + livestream_id: + description: The ID of the livestream. + type: string + paging: + properties: + end_offset: + type: number + start_offset: + type: number + total_count: + type: number + type: object + stopped_time: + description: Specifies if the livestream was disabled. + format: date-time + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is + returned in ISO format. + format: date-time + type: string + readOnly: true + viewer_seconds: + description: >- + The total view time for which the viewers watched the + stream. + type: number + type: object + success: + type: boolean + type: object + description: OK + security: + - api_token: [] + summary: Fetch livestream session details using a session ID + tags: + - Live streams + x-api-token-group: + - Realtime Admin + - Realtime + /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants: + get: + description: Returns a list of participants for the given session ID. + operationId: GetSessionParticipants + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: >- + The search query string. You can search using the meeting ID or + title. + in: query + name: search + schema: + type: string + - allowEmptyValue: true + description: >- + The page number from which you want your page search results to be + displayed. + in: query + name: page_no + schema: + minimum: 0 + type: number + - allowEmptyValue: true + description: Number of results per page + in: query + name: per_page + schema: + minimum: 0 + type: number + - in: query + name: sort_order + schema: + enum: + - ASC + - DESC + type: string + - in: query + name: sort_by + schema: + enum: + - joinedAt + - duration + type: string + - description: if true, response includes all the peer events of participants. + in: query + name: include_peer_events + schema: + default: false + type: boolean + - description: >- + In breakout room sessions, the view parameter can be set to `raw` + for session specific duration for participants or `consolidated` to + accumulate breakout room durations. + in: query + name: view + schema: + default: raw + enum: + - raw + - consolidated + type: string + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + participants: + items: + $ref: '#/components/schemas/realtimekitParticipantsList' + type: array + type: object + success: + type: boolean + type: object + description: Get participants list of a particular session + security: + - api_token: [] + summary: Fetch participants list of a session + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_session_participants + /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}: + get: + description: >- + Returns details of the given participant ID along with call statistics + for the given session ID. + operationId: GetParticipantDetails + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - allowEmptyValue: true + description: >- + Comma separated list of filters to apply. Note that there must be no + spaces between the filters. + in: query + name: filters + schema: + enum: + - device_info + - ip_information + - precall_network_information + - events + - quality_stats + type: string + - description: if true, response includes all the peer events of participant. + in: query + name: include_peer_events + schema: + default: false + type: boolean + - description: ID of the participant + in: path + name: participant_id + schema: + type: string + required: true + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + participant: + properties: + created_at: + description: timestamp when this participant was created. + type: string + readOnly: true + custom_participant_id: + description: ID passed by client to create this participant. + type: string + display_name: + description: >- + Display name of participant when joining the + session. + type: string + duration: + description: >- + number of minutes for which the participant was in + the session. + type: number + id: + description: >- + Participant ID. This maps to the corresponding + peerId. + type: string + joined_at: + description: timestamp at which participant joined the session. + type: string + left_at: + description: timestamp at which participant left the session. + type: string + preset_name: + description: >- + Name of the preset associated with the + participant. + type: string + updated_at: + description: >- + timestamp when this participant's data was last + updated. + type: string + readOnly: true + user_id: + description: User id for this participant. + type: string + peer_stats: + properties: + config: + type: string + device_info: + properties: + browser: + type: string + browser_version: + type: string + cpus: + type: number + engine: + type: string + is_mobile: + type: boolean + memory: + type: number + os: + type: string + os_version: + type: string + sdk_name: + type: string + sdk_version: + type: string + user_agent: + type: string + webgl_support: + type: string + type: object + events: + items: + properties: + timestamp: + type: string + type: + type: string + type: object + type: array + ip_information: + properties: + city: + type: string + country: + type: string + ip_location: + type: string + ipv4: + type: string + org: + type: string + portal: + type: string + region: + type: string + timezone: + type: string + type: object + precall_network_information: + properties: + backend_rtt: + type: number + effective_networktype: + type: string + fractional_loss: + type: number + jitter: + type: number + reflexive_connectivity: + type: boolean + relay_connectivity: + type: boolean + rtt: + type: number + throughtput: + type: number + turn_connectivity: + type: boolean + type: object + status: + type: string + type: object + quality_stats: + items: + properties: + audio_bandwidth: + type: number + audio_packet_loss: + type: number + audio_stats: + items: + properties: + concealment_events: + type: number + jitter: + type: number + packets_lost: + type: number + quality: + type: number + timestamp: + type: string + type: object + type: array + average_quality: + type: number + end: + type: string + peer_id: + type: string + start: + type: string + video_bandwidth: + type: number + video_packet_loss: + type: number + video_stats: + items: + properties: + frame_height: + type: number + frame_width: + type: number + frames_dropped: + type: number + frames_per_second: + type: number + jitter: + type: number + packets_lost: + type: number + quality: + type: number + timestamp: + type: string + type: object + type: array + type: object + type: array + type: object + type: object + success: + type: boolean + type: object + description: Returns details of a participant along with callstats data. + security: + - api_token: [] + summary: Fetch details of a participant + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_session_participant_details + /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary: + get: + description: >- + Returns a Summary URL to download the Summary of Transcripts for the + session ID as plain text. + operationId: GetSessionSummary + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + $ref: '#/components/schemas/realtimekitTranscriptSummary' + success: + type: boolean + type: object + description: Returns a complete summary of transcripts of a session. + security: + - api_token: [] + summary: Fetch summary of transcripts for a session + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_session_summary + post: + description: Trigger Summary generation of Transcripts for the session ID. + operationId: post-sessions-session_id-summary + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + 2XX: + content: + application/json: + schema: + properties: + data: + properties: + message: + type: string + success: + type: boolean + type: object + success: + type: boolean + type: object + description: Success + security: + - api_token: [] + summary: Generate summary of Transcripts for the session + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: generate_summary_of_transcripts + /accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript: + get: + description: >- + Returns a URL to download the transcript for the session ID in CSV + format. + operationId: GetSessionTranscript + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: session_id + in: path + required: true + description: The session ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + $ref: '#/components/schemas/realtimekitTranscript' + success: + type: boolean + type: object + description: Returns the complete transcript of a session. + security: + - api_token: [] + summary: Fetch the complete transcript for a session + tags: + - Sessions + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - sessions + method: get_session_transcripts + /accounts/{account_id}/realtime/kit/{app_id}/webhooks: + get: + description: Returns details of all webhooks for an App. + operationId: getAllWebhooks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhooksListSuccessResponse' + description: Operation successful + '401': + content: + application/json: {} + description: Invalid credentials + security: + - api_token: [] + summary: Fetch all webhooks details + tags: + - Webhooks + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - webhooks + method: get_webhooks + post: + description: Adds a new webhook to an App. + operationId: addWebhook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhookRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhookSuccessResponse' + description: Webhook registered successfully + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitErrorResponse' + description: Error - malformed request + '401': + content: + application/json: {} + description: Invalid credentials + security: + - api_token: [] + summary: Add a webhook + tags: + - Webhooks + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - webhooks + method: create_webhook + /accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}: + delete: + description: Removes a webhook for the given webhook ID. + operationId: deleteWebhook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the webhook + in: path + name: webhook_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhookSuccessResponse' + description: Operation successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitErrorResponse' + description: Error - malformed request + '401': + content: + application/json: {} + description: Invalid credentials + security: + - api_token: [] + summary: Delete a webhook + tags: + - Webhooks + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - webhooks + method: delete_webhook + get: + description: Returns webhook details for the given webhook ID. + operationId: getWebhook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the webhook + in: path + name: webhook_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhookSuccessResponse' + description: Operation successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitErrorResponse' + description: Error - malformed request + '401': + content: + application/json: {} + description: Invalid credentials + security: + - api_token: [] + summary: Fetch details of a webhook + tags: + - Webhooks + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - webhooks + method: get_webhook_by_id + patch: + description: Edits the webhook details for the given webhook ID. + operationId: editWebhook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the webhook + in: path + name: webhook_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitPatchWebhookRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhookSuccessResponse' + description: Operation successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitErrorResponse' + description: Error - malformed request + '401': + content: + application/json: {} + description: Invalid credentials + security: + - api_token: [] + summary: Edit a webhook + tags: + - Webhooks + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - webhooks + method: edit_webhook + put: + description: Replace all details for the given webhook ID. + operationId: replaceWebhook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - description: ID of the webhook + in: path + name: webhook_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhookRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitWebhookSuccessResponse' + description: Operation successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/realtimekitErrorResponse' + description: Error - malformed request + '401': + content: + application/json: {} + description: Invalid credentials + security: + - api_token: [] + summary: Replace a webhook + tags: + - Webhooks + x-api-token-group: + - Realtime Admin + - Realtime + x-stackql-sdk: + service: realtime_kit + resource_chain: + - webhooks + method: replace_webhook +components: + schemas: + moqApiResponseError: + properties: + errors: + example: + - code: 21007 + message: A MoQ relay with this ID was not found. + items: + properties: + code: + description: >- + Error codes: - 21001: Request body too large (HTTP 413) - + 21002: Request body too small / missing name (HTTP 400) - + 21003: Relay ID should be 32 hex characters (HTTP 400) - + 21004: Failed to decode body — invalid JSON (HTTP 400) - + 21005: Failed to read body (HTTP 400) - 21006: Unexpected + server error (HTTP 500) - 21007: Relay not found (HTTP 404) - + 21008: Relay limit exceeded for this account (HTTP 409) - + 21009: origin_fallback and lingering_subscribe are mutually + exclusive (HTTP 400) - 21010: Invalid token type — must be + "publish_subscribe" or "subscribe" (HTTP 400) - 21011: Invalid + relay name — name must not be empty (HTTP 400) + type: integer + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: object + type: array + result: + nullable: true + type: object + success: + example: false + type: boolean + required: + - success + - errors + - messages + type: object + moqLingeringSubscribeConfig: + properties: + enabled: + default: true + type: boolean + max_timeout_ms: + default: 30000 + description: >- + Relay-level ceiling on lingering subscribe timeout (ms). Default + 30000. + maximum: 300000 + minimum: 0 + type: integer + type: object + moqOriginFallbackConfig: + properties: + enabled: + default: false + type: boolean + urls: + default: [] + description: Ordered list of upstream origin relay URLs. + items: + type: string + type: array + type: object + moqRelay: + description: Full relay details (no tokens). + properties: + config: + $ref: '#/components/schemas/moqRelayConfig' + created: + format: date-time + type: string + modified: + format: date-time + type: string + name: + example: Production Live Stream + type: string + status: + description: '"connected" when active, omitted otherwise.' + enum: + - connected + type: string + uid: + example: a1b2c3d4e5f67890a1b2c3d4e5f67890 + type: string + required: + - uid + - created + - modified + - name + - config + type: object + moqRelayConfig: + description: origin_fallback and lingering_subscribe are mutually exclusive. + properties: + lingering_subscribe: + $ref: '#/components/schemas/moqLingeringSubscribeConfig' + origin_fallback: + $ref: '#/components/schemas/moqOriginFallbackConfig' + type: object + moqRelayCreateResponse: + description: Relay with auto-generated tokens (shown once). + properties: + config: + $ref: '#/components/schemas/moqRelayConfig' + created: + format: date-time + type: string + modified: + format: date-time + type: string + name: + example: Production Live Stream + type: string + token_publish_subscribe: + description: Full access token (publish + subscribe). Treat as sensitive. + example: eyJhbGciOiJFZDI1NTE5... + type: string + token_subscribe: + description: Subscribe-only token. Treat as sensitive. + example: eyJhbGciOiJFZDI1NTE5... + type: string + uid: + description: Server-generated unique identifier (32 hex chars). + example: a1b2c3d4e5f67890a1b2c3d4e5f67890 + type: string + required: + - uid + - created + - modified + - name + - token_publish_subscribe + - token_subscribe + - config + type: object + moqRelayListItem: + description: Abbreviated relay for list responses. + properties: + created: + format: date-time + type: string + modified: + format: date-time + type: string + name: + type: string + uid: + example: a1b2c3d4e5f67890a1b2c3d4e5f67890 + type: string + required: + - uid + - created + - modified + - name + type: object + moqResultInfo: + properties: + count: + type: integer + total: + type: integer + type: object + moqRotateTokenResponse: + properties: + token: + description: New token value (shown once). Treat as sensitive. + example: eyJhbGciOiJFZDI1NTE5... + type: string + type: + enum: + - publish_subscribe + - subscribe + type: string + required: + - type + - token + type: object + realtimekitAIConfig: + description: >- + The AI Config allows you to customize the behavior of meeting + transcriptions and summaries + properties: + summarization: + $ref: '#/components/schemas/realtimekitSummarizationConfig' + transcription: + $ref: '#/components/schemas/realtimekitTranscriptionConfig' + title: AIConfig + type: object + realtimekitActiveSession: + properties: + associated_id: + description: >- + ID of the meeting this session is associated with. In the case of V2 + meetings, it is always a UUID. In V1 meetings, it is a room name of + the form `abcdef-ghijkl` + type: string + breakout_rooms: + items: + $ref: '#/components/schemas/realtimekitActiveSession' + readOnly: true + type: array + created_at: + description: timestamp when session created + type: string + readOnly: true + ended_at: + description: timestamp when session ended + type: string + id: + description: ID of the session + readOnly: true + type: string + live_participants: + description: number of participants currently in the session + type: number + max_concurrent_participants: + description: number of maximum participants that were in the session + type: number + meeting_display_name: + description: Title of the meeting this session belongs to + type: string + meta: + description: Any meta data about session. + type: object + minutes_consumed: + description: number of minutes consumed since the session started + type: number + organization_id: + description: App id that hosted this session + type: string + started_at: + description: timestamp when session started + type: string + status: + description: current status of session + enum: + - LIVE + - ENDED + type: string + type: + description: type of session + enum: + - meeting + - livestream + - participant + type: string + updated_at: + description: timestamp when session was last updated + type: string + readOnly: true + required: + - id + - associated_id + - meeting_display_name + - type + - status + - live_participants + - max_concurrent_participants + - minutes_consumed + - organization_id + - started_at + - created_at + - updated_at + type: object + realtimekitAudioConfig: + description: >- + Object containing configuration regarding the audio that is being + recorded. + properties: + channel: + default: stereo + description: >- + Audio signal pathway within an audio file that carries a specific + sound source. + enum: + - mono + - stereo + type: string + codec: + default: AAC + description: >- + Codec using which the recording will be encoded. If VP8/VP9 is + selected for videoConfig, changing audioConfig is not allowed. In + this case, the codec in the audioConfig is automatically set to + vorbis. + enum: + - MP3 + - AAC + type: string + export_file: + default: true + description: Controls whether to export audio file seperately + type: boolean + title: AudioConfig + type: object + realtimekitChatMessage: + properties: + chat_download_url: + description: URL where the chat logs can be downloaded + type: string + chat_download_url_expiry: + description: Time when the download URL will expire + type: string + required: + - chat_download_url + - chat_download_url_expiry + type: object + realtimekitErrorResponse: + properties: + error: + description: Object containing details of the error that occurred + properties: + code: + description: Error code + example: 404 + type: number + message: + description: Error message + example: 'Error: resource not found' + type: string + required: + - code + - message + type: object + success: + description: Whether the operation succeeded or not + example: false + type: boolean + required: + - success + - error + type: object + realtimekitGenericErrorResponse: + properties: + error: + properties: + code: + description: HTTP status code of the error. + type: number + message: + description: Error message describing what went wrong. + type: string + required: + - code + - message + type: object + success: + default: false + description: Success status of the request. + type: boolean + required: + - success + - error + type: object + realtimekitInteractiveConfig: + description: >- + Allows you to add timed metadata to your recordings, which are digital + markers inserted into a video file to provide contextual information at + specific points in the content range. The ID3 tags containing this + information are available to clients on the playback timeline in HLS + format. The output files are generated in a compressed .tar format. + properties: + type: + description: The metadata is presented in the form of ID3 tags. + enum: + - ID3 + type: string + title: InteractiveConfig + type: object + realtimekitLivestreamingConfig: + properties: + rtmp_url: + description: RTMP URL to stream to + example: rtmp://a.rtmp.youtube.com/live2 + format: uri + type: string + title: LivestreamingConfig + type: object + realtimekitMeeting: + properties: + created_at: + description: >- + Timestamp the object was created at. The time is returned in ISO + format. + format: date-time + readOnly: true + type: string + id: + description: ID of the meeting. + format: uuid + readOnly: true + type: string + live_stream_on_start: + description: Specifies if the meeting should start getting livestreamed on start. + type: boolean + persist_chat: + description: Specifies if Chat within a meeting should persist for a week. + type: boolean + record_on_start: + description: >- + Specifies if the meeting should start getting recorded as soon as + someone joins the meeting. + type: boolean + session_keep_alive_time_in_secs: + default: 60 + description: >- + Time in seconds, for which a session remains active, after the last + participant has left the meeting. + maximum: 600 + minimum: 60 + type: number + status: + description: >- + Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be + able to join an `INACTIVE` meeting. + enum: + - ACTIVE + - INACTIVE + type: string + summarize_on_end: + description: >- + Automatically generate summary of meetings using transcripts. + Requires Transcriptions to be enabled, and can be retrieved via + Webhooks or summary API. + type: boolean + title: + description: Title of the meeting. + type: string + updated_at: + description: >- + Timestamp the object was updated at. The time is returned in ISO + format. + format: date-time + readOnly: true + type: string + required: + - id + - created_at + - updated_at + type: object + realtimekitParticipant: + description: Represents a participant. + properties: + created_at: + description: When this object was created. The time is returned in ISO format. + format: date-time + type: string + readOnly: true + custom_participant_id: + description: A unique participant ID generated by the client. + type: string + id: + description: ID of the participant. + format: uuid + type: string + name: + description: Name of the participant. + nullable: true + type: string + picture: + description: URL to a picture of the participant. + format: uri + nullable: true + type: string + preset_name: + description: Preset applied to the participant. + type: string + updated_at: + description: When this object was updated. The time is returned in ISO format. + format: date-time + type: string + readOnly: true + required: + - id + - custom_participant_id + - preset_name + - created_at + - updated_at + title: Participant + type: object + realtimekitParticipantsList: + properties: + created_at: + description: timestamp when this participant was created. + type: string + readOnly: true + custom_participant_id: + description: ID passed by client to create this participant. + type: string + display_name: + description: Display name of participant when joining the session. + type: string + duration: + description: number of minutes for which the participant was in the session. + type: number + id: + description: Participant ID. This maps to the corresponding peerId. + type: string + joined_at: + description: timestamp at which participant joined the session. + type: string + left_at: + description: timestamp at which participant left the session. + type: string + preset_name: + description: Name of the preset associated with the participant. + type: string + updated_at: + description: timestamp when this participant's data was last updated. + type: string + readOnly: true + user_id: + description: User id for this participant. + type: string + type: object + realtimekitPatchWebhookRequest: + properties: + enabled: + default: true + type: boolean + events: + description: Events that the webhook will get triggered by + items: + enum: + - meeting.started + - meeting.ended + - meeting.participantJoined + - meeting.participantLeft + - recording.statusUpdate + - livestreaming.statusUpdate + - meeting.chatSynced + - meeting.transcript + - meeting.summary + type: string + type: array + name: + description: Name of the webhook + type: string + url: + description: URL the webhook will send events to + example: https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e + format: uri + type: string + type: object + realtimekitPoll: + properties: + anonymous: + type: boolean + created_by: + type: string + hide_votes: + type: boolean + id: + description: ID of the poll + readOnly: true + type: string + options: + description: Answer options + items: + properties: + count: + type: number + text: + description: Text of the answer option + type: string + votes: + items: + properties: + id: + type: string + name: + type: string + required: + - id + - name + type: object + type: array + required: + - text + - count + - votes + type: object + type: array + question: + description: Question asked by the poll + type: string + voted: + items: + type: string + type: array + required: + - id + - question + - options + type: object + realtimekitPreset: + properties: + config: + properties: + max_screenshare_count: + description: >- + Maximum number of screen shares that can be active at a given + time + type: integer + max_video_streams: + description: Maximum number of streams that are visible on a device + properties: + desktop: + description: Maximum number of video streams visible on desktop devices + type: integer + mobile: + description: Maximum number of streams visible on mobile devices + type: integer + required: + - mobile + - desktop + type: object + media: + description: 'Media configuration options. eg: Video quality' + properties: + audio: + description: Control options for Audio quality. + properties: + enable_high_bitrate: + default: false + description: Enable High Quality Audio for your meetings + type: boolean + enable_stereo: + default: false + description: Enable Stereo for your meetings + type: boolean + type: object + screenshare: + description: Configuration options for participant screen shares + properties: + frame_rate: + description: Frame rate of screen share + type: integer + quality: + description: Quality of screen share + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + video: + description: Configuration options for participant videos + properties: + frame_rate: + description: Frame rate of participants' video + maximum: 30 + type: integer + quality: + description: Video quality of participants + enum: + - hd + - vga + - qvga + type: string + required: + - quality + - frame_rate + type: object + required: + - video + - screenshare + type: object + view_type: + description: Type of the meeting + enum: + - GROUP_CALL + - WEBINAR + - AUDIO_ROOM + type: string + required: + - view_type + - max_video_streams + - max_screenshare_count + - media + type: object + name: + description: Name of the preset + type: string + permissions: + properties: + accept_waiting_requests: + description: Whether this participant can accept waiting requests + type: boolean + can_accept_production_requests: + type: boolean + can_change_participant_permissions: + type: boolean + can_edit_display_name: + type: boolean + can_livestream: + type: boolean + can_record: + type: boolean + can_spotlight: + type: boolean + chat: + description: Chat permissions + properties: + private: + properties: + can_receive: + type: boolean + can_send: + type: boolean + files: + type: boolean + text: + type: boolean + required: + - can_send + - can_receive + - text + - files + type: object + public: + properties: + can_send: + description: Can send messages in general + type: boolean + files: + description: Can send file messages + type: boolean + text: + description: Can send text messages + type: boolean + required: + - can_send + - text + - files + type: object + required: + - public + - private + type: object + connected_meetings: + properties: + can_alter_connected_meetings: + type: boolean + can_switch_connected_meetings: + type: boolean + can_switch_to_parent_meeting: + type: boolean + required: + - can_alter_connected_meetings + - can_switch_connected_meetings + - can_switch_to_parent_meeting + type: object + disable_participant_audio: + type: boolean + disable_participant_screensharing: + type: boolean + disable_participant_video: + type: boolean + hidden_participant: + description: Whether this participant is visible to others or not + type: boolean + is_recorder: + default: false + type: boolean + kick_participant: + type: boolean + media: + description: Media permissions + properties: + audio: + description: Audio permissions + properties: + can_produce: + description: Can produce audio + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + screenshare: + description: Screenshare permissions + properties: + can_produce: + description: Can produce screen share video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + video: + description: Video permissions + properties: + can_produce: + description: Can produce video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + required: + - can_produce + type: object + required: + - video + - audio + - screenshare + type: object + pin_participant: + type: boolean + plugins: + description: Plugin permissions + properties: + can_close: + description: Can close plugins that are already open + type: boolean + can_edit_config: + description: Can edit plugin config + type: boolean + can_start: + description: Can start plugins + type: boolean + config: + type: string + format: uuid + properties: + access_control: + enum: + - FULL_ACCESS + - VIEW_ONLY + type: string + handles_view_only: + type: boolean + required: + - access_control + - handles_view_only + required: + - can_close + - can_start + - can_edit_config + - config + type: object + polls: + description: Poll permissions + properties: + can_create: + description: Can create polls + type: boolean + can_view: + description: Can view polls + type: boolean + can_vote: + description: Can vote on polls + type: boolean + required: + - can_create + - can_vote + - can_view + type: object + recorder_type: + default: NONE + description: Type of the recording peer + enum: + - RECORDER + - LIVESTREAMER + - NONE + type: string + show_participant_list: + type: boolean + waiting_room_type: + description: Waiting room type + enum: + - SKIP + - ON_PRIVILEGED_USER_ENTRY + - SKIP_ON_ACCEPT + type: string + required: + - accept_waiting_requests + - can_accept_production_requests + - can_edit_display_name + - can_spotlight + - recorder_type + - disable_participant_audio + - disable_participant_screensharing + - disable_participant_video + - kick_participant + - pin_participant + - can_record + - can_livestream + - waiting_room_type + - plugins + - connected_meetings + - polls + - media + - chat + - hidden_participant + - show_participant_list + - can_change_participant_permissions + type: object + ui: + properties: + config_diff: + type: object + design_tokens: + properties: + border_radius: + enum: + - rounded + type: string + border_width: + enum: + - thin + type: string + colors: + properties: + background: + properties: + '600': + default: '#222222' + type: string + '700': + default: '#1f1f1f' + type: string + '800': + default: '#1b1b1b' + type: string + '900': + default: '#181818' + type: string + '1000': + default: '#141414' + type: string + required: + - '600' + - '700' + - '800' + - '900' + - '1000' + type: object + brand: + properties: + '300': + default: '#844d1c' + type: string + '400': + default: '#9d5b22' + type: string + '500': + default: '#b56927' + type: string + '600': + default: '#d37c30' + type: string + '700': + default: '#d9904f' + type: string + required: + - '300' + - '400' + - '500' + - '600' + - '700' + type: object + danger: + default: '#FF2D2D' + type: string + success: + default: '#62A504' + type: string + text: + default: '#EEEEEE' + type: string + text_on_brand: + default: '#EEEEEE' + type: string + video_bg: + default: '#191919' + type: string + warning: + default: '#FFCD07' + type: string + required: + - brand + - background + - danger + - text + - text_on_brand + - success + - video_bg + - warning + type: object + logo: + type: string + spacing_base: + default: 4 + type: number + theme: + enum: + - dark + type: string + required: + - border_radius + - border_width + - spacing_base + - theme + - colors + - logo + type: object + required: + - design_tokens + type: object + required: + - name + - config + - ui + title: Preset + type: object + realtimekitPresetListItem: + description: Returned by Get All Presets route + properties: + created_at: + description: Timestamp this preset was created at + format: date-time + type: string + readOnly: true + id: + description: ID of the preset + format: uuid + type: string + name: + description: Name of the preset + type: string + updated_at: + description: Timestamp this preset was last updated + format: date-time + type: string + readOnly: true + title: PresetListItem + type: object + realtimekitRealtimekitBucketConfig: + properties: + enabled: + description: >- + Controls whether recordings are uploaded to RealtimeKit's bucket. If + set to false, `download_url`, `audio_download_url`, + `download_url_expiry` won't be generated for a recording. + type: boolean + required: + - enabled + title: realtimekitBucketConfig + type: object + realtimekitRecording: + properties: + audio_download_url: + description: >- + If the audio_config is passed, the URL for downloading the audio + recording is returned. + format: uri + nullable: true + readOnly: true + type: string + download_url: + description: URL where the recording can be downloaded. + format: uri + nullable: true + readOnly: true + type: string + download_url_expiry: + description: Timestamp when the download URL expires. + format: date-time + nullable: true + readOnly: true + type: string + file_size: + description: File size of the recording, in bytes. + nullable: true + readOnly: true + type: number + id: + description: ID of the recording + format: uuid + readOnly: true + type: string + invoked_time: + description: Timestamp when this recording was invoked. + format: date-time + type: string + output_file_name: + description: File name of the recording. + type: string + recording_duration: + description: Total recording time in seconds. + type: integer + session_id: + description: ID of the meeting session this recording is for. + format: uuid + nullable: true + readOnly: true + type: string + started_time: + description: >- + Timestamp when this recording actually started after being invoked. + Usually a few seconds after `invoked_time`. + format: date-time + nullable: true + type: string + status: + description: Current status of the recording. + enum: + - INVOKED + - RECORDING + - UPLOADING + - UPLOADED + - ERRORED + - PAUSED + type: string + stopped_time: + description: >- + Timestamp when this recording was stopped. Optional; is present only + when the recording has actually been stopped. + format: date-time + nullable: true + type: string + required: + - id + - download_url + - download_url_expiry + - audio_download_url + - file_size + - session_id + - output_file_name + - status + - invoked_time + - started_time + - stopped_time + title: Recording + type: object + realtimekitRecordingConfig: + description: >- + Recording Configurations to be used for this meeting. This level of + configs takes higher preference over App level configs on the + RealtimeKit developer portal. + properties: + audio_config: + $ref: '#/components/schemas/realtimekitAudioConfig' + file_name_prefix: + description: Adds a prefix to the beginning of the file name of the recording. + type: string + live_streaming_config: + $ref: '#/components/schemas/realtimekitLivestreamingConfig' + max_seconds: + description: >- + Specifies the maximum duration for recording in seconds, ranging + from a minimum of 60 seconds to a maximum of 24 hours. + maximum: 86400 + minimum: 60 + type: number + realtimekit_bucket_config: + $ref: '#/components/schemas/realtimekitRealtimekitBucketConfig' + storage_config: + $ref: '#/components/schemas/realtimekitStorageConfig' + video_config: + $ref: '#/components/schemas/realtimekitVideoConfig' + title: RecordingConfig + type: object + realtimekitSessionParticipant: + properties: + created_at: + type: string + readOnly: true + email: + description: Email of the session participant. + type: string + id: + description: ID of the session participant + type: string + name: + description: Name of the session participant. + type: string + picture: + description: A URL pointing to a picture of the participant. + type: string + updated_at: + type: string + readOnly: true + required: + - id + - created_at + - updated_at + title: SessionParticipant + type: object + realtimekitStartReason: + properties: + caller: + properties: + name: + description: Name of the user who started the recording. + example: RealtimeKit_test + type: string + type: + description: >- + The type can be an App or a user. If the type is `user`, then + only the `user_Id` and `name` are returned. + enum: + - ORGANIZATION + - USER + type: string + user_Id: + description: The user ID of the person who started the recording. + example: d61f6956-e68f-4375-bf10-c38a704d1bec + format: uuid + type: string + type: object + reason: + description: >- + Specifies if the recording was started using the "Start a + Recording"API or using the parameter RECORD_ON_START in the "Create + a meeting" API. If the recording is initiated using the + "RECORD_ON_START" parameter, the user details will not be populated. + enum: + - API_CALL + - RECORD_ON_START + type: string + title: startReason + type: object + realtimekitStopReason: + properties: + caller: + properties: + name: + description: Name of the user who stopped the recording. + example: RealtimeKit_test + type: string + type: + description: >- + The type can be an App or a user. If the type is `user`, then + only the `user_Id` and `name` are returned. + enum: + - ORGANIZATION + - USER + type: string + user_Id: + description: The user ID of the person who stopped the recording. + example: d61f6956-e68f-4375-bf10-c38a704d1bec + format: uuid + type: string + type: object + reason: + description: Specifies the reason why the recording stopped. + enum: + - API_CALL + - INTERNAL_ERROR + - ALL_PEERS_LEFT + type: string + title: stopReason + type: object + realtimekitStorageConfig: + nullable: true + properties: + access_key: + description: >- + Access key of the storage medium. Access key is not required for the + `gcs` storage media type. Note that this field is not readable by + clients, only writeable. + type: string + writeOnly: true + auth_method: + description: Authentication method used for "sftp" type storage medium + enum: + - KEY + - PASSWORD + type: string + bucket: + description: Name of the storage medium's bucket. + type: string + host: + description: SSH destination server host for SFTP type storage medium + type: string + password: + description: >- + SSH destination server password for SFTP type storage medium when + auth_method is "PASSWORD". If auth_method is "KEY", this specifies + the password for the ssh private key. + type: string + path: + description: >- + Path relative to the bucket root at which the recording will be + placed. + type: string + port: + description: SSH destination server port for SFTP type storage medium + type: number + private_key: + description: >- + Private key used to login to destination SSH server for SFTP type + storage medium, when auth_method used is "KEY" + type: string + region: + description: Region of the storage medium. + example: us-east-1 + type: string + secret: + description: >- + Secret key of the storage medium. Similar to `access_key`, it is + only writeable by clients, not readable. + type: string + type: + description: Type of storage media. + enum: + - aws + - azure + - digitalocean + - gcs + - sftp + type: string + username: + description: SSH destination server username for SFTP type storage medium + type: string + required: + - type + title: StorageConfig + type: object + realtimekitSummarizationConfig: + description: Summary Config + properties: + summary_type: + default: general + description: >- + Defines the style of the summary, such as general, team meeting, or + sales call. + enum: + - general + - team_meeting + - sales_call + - client_check_in + - interview + - daily_standup + - one_on_one_meeting + - lecture + - code_review + type: string + text_format: + default: markdown + description: >- + Determines the text format of the summary, such as plain text or + markdown. + enum: + - plain_text + - markdown + type: string + word_limit: + default: 500 + description: Sets the maximum number of words in the meeting summary. + maximum: 1000 + minimum: 150 + type: integer + title: SummarizationConfig + type: object + realtimekitTranscript: + properties: + sessionId: + type: string + transcript_download_url: + description: URL where the transcript can be downloaded + type: string + transcript_download_url_expiry: + description: Time when the download URL will expire + type: string + required: + - sessionId + - transcript_download_url + - transcript_download_url_expiry + type: object + realtimekitTranscriptSummary: + properties: + sessionId: + type: string + summaryDownloadUrl: + description: URL where the summary of transcripts can be downloaded + type: string + summaryDownloadUrlExpiry: + description: Time of Expiry before when you need to download the csv file. + type: string + required: + - sessionId + - summaryDownloadUrl + - summaryDownloadUrlExpiry + title: TranscriptSummary + type: object + realtimekitTranscriptionConfig: + description: Transcription Configurations + properties: + keywords: + description: >- + Adds specific terms to improve accurate detection during + transcription. + items: + type: string + type: array + language: + default: en-US + description: >- + Specifies the language code for transcription to ensure accurate + results. + enum: + - en-US + - en-IN + - de + - hi + - sv + - ru + - pl + - el + - fr + - nl + type: string + profanity_filter: + default: false + description: Control the inclusion of offensive language in transcriptions. + type: boolean + title: TranscriptionConfig + type: object + realtimekitUpdatePreset: + properties: + config: + properties: + max_screenshare_count: + description: >- + Maximum number of screen shares that can be active at a given + time + type: integer + max_video_streams: + description: Maximum number of streams that are visible on a device + properties: + desktop: + description: Maximum number of video streams visible on desktop devices + type: integer + mobile: + description: Maximum number of streams visible on mobile devices + type: integer + type: object + media: + description: 'Media configuration options. eg: Video quality' + properties: + screenshare: + description: Configuration options for participant screen shares + properties: + frame_rate: + description: Frame rate of screen share + type: integer + quality: + description: Quality of screen share + enum: + - hd + - vga + - qvga + type: string + type: object + video: + description: Configuration options for participant videos + properties: + frame_rate: + description: Frame rate of participants' video + maximum: 30 + type: integer + quality: + description: Video quality of participants + enum: + - hd + - vga + - qvga + type: string + type: object + type: object + view_type: + description: Type of the meeting + enum: + - GROUP_CALL + - WEBINAR + - AUDIO_ROOM + type: string + type: object + name: + description: Name of the preset + type: string + permissions: + properties: + accept_waiting_requests: + description: Whether this participant can accept waiting requests + type: boolean + can_accept_production_requests: + type: boolean + can_change_participant_permissions: + type: boolean + can_edit_display_name: + type: boolean + can_livestream: + type: boolean + can_record: + type: boolean + can_spotlight: + type: boolean + chat: + description: Chat permissions + properties: + private: + properties: + can_receive: + type: boolean + can_send: + type: boolean + files: + type: boolean + text: + type: boolean + type: object + public: + properties: + can_send: + description: Can send messages in general + type: boolean + files: + description: Can send file messages + type: boolean + text: + description: Can send text messages + type: boolean + type: object + type: object + connected_meetings: + properties: + can_alter_connected_meetings: + type: boolean + can_switch_connected_meetings: + type: boolean + can_switch_to_parent_meeting: + type: boolean + type: object + disable_participant_audio: + type: boolean + disable_participant_screensharing: + type: boolean + disable_participant_video: + type: boolean + hidden_participant: + description: Whether this participant is visible to others or not + type: boolean + is_recorder: + default: false + type: boolean + kick_participant: + type: boolean + media: + description: Media permissions + properties: + audio: + description: Audio permissions + properties: + can_produce: + description: Can produce audio + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + type: object + screenshare: + description: Screenshare permissions + properties: + can_produce: + description: Can produce screen share video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + type: object + video: + description: Video permissions + properties: + can_produce: + description: Can produce video + enum: + - ALLOWED + - NOT_ALLOWED + - CAN_REQUEST + type: string + type: object + type: object + pin_participant: + type: boolean + plugins: + description: Plugin permissions + properties: + can_close: + description: Can close plugins that are already open + type: boolean + can_edit_config: + description: Can edit plugin config + type: boolean + can_start: + description: Can start plugins + type: boolean + config: + type: string + format: uuid + properties: + access_control: + enum: + - FULL_ACCESS + - VIEW_ONLY + type: string + handles_view_only: + type: boolean + type: object + polls: + description: Poll permissions + properties: + can_create: + description: Can create polls + type: boolean + can_view: + description: Can view polls + type: boolean + can_vote: + description: Can vote on polls + type: boolean + type: object + recorder_type: + default: NONE + description: Type of the recording peer + enum: + - RECORDER + - LIVESTREAMER + - NONE + type: string + show_participant_list: + type: boolean + waiting_room_type: + description: Waiting room type + enum: + - SKIP + - ON_PRIVILEGED_USER_ENTRY + - SKIP_ON_ACCEPT + type: string + type: object + ui: + properties: + config_diff: + type: object + design_tokens: + properties: + border_radius: + enum: + - rounded + type: string + border_width: + enum: + - thin + type: string + colors: + properties: + background: + properties: + '600': + default: '#222222' + type: string + '700': + default: '#1f1f1f' + type: string + '800': + default: '#1b1b1b' + type: string + '900': + default: '#181818' + type: string + '1000': + default: '#141414' + type: string + type: object + brand: + properties: + '300': + default: '#844d1c' + type: string + '400': + default: '#9d5b22' + type: string + '500': + default: '#b56927' + type: string + '600': + default: '#d37c30' + type: string + '700': + default: '#d9904f' + type: string + type: object + danger: + default: '#FF2D2D' + type: string + success: + default: '#62A504' + type: string + text: + default: '#EEEEEE' + type: string + text_on_brand: + default: '#EEEEEE' + type: string + video_bg: + default: '#191919' + type: string + warning: + default: '#FFCD07' + type: string + type: object + logo: + type: string + spacing_base: + default: 4 + type: number + theme: + enum: + - dark + type: string + type: object + type: object + title: UpdatePreset + type: object + realtimekitVideoConfig: + properties: + codec: + default: H264 + description: Codec using which the recording will be encoded. + enum: + - H264 + - VP8 + type: string + export_file: + default: true + description: Controls whether to export video file seperately + type: boolean + height: + default: 720 + description: Height of the recording video in pixels + example: 720 + maximum: 1920 + minimum: 1 + type: integer + watermark: + description: Watermark to be added to the recording + properties: + position: + default: left top + description: Position of the watermark + enum: + - left top + - right top + - left bottom + - right bottom + type: string + size: + description: Size of the watermark + properties: + height: + description: Height of the watermark in px + minimum: 1 + type: integer + width: + description: Width of the watermark in px + minimum: 1 + type: integer + type: object + url: + description: URL of the watermark image + format: uri + type: string + type: object + width: + default: 1280 + description: Width of the recording video in pixels + example: 1280 + maximum: 1920 + minimum: 1 + type: integer + title: VideoConfig + type: object + realtimekitWebhook: + properties: + created_at: + description: Timestamp when this webhook was created + example: '2022-05-28T07:01:53.075Z' + format: date-time + type: string + readOnly: true + enabled: + description: Set to true if the webhook is active + type: boolean + events: + description: Events this webhook will send updates for + example: + - meeting.started + - meeting.ended + - meeting.participantJoined + - meeting.participantLeft + - meeting.chatSynced + - recording.statusUpdate + - livestreaming.statusUpdate + - meeting.transcript + - meeting.summary + items: + enum: + - meeting.started + - meeting.ended + - meeting.participantJoined + - meeting.participantLeft + - meeting.chatSynced + - recording.statusUpdate + - livestreaming.statusUpdate + - meeting.transcript + - meeting.summary + type: string + type: array + id: + description: ID of the webhook + example: 0d1f069d-43bb-489a-ad8c-7eb95592ba8e + format: uuid + readOnly: true + type: string + name: + description: Name of the webhook + example: All events webhook + type: string + updated_at: + description: Timestamp when this webhook was updated + example: '2022-05-28T07:01:53.075Z' + format: date-time + type: string + readOnly: true + url: + description: URL the webhook will send events to + example: https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e + format: uri + type: string + required: + - id + - name + - url + - events + - created_at + - updated_at + - enabled + type: object + realtimekitWebhookRequest: + properties: + enabled: + default: true + description: Set whether or not the webhook should be active when created + type: boolean + events: + description: Events that this webhook will get triggered by + example: + - meeting.started + - meeting.ended + - meeting.participantJoined + - meeting.participantLeft + - meeting.chatSynced + - recording.statusUpdate + - livestreaming.statusUpdate + - meeting.transcript + - meeting.summary + items: + enum: + - meeting.started + - meeting.ended + - meeting.participantJoined + - meeting.participantLeft + - meeting.chatSynced + - recording.statusUpdate + - livestreaming.statusUpdate + - meeting.transcript + - meeting.summary + type: string + type: array + name: + description: Name of the webhook + example: All events webhook + type: string + url: + description: URL this webhook will send events to + example: https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e + format: uri + type: string + required: + - name + - url + - events + type: object + realtimekitWebhookSuccessResponse: + properties: + data: + $ref: '#/components/schemas/realtimekitWebhook' + success: + example: true + type: boolean + required: + - success + - data + type: object + realtimekitWebhooksListSuccessResponse: + properties: + data: + items: + $ref: '#/components/schemas/realtimekitWebhook' + type: array + success: + example: true + type: boolean + required: + - success + - data + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + relays: + id: cloudflare.realtime_kit.relays + name: relays + title: Relays + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1moq~1relays/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_accounts_account_id_moq_relays: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1moq~1relays/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_accounts_account_id_moq_relays_relay_id: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1moq~1relays~1{relay_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1moq~1relays~1{relay_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + put_accounts_account_id_moq_relays_relay_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1moq~1relays~1{relay_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + rotate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1moq~1relays~1{relay_id}~1tokens~1rotate/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/relays/methods/get' + - $ref: '#/components/x-stackQL-resources/relays/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/relays/methods/post_accounts_account_id_moq_relays + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/relays/methods/delete_accounts_account_id_moq_relays_relay_id + replace: + - $ref: >- + #/components/x-stackQL-resources/relays/methods/put_accounts_account_id_moq_relays_relay_id + apps: + id: cloudflare.realtime_kit.apps + name: apps + title: Apps + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1realtime~1kit~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + post: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1realtime~1kit~1apps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/post' + update: [] + delete: [] + replace: [] + analytics: + id: cloudflare.realtime_kit.analytics + name: analytics + title: Analytics + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1analytics~1daywise/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/analytics/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + livestreams_overall: + id: cloudflare.realtime_kit.livestreams_overall + name: livestreams_overall + title: Livestreams Overall + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1analytics~1livestreams~1overall/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/livestreams_overall/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + kit_livestreams: + id: cloudflare.realtime_kit.kit_livestreams + name: kit_livestreams + title: Kit Livestreams + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1livestreams/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1livestreams~1{livestream_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/kit_livestreams/methods/get_by_account + - $ref: '#/components/x-stackQL-resources/kit_livestreams/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + livestreams: + id: cloudflare.realtime_kit.livestreams + name: livestreams + title: Livestreams + methods: + create_independent_livestream: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1livestreams/post + response: + mediaType: application/json + openAPIDocKey: '201' + stop_livestreaming_a_meeting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-livestream~1stop/post + response: + mediaType: application/json + openAPIDocKey: '200' + start_livestreaming_a_meeting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1livestreams/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/livestreams/methods/start_livestreaming_a_meeting + - $ref: >- + #/components/x-stackQL-resources/livestreams/methods/create_independent_livestream + update: [] + delete: [] + replace: [] + livestreams_sessions: + id: cloudflare.realtime_kit.livestreams_sessions + name: livestreams_sessions + title: Livestreams Sessions + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1livestreams~1sessions~1{livestream_session_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/livestreams_sessions/methods/get_by_account + insert: [] + update: [] + delete: [] + replace: [] + livestreams_active_livestream_session: + id: cloudflare.realtime_kit.livestreams_active_livestream_session + name: livestreams_active_livestream_session + title: Livestreams Active Livestream Session + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1livestreams~1{livestream_id}~1active-livestream-session/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/livestreams_active_livestream_session/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + kit_meetings: + id: cloudflare.realtime_kit.kit_meetings + name: kit_meetings + title: Kit Meetings + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/kit_meetings/methods/get_by_account + - $ref: >- + #/components/x-stackQL-resources/kit_meetings/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + meetings: + id: cloudflare.realtime_kit.meetings + name: meetings + title: Meetings + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings/post + response: + mediaType: application/json + openAPIDocKey: '201' + update_meeting_by_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + replace_meeting_by_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + add_participant: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1participants/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete_meeting_participant: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1participants~1{participant_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + edit_participant: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1participants~1{participant_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + refresh_participant_token: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1participants~1{participant_id}~1token/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/meetings/methods/refresh_participant_token + - $ref: '#/components/x-stackQL-resources/meetings/methods/add_participant' + - $ref: '#/components/x-stackQL-resources/meetings/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/meetings/methods/edit_participant' + - $ref: >- + #/components/x-stackQL-resources/meetings/methods/update_meeting_by_id + delete: + - $ref: >- + #/components/x-stackQL-resources/meetings/methods/delete_meeting_participant + replace: + - $ref: >- + #/components/x-stackQL-resources/meetings/methods/replace_meeting_by_id + livestreams_active_livestream: + id: cloudflare.realtime_kit.livestreams_active_livestream + name: livestreams_active_livestream + title: Livestreams Active Livestream + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-livestream/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/livestreams_active_livestream/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + active_session: + id: cloudflare.realtime_kit.active_session + name: active_session + title: Active Session + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-session/get + response: + mediaType: application/json + openAPIDocKey: '200' + kick: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-session~1kick/post + response: + mediaType: application/json + openAPIDocKey: '200' + kick_all: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-session~1kick-all/post + response: + mediaType: application/json + openAPIDocKey: '200' + mute: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-session~1mute/post + response: + mediaType: application/json + openAPIDocKey: '200' + mute_all: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-session~1mute-all/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_poll: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1active-session~1poll/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/active_session/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + livestream: + id: cloudflare.realtime_kit.livestream + name: livestream + title: Livestream + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1livestream/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/livestream/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + meetings_participants: + id: cloudflare.realtime_kit.meetings_participants + name: meetings_participants + title: Meetings Participants + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1participants/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1meetings~1{meeting_id}~1participants~1{participant_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/meetings_participants/methods/get_by_account + - $ref: >- + #/components/x-stackQL-resources/meetings_participants/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + presets: + id: cloudflare.realtime_kit.presets + name: presets + title: Presets + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1presets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1presets/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1presets~1{preset_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1presets~1{preset_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1presets~1{preset_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/presets/methods/get' + - $ref: '#/components/x-stackQL-resources/presets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/presets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/presets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/presets/methods/delete' + replace: [] + recordings: + id: cloudflare.realtime_kit.recordings + name: recordings + title: Recordings + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1recordings/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_track: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1recordings~1track/post + response: + mediaType: application/json + openAPIDocKey: '200' + pause_resume_stop_recording: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1recordings~1{recording_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recordings/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/recordings/methods/pause_resume_stop_recording + kit_recordings: + id: cloudflare.realtime_kit.kit_recordings + name: kit_recordings + title: Kit Recordings + methods: + start_recordings: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1recordings/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1recordings~1{recording_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/kit_recordings/methods/get_by_account + insert: + - $ref: >- + #/components/x-stackQL-resources/kit_recordings/methods/start_recordings + update: [] + delete: [] + replace: [] + recordings_active_recording: + id: cloudflare.realtime_kit.recordings_active_recording + name: recordings_active_recording + title: Recordings Active Recording + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1recordings~1active-recording~1{meeting_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/recordings_active_recording/methods/get_by_account + insert: [] + update: [] + delete: [] + replace: [] + sessions: + id: cloudflare.realtime_kit.sessions + name: sessions + title: Sessions + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + generate_summary_of_transcripts: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}~1summary/post + response: + mediaType: application/json + openAPIDocKey: 2XX + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sessions/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/generate_summary_of_transcripts + update: [] + delete: [] + replace: [] + sessions_peer_report: + id: cloudflare.realtime_kit.sessions_peer_report + name: sessions_peer_report + title: Sessions Peer Report + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1peer-report~1{peer_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sessions_peer_report/methods/get_by_account + insert: [] + update: [] + delete: [] + replace: [] + kit_sessions: + id: cloudflare.realtime_kit.kit_sessions + name: kit_sessions + title: Kit Sessions + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/kit_sessions/methods/get_by_account + insert: [] + update: [] + delete: [] + replace: [] + sessions_chat: + id: cloudflare.realtime_kit.sessions_chat + name: sessions_chat + title: Sessions Chat + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}~1chat/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sessions_chat/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + livestream_sessions: + id: cloudflare.realtime_kit.livestream_sessions + name: livestream_sessions + title: Livestream Sessions + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}~1livestream-sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/livestream_sessions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + sessions_participants: + id: cloudflare.realtime_kit.sessions_participants + name: sessions_participants + title: Sessions Participants + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}~1participants/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}~1participants~1{participant_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sessions_participants/methods/get_by_account + - $ref: >- + #/components/x-stackQL-resources/sessions_participants/methods/list + insert: [] + update: [] + delete: [] + replace: [] + sessions_summary: + id: cloudflare.realtime_kit.sessions_summary + name: sessions_summary + title: Sessions Summary + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}~1summary/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sessions_summary/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + sessions_transcript: + id: cloudflare.realtime_kit.sessions_transcript + name: sessions_transcript + title: Sessions Transcript + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1sessions~1{session_id}~1transcript/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sessions_transcript/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + webhooks: + id: cloudflare.realtime_kit.webhooks + name: webhooks + title: Webhooks + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1webhooks/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data + create_webhook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1webhooks/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete_webhook: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1webhooks~1{webhook_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1webhooks~1{webhook_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit_webhook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1webhooks~1{webhook_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + replace_webhook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1realtime~1kit~1{app_id}~1webhooks~1{webhook_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/get' + - $ref: '#/components/x-stackQL-resources/webhooks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/create_webhook' + update: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/edit_webhook' + delete: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/delete_webhook' + replace: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/replace_webhook' diff --git a/providers/src/cloudflare/v00.00.00000/services/registrar.yaml b/providers/src/cloudflare/v00.00.00000/services/registrar.yaml new file mode 100644 index 00000000..4c409983 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/registrar.yaml @@ -0,0 +1,2152 @@ +openapi: 3.0.3 +info: + title: registrar API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/registrar/domain-check: + post: + description: >- + Performs real-time, authoritative availability checks directly against + domain registries. Use this endpoint to verify a domain is available + before attempting registration via `POST /registrations`. **Important:** + Unlike the Search endpoint, these results are authoritative and reflect + current registry status. Always check availability immediately before + registration as domain status can change rapidly. **Note:** This + endpoint uses POST to accept a list of domains in the request body. It + is a read-only operation — it does not create, modify, or reserve any + domains. **Extension support:** Only domains on extensions supported for + programmatic registration by this API can be registered. If you check a + domain on an unsupported extension, the response will include + `registrable: false` with a `reason` field explaining why: - + `extension_not_supported_via_api` — Cloudflare Registrar supports this + extension in the dashboard, but it is not yet available for programmatic + registration via this API. Register via + `https://dash.cloudflare.com/{account_id}/domains/registrations` + instead. - `extension_not_supported` — This extension is not supported + by Cloudflare Registrar. - `extension_disallows_registration` — The + extension's registry has temporarily or permanently frozen new + registrations. No registrar can register domains on this extension at + this time. - `domain_premium` — The domain is premium priced. Premium + registration is not currently supported by this API. - + `domain_unavailable` — The domain is already registered, reserved, or + otherwise not available for registration on a supported extension. The + `reason` field is only present when `registrable` is `false`. + **Behavior:** - Maximum 20 domains per request - Pricing is only + returned for domains where `registrable: true` - Results are not cached; + each request queries the registry **Workflow:** 1. Call this endpoint + with domains the user wants to register. 2. For each domain where + `registrable: true`, present pricing to the user. 3. If `tier: premium`, + note that premium registration is not currently supported by this API + and do not proceed to `POST /registrations`. 4. Proceed to `POST + /registrations` only for supported non-premium domains. + operationId: registrar-domain-discovery-check + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiDomainCheckRequest' + description: >- + List of fully qualified domain names (FQDNs) to check. Each domain + must include the extension (e.g., "example.com", not "example"). + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiDomainCheckResponse' + description: >- + Successfully returned availability results. Each requested domain + appears in the `domains` array with its current availability status + and pricing (if available). + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: >- + Invalid request parameters. Common causes: - Empty `domains` array - + Exceeds maximum of 20 domains per request - Malformed request body - + None of the provided domains are valid + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Check domain availability + tags: + - Domain Discovery + x-stackql-sdk: + service: registrar + resource_chain: [] + method: check + /accounts/{account_id}/registrar/domain-search: + get: + description: >- + Searches for domain name suggestions based on a keyword, phrase, or + partial domain name. Returns a list of potentially available domains + with pricing information. **Important:** Results are non-authoritative + and based on cached data. Always use the `/domain-check` endpoint to + verify real-time availability before attempting registration. + Suggestions are scoped to extensions supported for programmatic + registration via this API (`POST /registrations`). Domains on + unsupported extensions will not appear in results, even if they are + available at the registry level. **Use cases:** - Brand name discovery + (e.g., "acme corp" → acmecorp.com, acmecorp.dev) - Keyword-based + suggestions (e.g., "coffee shop" → coffeeshop.com, mycoffeeshop.net) - + Alternative extension discovery (e.g., "example.com" → example.com, + example.app, example.xyz) **Workflow:** 1. Call this endpoint with a + keyword or domain name. 2. Present suggestions to the user. 3. Call + `/domain-check` with the user's chosen domains to confirm real-time + availability and pricing. 4. Proceed to `POST /registrations` only for + supported non-premium domains where the Check response returns + `registrable: true`. **Note:** Searching with just a domain extension + (e.g., "com" or ".app") is not supported. Provide a keyword or domain + name. + operationId: registrar-domain-discovery-search + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + The search term to find domain suggestions. Accepts keywords, + phrases, or full domain names. - Phrases: "coffee shop" returns + coffeeshop.com, mycoffeeshop.net, etc. - Domain names: "example.com" + returns example.com and variations across extensions + in: query + name: q + schema: + maxLength: 100 + minLength: 1 + type: string + - description: >- + Limits results to specific domain extensions from the supported set. + If not specified, returns results across all supported extensions. + Extensions not in the supported set are silently ignored. + explode: false + in: query + name: extensions + schema: + items: + type: string + maxItems: 20 + type: array + style: form + - description: >- + Maximum number of domain suggestions to return. Defaults to 20 if + not specified. + in: query + name: limit + schema: + default: 20 + maximum: 50 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiDomainSearchResponse' + description: Successfully returned domain search results. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: >- + Invalid request parameters. Common causes: - Missing required `q` + parameter - Query exceeds 100 character limit - Invalid extension + format + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search for available domains + tags: + - Domain Discovery + x-stackql-sdk: + service: registrar + resource_chain: [] + method: search + /accounts/{account_id}/registrar/domains: + get: + deprecated: true + description: List domains handled by Registrar. + operationId: registrar-domains-list-domains + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiDomainResponseCollection' + description: List domains response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + items: + $ref: '#/components/schemas/registrarApiDomains' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/registrarApiResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List domains response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List domains + tags: + - Registrar Domains + x-api-token-group: null + x-stainless-deprecation-message: >- + This operation is deprecated and will be removed in a future release. A + replacement Registrar API will be announced separately. + x-stackql-sdk: + service: registrar + resource_chain: + - domains + method: list + /accounts/{account_id}/registrar/domains/{domain_name}: + get: + deprecated: true + description: Show individual domain. + operationId: registrar-domains-get-domain + parameters: + - in: path + name: domain_name + schema: + $ref: '#/components/schemas/registrarApiDomainName' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiDomainResponseSingle' + description: Get domain response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get domain response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get domain + tags: + - Registrar Domains + x-api-token-group: null + x-stainless-deprecation-message: >- + This operation is deprecated and will be removed in a future release. A + replacement Registrar API will be announced separately. + x-stackql-sdk: + service: registrar + resource_chain: + - domains + method: get + put: + deprecated: true + description: Update individual domain. + operationId: registrar-domains-update-domain + parameters: + - in: path + name: domain_name + schema: + $ref: '#/components/schemas/registrarApiDomainName' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiDomainUpdateProperties' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiDomainResponseSingle' + description: Update domain response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update domain response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update domain + tags: + - Registrar Domains + x-api-token-group: null + x-stainless-deprecation-message: >- + This operation is deprecated and will be removed in a future release. A + replacement Registrar API will be announced separately. + x-stackql-sdk: + service: registrar + resource_chain: + - domains + method: update + /accounts/{account_id}/registrar/registrations: + get: + description: >- + Returns a paginated list of domain registrations owned by the account. + This endpoint uses cursor-based pagination. Results are ordered by + registration date by default. To fetch the next page, pass the `cursor` + value from the `result_info` object in the response as the `cursor` + query parameter in your next request. An empty `cursor` string indicates + there are no more pages. + operationId: registrar-domain-registration-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Opaque token from a previous response's `result_info.cursor`. Pass + this value to fetch the next page of results. Omit (or pass an empty + string) for the first page. + in: query + name: cursor + schema: + maxLength: 256 + type: string + - description: Number of items to return per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 1 + type: integer + - description: Sort direction for results. Defaults to ascending order. + in: query + name: direction + schema: + default: asc + enum: + - asc + - desc + type: string + - description: >- + Column to sort results by. Defaults to registration date + (`registry_created_at`) when omitted. + in: query + name: sort_by + schema: + default: registry_created_at + enum: + - registry_created_at + - registry_expires_at + - name + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/registrarApiRegistrationResponseCollection + description: List of registrations for the account. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: List registrations failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Registrations + tags: + - Registrar Registration + x-stackql-sdk: + service: registrar + resource_chain: + - registrations + method: list + post: + description: >- + Starts a domain registration workflow. This is a billable operation — + successful registration charges the account's default payment method. + All successful domain registrations are non-refundable — once the + workflow completes with `state: succeeded`, the charge cannot be + reversed. **Prerequisites:** - The account must have a billing profile + with a valid default payment method. Set this up at + `https://dash.cloudflare.com/{account_id}/billing/payment-info`. - The + account must not already be at the maximum supported domain limit. A + single account may own up to 100 domains in total across registrations + created through either the dashboard or this API. - The domain must be + on a supported extension for programmatic registration. - Use `POST + /domain-check` immediately before calling this endpoint to confirm + real-time availability and pricing. **Supported extensions:** In this + API, "extension" means the full registrable suffix after the domain + label. For example, in `example.co.uk`, the extension is `co.uk`. + Programmatic registration is currently supported for: `com`, `org`, + `net`, `app`, `dev`, `cc`, `xyz`, `info`, `cloud`, `studio`, `live`, + `link`, `pro`, `tech`, `fyi`, `shop`, `online`, `tools`, `run`, `games`, + `build`, `systems`, `world`, `news`, `site`, `network`, `chat`, `space`, + `family`, `page`, `life`, `group`, `email`, `solutions`, `day`, `blog`, + `ing`, `icu`, `academy`, `today` Cloudflare Registrar supports 400+ + extensions in the dashboard. Extensions not listed above can still be + registered at + `https://dash.cloudflare.com/{account_id}/domains/registrations`. + **Express mode:** The only required field is `domain_name`. If + `contacts` is omitted, the system uses the account's default address + book entry as the registrant. If no default exists and no contact is + provided, the request fails. Set up a default address book entry and + accept the required agreement at + `https://dash.cloudflare.com/{account_id}/domains/registrations`. + **Defaults:** - `years`: defaults to the extension's minimum + registration period (1 year for most extensions, but varies — for + example, `.ai` (if supported) requires a minimum of 2 years). - + `auto_renew`: defaults to `false`. Setting it to `true` is an explicit + opt-in authorizing Cloudflare to charge the account's default payment + method up to 30 days before domain expiry to renew the registration. + Renewal pricing may change over time based on registry pricing. - + `privacy_mode`: defaults to `redaction`. **Premium domains:** Premium + domain registration is not currently supported by this API. If `POST + /domain-check` returns `tier: premium`, do not call this endpoint for + that domain. **Response behavior:** By default, the server holds the + connection for a bounded, server-defined amount of time while the + registration completes. Most registrations finish within this window and + return `201 Created` with a completed workflow status. If the + registration is still processing after this synchronous wait window, the + server returns `202 Accepted`. Poll the URL in `links.self` to track + progress. To skip the wait and receive an immediate `202`, send `Prefer: + respond-async`. + operationId: registrar-domain-registration-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Set to `respond-async` to receive an immediate `202 Accepted` + without waiting for the operation to complete (RFC 7240). The header + may be combined with other preferences using standard + comma-separated syntax. + in: header + name: Prefer + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiRegistrationCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiWorkflowStatusResponseSingle' + description: >- + Registration completed successfully within the synchronous wait + window. The workflow status will have `state: succeeded` and + `completed: true`. + headers: + Preference-Applied: + description: Echoed when the server honored a `Prefer` header. + schema: + type: string + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiWorkflowStatusResponseSingle' + description: >- + Registration is still processing. This occurs when the operation did + not complete within the synchronous wait window, or when `Prefer: + respond-async` was sent. Poll the URL in `links.self` to track + progress. + headers: + Location: + description: URL of the workflow status resource (same as `links.self`). + schema: + type: string + Preference-Applied: + description: Set to `respond-async` when the server honored the preference. + schema: + type: string + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: Create registration failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Registration + tags: + - Registrar Registration + x-stackql-sdk: + service: registrar + resource_chain: + - registrations + method: create + /accounts/{account_id}/registrar/registrations/{domain_name}: + get: + description: >- + Returns the current state of a domain registration. This is the + canonical read endpoint for a domain you own. It returns the full + registration resource including current settings and expiration. When + the registration resource is ready, both `created_at` and `expires_at` + are present in the response. + operationId: registrar-domain-registration-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Domain name to retrieve. + in: path + name: domain_name + schema: + $ref: '#/components/schemas/registrarApiDomainName' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiRegistrationResponseSingle' + description: Registration details. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: Get registration failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Registration + tags: + - Registrar Registration + x-stackql-sdk: + service: registrar + resource_chain: + - registrations + method: get + patch: + description: >- + Updates an existing domain registration. By default, the server holds + the connection for a bounded, server-defined amount of time while the + update completes. Most updates finish within this window and return `200 + OK` with a completed workflow status. If the update is still processing + after this synchronous wait window, the server returns `202 Accepted`. + Poll the URL in `links.self` to track progress. To skip the wait and + receive an immediate `202`, send `Prefer: respond-async`. This endpoint + currently supports updating `auto_renew` only. + operationId: registrar-domain-registration-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Domain name to update. + in: path + name: domain_name + schema: + $ref: '#/components/schemas/registrarApiDomainName' + required: true + - description: >- + Set to `respond-async` to receive an immediate `202 Accepted` + without waiting for the operation to complete (RFC 7240). + in: header + name: Prefer + schema: + enum: + - respond-async + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiRegistrationUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiWorkflowStatusResponseSingle' + description: >- + Update completed successfully within the synchronous wait window. + The workflow status will have `state: succeeded` and `completed: + true`. + headers: + Preference-Applied: + description: Echoed when the server honored a `Prefer` header. + schema: + type: string + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiWorkflowStatusResponseSingle' + description: >- + Update is still processing. This occurs when the operation did not + complete within the synchronous wait window, or when `Prefer: + respond-async` was sent. Poll the URL in `links.self` to track + progress. + headers: + Location: + description: URL of the workflow status resource (same as `links.self`). + schema: + type: string + Preference-Applied: + description: Set to `respond-async` when the server honored the preference. + schema: + type: string + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: Update registration failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Registration + tags: + - Registrar Registration + x-stackql-sdk: + service: registrar + resource_chain: + - registrations + method: edit + /accounts/{account_id}/registrar/registrations/{domain_name}/registration-status: + get: + description: >- + Returns the current status of a domain registration workflow. Use this + endpoint to poll for completion when the POST response returned `202 + Accepted`. The URL is provided in the `links.self` field of the workflow + status response. Poll this endpoint until the workflow reaches a + terminal state or a state that requires user attention. **Terminal + states:** `succeeded` and `failed` are terminal and always have + `completed: true`. **Non-terminal states:** - `action_required` has + `completed: false` and will not resolve on its own. The workflow is + paused pending user intervention. - `blocked` has `completed: false` and + indicates the workflow is waiting on a third party such as the extension + registry or losing registrar. Continue polling while informing the user + of the delay. Use increasing backoff between polls. When `state: + blocked`, use a longer polling interval and do not poll indefinitely. A + naive polling loop that only checks `completed` can run indefinitely + when `state: action_required`. Break explicitly on `action_required`: + ```js let status; do { await new Promise(r => setTimeout(r, 2000)); + status = await cloudflare.request({ method: 'GET', path: + reg.result.links.self, }); } while ( !status.result.completed && + status.result.state !== 'action_required' ); if (status.result.state === + 'action_required') { // Surface context.action and + context.confirmation_sent_to to the user. // Do not re-submit the + registration request. } ``` + operationId: registrar-domain-registration-get-status + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain_name + schema: + $ref: '#/components/schemas/registrarApiDomainName' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiWorkflowStatusResponseSingle' + description: Registration workflow status. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: Get status failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Registration Status + tags: + - Registrar Registration + x-stackql-sdk: + service: registrar + resource_chain: + - registration_status + method: get + /accounts/{account_id}/registrar/registrations/{domain_name}/update-status: + get: + description: >- + Returns the current status of a domain update workflow. Use this + endpoint to poll for completion when the PATCH response returned `202 + Accepted`. The URL is provided in the `links.self` field of the workflow + status response. Poll this endpoint until the workflow reaches a + terminal state or a state that requires user attention. Use increasing + backoff between polls. When the workflow remains blocked on a third + party, use a longer polling interval and do not poll indefinitely. + operationId: registrar-domain-registration-get-update-status + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain_name + schema: + $ref: '#/components/schemas/registrarApiDomainName' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiWorkflowStatusResponseSingle' + description: Update workflow status. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/registrarApiApiResponseCommonFailure' + description: Get update status failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Update Status + tags: + - Registrar Registration + x-stackql-sdk: + service: registrar + resource_chain: + - update_status + method: get +components: + schemas: + registrarApiAddress: + description: Address. + example: 123 Sesame St. + type: string + registrarApiAddress2: + description: Optional address line for unit, floor, suite, etc. + example: Suite 430 + type: string + registrarApiApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minItems: 1 + $ref: '#/components/schemas/registrarApiMessages' + messages: + example: [] + $ref: '#/components/schemas/registrarApiMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + registrarApiAutoRenew: + description: >- + Auto-renew controls whether subscription is automatically renewed upon + domain expiration. + example: true + type: boolean + x-auditable: true + registrarApiAvailable: + description: >- + Shows if a domain is available for transferring into Cloudflare + Registrar. + example: false + type: boolean + registrarApiCanRegister: + description: Indicates if the domain can be registered as a new domain. + example: false + type: boolean + registrarApiCity: + description: City. + example: Austin + type: string + registrarApiContactIdentifier: + description: Contact Identifier. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + readOnly: true + type: string + registrarApiContactProperties: + properties: + address: + $ref: '#/components/schemas/registrarApiAddress' + address2: + $ref: '#/components/schemas/registrarApiAddress2' + city: + $ref: '#/components/schemas/registrarApiCity' + country: + $ref: '#/components/schemas/registrarApiCountry' + email: + $ref: '#/components/schemas/registrarApiEmail' + fax: + $ref: '#/components/schemas/registrarApiFax' + first_name: + $ref: '#/components/schemas/registrarApiFirstName' + id: + $ref: '#/components/schemas/registrarApiContactIdentifier' + last_name: + $ref: '#/components/schemas/registrarApiLastName' + organization: + $ref: '#/components/schemas/registrarApiOrganization' + phone: + $ref: '#/components/schemas/registrarApiTelephone' + state: + $ref: '#/components/schemas/registrarApiState' + zip: + $ref: '#/components/schemas/registrarApiZipcode' + required: + - first_name + - last_name + - address + - city + - state + - zip + - country + - phone + - organization + type: object + registrarApiContacts: + type: object + $ref: '#/components/schemas/registrarApiContactProperties' + registrarApiCountry: + description: The country in which the user lives. + example: US + maxLength: 30 + nullable: true + type: string + registrarApiCreatedAt: + description: Shows time of creation. + example: '2018-08-28T17:26:26Z' + format: date-time + type: string + registrarApiCurrentRegistrar: + description: Shows name of current registrar. + example: Cloudflare + type: string + registrarApiCursorResultInfo: + description: >- + Cursor-based pagination metadata. Used by list endpoints that support + cursor pagination. Pass the `cursor` value as a query parameter in the + next request to fetch the next page. An empty string indicates there are + no more pages. + properties: + count: + description: Number of items in the current result set. + example: 20 + type: integer + cursor: + description: >- + Opaque cursor for fetching the next page. Pass this value as the + `cursor` query parameter in a subsequent request. An empty string + indicates there are no more pages. + example: eyJ0IjoiMjAyNS0wNi0xNVQxMjowMDowMC4wMDAwMDBaIiwibiI6ImJyYXZvLm5ldCJ9 + type: string + per_page: + description: Maximum number of items per page. + example: 20 + type: integer + required: + - cursor + - per_page + - count + type: object + registrarApiDomainCheckRequest: + description: Request body for checking domain availability. + properties: + domains: + description: >- + List of fully qualified domain names (FQDNs) to check for + availability. Each domain must include the extension. - Minimum: 1 + domain - Maximum: 20 domains per request - Domains on unsupported + extensions are returned with `registrable: false` and a `reason` + field - Malformed domain names (e.g., missing extension) may be + omitted from the response + example: + - example.com + - example.net + items: + type: string + maxItems: 20 + minItems: 1 + type: array + required: + - domains + type: object + registrarApiDomainCheckResponse: + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + description: Contains the availability check results. + properties: + domains: + description: >- + Array of domain availability results. Domains on unsupported + extensions are included with `registrable: false` and a `reason` + field. Malformed domain names may be omitted. + items: + $ref: '#/components/schemas/registrarApiDomainCheckResult' + type: array + required: + - domains + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + type: object + registrarApiDomainCheckResult: + description: >- + Represents a single authoritative domain availability result returned by + the Check endpoint. Check results reflect current registry status and + should be used immediately before registration. + properties: + name: + description: >- + The fully qualified domain name (FQDN) in punycode format for + internationalized domain names (IDNs). + example: example.com + type: string + pricing: + $ref: '#/components/schemas/registrarApiPricing' + reason: + description: >- + Present only when `registrable` is `false`. Explains why the domain + cannot be registered via this API. - + `extension_not_supported_via_api`: Cloudflare Registrar supports + this extension in the dashboard but it is not yet available for + programmatic registration via this API. The user can register via + `https://dash.cloudflare.com/{account_id}/domains/registrations`. - + `extension_not_supported`: This extension is not supported by + Cloudflare Registrar at all. - `extension_disallows_registration`: + The extension's registry has temporarily or permanently frozen new + registrations. No registrar can register domains on this extension + at this time. - `domain_premium`: The domain is premium priced. + Premium registration is not currently supported by this API. - + `domain_unavailable`: The domain is already registered, reserved, or + otherwise not available on a supported extension. + enum: + - extension_not_supported_via_api + - extension_not_supported + - extension_disallows_registration + - domain_premium + - domain_unavailable + example: domain_unavailable + type: string + registrable: + description: >- + Indicates whether this domain can be registered programmatically + through this API based on a real-time registry check. - `true`: + Domain is available for registration. The `pricing` object will be + included. - `false`: Domain is not available. See the `reason` field + for why. `tier` may still be present on some non-registrable + results, such as premium domains. + example: true + type: boolean + tier: + description: >- + The pricing tier for this domain. Always present when `registrable` + is `true`; defaults to `standard` for most domains. May be absent + when `registrable` is `false`. - `standard`: Standard registry + pricing - `premium`: Premium domain with higher pricing set by the + registry + enum: + - standard + - premium + example: standard + type: string + required: + - name + - registrable + type: object + registrarApiDomainIdentifier: + description: Domain identifier. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + readOnly: true + type: string + registrarApiDomainName: + description: >- + Fully qualified domain name (FQDN) including the extension (e.g., + `example.com`, `mybrand.app`). The domain name uniquely identifies a + registration — the same domain cannot be registered twice, making it a + natural idempotency key for registration requests. + example: example.com + type: string + x-auditable: true + registrarApiDomainProperties: + properties: + available: + $ref: '#/components/schemas/registrarApiAvailable' + can_register: + $ref: '#/components/schemas/registrarApiCanRegister' + created_at: + $ref: '#/components/schemas/registrarApiCreatedAt' + readOnly: true + current_registrar: + $ref: '#/components/schemas/registrarApiCurrentRegistrar' + expires_at: + $ref: '#/components/schemas/registrarApiExpiresAt' + id: + $ref: '#/components/schemas/registrarApiDomainIdentifier' + locked: + $ref: '#/components/schemas/registrarApiLocked' + registrant_contact: + $ref: '#/components/schemas/registrarApiRegistrantContact' + registry_statuses: + $ref: '#/components/schemas/registrarApiRegistryStatuses' + supported_tld: + $ref: '#/components/schemas/registrarApiSupportedTld' + transfer_in: + $ref: '#/components/schemas/registrarApiTransferIn' + updated_at: + $ref: '#/components/schemas/registrarApiUpdatedAt' + readOnly: true + type: object + registrarApiDomainResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + items: + $ref: '#/components/schemas/registrarApiDomains' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/registrarApiResultInfo' + required: + - success + - errors + - messages + - result + registrarApiDomainResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + registrarApiDomainSearchResponse: + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + description: Contains the search results. + properties: + domains: + description: >- + Array of domain suggestions sorted by relevance. May be empty if + no domains match the search criteria. + items: + $ref: '#/components/schemas/registrarApiDomainSearchResult' + type: array + required: + - domains + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + - result + type: object + registrarApiDomainSearchResult: + description: >- + Represents a single domain suggestion returned by the Search endpoint. + Search results are non-authoritative and may be based on cached data. + Use POST /domain-check to confirm real-time availability and pricing + before registration. + properties: + name: + description: >- + The fully qualified domain name (FQDN) in punycode format for + internationalized domain names (IDNs). + example: example.com + type: string + pricing: + $ref: '#/components/schemas/registrarApiPricing' + reason: + description: >- + Present only when `registrable` is `false` on search results. + Explains why the domain does not appear registrable through this + API. These values are advisory; use POST /domain-check for + authoritative status. - `extension_not_supported_via_api`: + Cloudflare Registrar supports this extension in the dashboard but it + is not yet available for programmatic registration via this API. - + `extension_not_supported`: This extension is not supported by + Cloudflare Registrar at all. - `extension_disallows_registration`: + The extension's registry has temporarily or permanently frozen new + registrations. - `domain_premium`: The domain is premium priced. + Premium registration is not currently supported by this API. - + `domain_unavailable`: The domain appears unavailable. + enum: + - extension_not_supported_via_api + - extension_not_supported + - extension_disallows_registration + - domain_premium + - domain_unavailable + example: domain_unavailable + type: string + registrable: + description: >- + Indicates whether this domain appears available based on search + data. Search results are non-authoritative and may be stale. - + `true`: The domain appears available. Use POST /domain-check to + confirm before registration. - `false`: The domain does not appear + available in search results. + example: true + type: boolean + tier: + description: >- + The pricing tier for this domain. Always present when `registrable` + is `true`; defaults to `standard` for most domains. May be absent + when `registrable` is `false`. - `standard`: Standard registry + pricing - `premium`: Premium domain with higher pricing set by the + registry + enum: + - standard + - premium + example: standard + type: string + required: + - name + - registrable + type: object + registrarApiDomainUpdateProperties: + properties: + auto_renew: + $ref: '#/components/schemas/registrarApiAutoRenew' + locked: + $ref: '#/components/schemas/registrarApiLocked' + privacy: + $ref: '#/components/schemas/registrarApiPrivacy' + type: object + registrarApiDomains: + type: object + $ref: '#/components/schemas/registrarApiDomainProperties' + registrarApiEmail: + description: The contact email address of the user. + example: user@example.com + maxLength: 90 + type: string + registrarApiExpiresAt: + description: Shows when domain name registration expires. + example: '2019-08-28T23:59:59Z' + format: date-time + type: string + registrarApiFax: + description: Contact fax number. + example: 123-867-5309 + type: string + registrarApiFirstName: + description: User's first name + example: John + maxLength: 60 + nullable: true + type: string + registrarApiLastName: + description: User's last name + example: Appleseed + maxLength: 60 + nullable: true + type: string + registrarApiLocked: + description: Shows whether a registrar lock is in place for a domain. + example: false + type: boolean + x-auditable: true + registrarApiMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + registrarApiOrganization: + description: Name of organization. + example: Cloudflare, Inc. + type: string + registrarApiPricing: + description: >- + Annual pricing information for a registrable domain. This object is only + present when `registrable` is `true`. All prices are per year and + returned as strings to preserve decimal precision. `registration_cost` + and `renewal_cost` are frequently the same value, but may differ — + especially for premium domains where registries set different rates for + initial registration vs. renewal. For a multi-year registration (e.g., 4 + years), the first year is charged at `registration_cost` and each + subsequent year at `renewal_cost`. Registry pricing may change over + time; the values returned here reflect the current registry rate. + Premium pricing may be surfaced by Search and Check, but premium + registration is not currently supported by this API. + properties: + currency: + description: ISO-4217 currency code for the prices (e.g., "USD", "EUR", "GBP"). + example: USD + type: string + registration_cost: + description: >- + The first-year cost to register this domain. For premium domains + (`tier: premium`), this price is set by the registry and may be + significantly higher than standard pricing. For multi-year + registrations, this cost applies to the first year only; subsequent + years are charged at `renewal_cost`. + example: '8.57' + type: string + renewal_cost: + description: >- + Per-year renewal cost for this domain. Applied to each year beyond + the first year of a multi-year registration, and to each annual + auto-renewal thereafter. May differ from `registration_cost`, + especially for premium domains where initial registration often + costs more than renewals. + example: '8.57' + type: string + required: + - currency + - registration_cost + - renewal_cost + type: object + registrarApiPrivacy: + description: Privacy option controls redacting WHOIS information. + example: true + type: boolean + x-auditable: true + registrarApiRegistrantContact: + description: Shows contact information for domain registrant. + $ref: '#/components/schemas/registrarApiContacts' + registrarApiRegistration: + description: >- + A domain registration resource representing the current state of a + registered domain. + properties: + auto_renew: + description: Whether the domain will be automatically renewed before expiration. + example: true + type: boolean + created_at: + description: >- + When the domain was registered. Present when the registration + resource exists. + example: '2025-01-15T10:00:00Z' + format: date-time + type: string + readOnly: true + domain_name: + $ref: '#/components/schemas/registrarApiDomainName' + expires_at: + description: >- + When the domain registration expires. Present when the registration + is ready; may be null only while `status` is `registration_pending`. + example: '2026-01-15T10:00:00Z' + format: date-time + nullable: true + type: string + locked: + description: Whether the domain is locked for transfer. + example: true + type: boolean + privacy_mode: + description: Current WHOIS privacy mode for the registration. + enum: + - false + - redaction + example: redaction + type: string + status: + description: >- + Current registration status. - `active`: Domain is registered and + operational - `registration_pending`: Registration is in progress - + `expired`: Domain has expired - `suspended`: Domain is suspended by + the registry - `redemption_period`: Domain is in the redemption + grace period - `pending_delete`: Domain is pending deletion by the + registry + enum: + - active + - registration_pending + - expired + - suspended + - redemption_period + - pending_delete + example: active + type: string + required: + - domain_name + - status + - created_at + - expires_at + - auto_renew + - privacy_mode + - locked + type: object + registrarApiRegistrationContact: + description: >- + Registrant contact data for the domain registration. This information is + submitted to the domain registry and, depending on extension and privacy + settings, may appear in public WHOIS records. + properties: + email: + description: >- + Email address for the registrant. Used for domain-related + communications from the registry, including ownership verification + and renewal notices. + example: ada@example.com + format: email + type: string + fax: + description: >- + Fax number in E.164 format (e.g., `+1.5555555555`). Optional. Most + registrations do not require a fax number. + example: '+1.5555555555' + type: string + phone: + description: >- + Phone number in E.164 format: `+{country_code}.{number}` with no + spaces or dashes. Examples: `+1.5555555555` (US), `+44.2071234567` + (UK), `+81.312345678` (Japan). + example: '+1.5555555555' + type: string + postal_info: + $ref: '#/components/schemas/registrarApiRegistrationContactPostalInfo' + required: + - phone + - email + - postal_info + type: object + registrarApiRegistrationContactAddress: + description: Physical mailing address for the registrant contact. + properties: + city: + description: City or locality name. + example: Austin + type: string + country_code: + description: >- + Two-letter country code per ISO 3166-1 alpha-2 (e.g., `US`, `GB`, + `CA`, `DE`). + example: US + type: string + postal_code: + description: Postal or ZIP code. + example: '78701' + type: string + state: + description: >- + State, province, or region. Use the standard abbreviation where + applicable (e.g., `TX` for Texas, `ON` for Ontario). + example: TX + type: string + street: + description: Street address including building/suite number. + example: 123 Main St + type: string + required: + - street + - city + - state + - postal_code + - country_code + type: object + registrarApiRegistrationContactPostalInfo: + description: Postal/mailing information for the registrant contact. + properties: + address: + $ref: '#/components/schemas/registrarApiRegistrationContactAddress' + name: + description: >- + Full legal name of the registrant (individual or authorized + representative). + example: Ada Lovelace + type: string + organization: + description: Organization or company name. Optional for individual registrants. + example: Example Inc + type: string + required: + - name + - address + type: object + registrarApiRegistrationContacts: + description: >- + Contact data for the registration request. If the `contacts` object is + omitted entirely from the request, or if `contacts.registrant` is not + provided, the system will use the account's default address book entry + as the registrant contact. This default must be pre-configured by the + account owner at + `https://dash.cloudflare.com/{account_id}/domains/registrations`, where + they can create or update the address book entry and accept the required + agreement. No API exists for managing address book entries at this time. + If no default address book entry exists and no registrant contact is + provided, the registration request will fail with a validation error. + properties: + registrant: + $ref: '#/components/schemas/registrarApiRegistrationContact' + type: object + registrarApiRegistrationCreateRequest: + properties: + auto_renew: + default: false + description: >- + Enable or disable automatic renewal. Defaults to `false` if omitted. + Setting this field to `true` is an explicit opt-in authorizing + Cloudflare to charge the account's default payment method up to 30 + days before domain expiry to renew the domain automatically. Renewal + pricing may change over time based on registry pricing. + example: false + type: boolean + contacts: + $ref: '#/components/schemas/registrarApiRegistrationContacts' + domain_name: + $ref: '#/components/schemas/registrarApiDomainName' + privacy_mode: + default: redaction + description: >- + WHOIS privacy mode for the registration. Defaults to `redaction`. - + `off`: Do not request WHOIS privacy. - `redaction`: Request WHOIS + redaction where supported by the extension. Some extensions do not + support privacy/redaction. + enum: + - false + - redaction + example: redaction + type: string + years: + description: >- + Number of years to register (1–10). If omitted, defaults to the + minimum registration period required by the registry for this + extension. For most extensions this is 1 year, but some extensions + require longer minimum terms (e.g., `.ai` requires a minimum of 2 + years). The registry for each extension may also enforce its own + maximum registration term. If the requested value exceeds the + registry's maximum, the registration will be rejected. When in + doubt, use the default by omitting this field. + example: 1 + maximum: 10 + minimum: 1 + type: integer + required: + - domain_name + type: object + registrarApiRegistrationResponseCollection: + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + items: + $ref: '#/components/schemas/registrarApiRegistration' + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/registrarApiCursorResultInfo' + required: + - success + - errors + - messages + - result + - result + - result_info + type: object + registrarApiRegistrationResponseSingle: + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + $ref: '#/components/schemas/registrarApiRegistration' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + registrarApiRegistrationUpdateRequest: + description: >- + Request to update an existing domain registration. This endpoint + currently supports updating `auto_renew` only. + minProperties: 1 + properties: + auto_renew: + description: >- + Enable or disable automatic renewal. Setting this field to `true` + authorizes Cloudflare to charge the account's default payment method + up to 30 days before domain expiry to renew the domain + automatically. Renewal pricing may change over time based on + registry pricing. + example: true + type: boolean + type: object + registrarApiRegistryStatuses: + description: >- + A comma-separated list of registry status codes. A full list of status + codes can be found at [EPP Status + Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en). + example: ok,serverTransferProhibited + type: string + registrarApiResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + registrarApiState: + description: State. + example: TX + type: string + registrarApiSupportedTld: + description: >- + Whether a particular TLD is currently supported by Cloudflare Registrar. + Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a + list of supported TLDs. + example: true + type: boolean + registrarApiTelephone: + description: User's telephone number + example: +1 123-123-1234 + maxLength: 20 + nullable: true + type: string + registrarApiTransferIn: + description: Statuses for domain transfers into Cloudflare Registrar. + properties: + accept_foa: + description: Form of authorization has been accepted by the registrant. + enum: + - needed + - ok + example: needed + type: string + approve_transfer: + description: Shows transfer status with the registry. + enum: + - needed + - ok + - pending + - trying + - rejected + - unknown + example: unknown + type: string + can_cancel_transfer: + description: Indicates if cancellation is still possible. + example: true + type: boolean + disable_privacy: + description: Privacy guards are disabled at the foreign registrar. + enum: + - needed + - ok + - unknown + example: ok + type: string + enter_auth_code: + description: Auth code has been entered and verified. + enum: + - needed + - ok + - pending + - trying + - rejected + example: needed + type: string + unlock_domain: + description: Domain is unlocked at the foreign registrar. + enum: + - needed + - ok + - pending + - trying + - unknown + example: ok + type: string + type: object + registrarApiUpdatedAt: + description: Last updated. + example: '2018-08-28T17:26:26Z' + format: date-time + type: string + registrarApiWorkflowError: + description: >- + Error details when a workflow reaches the `failed` state. The specific + error codes and messages depend on the workflow type (registration, + update, etc.) and the underlying registry response. These workflow error + codes are separate from immediate HTTP error `errors[].code` values + returned by non-2xx responses. Surface `error.message` to the user for + context. + properties: + code: + description: Machine-readable error code identifying the failure reason. + example: registry_rejected + type: string + message: + description: >- + Human-readable explanation of the failure. May include + registry-specific details. + example: Registry rejected the request. + type: string + required: + - code + - message + type: object + registrarApiWorkflowLinks: + properties: + resource: + description: URL to the domain resource. + example: /accounts/{account_id}/registrar/registrations/example.com + type: string + self: + description: URL to this status resource. + example: >- + /accounts/{account_id}/registrar/registrations/example.com/registration-status + type: string + required: + - self + type: object + registrarApiWorkflowStatus: + description: Status of an async registration workflow. + properties: + completed: + description: >- + Whether the workflow has reached a terminal state. `true` when + `state` is `succeeded` or `failed`. `false` for `pending`, + `in_progress`, `action_required`, and `blocked`. + example: false + type: boolean + context: + description: >- + Workflow-specific data for this workflow. The workflow subject is + identified by `context.domain_name` for domain-centric workflows. + type: object + created_at: + format: date-time + type: string + readOnly: true + error: + nullable: true + $ref: '#/components/schemas/registrarApiWorkflowError' + links: + $ref: '#/components/schemas/registrarApiWorkflowLinks' + state: + description: >- + Workflow lifecycle state. - `pending`: Workflow has been created but + not yet started processing. - `in_progress`: Actively processing. + Continue polling `links.self`. The workflow has an internal deadline + and will not remain in this state indefinitely. - `action_required`: + Paused — requires action by the user (not the system). See + `context.action` for what is needed. An automated polling loop must + break on this state; it will not resolve on its own without user + intervention. - `blocked`: The workflow cannot make progress due to + a third party such as the domain extension's registry or a losing + registrar. No user action will help. Continue polling — the block + may resolve when the third party responds. - `succeeded`: Terminal. + The operation completed successfully. `completed` will be `true`. + For registrations, `context.registration` contains the resulting + registration resource. - `failed`: Terminal. The operation failed. + `completed` will be `true`. See `error.code` and `error.message` for + the reason. Do not auto-retry without user review. + enum: + - pending + - in_progress + - action_required + - blocked + - succeeded + - failed + example: in_progress + type: string + updated_at: + format: date-time + type: string + readOnly: true + required: + - state + - completed + - created_at + - updated_at + - links + type: object + registrarApiWorkflowStatusResponseSingle: + properties: + errors: + $ref: '#/components/schemas/registrarApiMessages' + messages: + $ref: '#/components/schemas/registrarApiMessages' + result: + $ref: '#/components/schemas/registrarApiWorkflowStatus' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + registrarApiZipcode: + description: The zipcode or postal code where the user lives. + example: '12345' + maxLength: 20 + nullable: true + type: string + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + registrar: + id: cloudflare.registrar.registrar + name: registrar + title: Registrar + methods: + create_domain_check: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1registrar~1domain-check/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + domain_search: + id: cloudflare.registrar.domain_search + name: domain_search + title: Domain Search + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1registrar~1domain-search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.domains + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domain_search/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + domains: + id: cloudflare.registrar.domains + name: domains + title: Domains + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1registrar~1domains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1registrar~1domains~1{domain_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1registrar~1domains~1{domain_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/domains/methods/update' + registrations: + id: cloudflare.registrar.registrations + name: registrations + title: Registrations + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1registrar~1registrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1registrar~1registrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1registrar~1registrations~1{domain_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1registrar~1registrations~1{domain_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/registrations/methods/get' + - $ref: '#/components/x-stackQL-resources/registrations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/registrations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/registrations/methods/edit' + delete: [] + replace: [] + registration_status: + id: cloudflare.registrar.registration_status + name: registration_status + title: Registration Status + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1registrar~1registrations~1{domain_name}~1registration-status/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/registration_status/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + update_status: + id: cloudflare.registrar.update_status + name: update_status + title: Update Status + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1registrar~1registrations~1{domain_name}~1update-status/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/update_status/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/request_tracers.yaml b/providers/src/cloudflare/v00.00.00000/services/request_tracers.yaml new file mode 100644 index 00000000..ac5a0068 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/request_tracers.yaml @@ -0,0 +1,362 @@ +openapi: 3.0.3 +info: + title: request_tracers API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/request-tracer/trace: + post: + operationId: account-request-tracer-request-trace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + body: + properties: + base64: + description: Base64 encoded request body + type: string + x-auditable: true + json: + description: Arbitrary json as request body + type: object + plain_text: + description: Request body as plain text + type: string + x-auditable: true + type: object + context: + description: Additional request parameters + properties: + bot_score: + description: Bot score used for evaluating tracing request processing + type: integer + x-auditable: true + geoloc: + description: Geodata for tracing request + properties: + city: + type: string + x-auditable: true + continent: + type: string + x-auditable: true + is_eu_country: + type: boolean + x-auditable: true + iso_code: + type: string + x-auditable: true + latitude: + type: number + x-auditable: true + longitude: + type: number + x-auditable: true + postal_code: + type: string + x-auditable: true + region_code: + type: string + x-auditable: true + subdivision_2_iso_code: + type: string + x-auditable: true + timezone: + type: string + x-auditable: true + type: object + skip_challenge: + description: >- + Whether to skip any challenges for tracing request + (e.g.: captcha) + type: boolean + x-auditable: true + threat_score: + description: >- + Threat score used for evaluating tracing request + processing + type: integer + x-auditable: true + type: object + cookies: + description: Cookies added to tracing request + type: object + headers: + description: Headers added to tracing request + type: object + method: + description: HTTP Method of tracing request + type: string + x-auditable: true + protocol: + description: HTTP Protocol of tracing request + type: string + x-auditable: true + skip_response: + description: >- + Skip sending the request to the Origin server after all + rules evaluation + type: boolean + x-auditable: true + url: + description: URL to which perform tracing request + type: string + x-auditable: true + required: + - url + - method + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/requestTracerMessages' + messages: + $ref: '#/components/schemas/requestTracerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + description: Trace result with an origin status code + properties: + status_code: + description: HTTP Status code of zone response + type: integer + x-auditable: true + trace: + $ref: '#/components/schemas/requestTracerTrace' + type: object + required: + - success + - errors + - messages + description: Request Trace response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/requestTracerApiResponseCommonFailure' + description: Request Trace response failure + security: + - api_email: [] + api_key: [] + summary: Request Trace + tags: + - Account Request Tracer + x-api-token-group: + - Allow Request Tracer Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: request_tracers + resource_chain: + - traces + method: create +components: + schemas: + requestTracerApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/requestTracerMessages' + messages: + example: [] + $ref: '#/components/schemas/requestTracerMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + requestTracerMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + requestTracerTrace: + items: + description: List of steps acting on request/response + properties: + action: + description: If step type is rule, then action performed by this rule + example: execute + type: string + x-auditable: true + action_parameters: + description: If step type is rule, then action parameters of this rule as JSON + example: + id: 4814384a9e5d4991b9815dcfc25d2f1f + type: object + x-auditable: true + description: + description: If step type is rule or ruleset, the description of this entity + example: some rule + type: string + x-auditable: true + expression: + description: If step type is rule, then expression used to match for this rule + example: ip.src ne 1.1.1.1 + type: string + x-auditable: true + kind: + description: If step type is ruleset, then kind of this ruleset + example: zone + type: string + x-auditable: true + matched: + description: Whether tracing step affected tracing request/response + example: true + type: boolean + x-auditable: true + name: + description: If step type is ruleset, then name of this ruleset + example: some ruleset name + type: string + x-auditable: true + step_name: + description: Tracing step identifying name + example: rule_id01 + type: string + x-auditable: true + trace: + $ref: '#/components/schemas/requestTracerTrace' + type: + description: Tracing step type + example: rule + type: string + x-auditable: true + type: object + type: array + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + request_tracer: + id: cloudflare.request_tracers.request_tracer + name: request_tracer + title: Request Tracer + methods: + create_trace: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1request-tracer~1trace/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/resource_sharing.yaml b/providers/src/cloudflare/v00.00.00000/services/resource_sharing.yaml new file mode 100644 index 00000000..d52edcf7 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/resource_sharing.yaml @@ -0,0 +1,1682 @@ +openapi: 3.0.3 +info: + title: resource_sharing API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/shares: + get: + description: Lists all account shares. + operationId: shares-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Filter shares by status. + in: query + name: status + schema: + $ref: '#/components/schemas/resourceSharingShareStatus' + - description: Filter shares by kind. + in: query + name: kind + schema: + $ref: '#/components/schemas/resourceSharingShareKind' + - description: Filter shares by target_type. + in: query + name: target_type + schema: + $ref: '#/components/schemas/resourceSharingShareTargetType' + - description: Filter share resources by resource_types. + in: query + name: resource_types + schema: + items: + $ref: '#/components/schemas/resourceSharingResourceType' + type: array + explode: true + - description: Order shares by values in the given field. + in: query + name: order + schema: + default: created + enum: + - name + - created + type: string + - description: Direction to sort objects. + in: query + name: direction + schema: + default: asc + enum: + - asc + - desc + type: string + - description: Page number. + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page. + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + - description: Include resources in the response. + in: query + name: include_resources + schema: + type: boolean + - description: Include recipient counts in the response. + in: query + name: include_recipient_counts + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingShareResponseCollection' + description: List account shares response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List account shares response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List account shares response failure. + security: + - api_email: [] + api_key: [] + summary: List account shares + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: [] + method: list + post: + description: >- + Creates a new resource share for sharing Cloudflare resources with other + accounts or organizations. + operationId: share-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingCreateShareRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingShareResponseSingle' + description: Share created. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Create share failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Create share failure. + security: + - api_email: [] + api_key: [] + summary: Create a new share + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: [] + method: create + /accounts/{account_id}/shares/{share_id}: + delete: + description: >- + Deletion is not immediate, an updated share object with a new status + will be returned. + operationId: share-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingShareResponseSingle' + description: Share deleted. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Delete share failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Delete share failure. + security: + - api_email: [] + api_key: [] + summary: Delete a share + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: [] + method: delete + get: + description: Fetches share by ID. + operationId: shares-get-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - description: Include resources in the response. + in: query + name: include_resources + schema: + type: boolean + - description: Include recipient counts in the response. + in: query + name: include_recipient_counts + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingShareResponseSingle' + description: Get account share response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Get account share response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Get account share response failure. + security: + - api_email: [] + api_key: [] + summary: Get account share by ID + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: [] + method: get + put: + description: >- + Updating is not immediate, an updated share object with a new status + will be returned. + operationId: share-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingUpdateShareRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingShareResponseSingle' + description: Share updated. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Update share failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Update share failure. + security: + - api_email: [] + api_key: [] + summary: Update a share + tags: + - Resource Sharing + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: [] + method: update + /accounts/{account_id}/shares/{share_id}/recipients: + get: + description: List share recipients by share ID. + operationId: share-recipients-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - description: Include resources in the response. + in: query + name: include_resources + schema: + type: boolean + - description: Page number. + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page. + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareRecipientResponseCollection + description: List account share recipients response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List account share recipients response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List account share recipients response failure. + security: + - api_email: [] + api_key: [] + summary: List share recipients by share ID + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - recipients + method: list + post: + description: >- + Adds a recipient to a resource share, granting them access to the shared + resources. + operationId: share-recipient-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingCreateShareRecipientRequest' + responses: + '201': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareRecipientResponseSingle + description: Share recipient created. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Create share recipient failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Create share recipient failure. + security: + - api_email: [] + api_key: [] + summary: Create a new share recipient + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + put: + description: >- + Changes a share's recipients to match the given list. Returns an error + if the share targets an organization. + operationId: share-recipients-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingUpdateShareRecipientsRequest' + responses: + '204': + description: Empty body + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Update share recipients failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Update share recipients failure. + security: + - api_email: [] + api_key: [] + summary: Update a share's recipients + tags: + - Resource Sharing + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}: + delete: + description: >- + Deletion is not immediate, an updated share recipient object with a new + status will be returned. + operationId: share-recipient-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - in: path + name: recipient_id + schema: + $ref: '#/components/schemas/resourceSharingRecipientId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareRecipientResponseSingle + description: Share recipient deleted. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Delete share recipient failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Delete share recipient failure. + security: + - api_email: [] + api_key: [] + summary: Delete a share recipient + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - recipients + method: delete + get: + description: Get share recipient by ID. + operationId: share-recipients-get-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - in: path + name: recipient_id + schema: + $ref: '#/components/schemas/resourceSharingRecipientId' + required: true + - description: Include resources in the response. + in: query + name: include_resources + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareRecipientResponseSingle + description: Get account share recipient response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Get account share recipient response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Get account share recipient response failure. + security: + - api_email: [] + api_key: [] + summary: Get share recipient by ID + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - recipients + method: get + /accounts/{account_id}/shares/{share_id}/resources: + get: + description: List share resources by share ID. + operationId: share-resources-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - description: Filter share resources by status. + in: query + name: status + schema: + $ref: '#/components/schemas/resourceSharingResourceStatus' + - description: Filter share resources by resource_type. + in: query + name: resource_type + schema: + $ref: '#/components/schemas/resourceSharingResourceType' + - description: Page number. + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page. + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareResourceResponseCollection + description: List account share resources response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List account share resources response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: List account share resources response failure. + security: + - api_email: [] + api_key: [] + summary: List share resources by share ID + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - resources + method: list + post: + description: >- + Adds a resource to an existing share, making it available to share + recipients. + operationId: share-resource-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingCreateShareResourceRequest' + responses: + '201': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareResourceResponseSingle + description: Share resource created. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Create share resource failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Create share resource failure. + security: + - api_email: [] + api_key: [] + summary: Create a new share resource + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - resources + method: create + /accounts/{account_id}/shares/{share_id}/resources/{resource_id}: + delete: + description: >- + Deletion is not immediate, an updated share resource object with a new + status will be returned. + operationId: share-resource-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - in: path + name: resource_id + schema: + $ref: '#/components/schemas/resourceSharingResourceId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareResourceResponseSingle + description: Share resource deleted. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Delete share resource failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Delete share resource failure. + security: + - api_email: [] + api_key: [] + summary: Delete a share resource + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - resources + method: delete + get: + description: Get share resource by ID. + operationId: share-resources-get-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - in: path + name: resource_id + schema: + $ref: '#/components/schemas/resourceSharingResourceId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareResourceResponseSingle + description: Get account share resource response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Get account share resource response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Get account share resource response failure. + security: + - api_email: [] + api_key: [] + summary: Get share resource by ID + tags: + - Resource Sharing + x-api-token-group: null + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - resources + method: get + put: + description: >- + Update is not immediate, an updated share resource object with a new + status will be returned. + operationId: share-resource-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: share_id + schema: + $ref: '#/components/schemas/resourceSharingShareId' + required: true + - in: path + name: resource_id + schema: + $ref: '#/components/schemas/resourceSharingResourceId' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingUpdateShareResourceRequest' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceSharingShareResourceResponseSingle + description: Share resource updated. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Update share resource failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceSharingApiResponseCommonFailure' + description: Update share resource failure. + security: + - api_email: [] + api_key: [] + summary: Update a share resource + tags: + - Resource Sharing + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_sharing + resource_chain: + - resources + method: update +components: + schemas: + resourceSharingAccountId: + description: Account identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingAccountName: + description: The display name of an account. + example: Account A + type: string + x-auditable: true + resourceSharingApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/resourceSharingV4errors' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + example: false + type: boolean + x-auditable: true + required: + - success + - errors + - result + type: object + resourceSharingCreateShareRecipientRequest: + description: Account or organization ID must be provided. + properties: + account_id: + $ref: '#/components/schemas/resourceSharingAccountId' + organization_id: + $ref: '#/components/schemas/resourceSharingOrganizationId' + type: object + resourceSharingCreateShareRequest: + properties: + name: + $ref: '#/components/schemas/resourceSharingShareName' + recipients: + items: + $ref: '#/components/schemas/resourceSharingCreateShareRecipientRequest' + type: array + resources: + items: + $ref: '#/components/schemas/resourceSharingCreateShareResourceRequest' + type: array + required: + - name + - resources + - recipients + type: object + resourceSharingCreateShareResourceRequest: + properties: + meta: + $ref: '#/components/schemas/resourceSharingResourceMeta' + resource_account_id: + $ref: '#/components/schemas/resourceSharingAccountId' + resource_id: + $ref: '#/components/schemas/resourceSharingResourceResourceId' + resource_type: + $ref: '#/components/schemas/resourceSharingResourceType' + required: + - resource_id + - resource_type + - resource_account_id + - meta + type: object + resourceSharingCreated: + description: When the share was created. + example: '2023-09-21T18:56:32.624632Z' + format: date-time + type: string + x-auditable: true + resourceSharingModified: + description: When the share was modified. + example: '2023-09-21T18:56:32.624632Z' + format: date-time + type: string + x-auditable: true + resourceSharingOrganizationId: + description: Organization identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingRecipientAssociationStatus: + description: Share Recipient association status. + enum: + - associating + - associated + - disassociating + - disassociated + type: string + x-auditable: true + resourceSharingRecipientId: + description: Share Recipient identifier tag. + example: 3fd85f74b32742f1bff64a85009dda07 + maxLength: 32 + type: string + x-auditable: true + resourceSharingRecipientResourceError: + description: Share Recipient error message. + example: Recipient is missing necessary entitlement + type: string + x-auditable: true + resourceSharingRecipientResourceErrorTerminal: + description: Whether the error is terminal or will be continually retried. + example: true + type: boolean + x-auditable: true + resourceSharingResourceId: + description: Share Resource identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingResourceMeta: + description: Resource Metadata. + type: object + resourceSharingResourceResourceId: + description: Share Resource identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceSharingResourceStatus: + description: Resource Status. + enum: + - active + - deleting + - deleted + type: string + x-auditable: true + resourceSharingResourceType: + description: Resource Type. + enum: + - custom-ruleset + - gateway-policy + - gateway-destination-ip + - gateway-block-page-settings + - gateway-extended-email-matching + type: string + x-auditable: true + resourceSharingResourceVersion: + description: Resource Version. + type: integer + x-auditable: true + resourceSharingResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: Total number of pages using the given per page. + example: 50 + type: number + type: object + resourceSharingShareId: + description: Share identifier tag. + example: 3fd85f74b32742f1bff64a85009dda07 + maxLength: 32 + type: string + x-auditable: true + resourceSharingShareKind: + enum: + - sent + - received + type: string + x-auditable: true + resourceSharingShareName: + description: The name of the share. + example: My Shared WAF Managed Rule + type: string + x-auditable: true + resourceSharingShareObject: + properties: + account_id: + $ref: '#/components/schemas/resourceSharingAccountId' + account_name: + $ref: '#/components/schemas/resourceSharingAccountName' + associated_recipient_count: + description: >- + The number of recipients in the 'associated' state. This field is + only included when requested via the 'include_recipient_counts' + parameter. + example: 10 + type: integer + associating_recipient_count: + description: >- + The number of recipients in the 'associating' state. This field is + only included when requested via the 'include_recipient_counts' + parameter. + example: 1 + type: integer + created: + $ref: '#/components/schemas/resourceSharingCreated' + disassociated_recipient_count: + description: >- + The number of recipients in the 'disassociated' state. This field is + only included when requested via the 'include_recipient_counts' + parameter. + example: 0 + type: integer + disassociating_recipient_count: + description: >- + The number of recipients in the 'disassociating' state. This field + is only included when requested via the 'include_recipient_counts' + parameter. + example: 0 + type: integer + id: + $ref: '#/components/schemas/resourceSharingShareId' + kind: + $ref: '#/components/schemas/resourceSharingShareKind' + modified: + $ref: '#/components/schemas/resourceSharingModified' + name: + $ref: '#/components/schemas/resourceSharingShareName' + organization_id: + $ref: '#/components/schemas/resourceSharingOrganizationId' + resources: + description: >- + A list of resources that are part of the share. This field is only + included when requested via the 'include_resources' parameter. + items: + $ref: '#/components/schemas/resourceSharingShareResourceObject' + type: array + status: + $ref: '#/components/schemas/resourceSharingShareStatus' + target_type: + $ref: '#/components/schemas/resourceSharingShareTargetType' + required: + - id + - name + - account_id + - account_name + - organization_id + - created + - modified + - status + - target_type + type: object + resourceSharingShareRecipientObject: + properties: + account_id: + $ref: '#/components/schemas/resourceSharingAccountId' + association_status: + $ref: '#/components/schemas/resourceSharingRecipientAssociationStatus' + created: + $ref: '#/components/schemas/resourceSharingCreated' + id: + $ref: '#/components/schemas/resourceSharingRecipientId' + modified: + $ref: '#/components/schemas/resourceSharingModified' + resources: + items: + $ref: '#/components/schemas/resourceSharingShareRecipientResourceObject' + type: array + required: + - id + - account_id + - association_status + - created + - modified + type: object + resourceSharingShareRecipientResourceObject: + properties: + error: + $ref: '#/components/schemas/resourceSharingRecipientResourceError' + resource_id: + $ref: '#/components/schemas/resourceSharingResourceResourceId' + resource_version: + $ref: '#/components/schemas/resourceSharingResourceVersion' + terminal: + $ref: '#/components/schemas/resourceSharingRecipientResourceErrorTerminal' + required: + - error + - terminal + - resource_id + - resource_version + type: object + resourceSharingShareRecipientResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/resourceSharingV4errors' + result: + items: + $ref: '#/components/schemas/resourceSharingShareRecipientObject' + nullable: true + type: array + success: + description: Whether the API call was successful. + example: true + type: boolean + result_info: + $ref: '#/components/schemas/resourceSharingResultInfo' + required: + - success + - errors + resourceSharingShareRecipientResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/resourceSharingV4errors' + result: + $ref: '#/components/schemas/resourceSharingShareRecipientObject' + success: + description: Whether the API call was successful. + example: true + type: boolean + required: + - success + - errors + resourceSharingShareResourceObject: + properties: + created: + $ref: '#/components/schemas/resourceSharingCreated' + id: + $ref: '#/components/schemas/resourceSharingResourceId' + meta: + $ref: '#/components/schemas/resourceSharingResourceMeta' + modified: + $ref: '#/components/schemas/resourceSharingModified' + resource_account_id: + $ref: '#/components/schemas/resourceSharingAccountId' + resource_id: + $ref: '#/components/schemas/resourceSharingResourceResourceId' + resource_type: + $ref: '#/components/schemas/resourceSharingResourceType' + resource_version: + $ref: '#/components/schemas/resourceSharingResourceVersion' + status: + $ref: '#/components/schemas/resourceSharingResourceStatus' + required: + - id + - resource_id + - resource_type + - resource_account_id + - meta + - status + - created + - modified + - resource_version + type: object + resourceSharingShareResourceResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/resourceSharingV4errors' + result: + items: + $ref: '#/components/schemas/resourceSharingShareResourceObject' + nullable: true + type: array + success: + description: Whether the API call was successful. + example: true + type: boolean + result_info: + $ref: '#/components/schemas/resourceSharingResultInfo' + required: + - success + - errors + resourceSharingShareResourceResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/resourceSharingV4errors' + result: + $ref: '#/components/schemas/resourceSharingShareResourceObject' + success: + description: Whether the API call was successful. + example: true + type: boolean + required: + - success + - errors + resourceSharingShareResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/resourceSharingV4errors' + result: + items: + $ref: '#/components/schemas/resourceSharingShareObject' + nullable: true + type: array + success: + description: Whether the API call was successful. + example: true + type: boolean + result_info: + $ref: '#/components/schemas/resourceSharingResultInfo' + required: + - success + - errors + resourceSharingShareResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/resourceSharingV4errors' + result: + $ref: '#/components/schemas/resourceSharingShareObject' + success: + description: Whether the API call was successful. + example: true + type: boolean + required: + - success + - errors + resourceSharingShareStatus: + enum: + - active + - deleting + - deleted + type: string + x-auditable: true + resourceSharingShareTargetType: + enum: + - account + - organization + type: string + x-auditable: true + resourceSharingUpdateShareRecipientsRequest: + items: + $ref: '#/components/schemas/resourceSharingCreateShareRecipientRequest' + type: array + resourceSharingUpdateShareRequest: + properties: + name: + $ref: '#/components/schemas/resourceSharingShareName' + required: + - name + type: object + resourceSharingUpdateShareResourceRequest: + properties: + meta: + $ref: '#/components/schemas/resourceSharingResourceMeta' + required: + - meta + type: object + resourceSharingV4error: + $ref: '#/components/schemas/responseInfo' + resourceSharingV4errors: + example: [] + items: + $ref: '#/components/schemas/resourceSharingV4error' + type: array + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + shares: + id: cloudflare.resource_sharing.shares + name: shares + title: Shares + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1shares/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1shares/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1shares~1{share_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1shares~1{share_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1shares~1{share_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/shares/methods/get' + - $ref: '#/components/x-stackQL-resources/shares/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/shares/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/shares/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/shares/methods/update' + recipients: + id: cloudflare.resource_sharing.recipients + name: recipients + title: Recipients + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1recipients/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + share_recipient_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1recipients/post + response: + mediaType: application/json + openAPIDocKey: '201' + share_recipients_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1recipients/put + response: + mediaType: application/json + openAPIDocKey: '204' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1recipients~1{recipient_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1recipients~1{recipient_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recipients/methods/get' + - $ref: '#/components/x-stackQL-resources/recipients/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/recipients/methods/share_recipient_create + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/recipients/methods/delete' + replace: + - $ref: >- + #/components/x-stackQL-resources/recipients/methods/share_recipients_update + resources: + id: cloudflare.resource_sharing.resources + name: resources + title: Resources + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1resources/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1resources/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1resources~1{resource_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1resources~1{resource_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1shares~1{share_id}~1resources~1{resource_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resources/methods/get' + - $ref: '#/components/x-stackQL-resources/resources/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/resources/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/resources/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/resources/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/resource_tagging.yaml b/providers/src/cloudflare/v00.00.00000/services/resource_tagging.yaml new file mode 100644 index 00000000..0d49faa0 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/resource_tagging.yaml @@ -0,0 +1,1160 @@ +openapi: 3.0.3 +info: + title: resource_tagging API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/tags: + delete: + description: Removes all tags from a specific account-level resource. + operationId: tags-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + ETag value for optimistic concurrency control. When provided, the + server will verify the current resource ETag matches before applying + the write. Returns 412 Precondition Failed if the resource has been + modified since the ETag was obtained. Omit this header for + unconditional writes. + in: header + name: If-Match + schema: + type: string + responses: + '204': + description: Tags successfully deleted (no content). + '412': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: >- + Precondition failed. The resource has been modified since the + provided ETag was obtained. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Delete tags response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Delete tags response failure. + security: + - api_email: [] + api_key: [] + summary: Delete tags from an account-level resource + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - account_tags + method: delete + get: + description: Retrieves tags for a specific account-level resource. + operationId: tags-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The ID of the resource to retrieve tags for. + in: query + name: resource_id + schema: + $ref: '#/components/schemas/resourceTaggingResourceId' + - description: The type of the resource. + in: query + name: resource_type + schema: + $ref: '#/components/schemas/resourceTaggingAccountResourceType' + - description: Worker identifier. Required for worker_version resources. + in: query + name: worker_id + schema: + $ref: '#/components/schemas/resourceTaggingWorkerId' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceTaggingTaggedResourceResponseSingle + description: Get tags for single resource response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Get tags for single resource response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Get tags for single resource response failure. + security: + - api_email: [] + api_key: [] + summary: Get tags for an account-level resource + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - account_tags + method: get + put: + description: Creates or updates tags for a specific account-level resource. + operationId: tags-set + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + ETag value for optimistic concurrency control. When provided, the + server will verify the current resource ETag matches before applying + the write. Returns 412 Precondition Failed if the resource has been + modified since the ETag was obtained. Omit this header for + unconditional writes. + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingSetTagsRequestAccountLevel' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceTaggingTaggedResourceResponseSingle + description: Set tags response. + '412': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: >- + Precondition failed. The resource has been modified since the + provided ETag was obtained. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Set tags response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Set tags response failure. + security: + - api_email: [] + api_key: [] + summary: Set tags for an account-level resource + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - account_tags + method: update + /accounts/{account_id}/tags/keys: + get: + description: Lists all distinct tag keys used across resources in an account. + operationId: tags-list-keys + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Cursor for pagination. + in: query + name: cursor + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingTagKeysResponseCollection' + description: List tag keys response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: List tag keys response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: List tag keys response failure. + security: + - api_email: [] + api_key: [] + summary: List tag keys + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - keys + method: list + /accounts/{account_id}/tags/resources: + get: + description: Lists all tagged resources for an account. + operationId: tags-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: >- + Filter by resource type. Can be repeated to filter by multiple types + (OR logic). Example: ?type=zone&type=worker + explode: true + in: query + name: type + schema: + items: + $ref: '#/components/schemas/resourceTaggingResourceType' + type: array + style: form + - description: >- + Filter resources by tag criteria. This parameter can be repeated + multiple times, with AND logic between parameters. Supported syntax: + - **Key-only**: `tag=` - Resource must have the tag key (e.g., + `tag=production`) - **Key-value**: `tag==` - Resource + must have the tag with specific value (e.g., `tag=env=prod`) - + **Multiple values (OR)**: `tag==,` - Resource must have + tag with any of the values (e.g., `tag=env=prod,staging`) - **Negate + key-only**: `tag=!` - Resource must not have the tag key (e.g., + `tag=!archived`) - **Negate key-value**: `tag=!=` - + Resource must not have the tag with specific value (e.g., + `tag=region!=us-west-1`) Multiple tag parameters are combined with + AND logic. + explode: true + in: query + name: tag + schema: + items: + type: string + type: array + - description: Cursor for pagination. + in: query + name: cursor + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceTaggingTaggedResourceResponseCollection + description: List tagged resources response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: List tagged resources response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: List tagged resources response failure. + security: + - api_email: [] + api_key: [] + summary: List tagged resources + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: [] + method: list + /accounts/{account_id}/tags/values/{tag_key}: + get: + description: >- + Lists all distinct values for a given tag key, optionally filtered by + resource type. + operationId: tags-list-values + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The tag key to retrieve values for. + in: path + name: tag_key + schema: + type: string + required: true + - description: Filter by resource type. + in: query + name: type + schema: + $ref: '#/components/schemas/resourceTaggingResourceType' + - description: Cursor for pagination. + in: query + name: cursor + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceTaggingTagValuesResponseCollection + description: List tag values response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: List tag values response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: List tag values response failure. + security: + - api_email: [] + api_key: [] + summary: List tag values + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - values + method: list + /zones/{zone_id}/tags: + delete: + description: Removes all tags from a specific zone-level resource. + operationId: tags-zone-delete + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: >- + ETag value for optimistic concurrency control. When provided, the + server will verify the current resource ETag matches before applying + the write. Returns 412 Precondition Failed if the resource has been + modified since the ETag was obtained. Omit this header for + unconditional writes. + in: header + name: If-Match + schema: + type: string + responses: + '204': + description: Tags successfully deleted (no content). + '412': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: >- + Precondition failed. The resource has been modified since the + provided ETag was obtained. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Delete tags response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Delete tags response failure. + security: + - api_email: [] + api_key: [] + summary: Delete tags from a zone-level resource + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - zone_tags + method: delete + get: + description: Retrieves tags for a specific zone-level resource. + operationId: tags-zone-get + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: The ID of the resource to retrieve tags for. + in: query + name: resource_id + schema: + $ref: '#/components/schemas/resourceTaggingResourceId' + - description: The type of the resource. + in: query + name: resource_type + schema: + $ref: '#/components/schemas/resourceTaggingZoneResourceType' + - description: >- + Access application ID identifier. Required for + access_application_policy resources. + in: query + name: access_application_id + schema: + $ref: '#/components/schemas/resourceTaggingAccessApplicationId' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceTaggingTaggedResourceResponseSingle + description: Get tags for single resource response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Get tags for single resource response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Get tags for single resource response failure. + security: + - api_email: [] + api_key: [] + summary: Get tags for a zone-level resource + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - zone_tags + method: get + put: + description: >- + Creates or updates tags for a specific zone-level resource. Replaces all + existing tags for the resource. + operationId: tags-zone-set + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: >- + ETag value for optimistic concurrency control. When provided, the + server will verify the current resource ETag matches before applying + the write. Returns 412 Precondition Failed if the resource has been + modified since the ETag was obtained. Omit this header for + unconditional writes. + in: header + name: If-Match + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingSetTagsRequestZoneLevel' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/resourceTaggingTaggedResourceResponseSingle + description: Set tags response. + '412': + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: >- + Precondition failed. The resource has been modified since the + provided ETag was obtained. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Set tags response failure. + 5XX: + content: + application/json: + schema: + $ref: '#/components/schemas/resourceTaggingApiResponseCommonFailure' + description: Set tags response failure. + security: + - api_email: [] + api_key: [] + summary: Set tags for a zone-level resource + tags: + - Resource Tagging + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: resource_tagging + resource_chain: + - zone_tags + method: update +components: + schemas: + resourceTaggingAccessApplicationId: + description: >- + Access application ID is required only for access_application_policy + resources + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + resourceTaggingAccountResourceType: + description: Identifies the type of account-level resource. + enum: + - access_application + - access_group + - account + - ai_gateway + - alerting_policy + - alerting_webhook + - cloudflared_tunnel + - d1_database + - durable_object_namespace + - gateway_list + - gateway_rule + - image + - kv_namespace + - queue + - r2_bucket + - resource_share + - stream_live_input + - stream_video + - worker + - worker_version + example: worker + type: string + x-auditable: true + resourceTaggingApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/resourceTaggingMessages' + messages: + example: [] + $ref: '#/components/schemas/resourceTaggingMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + resourceTaggingCursorResultInfo: + properties: + count: + description: Indicates the number of results returned in the current page. + example: 20 + type: integer + cursor: + description: >- + Provides a cursor for the next page of results. Include this value + in the next request to continue pagination. + example: eyJhY2NvdW50X2lkIjoxMjM0NTY3ODkwfQ + nullable: true + type: string + type: object + resourceTaggingEtag: + description: >- + ETag identifier for optimistic concurrency control. Formatted as + "v1:" where the hash is the base64url-encoded SHA-256 (truncated + to 128 bits) of the tags map canonicalized using RFC 8785 (JSON + Canonicalization Scheme). Clients should treat ETags as opaque strings + and pass them back via the If-Match header on write operations. + example: v1:RBNvo1WzZ4oRRq0W9-hkng + readOnly: true + type: string + resourceTaggingIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + resourceTaggingMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + resourceTaggingResourceId: + description: Identifies the unique resource. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + x-auditable: true + resourceTaggingResourceName: + description: Human-readable name of the resource. + example: my-worker-script + type: string + resourceTaggingResourceType: + description: Identifies the type of resource. + enum: + - access_application + - access_application_policy + - access_group + - account + - ai_gateway + - alerting_policy + - alerting_webhook + - api_gateway_operation + - cloudflared_tunnel + - custom_certificate + - custom_hostname + - d1_database + - dns_record + - durable_object_namespace + - gateway_list + - gateway_rule + - image + - kv_namespace + - managed_client_certificate + - queue + - r2_bucket + - resource_share + - stream_live_input + - stream_video + - worker + - worker_version + - zone + example: zone + type: string + x-auditable: true + resourceTaggingSetTagsRequestAccountLevel: + description: Request body schema for setting tags on account-level resources. + type: object + properties: + resource_id: + $ref: '#/components/schemas/resourceTaggingResourceId' + resource_type: + description: >- + Enum for base account-level resource types (those with no extra + required fields). + enum: + - access_application + - access_group + - account + - ai_gateway + - alerting_policy + - alerting_webhook + - cloudflared_tunnel + - d1_database + - durable_object_namespace + - gateway_list + - gateway_rule + - image + - kv_namespace + - queue + - r2_bucket + - resource_share + - stream_live_input + - stream_video + - worker + - worker_version + example: worker + type: string + x-auditable: true + worker_id: + $ref: '#/components/schemas/resourceTaggingWorkerId' + tags: + $ref: '#/components/schemas/resourceTaggingTags' + required: + - resource_id + - resource_type + resourceTaggingSetTagsRequestZoneLevel: + description: Request body schema for setting tags on zone-level resources. + type: object + properties: + resource_id: + $ref: '#/components/schemas/resourceTaggingResourceId' + resource_type: + $ref: '#/components/schemas/resourceTaggingZoneResourceTypeBaseEnum' + tags: + $ref: '#/components/schemas/resourceTaggingTags' + access_application_id: + $ref: '#/components/schemas/resourceTaggingAccessApplicationId' + required: + - resource_id + - resource_type + resourceTaggingTagKeysResponseCollection: + properties: + errors: + $ref: '#/components/schemas/resourceTaggingMessages' + messages: + $ref: '#/components/schemas/resourceTaggingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: Contains an array of distinct tag keys. + example: + - environment + - team + - region + items: + type: string + type: array + result_info: + $ref: '#/components/schemas/resourceTaggingCursorResultInfo' + required: + - success + - errors + - messages + type: object + resourceTaggingTagValuesResponseCollection: + properties: + errors: + $ref: '#/components/schemas/resourceTaggingMessages' + messages: + $ref: '#/components/schemas/resourceTaggingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + example: + - production + - staging + items: + type: string + type: array + result_info: + $ref: '#/components/schemas/resourceTaggingCursorResultInfo' + required: + - success + - errors + - messages + type: object + resourceTaggingTaggedResourceObject: + type: object + description: Response for access_application resources + properties: + type: + enum: + - access_application + type: string + etag: + $ref: '#/components/schemas/resourceTaggingEtag' + id: + $ref: '#/components/schemas/resourceTaggingResourceId' + name: + $ref: '#/components/schemas/resourceTaggingResourceName' + tags: + $ref: '#/components/schemas/resourceTaggingTags' + access_application_id: + $ref: '#/components/schemas/resourceTaggingAccessApplicationId' + zone_id: + $ref: '#/components/schemas/resourceTaggingZoneId' + worker_id: + $ref: '#/components/schemas/resourceTaggingWorkerId' + required: + - etag + - id + - name + - tags + - type + resourceTaggingTaggedResourceResponseCollection: + properties: + errors: + $ref: '#/components/schemas/resourceTaggingMessages' + messages: + $ref: '#/components/schemas/resourceTaggingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/resourceTaggingTaggedResourceObject' + type: array + result_info: + $ref: '#/components/schemas/resourceTaggingCursorResultInfo' + required: + - success + - errors + - messages + type: object + resourceTaggingTaggedResourceResponseSingle: + properties: + errors: + $ref: '#/components/schemas/resourceTaggingMessages' + messages: + $ref: '#/components/schemas/resourceTaggingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/resourceTaggingTaggedResourceObject' + required: + - success + - errors + - messages + type: object + resourceTaggingTags: + description: Contains key-value pairs of tags. + example: + environment: production + team: engineering + type: object + x-auditable: true + resourceTaggingWorkerId: + description: Worker ID is required only for worker_version resources + example: 3f72a691-44b3-4c11-8642-c18a88ddaa5e + type: string + resourceTaggingZoneId: + description: Zone ID is required only for zone-level resources + minLength: 32 + $ref: '#/components/schemas/resourceTaggingIdentifier' + resourceTaggingZoneResourceType: + description: Identifies the type of zone-level resource. + enum: + - access_application_policy + - api_gateway_operation + - custom_certificate + - custom_hostname + - dns_record + - managed_client_certificate + - zone + example: zone + type: string + x-auditable: true + resourceTaggingZoneResourceTypeBaseEnum: + description: >- + Enum for base zone-level resource types (those with no extra required + fields). + enum: + - api_gateway_operation + - custom_certificate + - custom_hostname + - dns_record + - managed_client_certificate + - zone + example: zone + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + account_tags: + id: cloudflare.resource_tagging.account_tags + name: account_tags + title: Account Tags + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tags/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tags/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/account_tags/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/account_tags/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/account_tags/methods/update' + keys: + id: cloudflare.resource_tagging.keys + name: keys + title: Keys + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tags~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + resources: + id: cloudflare.resource_tagging.resources + name: resources + title: Resources + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tags~1resources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resources/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + values: + id: cloudflare.resource_tagging.values + name: values + title: Values + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tags~1values~1{tag_key}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/values/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + zone_tags: + id: cloudflare.resource_tagging.zone_tags + name: zone_tags + title: Zone Tags + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1tags/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1tags/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zone_tags/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/zone_tags/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/zone_tags/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/rules.yaml b/providers/src/cloudflare/v00.00.00000/services/rules.yaml new file mode 100644 index 00000000..5fe50c1e --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/rules.yaml @@ -0,0 +1,1681 @@ +openapi: 3.0.3 +info: + title: rules API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/rules/lists: + get: + description: Fetches all lists in the account. + operationId: lists-get-lists + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListsResponseCollection' + description: Get lists response. + 4XX: + content: + application/json: + schema: + type: object + properties: + result: + items: + $ref: '#/components/schemas/listsList' + type: array + enum: + - null + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get lists response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get lists + tags: + - Lists + x-api-token-group: + - Account Filter Lists Read + - Account Filter Lists Edit + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + method: list + post: + description: Creates a new list of the specified kind. + operationId: lists-create-a-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/listsDescription' + kind: + $ref: '#/components/schemas/listsKind' + name: + $ref: '#/components/schemas/listsName' + required: + - name + - kind + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListResponseCollection' + description: Create a list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRefE706d5e8367564544e2991af82ebb07a + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create a list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a list + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + method: create + /accounts/{account_id}/rules/lists/bulk_operations/{operation_id}: + get: + description: >- + Gets the current status of an asynchronous operation on a list. The + `status` property can have one of the following values: `pending`, + `running`, `completed`, or `failed`. If the status is `failed`, the + `error` property will contain a message describing the error. + operationId: lists-get-bulk-operation-status + parameters: + - in: path + name: operation_id + schema: + $ref: '#/components/schemas/listsOperationId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsBulkOperationResponseSingle' + description: Get bulk operation status response. + 4XX: + content: + application/json: + schema: + properties: + result: + enum: + - null + type: object + properties: + id: + $ref: '#/components/schemas/listsOperationId' + status: + description: The current status of the asynchronous operation. + enum: + - pending + - running + readOnly: true + type: string + x-auditable: true + completed: + $ref: '#/components/schemas/listsCompleted' + error: + description: >- + A message describing the error when the status is + `failed`. + readOnly: true + type: string + x-auditable: true + required: + - id + - status + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get bulk operation status response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get bulk operation status + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + - Account Filter Lists Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + - bulk_operations + method: get + /accounts/{account_id}/rules/lists/{list_id}: + delete: + description: Deletes a specific list and all its items. + operationId: lists-delete-a-list + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListDeleteResponseCollection' + description: Delete a list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + result: + properties: + id: + $ref: '#/components/schemas/listsListId' + required: + - id + type: object + enum: + - null + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a list + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + method: delete + get: + description: Fetches the details of a list. + operationId: lists-get-a-list + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListResponseCollection' + description: Get a list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRefE706d5e8367564544e2991af82ebb07a + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get a list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a list + tags: + - Lists + x-api-token-group: + - Account Filter Lists Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + method: get + put: + description: Updates the description of a list. + operationId: lists-update-a-list + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/listsDescription' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListResponseCollection' + description: Update a list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRefE706d5e8367564544e2991af82ebb07a + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a list + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + method: update + /accounts/{account_id}/rules/lists/{list_id}/items: + delete: + description: >- + Removes one or more items from a list. This operation is asynchronous. + To get current the operation status, invoke the `Get bulk operation + status` endpoint with the returned `operation_id`. There is a limit of 1 + pending bulk operation per account. If an outstanding bulk operation is + in progress, the request will be rejected. + operationId: lists-delete-list-items + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + items: + items: + properties: + id: + description: Defines the unique ID of the item in the List. + maxLength: 32 + minLength: 32 + type: string + x-auditable: true + required: + - id + type: object + minItems: 1 + type: array + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListsAsyncResponse' + description: Delete list items response. + 4XX: + content: + application/json: + schema: + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRef46621d4d5b6644caae5c9167b8e28865 + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete list items response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete list items + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + - items + method: delete + get: + description: Fetches all the items in the list. + operationId: lists-get-list-items + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: cursor + schema: + description: >- + The pagination cursor. An opaque string token indicating the + position from which to continue when requesting the next/previous + set of records. Cursor values are provided under + `result_info.cursors` in the response. You should make no + assumptions about a cursor's content or length. + type: string + - in: query + name: per_page + schema: + description: >- + Amount of results to include in each paginated response. A + non-negative 32 bit integer. + maximum: 500 + minimum: 1 + type: integer + - in: query + name: search + schema: + description: >- + A search query to filter returned items. Its meaning depends on + the list type: IP addresses must start with the provided string, + hostnames and bulk redirects must contain the string, and ASNs + must match the string exactly. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsItemsListResponseCollection' + description: Get list items response. + 4XX: + content: + application/json: + schema: + properties: + result: + items: + $ref: '#/components/schemas/listsItem' + type: array + enum: + - null + result_info: + properties: + cursors: + $ref: >- + #/components/schemas/unnamedSchemaRef34bb6e31800bc0207c083affa12d2775 + type: object + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get list items response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get list items + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + - Account Filter Lists Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + - items + method: list + post: + description: >- + Appends new items to the list. This operation is asynchronous. To get + current the operation status, invoke the `Get bulk operation status` + endpoint with the returned `operation_id`. There is a limit of 1 pending + bulk operation per account. If an outstanding bulk operation is in + progress, the request will be rejected. + operationId: lists-create-list-items + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/listsItemsUpdateRequestCollection' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListsAsyncResponse' + description: Create list items response. + 4XX: + content: + application/json: + schema: + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRef46621d4d5b6644caae5c9167b8e28865 + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create list items response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create list items + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + - items + method: create + put: + description: >- + Removes all existing items from the list and adds the provided items to + the list. This operation is asynchronous. To get current the operation + status, invoke the `Get bulk operation status` endpoint with the + returned `operation_id`. There is a limit of 1 pending bulk operation + per account. If an outstanding bulk operation is in progress, the + request will be rejected. + operationId: lists-update-all-list-items + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/listsItemsUpdateRequestCollection' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsListsAsyncResponse' + description: Update all list items response. + 4XX: + content: + application/json: + schema: + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRef46621d4d5b6644caae5c9167b8e28865 + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update all list items response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update all list items + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + - items + method: update + /accounts/{account_id}/rules/lists/{list_id}/items/{item_id}: + get: + description: Fetches a list item in the list. + operationId: lists-get-a-list-item + parameters: + - in: path + name: item_id + schema: + $ref: '#/components/schemas/listsItemId' + required: true + - in: path + name: list_id + schema: + $ref: '#/components/schemas/listsListId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/listsItemResponseSingle' + description: Get a list item response. + 4XX: + content: + application/json: + schema: + properties: + result: + enum: + - null + type: object + properties: + ip: + $ref: '#/components/schemas/listsItemIp' + comment: + $ref: '#/components/schemas/listsItemComment' + created_on: + $ref: '#/components/schemas/listsCreatedOn' + readOnly: true + id: + $ref: '#/components/schemas/listsItemId' + modified_on: + $ref: '#/components/schemas/listsModifiedOn' + readOnly: true + hostname: + $ref: '#/components/schemas/listsItemHostname' + redirect: + $ref: '#/components/schemas/listsItemRedirect' + asn: + $ref: '#/components/schemas/listsItemAsn' + required: + - created_on + - id + - modified_on + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get a list item response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a list item + tags: + - Lists + x-api-token-group: + - Account Filter Lists Edit + - Account Filter Lists Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rules + resource_chain: + - lists + - items + method: get +components: + schemas: + listsBulkOperationResponseSingle: + properties: + result: + type: object + properties: + id: + $ref: '#/components/schemas/listsOperationId' + status: + description: The current status of the asynchronous operation. + enum: + - pending + - running + example: pending + readOnly: true + type: string + x-auditable: true + completed: + $ref: '#/components/schemas/listsCompleted' + error: + description: A message describing the error when the status is `failed`. + example: This list is at the maximum number of items + readOnly: true + type: string + x-auditable: true + required: + - id + - status + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + type: object + required: + - success + - errors + - messages + - result + listsCompleted: + description: The RFC 3339 timestamp of when the operation was completed. + example: '2020-01-01T08:00:00Z' + readOnly: true + type: string + x-auditable: true + listsCreatedOn: + description: The RFC 3339 timestamp of when the list was created. + example: '2020-01-01T08:00:00Z' + readOnly: true + type: string + x-auditable: true + listsDescription: + description: An informative summary of the list. + example: This is a note + maxLength: 500 + type: string + x-auditable: true + listsItem: + type: object + properties: + ip: + $ref: '#/components/schemas/listsItemIp' + comment: + $ref: '#/components/schemas/listsItemComment' + created_on: + $ref: '#/components/schemas/listsCreatedOn' + readOnly: true + id: + $ref: '#/components/schemas/listsItemId' + modified_on: + $ref: '#/components/schemas/listsModifiedOn' + readOnly: true + hostname: + $ref: '#/components/schemas/listsItemHostname' + redirect: + $ref: '#/components/schemas/listsItemRedirect' + asn: + $ref: '#/components/schemas/listsItemAsn' + required: + - created_on + - id + - modified_on + listsItemAsn: + description: Defines a non-negative 32 bit integer. + example: 5567 + type: integer + x-auditable: true + listsItemComment: + description: Defines an informative summary of the list item. + example: Private IP address + type: string + x-auditable: true + listsItemHostname: + description: >- + Valid characters for hostnames are ASCII(7) letters from a to z, the + digits from 0 to 9, wildcards (*), and the hyphen (-). + properties: + exclude_exact_hostname: + description: >- + Only applies to wildcard hostnames (e.g., *.example.com). When true + (default), only subdomains are blocked. When false, both the root + domain and subdomains are blocked. + example: true + type: boolean + url_hostname: + example: example.com + type: string + x-auditable: true + required: + - url_hostname + type: object + listsItemId: + description: Defines the unique ID of the item in the List. + example: 34b12448945f11eaa1b71c4d701ab86e + maxLength: 32 + minLength: 32 + readOnly: true + type: string + x-auditable: true + listsItemIp: + description: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR. + example: 10.0.0.1 + type: string + x-auditable: true + listsItemRedirect: + description: The definition of the redirect. + properties: + include_subdomains: + default: false + type: boolean + x-auditable: true + preserve_path_suffix: + default: false + type: boolean + x-auditable: true + preserve_query_string: + default: false + type: boolean + x-auditable: true + source_url: + example: example.com/arch + type: string + x-auditable: true + status_code: + default: 301 + enum: + - 301 + - 302 + - 307 + - 308 + type: integer + x-auditable: true + subpath_matching: + default: false + type: boolean + x-auditable: true + target_url: + example: https://archlinux.org/ + type: string + x-auditable: true + required: + - source_url + - target_url + type: object + listsItemResponseSingle: + properties: + result: + type: object + properties: + ip: + $ref: '#/components/schemas/listsItemIp' + comment: + $ref: '#/components/schemas/listsItemComment' + created_on: + $ref: '#/components/schemas/listsCreatedOn' + readOnly: true + id: + $ref: '#/components/schemas/listsItemId' + modified_on: + $ref: '#/components/schemas/listsModifiedOn' + readOnly: true + hostname: + $ref: '#/components/schemas/listsItemHostname' + redirect: + $ref: '#/components/schemas/listsItemRedirect' + asn: + $ref: '#/components/schemas/listsItemAsn' + required: + - created_on + - id + - modified_on + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + type: object + required: + - success + - errors + - messages + - result + listsItemsListResponseCollection: + properties: + result: + items: + $ref: '#/components/schemas/listsItem' + type: array + result_info: + properties: + cursors: + $ref: >- + #/components/schemas/unnamedSchemaRef34bb6e31800bc0207c083affa12d2775 + type: object + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + type: object + required: + - success + - errors + - messages + - result + listsItemsUpdateRequestCollection: + items: + type: object + properties: + ip: + $ref: '#/components/schemas/listsItemIp' + comment: + $ref: '#/components/schemas/listsItemComment' + redirect: + $ref: '#/components/schemas/listsItemRedirect' + hostname: + $ref: '#/components/schemas/listsItemHostname' + asn: + $ref: '#/components/schemas/listsItemAsn' + required: [] + type: array + listsKind: + description: >- + The type of the list. Each type supports specific list items (IP + addresses, ASNs, hostnames or redirects). + enum: + - ip + - redirect + - hostname + - asn + example: ip + type: string + listsList: + properties: + created_on: + $ref: '#/components/schemas/listsCreatedOn' + readOnly: true + description: + $ref: '#/components/schemas/listsDescription' + id: + $ref: '#/components/schemas/listsListId' + kind: + $ref: '#/components/schemas/listsKind' + modified_on: + $ref: '#/components/schemas/listsModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/listsName' + num_items: + $ref: '#/components/schemas/listsNumItems' + num_referencing_filters: + $ref: '#/components/schemas/listsNumReferencingFilters' + required: + - id + - name + - kind + - num_items + - num_referencing_filters + - created_on + - modified_on + type: object + listsListDeleteResponseCollection: + type: object + properties: + result: + properties: + id: + $ref: '#/components/schemas/listsListId' + required: + - id + type: object + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + listsListId: + description: The unique ID of the list. + example: 2c0fc9fa937b11eaa1b71c4d701ab86e + maxLength: 32 + minLength: 32 + readOnly: true + type: string + x-auditable: true + listsListResponseCollection: + type: object + properties: + result: + properties: + created_on: + $ref: '#/components/schemas/listsCreatedOn' + readOnly: true + description: + $ref: '#/components/schemas/listsDescription' + id: + $ref: '#/components/schemas/listsListId' + kind: + $ref: '#/components/schemas/listsKind' + modified_on: + $ref: '#/components/schemas/listsModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/listsName' + num_items: + $ref: '#/components/schemas/listsNumItems' + num_referencing_filters: + $ref: '#/components/schemas/listsNumReferencingFilters' + required: + - id + - name + - kind + - num_items + - num_referencing_filters + - created_on + - modified_on + type: object + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + listsListsAsyncResponse: + properties: + result: + properties: + operation_id: + $ref: '#/components/schemas/listsOperationId' + required: + - operation_id + type: object + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + type: object + required: + - success + - errors + - messages + - result + listsListsResponseCollection: + type: object + properties: + result: + items: + $ref: '#/components/schemas/listsList' + type: array + errors: + $ref: '#/components/schemas/listsMessages' + messages: + $ref: '#/components/schemas/listsMessages' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + listsMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + listsModifiedOn: + description: The RFC 3339 timestamp of when the list was last modified. + example: '2020-01-10T14:00:00Z' + readOnly: true + type: string + x-auditable: true + listsName: + description: >- + An informative name for the list. Use this name in filter and rule + expressions. + example: list1 + maxLength: 50 + type: string + x-auditable: true + listsNumItems: + description: The number of items in the list. + example: 10 + readOnly: true + type: number + x-auditable: true + listsNumReferencingFilters: + description: The number of [filters](/api/resources/filters/) referencing the list. + example: 2 + readOnly: true + type: number + x-auditable: true + listsOperationId: + description: The unique operation ID of the asynchronous action. + example: 4da8780eeb215e6cb7f48dd981c4ea02 + readOnly: true + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef34bb6e31800bc0207c083affa12d2775: + properties: + after: + example: yyy + type: string + x-auditable: true + before: + example: xxx + type: string + x-auditable: true + type: object + unnamedSchemaRef46621d4d5b6644caae5c9167b8e28865: + properties: + operation_id: + $ref: '#/components/schemas/listsOperationId' + required: + - operation_id + type: object + enum: + - null + unnamedSchemaRefE706d5e8367564544e2991af82ebb07a: + properties: + created_on: + $ref: '#/components/schemas/listsCreatedOn' + readOnly: true + description: + $ref: '#/components/schemas/listsDescription' + id: + $ref: '#/components/schemas/listsListId' + kind: + $ref: '#/components/schemas/listsKind' + modified_on: + $ref: '#/components/schemas/listsModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/listsName' + num_items: + $ref: '#/components/schemas/listsNumItems' + num_referencing_filters: + $ref: '#/components/schemas/listsNumReferencingFilters' + required: + - id + - name + - kind + - num_items + - num_referencing_filters + - created_on + - modified_on + type: object + enum: + - null + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + lists: + id: cloudflare.rules.lists + name: lists + title: Lists + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rules~1lists/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rules~1lists/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/lists/methods/get' + - $ref: '#/components/x-stackQL-resources/lists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/lists/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/lists/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/lists/methods/update' + bulk_operations: + id: cloudflare.rules.bulk_operations + name: bulk_operations + title: Bulk Operations + methods: + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rules~1lists~1bulk_operations~1{operation_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bulk_operations/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + items: + id: cloudflare.rules.items + name: items + title: Items + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}~1items/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}~1items/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}~1items/post + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}~1items/put + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rules~1lists~1{list_id}~1items~1{item_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/items/methods/get' + - $ref: '#/components/x-stackQL-resources/items/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/items/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/items/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/items/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/rulesets.yaml b/providers/src/cloudflare/v00.00.00000/services/rulesets.yaml index b3c3d077..a0fa04f3 100644 --- a/providers/src/cloudflare/v00.00.00000/services/rulesets.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/rulesets.yaml @@ -1,2319 +1,6086 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Account Rulesets - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - rulesets + title: rulesets API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - rulesets_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - description: A list of rulesets. The returned information will not include the rules in each ruleset. - items: - $ref: '#/components/schemas/ruleset_without_rules' - type: array - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - ruleset_without_rules: - description: A ruleset object. - properties: - description: - $ref: '#/components/schemas/rulesets_components-schemas-description' - id: - $ref: '#/components/schemas/rulesets_components-schemas-id' - kind: - $ref: '#/components/schemas/schemas-kind' - last_updated: - $ref: '#/components/schemas/last_updated' - name: - $ref: '#/components/schemas/rulesets_components-schemas-name' - phase: - $ref: '#/components/schemas/phase' - version: - $ref: '#/components/schemas/version' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/rulesets: + get: + description: Fetches all rulesets. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - rulesets_components-schemas-description: - default: '' - description: An informative description of the ruleset. - example: My ruleset to execute managed rulesets - type: string - rulesets_components-schemas-id: - description: The unique ID of the ruleset. - example: 2f2feab2026849078ba485f918791bdc - pattern: '^[0-9a-f]{32}$' - type: string - schemas-kind: - description: The kind of the ruleset. - enum: - - custom - - root - - zone - example: root - type: string - last_updated: - description: The timestamp of when the ruleset was last modified. - example: '2000-01-01T00:00:00.000000Z' - type: string - rulesets_components-schemas-name: - description: The human-readable name of the ruleset. - example: My ruleset - type: string - phase: - description: The phase of the ruleset. - example: http_request_firewall_managed - pattern: '^[a-z_]+$' - type: string - version: - description: The version of the ruleset. - example: '1' - pattern: '^[0-9]+$' - type: string - create_ruleset: - description: A ruleset object. - properties: - description: - $ref: '#/components/schemas/rulesets_components-schemas-description' - kind: - $ref: '#/components/schemas/schemas-kind' - name: - $ref: '#/components/schemas/rulesets_components-schemas-name' - phase: - $ref: '#/components/schemas/phase' - rules: - $ref: '#/components/schemas/create_update_rules' - required: - - name - - kind - - phase - - rules - type: object - ruleset_response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - $ref: '#/components/schemas/ruleset' - type: object - create_update_rules: - description: The list of rules in the ruleset. - items: - anyOf: - - $ref: '#/components/schemas/create_update_rule' - - description: The unique ID of a rule. - type: array - ruleset: - description: A ruleset object. - properties: - description: - $ref: '#/components/schemas/rulesets_components-schemas-description' - id: - $ref: '#/components/schemas/rulesets_components-schemas-id' - kind: - $ref: '#/components/schemas/schemas-kind' - last_updated: - $ref: '#/components/schemas/last_updated' - name: - $ref: '#/components/schemas/rulesets_components-schemas-name' - phase: - $ref: '#/components/schemas/phase' - rules: - $ref: '#/components/schemas/components-schemas-rules' - version: - $ref: '#/components/schemas/version' - type: object - create_update_rule: - description: A rule object. - properties: - action: - $ref: '#/components/schemas/rules_components-schemas-action' - action_parameters: - $ref: '#/components/schemas/action_parameters' - description: - $ref: '#/components/schemas/rules_components-schemas-description' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled-2' - expression: - $ref: '#/components/schemas/schemas-expression' - logging: - $ref: '#/components/schemas/logging' - ref: - $ref: '#/components/schemas/components-schemas-ref' - required: - - expression - - action - type: object - components-schemas-rules: - description: The list of rules in the ruleset. - items: - $ref: '#/components/schemas/rules_components-schemas-rule' - type: array - rules_components-schemas-action: - description: The action to perform when the rule matches. - example: execute - pattern: '^[a-z_]+$' - type: string - action_parameters: - description: The parameters configuring the rule action. - example: - id: 4814384a9e5d4991b9815dcfc25d2f1f - type: object - rules_components-schemas-description: - default: '' - description: An informative description of the rule. - example: Execute the OWASP ruleset when the IP address is not 1.1.1.1 - type: string - rules_components-schemas-enabled-2: - default: 'true' - description: Whether the rule should be executed. - example: true - type: boolean - schemas-expression: - description: The expression defining which traffic will match the rule. - example: ip.src ne 1.1.1.1 - type: string - logging: - description: An object configuring the rule's logging behavior. - example: - enabled: true - properties: - enabled: - description: Whether to generate a log when the rule matches. - example: true - type: boolean - type: object - components-schemas-ref: - description: The reference of the rule (the rule ID by default). - example: my_ref - type: string - rules_components-schemas-rule: - description: A rule object. - properties: - action: - $ref: '#/components/schemas/rules_components-schemas-action' - action_parameters: - $ref: '#/components/schemas/action_parameters' - categories: - $ref: '#/components/schemas/categories' - description: - $ref: '#/components/schemas/rules_components-schemas-description' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled-2' - expression: - $ref: '#/components/schemas/schemas-expression' - id: - $ref: '#/components/schemas/rules_components-schemas-id' - last_updated: - $ref: '#/components/schemas/schemas-last_updated' - logging: - $ref: '#/components/schemas/logging' - ref: - $ref: '#/components/schemas/components-schemas-ref' - version: - $ref: '#/components/schemas/schemas-version' - type: object - categories: - description: The categories of the rule. - example: - - directory-traversal - - header - items: - $ref: '#/components/schemas/category' - type: array - rules_components-schemas-id: - description: The unique ID of the rule. - example: 3a03d665bac047339bb530ecb439a90d - type: string - schemas-last_updated: - description: The timestamp of when the rule was last modified. - example: '2000-01-01T00:00:00.000000Z' - type: string - schemas-version: - description: The version of the rule. - example: '1' - pattern: '^[0-9]+$' - type: string - category: - description: A category of the rule. - example: directory-traversal - type: string - update_ruleset: - description: A ruleset object. - properties: - description: - $ref: '#/components/schemas/rulesets_components-schemas-description' - rules: - $ref: '#/components/schemas/create_update_rules' - required: - - rules - type: object - components-schemas-ruleset: - properties: - description: - example: '' - id: - example: 2f2feab2026849078ba485f918791bdc - kind: - example: zone - name: - example: default - phase: - example: http_custom_errors - rules: - description: The rules in the ruleset. - items: - $ref: '#/components/schemas/custom-error-responses_components-schemas-rule' - type: array - custom-error-responses_components-schemas-rule: - properties: - action: - example: serve_error - action_parameters: - $ref: '#/components/schemas/action_parameters_serve_error' - description: - example: Change error response based on geolocation - expression: - example: ip.geoip.country eq "AL" - id: - example: 3a03d665bac047339bb530ecb439a90d - version: - example: '1' - action_parameters_serve_error: - description: The action parameters for the serve_error action. - properties: + - in: query + name: cursor + schema: + $ref: '#/components/schemas/rulesetsCursor' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/rulesetsPerPage' + responses: + '200': + content: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: >- + A list of rulesets. The returned information will not + include the rules in each ruleset. + title: Rulesets + items: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object + type: array + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + result_info: + $ref: '#/components/schemas/rulesetsResultInfo' + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A rulesets response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List account or zone rulesets + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: list + operationId: get_accounts_account_id_rulesets + post: + description: Creates a ruleset. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: content: - description: The new content for the response error. - example: some html error page - type: string - content_type: - description: The content-type of the response error. - example: text/html - type: string - status_code: - description: The HTTP status code of the response error. - example: 530 - type: number - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts: - id: cloudflare.rulesets.accounts - name: accounts - title: Accounts - methods: - account_rulesets_list_account_rulesets: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_rulesets_list_account_rulesets: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_create_an_account_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets/post' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_delete_an_account_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_get_an_account_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_rulesets_get_an_account_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_update_an_account_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts/methods/account_rulesets_list_account_rulesets' - insert: - - $ref: '#/components/x-stackQL-resources/accounts/methods/account_rulesets_create_an_account_ruleset' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts/methods/account_rulesets_delete_an_account_ruleset' - accounts_phases_entrypoint: - id: cloudflare.rulesets.accounts_phases_entrypoint - name: accounts_phases_entrypoint - title: Accounts Phases Entrypoint - methods: - account_rulesets_get_an_account_entry_point_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_rulesets_get_an_account_entry_point_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_update_an_account_entry_point_ruleset: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_phases_entrypoint/methods/account_rulesets_get_an_account_entry_point_ruleset' - insert: [] - update: [] - delete: [] - accounts_phases_versions: - id: cloudflare.rulesets.accounts_phases_versions - name: accounts_phases_versions - title: Accounts Phases Versions - methods: - account_rulesets_list_an_account_entry_point_rulesets_versions: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_rulesets_list_an_account_entry_point_rulesets_versions: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_get_an_account_entry_point_ruleset_version: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_rulesets_get_an_account_entry_point_ruleset_version: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_rules: - id: cloudflare.rulesets.accounts_rules - name: accounts_rules - title: Accounts Rules - methods: - account_rulesets_create_an_account_ruleset_rule: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_delete_an_account_ruleset_rule: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_update_an_account_ruleset_rule: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/accounts_rules/methods/account_rulesets_create_an_account_ruleset_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_rules/methods/account_rulesets_delete_an_account_ruleset_rule' - accounts_versions: - id: cloudflare.rulesets.accounts_versions - name: accounts_versions - title: Accounts Versions - methods: - account_rulesets_list_an_account_rulesets_versions: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_rulesets_list_an_account_rulesets_versions: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_delete_an_account_ruleset_version: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_rulesets_get_an_account_ruleset_version: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_rulesets_get_an_account_ruleset_version: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_versions/methods/account_rulesets_delete_an_account_ruleset_version' - accounts_versions_by_tag: - id: cloudflare.rulesets.accounts_versions_by_tag - name: accounts_versions_by_tag - title: Accounts Versions By Tag - methods: - account_rulesets_list_an_account_ruleset_versions_rules_by_tag: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _account_rulesets_list_an_account_ruleset_versions_rules_by_tag: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_versions_by_tag/methods/account_rulesets_list_an_account_ruleset_versions_rules_by_tag' - insert: [] - update: [] - delete: [] - zones_phases_http_custom_errors_entrypoint: - id: cloudflare.rulesets.zones_phases_http_custom_errors_entrypoint - name: zones_phases_http_custom_errors_entrypoint - title: Zones Phases Http Custom Errors Entrypoint - methods: - custom_error_responses_get_custom_error_responses: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1http_custom_errors~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _custom_error_responses_get_custom_error_responses: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1http_custom_errors~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_error_responses_update_custom_error_responses: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1http_custom_errors~1entrypoint/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones: - id: cloudflare.rulesets.zones - name: zones - title: Zones - methods: - zone_rulesets_list_zone_rulesets: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_rulesets_list_zone_rulesets: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_create_a_zone_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_delete_a_zone_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_get_a_zone_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_rulesets_get_a_zone_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_update_a_zone_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones/methods/zone_rulesets_list_zone_rulesets' - insert: - - $ref: '#/components/x-stackQL-resources/zones/methods/zone_rulesets_create_a_zone_ruleset' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones/methods/zone_rulesets_delete_a_zone_ruleset' - zones_phases_entrypoint: - id: cloudflare.rulesets.zones_phases_entrypoint - name: zones_phases_entrypoint - title: Zones Phases Entrypoint - methods: - zone_rulesets_get_a_zone_entry_point_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_rulesets_get_a_zone_entry_point_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_update_a_zone_entry_point_ruleset: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_phases_entrypoint/methods/zone_rulesets_get_a_zone_entry_point_ruleset' - insert: [] - update: [] - delete: [] - zones_phases_versions: - id: cloudflare.rulesets.zones_phases_versions - name: zones_phases_versions - title: Zones Phases Versions - methods: - zone_rulesets_list_a_zone_entry_point_rulesets_versions: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_rulesets_list_a_zone_entry_point_rulesets_versions: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_get_a_zone_entry_point_ruleset_version: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_rulesets_get_a_zone_entry_point_ruleset_version: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_phases_versions/methods/zone_rulesets_list_a_zone_entry_point_rulesets_versions' - insert: [] - update: [] - delete: [] - zones_rules: - id: cloudflare.rulesets.zones_rules - name: zones_rules - title: Zones Rules - methods: - zone_rulesets_create_a_zone_ruleset_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_delete_a_zone_ruleset_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_update_a_zone_ruleset_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/zones_rules/methods/zone_rulesets_create_a_zone_ruleset_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_rules/methods/zone_rulesets_delete_a_zone_ruleset_rule' - zones_versions: - id: cloudflare.rulesets.zones_versions - name: zones_versions - title: Zones Versions - methods: - zone_rulesets_list_a_zone_rulesets_versions: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_rulesets_list_a_zone_rulesets_versions: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_delete_a_zone_ruleset_version: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rulesets_get_a_zone_ruleset_version: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_rulesets_get_a_zone_ruleset_version: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_versions/methods/zone_rulesets_list_a_zone_rulesets_versions' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_versions/methods/zone_rulesets_delete_a_zone_ruleset_version' -paths: - '/accounts/{account_id}/rulesets': + application/json: + schema: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsRequestRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object + responses: + '200': + content: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: create + operationId: post_accounts_account_id_rulesets + /zones/{zone_id}/rulesets: get: - description: Fetches all rulesets at the account level. - operationId: account-rulesets-list-account-rulesets + description: Fetches all rulesets. parameters: - - in: path - name: account_id + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: cursor schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + $ref: '#/components/schemas/rulesetsCursor' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/rulesetsPerPage' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rulesets_response' - description: List account rulesets response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: >- + A list of rulesets. The returned information will not + include the rules in each ruleset. + title: Rulesets + items: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object + type: array + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + result_info: + $ref: '#/components/schemas/rulesetsResultInfo' + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A rulesets response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/rulesets_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List account rulesets response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List account rulesets - tags: - - Account Rulesets + summary: List account or zone rulesets + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: list + operationId: get_zones_zone_id_rulesets post: - description: Creates a ruleset at the account level. - operationId: account-rulesets-create-an-account-ruleset + description: Creates a ruleset. parameters: - - in: path - name: account_id + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_ruleset' - required: true + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsRequestRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Create an account ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an account ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create an account ruleset - tags: - - Account Rulesets + summary: Create an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint': + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: create + operationId: post_zones_zone_id_rulesets + /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint: get: - description: Fetches the latest version of the account entry point ruleset for a given phase. - operationId: account-rulesets-get-an-account-entry-point-ruleset + description: >- + Fetches the latest version of the account or zone entry point ruleset + for a given phase. parameters: - in: path name: ruleset_phase - required: true schema: - $ref: '#/components/schemas/phase' - - in: path - name: account_id + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: true + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get an account entry point ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an account entry point ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get an account entry point ruleset - tags: - - Account Rulesets + summary: Get an account or zone entry point ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + method: get + operationId: get_accounts_account_id_rulesets_phases_ruleset_phase_entrypoint put: - description: 'Updates an account entry point ruleset, creating a new version.' - operationId: account-rulesets-update-an-account-entry-point-ruleset + description: Updates an account or zone entry point ruleset, creating a new version. parameters: - in: path name: ruleset_phase - required: true schema: - $ref: '#/components/schemas/phase' - - in: path - name: account_id + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: true + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/update_ruleset' - required: true + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + rules: + $ref: '#/components/schemas/rulesetsRequestRules' + required: + - id + - version + - last_updated + title: Ruleset + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Update an account entry point ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an account entry point ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update an account entry point ruleset - tags: - - Account Rulesets + summary: Update an account or zone entry point ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/phases/{ruleset_phase}/versions': + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + method: update + operationId: put_accounts_account_id_rulesets_phases_ruleset_phase_entrypoint + /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint: get: - description: Fetches the versions of an account entry point ruleset. - operationId: account-rulesets-list-an-account-entry-point-ruleset'-s-versions + description: >- + Fetches the latest version of the account or zone entry point ruleset + for a given phase. parameters: - in: path name: ruleset_phase - required: true schema: - $ref: '#/components/schemas/phase' - - in: path - name: account_id + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: true + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rulesets_response' - description: List an account entry point ruleset's versions response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/rulesets_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List an account entry point ruleset's versions response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List an account entry point ruleset's versions - tags: - - Account Rulesets + summary: Get an account or zone entry point ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/phases/{ruleset_phase}/versions/{ruleset_version}': - get: - description: Fetches a specific version of an account entry point ruleset. - operationId: account-rulesets-get-an-account-entry-point-ruleset-version + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + method: get + operationId: get_zones_zone_id_rulesets_phases_ruleset_phase_entrypoint + put: + description: Updates an account or zone entry point ruleset, creating a new version. parameters: - - in: path - name: ruleset_version - required: true - schema: - $ref: '#/components/schemas/version' - in: path name: ruleset_phase - required: true schema: - $ref: '#/components/schemas/phase' - - in: path - name: account_id + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: true + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + rules: + $ref: '#/components/schemas/rulesetsRequestRules' + required: + - id + - version + - last_updated + title: Ruleset + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get an account entry point ruleset version response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an account entry point ruleset version response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get an account entry point ruleset version - tags: - - Account Rulesets + summary: Update an account or zone entry point ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/{ruleset_id}': - delete: - description: Deletes all versions of an existing account ruleset. - operationId: account-rulesets-delete-an-account-ruleset + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + method: update + operationId: put_zones_zone_id_rulesets_phases_ruleset_phase_entrypoint + /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions: + get: + description: Fetches the versions of an account or zone entry point ruleset. parameters: - in: path - name: ruleset_id - required: true + name: ruleset_phase schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + $ref: '#/components/schemas/rulesetsRulesetPhase' required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: - application/json: {} - description: Delete an account ruleset response - 4xx: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: >- + A list of rulesets. The returned information will not + include the rules in each ruleset. + title: Rulesets + items: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object + type: array + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + result_info: + $ref: '#/components/schemas/rulesetsResultInfo' + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A rulesets response. + 4XX: content: - application/json: {} - description: Delete an account ruleset response failure + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Delete an account ruleset - tags: - - Account Rulesets + summary: List an account or zone entry point ruleset's versions + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + - versions + method: list + operationId: >- + get_accounts_account_id_rulesets_phases_ruleset_phase_entrypoint_versions + /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions: get: - description: Fetches the latest version of an account ruleset. - operationId: account-rulesets-get-an-account-ruleset + description: Fetches the versions of an account or zone entry point ruleset. parameters: - in: path - name: ruleset_id - required: true + name: ruleset_phase schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: true + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get an account ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: >- + A list of rulesets. The returned information will not + include the rules in each ruleset. + title: Rulesets + items: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object + type: array + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + result_info: + $ref: '#/components/schemas/rulesetsResultInfo' + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A rulesets response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an account ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get an account ruleset - tags: - - Account Rulesets + summary: List an account or zone entry point ruleset's versions + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - put: - description: 'Updates an account ruleset, creating a new version.' - operationId: account-rulesets-update-an-account-ruleset + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + - versions + method: list + operationId: get_zones_zone_id_rulesets_phases_ruleset_phase_entrypoint_versions + /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}: + get: + description: Fetches a specific version of an account or zone entry point ruleset. parameters: - in: path - name: ruleset_id - required: true + name: ruleset_version schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' + $ref: '#/components/schemas/rulesetsRulesetVersion' + required: true - in: path - name: account_id + name: ruleset_phase + schema: + $ref: '#/components/schemas/rulesetsRulesetPhase' required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/update_ruleset' - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Update an account ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an account ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update an account ruleset - tags: - - Account Rulesets + summary: Get an account or zone entry point ruleset version + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/{ruleset_id}/rules': - post: - description: Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset. - operationId: account-rulesets-create-an-account-ruleset-rule + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + - versions + method: get + operationId: >- + get_accounts_account_id_rulesets_phases_ruleset_phase_entrypoint_versions_ruleset_version + /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}: + get: + description: Fetches a specific version of an account or zone entry point ruleset. parameters: - in: path - name: ruleset_id - required: true + name: ruleset_version schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' + $ref: '#/components/schemas/rulesetsRulesetVersion' + required: true - in: path - name: account_id + name: ruleset_phase + schema: + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: true + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_update_rule' - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Create an account ruleset rule response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create an account ruleset rule response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create an account ruleset rule - tags: - - Account Rulesets + summary: Get an account or zone entry point ruleset version + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}': - delete: - description: Deletes an existing rule from an account ruleset. - operationId: account-rulesets-delete-an-account-ruleset-rule + x-stackql-sdk: + service: rulesets + resource_chain: + - phases + - versions + method: get + operationId: >- + get_zones_zone_id_rulesets_phases_ruleset_phase_entrypoint_versions_ruleset_version + /accounts/{account_id}/rulesets/{ruleset_id}: + get: + description: Fetches the latest version of an account or zone ruleset. parameters: - - in: path - name: rule_id + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rules_components-schemas-id' - - in: path - name: ruleset_id - required: true - schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Delete an account ruleset rule response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete an account ruleset rule response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Delete an account ruleset rule - tags: - - Account Rulesets + summary: Get an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - patch: - description: Updates an existing rule in an account ruleset. - operationId: account-rulesets-update-an-account-ruleset-rule + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: get + operationId: get_accounts_account_id_rulesets_ruleset_id + put: + description: Updates an account or zone ruleset, creating a new version. parameters: - - in: path - name: rule_id - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-id' - - in: path - name: ruleset_id + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_update_rule' - required: true + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsRequestRules' + required: + - id + - version + - last_updated + title: Ruleset + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Update an account ruleset rule response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update an account ruleset rule response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update an account ruleset rule - tags: - - Account Rulesets + summary: Update an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/{ruleset_id}/versions': - get: - description: Fetches the versions of an account ruleset. - operationId: account-rulesets-list-an-account-ruleset'-s-versions + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: update + operationId: put_accounts_account_id_rulesets_ruleset_id + delete: + description: Deletes all versions of an existing account or zone ruleset. parameters: - - in: path - name: ruleset_id + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: - '200': + '204': + description: An empty response. + 4XX: content: application/json: schema: - $ref: '#/components/schemas/rulesets_response' - description: List an account ruleset's versions response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rulesets_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List an account ruleset's versions response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List an account ruleset's versions - tags: - - Account Rulesets + summary: Delete an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}': - delete: - description: Deletes an existing version of an account ruleset. - operationId: account-rulesets-delete-an-account-ruleset-version + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: delete + operationId: delete_accounts_account_id_rulesets_ruleset_id + /zones/{zone_id}/rulesets/{ruleset_id}: + get: + description: Fetches the latest version of an account or zone ruleset. parameters: - - in: path - name: ruleset_version - required: true - schema: - $ref: '#/components/schemas/version' - - in: path - name: ruleset_id + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: - application/json: {} - description: Delete an account ruleset version response - 4xx: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: - application/json: {} - description: Delete an account ruleset version response failure + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Delete an account ruleset version - tags: - - Account Rulesets + summary: Get an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - get: - description: Fetches a specific version of an account ruleset. - operationId: account-rulesets-get-an-account-ruleset-version + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: get + operationId: get_zones_zone_id_rulesets_ruleset_id + put: + description: Updates an account or zone ruleset, creating a new version. parameters: - - in: path - name: ruleset_version - required: true - schema: - $ref: '#/components/schemas/version' - - in: path - name: ruleset_id + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsRequestRules' + required: + - id + - version + - last_updated + title: Ruleset + type: object responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get an account ruleset version response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get an account ruleset version response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get an account ruleset version - tags: - - Account Rulesets + summary: Update an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}': - get: - description: Fetches the rules of a managed account ruleset version for a given tag. - operationId: account-rulesets-list-an-account-ruleset-version'-s-rules-by-tag + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: update + operationId: put_zones_zone_id_rulesets_ruleset_id + delete: + description: Deletes all versions of an existing account or zone ruleset. parameters: - - in: path - name: rule_tag - required: true - schema: - $ref: '#/components/schemas/category' - - in: path - name: ruleset_version - required: true - schema: - $ref: '#/components/schemas/version' - - in: path - name: ruleset_id + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: account_id + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ruleset_response' - description: List an account ruleset version's rules by tag response - 4xx: + '204': + description: An empty response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List an account ruleset version's rules by tag response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List an account ruleset version's rules by tag - tags: - - Account Rulesets + summary: Delete an account or zone ruleset + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/phases/http_custom_errors/entrypoint': - get: - description: Fetches all Custom Error Responses in a zone. - operationId: custom-error-responses-get-custom-error-responses + x-stackql-sdk: + service: rulesets + resource_chain: [] + method: delete + operationId: delete_zones_zone_id_rulesets_ruleset_id + /accounts/{account_id}/rulesets/{ruleset_id}/rules: + post: + description: >- + Adds a new rule to an account or zone ruleset. The rule will be added to + the end of the existing list of rules in the ruleset by default. parameters: - - in: path - name: zone_id + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + properties: + position: + type: object + title: Before Position + description: An object configuring where the rule will be placed. + properties: + before: + description: >- + The ID of another rule to place the rule before. An + empty value causes the rule to be placed at the top. + title: Before + type: string + after: + description: >- + The ID of another rule to place the rule after. An empty + value causes the rule to be placed at the bottom. + title: After + type: string + index: + description: >- + An index at which to place the rule, where index 1 is + the first rule. + minimum: 1 + title: Index + type: integer + action: + description: The action to perform when the rule matches. + title: Action + type: string + enum: + - block + action_parameters: + default: {} + description: The parameters configuring the rule's action. + title: Action Parameters + type: object + properties: + response: + description: The response to show when the block is applied. + properties: + content: + description: The content to return. + minLength: 1 + title: Content + type: string + content_type: + description: The type of the content to return. + minLength: 1 + title: Content Type + type: string + status_code: + description: The status code to return. + maximum: 499 + minimum: 400 + title: Status Code + type: integer + required: + - status_code + - content + - content_type + title: Response + type: object + categories: + $ref: '#/components/schemas/rulesetsRuleCategories' + description: + default: '' + description: An informative description of the rule. + title: Description + type: string + enabled: + $ref: '#/components/schemas/rulesetsRuleEnabled' + default: true + exposed_credential_check: + $ref: '#/components/schemas/rulesetsRuleExposedCredentialCheck' + expression: + description: The expression defining which traffic will match the rule. + minLength: 1 + title: Expression + type: string + id: + $ref: '#/components/schemas/rulesetsRuleId' + last_updated: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + x-stainless-skip: + - terraform + logging: + $ref: >- + #/components/schemas/unnamedSchemaRef70f2c6ccd8a405358ac7ef8fc3d6751c + ratelimit: + $ref: '#/components/schemas/rulesetsRuleRatelimit' + ref: + description: The reference of the rule (the rule's ID by default). + minLength: 1 + title: Ref + type: string + version: + description: The version of the rule. + readOnly: true + title: Version + type: string + x-stainless-skip: + - terraform + type: object + title: Block Rule + required: + - last_updated + - version responses: '200': content: application/json: schema: - $ref: '#/components/schemas/components-schemas-ruleset' - description: Get Custom Error Responses response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/components-schemas-ruleset' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Custom Error Responses response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Custom Error Responses - tags: - - Custom Error Responses + summary: Create an account or zone ruleset rule + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - put: - description: Updates the Custom Error Responses of a zone. - operationId: custom-error-responses-update-custom-error-responses + x-stackql-sdk: + service: rulesets + resource_chain: + - rules + method: create + operationId: post_accounts_account_id_rulesets_ruleset_id_rules + /zones/{zone_id}/rulesets/{ruleset_id}/rules: + post: + description: >- + Adds a new rule to an account or zone ruleset. The rule will be added to + the end of the existing list of rules in the ruleset by default. parameters: - - in: path - name: zone_id + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/update_ruleset' - required: true + properties: + position: + type: object + title: Before Position + description: An object configuring where the rule will be placed. + properties: + before: + description: >- + The ID of another rule to place the rule before. An + empty value causes the rule to be placed at the top. + title: Before + type: string + after: + description: >- + The ID of another rule to place the rule after. An empty + value causes the rule to be placed at the bottom. + title: After + type: string + index: + description: >- + An index at which to place the rule, where index 1 is + the first rule. + minimum: 1 + title: Index + type: integer + action: + description: The action to perform when the rule matches. + title: Action + type: string + enum: + - block + action_parameters: + default: {} + description: The parameters configuring the rule's action. + title: Action Parameters + type: object + properties: + response: + description: The response to show when the block is applied. + properties: + content: + description: The content to return. + minLength: 1 + title: Content + type: string + content_type: + description: The type of the content to return. + minLength: 1 + title: Content Type + type: string + status_code: + description: The status code to return. + maximum: 499 + minimum: 400 + title: Status Code + type: integer + required: + - status_code + - content + - content_type + title: Response + type: object + categories: + $ref: '#/components/schemas/rulesetsRuleCategories' + description: + default: '' + description: An informative description of the rule. + title: Description + type: string + enabled: + $ref: '#/components/schemas/rulesetsRuleEnabled' + default: true + exposed_credential_check: + $ref: '#/components/schemas/rulesetsRuleExposedCredentialCheck' + expression: + description: The expression defining which traffic will match the rule. + minLength: 1 + title: Expression + type: string + id: + $ref: '#/components/schemas/rulesetsRuleId' + last_updated: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + x-stainless-skip: + - terraform + logging: + $ref: >- + #/components/schemas/unnamedSchemaRef70f2c6ccd8a405358ac7ef8fc3d6751c + ratelimit: + $ref: '#/components/schemas/rulesetsRuleRatelimit' + ref: + description: The reference of the rule (the rule's ID by default). + minLength: 1 + title: Ref + type: string + version: + description: The version of the rule. + readOnly: true + title: Version + type: string + x-stainless-skip: + - terraform + type: object + title: Block Rule + required: + - last_updated + - version responses: '200': content: application/json: schema: - $ref: '#/components/schemas/api-response-single' - description: Update Custom Error Responses response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Custom Error Responses response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update Custom Error Responses - tags: - - Custom Error Responses + summary: Create an account or zone ruleset rule + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets': - get: - description: Fetches all rulesets at the zone level. - operationId: zone-rulesets-list-zone-rulesets + x-stackql-sdk: + service: rulesets + resource_chain: + - rules + method: create + operationId: post_zones_zone_id_rulesets_ruleset_id_rules + /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}: + delete: + description: Deletes an existing rule from an account or zone ruleset. parameters: - - in: path - name: zone_id + - name: rule_id + in: path required: true + description: The rule ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rulesets_response' - description: List zone rulesets response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/rulesets_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List zone rulesets response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List zone rulesets - tags: - - Zone Rulesets + summary: Delete an account or zone ruleset rule + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - post: - description: Creates a ruleset at the zone level. - operationId: zone-rulesets-create-a-zone-ruleset + x-stackql-sdk: + service: rulesets + resource_chain: + - rules + method: delete + operationId: delete_accounts_account_id_rulesets_ruleset_id_rules_rule_id + patch: + description: Updates an existing rule in an account or zone ruleset. parameters: - - in: path - name: zone_id + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_ruleset' - required: true + properties: + position: + type: object + title: Before Position + description: An object configuring where the rule will be placed. + properties: + before: + description: >- + The ID of another rule to place the rule before. An + empty value causes the rule to be placed at the top. + title: Before + type: string + after: + description: >- + The ID of another rule to place the rule after. An empty + value causes the rule to be placed at the bottom. + title: After + type: string + index: + description: >- + An index at which to place the rule, where index 1 is + the first rule. + minimum: 1 + title: Index + type: integer + action: + description: The action to perform when the rule matches. + title: Action + type: string + enum: + - block + action_parameters: + default: {} + description: The parameters configuring the rule's action. + title: Action Parameters + type: object + properties: + response: + description: The response to show when the block is applied. + properties: + content: + description: The content to return. + minLength: 1 + title: Content + type: string + content_type: + description: The type of the content to return. + minLength: 1 + title: Content Type + type: string + status_code: + description: The status code to return. + maximum: 499 + minimum: 400 + title: Status Code + type: integer + required: + - status_code + - content + - content_type + title: Response + type: object + categories: + $ref: '#/components/schemas/rulesetsRuleCategories' + description: + default: '' + description: An informative description of the rule. + title: Description + type: string + enabled: + $ref: '#/components/schemas/rulesetsRuleEnabled' + default: true + exposed_credential_check: + $ref: '#/components/schemas/rulesetsRuleExposedCredentialCheck' + expression: + description: The expression defining which traffic will match the rule. + minLength: 1 + title: Expression + type: string + id: + $ref: '#/components/schemas/rulesetsRuleId' + last_updated: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + x-stainless-skip: + - terraform + logging: + $ref: >- + #/components/schemas/unnamedSchemaRef70f2c6ccd8a405358ac7ef8fc3d6751c + ratelimit: + $ref: '#/components/schemas/rulesetsRuleRatelimit' + ref: + description: The reference of the rule (the rule's ID by default). + minLength: 1 + title: Ref + type: string + version: + description: The version of the rule. + readOnly: true + title: Version + type: string + x-stainless-skip: + - terraform + type: object + title: Block Rule + required: + - last_updated + - version responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Create a zone ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a zone ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create a zone ruleset - tags: - - Zone Rulesets + summary: Update an account or zone ruleset rule + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint': - get: - description: Fetches the latest version of the zone entry point ruleset for a given phase. - operationId: zone-rulesets-get-a-zone-entry-point-ruleset + x-stackql-sdk: + service: rulesets + resource_chain: + - rules + method: edit + operationId: patch_accounts_account_id_rulesets_ruleset_id_rules_rule_id + /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}: + delete: + description: Deletes an existing rule from an account or zone ruleset. parameters: - - in: path - name: ruleset_phase + - name: rule_id + in: path required: true + description: The rule ID. schema: - $ref: '#/components/schemas/phase' - - in: path - name: zone_id + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get a zone entry point ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a zone entry point ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get a zone entry point ruleset - tags: - - Zone Rulesets + summary: Delete an account or zone ruleset rule + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - put: - description: 'Updates a zone entry point ruleset, creating a new version.' - operationId: zone-rulesets-update-a-zone-entry-point-ruleset + x-stackql-sdk: + service: rulesets + resource_chain: + - rules + method: delete + operationId: delete_zones_zone_id_rulesets_ruleset_id_rules_rule_id + patch: + description: Updates an existing rule in an account or zone ruleset. parameters: - - in: path - name: ruleset_phase + - name: rule_id + in: path required: true + description: The rule ID. schema: - $ref: '#/components/schemas/phase' - - in: path - name: zone_id + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/update_ruleset' - required: true + properties: + position: + type: object + title: Before Position + description: An object configuring where the rule will be placed. + properties: + before: + description: >- + The ID of another rule to place the rule before. An + empty value causes the rule to be placed at the top. + title: Before + type: string + after: + description: >- + The ID of another rule to place the rule after. An empty + value causes the rule to be placed at the bottom. + title: After + type: string + index: + description: >- + An index at which to place the rule, where index 1 is + the first rule. + minimum: 1 + title: Index + type: integer + action: + description: The action to perform when the rule matches. + title: Action + type: string + enum: + - block + action_parameters: + default: {} + description: The parameters configuring the rule's action. + title: Action Parameters + type: object + properties: + response: + description: The response to show when the block is applied. + properties: + content: + description: The content to return. + minLength: 1 + title: Content + type: string + content_type: + description: The type of the content to return. + minLength: 1 + title: Content Type + type: string + status_code: + description: The status code to return. + maximum: 499 + minimum: 400 + title: Status Code + type: integer + required: + - status_code + - content + - content_type + title: Response + type: object + categories: + $ref: '#/components/schemas/rulesetsRuleCategories' + description: + default: '' + description: An informative description of the rule. + title: Description + type: string + enabled: + $ref: '#/components/schemas/rulesetsRuleEnabled' + default: true + exposed_credential_check: + $ref: '#/components/schemas/rulesetsRuleExposedCredentialCheck' + expression: + description: The expression defining which traffic will match the rule. + minLength: 1 + title: Expression + type: string + id: + $ref: '#/components/schemas/rulesetsRuleId' + last_updated: + description: The timestamp of when the rule was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + x-stainless-skip: + - terraform + logging: + $ref: >- + #/components/schemas/unnamedSchemaRef70f2c6ccd8a405358ac7ef8fc3d6751c + ratelimit: + $ref: '#/components/schemas/rulesetsRuleRatelimit' + ref: + description: The reference of the rule (the rule's ID by default). + minLength: 1 + title: Ref + type: string + version: + description: The version of the rule. + readOnly: true + title: Version + type: string + x-stainless-skip: + - terraform + type: object + title: Block Rule + required: + - last_updated + - version responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Update a zone entry point ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a zone entry point ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update a zone entry point ruleset - tags: - - Zone Rulesets + summary: Update an account or zone ruleset rule + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/phases/{ruleset_phase}/versions': + x-stackql-sdk: + service: rulesets + resource_chain: + - rules + method: edit + operationId: patch_zones_zone_id_rulesets_ruleset_id_rules_rule_id + /accounts/{account_id}/rulesets/{ruleset_id}/versions: get: - description: Fetches the versions of a zone entry point ruleset. - operationId: zone-rulesets-list-a-zone-entry-point-ruleset'-s-versions + description: Fetches the versions of an account or zone ruleset. parameters: - - in: path - name: ruleset_phase + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/phase' - - in: path - name: zone_id + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rulesets_response' - description: List a zone entry point ruleset's versions response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: >- + A list of rulesets. The returned information will not + include the rules in each ruleset. + title: Rulesets + items: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object + type: array + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + result_info: + $ref: '#/components/schemas/rulesetsResultInfo' + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A rulesets response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/rulesets_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List a zone entry point ruleset's versions response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List a zone entry point ruleset's versions - tags: - - Zone Rulesets + summary: List an account or zone ruleset's versions + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/phases/{ruleset_phase}/versions/{ruleset_version}': + x-stackql-sdk: + service: rulesets + resource_chain: + - versions + method: list + operationId: get_accounts_account_id_rulesets_ruleset_id_versions + /zones/{zone_id}/rulesets/{ruleset_id}/versions: get: - description: Fetches a specific version of a zone entry point ruleset. - operationId: zone-rulesets-get-a-zone-entry-point-ruleset-version + description: Fetches the versions of an account or zone ruleset. parameters: - - in: path - name: ruleset_version - required: true - schema: - $ref: '#/components/schemas/version' - - in: path - name: ruleset_phase + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/phase' - - in: path - name: zone_id + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get a zone entry point ruleset version response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: >- + A list of rulesets. The returned information will not + include the rules in each ruleset. + title: Rulesets + items: + description: A ruleset object. + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + required: + - id + - version + - last_updated + - name + - kind + - phase + title: Ruleset + type: object + type: array + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + result_info: + $ref: '#/components/schemas/rulesetsResultInfo' + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A rulesets response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a zone entry point ruleset version response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get a zone entry point ruleset version - tags: - - Zone Rulesets + summary: List an account or zone ruleset's versions + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/{ruleset_id}': - delete: - description: Deletes all versions of an existing zone ruleset. - operationId: zone-rulesets-delete-a-zone-ruleset + x-stackql-sdk: + service: rulesets + resource_chain: + - versions + method: list + operationId: get_zones_zone_id_rulesets_ruleset_id_versions + /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}: + get: + description: Fetches a specific version of an account or zone ruleset. parameters: - in: path - name: ruleset_id - required: true + name: ruleset_version schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id + $ref: '#/components/schemas/rulesetsRulesetVersion' required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: {} - description: Delete a zone ruleset response - 4xx: - content: - application/json: {} - description: Delete a zone ruleset response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a zone ruleset - tags: - - Zone Rulesets - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the latest version of a zone ruleset. - operationId: zone-rulesets-get-a-zone-ruleset - parameters: - - in: path - name: ruleset_id + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get a zone ruleset response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a zone ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get a zone ruleset - tags: - - Zone Rulesets + summary: Get an account or zone ruleset version + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - put: - description: 'Updates a zone ruleset, creating a new version.' - operationId: zone-rulesets-update-a-zone-ruleset + x-stackql-sdk: + service: rulesets + resource_chain: + - versions + method: get + operationId: get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version + delete: + description: Deletes an existing version of an account or zone ruleset. parameters: - in: path - name: ruleset_id + name: ruleset_version + schema: + $ref: '#/components/schemas/rulesetsRulesetVersion' + required: true + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/update_ruleset' - required: true + type: string responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ruleset_response' - description: Update a zone ruleset response - 4xx: + '204': + description: An empty response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a zone ruleset response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Update a zone ruleset - tags: - - Zone Rulesets + summary: Delete an account or zone ruleset version + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/{ruleset_id}/rules': - post: - description: Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset. - operationId: zone-rulesets-create-a-zone-ruleset-rule + x-stackql-sdk: + service: rulesets + resource_chain: + - versions + method: delete + operationId: delete_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version + /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}: + get: + description: Fetches a specific version of an account or zone ruleset. parameters: - in: path - name: ruleset_id + name: ruleset_version + schema: + $ref: '#/components/schemas/rulesetsRulesetVersion' + required: true + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_update_rule' - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Create a zone ruleset rule response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a zone ruleset rule response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create a zone ruleset rule - tags: - - Zone Rulesets + summary: Get an account or zone ruleset version + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}': + x-stackql-sdk: + service: rulesets + resource_chain: + - versions + method: get + operationId: get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version delete: - description: Deletes an existing rule from a zone ruleset. - operationId: zone-rulesets-delete-a-zone-ruleset-rule + description: Deletes an existing version of an account or zone ruleset. parameters: - in: path - name: rule_id - required: true + name: ruleset_version schema: - $ref: '#/components/schemas/rules_components-schemas-id' - - in: path - name: ruleset_id + $ref: '#/components/schemas/rulesetsRulesetVersion' + required: true + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ruleset_response' - description: Delete a zone ruleset rule response - 4xx: + '204': + description: An empty response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a zone ruleset rule response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Delete a zone ruleset rule - tags: - - Zone Rulesets + summary: Delete an account or zone ruleset version + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - Transform Rules Write + - Select Configuration Write + - Account WAF Write + - Account Rulesets Write + - Logs Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - patch: - description: Updates an existing rule in a zone ruleset. - operationId: zone-rulesets-update-a-zone-ruleset-rule + x-stackql-sdk: + service: rulesets + resource_chain: + - versions + method: delete + operationId: delete_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version + /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}: + get: + description: >- + Fetches the rules of a managed account or zone ruleset version for a + given tag. parameters: - in: path - name: rule_id - required: true + name: rule_tag schema: - $ref: '#/components/schemas/rules_components-schemas-id' - - in: path - name: ruleset_id + $ref: '#/components/schemas/rulesetsRuleCategory' required: true - schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - in: path - name: zone_id - required: true + name: ruleset_version schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_update_rule' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ruleset_response' - description: Update a zone ruleset rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a zone ruleset rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a zone ruleset rule - tags: - - Zone Rulesets - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_id}/rulesets/{ruleset_id}/versions': - get: - description: Fetches the versions of a zone ruleset. - operationId: zone-rulesets-list-a-zone-ruleset'-s-versions - parameters: - - in: path - name: ruleset_id + $ref: '#/components/schemas/rulesetsRulesetVersion' + required: true + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id + type: string + - name: account_id + in: path required: true + description: The Cloudflare account ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/rulesets_response' - description: List a zone ruleset's versions response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/rulesets_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List a zone ruleset's versions response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: List a zone ruleset's versions - tags: - - Zone Rulesets + summary: List an account or zone ruleset version's rules by tag + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}': - delete: - description: Deletes an existing version of a zone ruleset. - operationId: zone-rulesets-delete-a-zone-ruleset-version + operationId: >- + get_accounts_account_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag + /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}: + get: + description: >- + Fetches the rules of a managed account or zone ruleset version for a + given tag. parameters: - in: path - name: ruleset_version - required: true + name: rule_tag schema: - $ref: '#/components/schemas/version' - - in: path - name: ruleset_id + $ref: '#/components/schemas/rulesetsRuleCategory' required: true - schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: {} - description: Delete a zone ruleset version response - 4xx: - content: - application/json: {} - description: Delete a zone ruleset version response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a zone ruleset version - tags: - - Zone Rulesets - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches a specific version of a zone ruleset. - operationId: zone-rulesets-get-a-zone-ruleset-version - parameters: - in: path name: ruleset_version - required: true schema: - $ref: '#/components/schemas/version' - - in: path - name: ruleset_id + $ref: '#/components/schemas/rulesetsRulesetVersion' + required: true + - name: ruleset_id + in: path required: true + description: The ruleset ID. schema: - $ref: '#/components/schemas/rulesets_components-schemas-id' - - in: path - name: zone_id + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ruleset_response' - description: Get a zone ruleset version response - 4xx: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A ruleset object. + title: Ruleset + properties: + description: + default: '' + description: An informative description of the ruleset. + title: Description + type: string + id: + $ref: '#/components/schemas/rulesetsRulesetId' + readOnly: true + last_updated: + description: The timestamp of when the ruleset was last modified. + format: date-time + readOnly: true + title: Last Updated + type: string + name: + description: The human-readable name of the ruleset. + minLength: 1 + title: Name + type: string + version: + $ref: '#/components/schemas/rulesetsRulesetVersion' + readOnly: true + kind: + $ref: '#/components/schemas/rulesetsRulesetKind' + phase: + $ref: '#/components/schemas/rulesetsRulesetPhase' + rules: + $ref: '#/components/schemas/rulesetsResponseRules' + required: + - id + - version + - last_updated + - name + - kind + - phase + - rules + type: object + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A ruleset response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ruleset_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a zone ruleset version response failure + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get a zone ruleset version - tags: - - Zone Rulesets + summary: List an account or zone ruleset version's rules by tag + tags: [] + x-api-token-group: + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true + operationId: >- + get_zones_zone_id_rulesets_ruleset_id_versions_ruleset_version_by_tag_rule_tag +components: + schemas: + rulesetsCursor: + description: The cursor to use for the next page. + example: dGhpc2lzYW5leGFtcGxlCg + minLength: 1 + title: Cursor + type: string + rulesetsErrors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + rulesetsMessage: + description: A message. + properties: + code: + description: A unique code for this message. + example: 10000 + title: Code + type: integer + message: + description: A text description of this message. + example: something bad happened + minLength: 1 + title: Description + type: string + source: + description: The source of this message. + properties: + pointer: + description: A JSON pointer to the field that is the source of the message. + example: /rules/0/action + minLength: 1 + title: Pointer + type: string + required: + - pointer + title: Source + type: object + required: + - message + title: Message + type: object + rulesetsMessages: + description: A list of warning messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Messages + type: array + uniqueItems: true + rulesetsPerPage: + description: The number of rulesets to return per page. + example: 3 + maximum: 50 + minimum: 1 + title: Per Page + type: integer + rulesetsRequestRule: + type: object + title: Block Rule + properties: + action: + description: The action to perform when the rule matches. + title: Action + type: string + enum: + - block + action_parameters: + default: {} + description: The parameters configuring the rule's action. + title: Action Parameters + type: object + properties: + response: + description: The response to show when the block is applied. + properties: + content: + description: The content to return. + example: |- + { + "success": false, + "error": "you have been blocked" + } + minLength: 1 + title: Content + type: string + content_type: + description: The type of the content to return. + example: application/json + minLength: 1 + title: Content Type + type: string + status_code: + description: The status code to return. + maximum: 499 + minimum: 400 + title: Status Code + type: integer + required: + - status_code + - content + - content_type + title: Response + type: object + categories: + $ref: '#/components/schemas/rulesetsRuleCategories' + description: + default: '' + description: An informative description of the rule. + title: Description + type: string + example: Block the request. + enabled: + $ref: '#/components/schemas/rulesetsRuleEnabled' + default: true + exposed_credential_check: + $ref: '#/components/schemas/rulesetsRuleExposedCredentialCheck' + expression: + description: The expression defining which traffic will match the rule. + example: ip.src eq 1.1.1.1 + minLength: 1 + title: Expression + type: string + id: + $ref: '#/components/schemas/rulesetsRuleId' + last_updated: + description: The timestamp of when the rule was last modified. + example: '2000-01-01T00:00:00.000000Z' + format: date-time + readOnly: true + title: Last Updated + type: string + x-stainless-skip: + - terraform + logging: + $ref: >- + #/components/schemas/unnamedSchemaRef70f2c6ccd8a405358ac7ef8fc3d6751c + ratelimit: + $ref: '#/components/schemas/rulesetsRuleRatelimit' + ref: + description: The reference of the rule (the rule's ID by default). + example: my_ref + minLength: 1 + title: Ref + type: string + version: + description: The version of the rule. + example: '1' + readOnly: true + title: Version + type: string + x-stainless-skip: + - terraform + required: + - last_updated + - version + rulesetsRequestRules: + default: [] + description: The list of rules in the ruleset. + items: + $ref: '#/components/schemas/rulesetsRequestRule' + title: Rules + type: array + rulesetsResponseRule: + $ref: '#/components/schemas/rulesetsRequestRule' + rulesetsResponseRules: + description: The list of rules in the ruleset. + items: + $ref: '#/components/schemas/rulesetsResponseRule' + title: Rules + type: array + rulesetsResultInfo: + description: Information to navigate the results. + properties: + cursors: + description: The set of cursors. + properties: + after: + $ref: '#/components/schemas/rulesetsCursor' + title: After Cursor + required: + - after + title: Cursors + type: object + title: Result Info + type: object + rulesetsRuleCategories: + description: The categories of the rule. + items: + $ref: '#/components/schemas/rulesetsRuleCategory' + minItems: 1 + readOnly: true + title: Categories + type: array + uniqueItems: true + rulesetsRuleCategory: + description: The category of a rule. + example: directory-traversal + minLength: 1 + title: Category + type: string + rulesetsRuleEnabled: + description: Whether the rule should be executed. + example: true + title: Enabled + type: boolean + rulesetsRuleExposedCredentialCheck: + description: Configuration for exposed credential checking. + properties: + password_expression: + description: >- + An expression that selects the password used in the credentials + check. + example: url_decode(http.request.body.form[\"password\"][0]) + minLength: 1 + title: Password Expression + type: string + username_expression: + description: >- + An expression that selects the user ID used in the credentials + check. + example: url_decode(http.request.body.form[\"username\"][0]) + minLength: 1 + title: Username Expression + type: string + required: + - username_expression + - password_expression + title: Exposed Credential Check + type: object + rulesetsRuleId: + description: The unique ID of the rule. + example: 3a03d665bac047339bb530ecb439a90d + title: Rule ID + type: string + rulesetsRuleLogging: + description: An object configuring the rule's logging behavior. + properties: + enabled: + description: Whether to generate a log when the rule matches. + example: true + title: Enabled + type: boolean + required: + - enabled + title: Logging + type: object + rulesetsRuleRatelimit: + description: An object configuring the rule's rate limit behavior. + properties: + characteristics: + description: >- + Characteristics of the request on which the rate limit counter will + be incremented. + items: + description: The characteristic of the request. + example: cf.colo.id + minLength: 1 + title: Characteristic + type: string + minItems: 1 + title: Characteristics + type: array + uniqueItems: true + counting_expression: + description: >- + An expression that defines when the rate limit counter should be + incremented. It defaults to the same as the rule's expression. + example: http.request.body.raw eq "abcd" + minLength: 1 + title: Counting Expression + type: string + mitigation_timeout: + description: >- + Period of time in seconds after which the action will be disabled + following its first execution. + example: 600 + title: Mitigation Timeout + type: integer + period: + description: Period in seconds over which the counter is being incremented. + example: 60 + minimum: 0 + title: Period + type: integer + requests_per_period: + description: >- + The threshold of requests per period after which the action will be + executed for the first time. + example: 1000 + minimum: 1 + title: Requests per Period + type: integer + requests_to_origin: + default: false + description: Whether counting is only performed when an origin is reached. + example: true + title: Requests to Origin + type: boolean + score_per_period: + description: >- + The score threshold per period for which the action will be executed + the first time. + example: 400 + title: Score per Period + type: integer + score_response_header_name: + description: >- + A response header name provided by the origin, which contains the + score to increment rate limit counter with. + example: my-score + minLength: 1 + title: Score Response Header Name + type: string + required: + - characteristics + - period + title: Rate Limit + type: object + rulesetsRulesetId: + description: The unique ID of the ruleset. + example: 2f2feab2026849078ba485f918791bdc + title: Ruleset ID + type: string + rulesetsRulesetKind: + description: The kind of the ruleset. + enum: + - managed + - custom + - root + - zone + example: root + title: Kind + type: string + rulesetsRulesetPhase: + description: The phase of the ruleset. + enum: + - ddos_l4 + - ddos_l7 + - http_config_settings + - http_custom_errors + - http_log_custom_fields + - http_ratelimit + - http_request_cache_settings + - http_request_dynamic_redirect + - http_request_firewall_custom + - http_request_firewall_managed + - http_request_late_transform + - http_request_origin + - http_request_redirect + - http_request_sanitize + - http_request_sbfm + - http_request_transform + - http_response_cache_settings + - http_response_compression + - http_response_firewall_managed + - http_response_headers_transform + - magic_transit + - magic_transit_ids_managed + - magic_transit_managed + - magic_transit_ratelimit + example: http_request_firewall_custom + title: Phase + type: string + rulesetsRulesetVersion: + description: The version of the ruleset. + example: '1' + title: Version + type: string + unnamedSchemaRef70f2c6ccd8a405358ac7ef8fc3d6751c: + $ref: '#/components/schemas/rulesetsRuleLogging' + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + rulesets: + id: cloudflare.rulesets.rulesets + name: rulesets + title: Rulesets + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rulesets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rulesets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/rulesets/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/rulesets/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/rulesets/methods/list_by_zone' + insert: + - $ref: >- + #/components/x-stackQL-resources/rulesets/methods/create_by_account + - $ref: '#/components/x-stackQL-resources/rulesets/methods/create_by_zone' + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/rulesets/methods/delete_by_account + - $ref: '#/components/x-stackQL-resources/rulesets/methods/delete_by_zone' + replace: + - $ref: >- + #/components/x-stackQL-resources/rulesets/methods/update_by_account + - $ref: '#/components/x-stackQL-resources/rulesets/methods/update_by_zone' + phases: + id: cloudflare.rulesets.phases + name: phases + title: Phases + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/put + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/phases/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/phases/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/phases/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/phases/methods/update_by_zone' + entrypoint_versions: + id: cloudflare.rulesets.entrypoint_versions + name: entrypoint_versions + title: Entrypoint Versions + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint~1versions~1{ruleset_version}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1phases~1{ruleset_phase}~1entrypoint~1versions~1{ruleset_version}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entrypoint_versions/methods/get_by_account + - $ref: >- + #/components/x-stackQL-resources/entrypoint_versions/methods/get_by_zone + - $ref: >- + #/components/x-stackQL-resources/entrypoint_versions/methods/list_by_account + - $ref: >- + #/components/x-stackQL-resources/entrypoint_versions/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + rules: + id: cloudflare.rulesets.rules + name: rules + title: Rules + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1rules/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + edit_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + edit_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/rules/methods/create_by_zone' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/edit_by_account' + - $ref: '#/components/x-stackQL-resources/rules/methods/edit_by_zone' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_by_zone' + replace: [] + rulesets_versions: + id: cloudflare.rulesets.rulesets_versions + name: rulesets_versions + title: Rulesets Versions + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/rulesets_versions/methods/get_by_account + - $ref: >- + #/components/x-stackQL-resources/rulesets_versions/methods/get_by_zone + - $ref: >- + #/components/x-stackQL-resources/rulesets_versions/methods/list_by_account + - $ref: >- + #/components/x-stackQL-resources/rulesets_versions/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + versions: + id: cloudflare.rulesets.versions + name: versions + title: Versions + methods: + delete_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + delete_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/delete_by_account + - $ref: '#/components/x-stackQL-resources/versions/methods/delete_by_zone' + replace: [] + by_tag: + id: cloudflare.rulesets.by_tag + name: by_tag + title: By Tag + methods: + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1rulesets~1{ruleset_id}~1versions~1{ruleset_version}~1by_tag~1{rule_tag}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/by_tag/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/by_tag/methods/get_by_zone' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/rum.yaml b/providers/src/cloudflare/v00.00.00000/services/rum.yaml new file mode 100644 index 00000000..927d4dc8 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/rum.yaml @@ -0,0 +1,1150 @@ +openapi: 3.0.3 +info: + title: rum API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/rum/site_info: + post: + description: Creates a new Web Analytics site. + operationId: web-analytics-create-site + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/rumCreateSiteRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumSiteResponseSingle' + description: Created Web Analytics site. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Web Analytics site + tags: + - Web Analytics + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - site_info + method: create + /accounts/{account_id}/rum/site_info/list: + get: + description: Lists all Web Analytics sites of an account. + operationId: web-analytics-list-sites + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: per_page + schema: + $ref: '#/components/schemas/rumPerPage' + - in: query + name: page + schema: + $ref: '#/components/schemas/rumPage' + - in: query + name: order_by + schema: + $ref: '#/components/schemas/rumOrderBy' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumSitesResponseCollection' + description: List of Web Analytics sites. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Web Analytics sites + tags: + - Web Analytics + x-api-token-group: + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - site_info + method: list + /accounts/{account_id}/rum/site_info/{site_id}: + delete: + description: Deletes an existing Web Analytics site. + operationId: web-analytics-delete-site + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumSiteTagResponseSingle' + description: Deleted Web Analytics site identifier. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Web Analytics site + tags: + - Web Analytics + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - site_info + method: delete + get: + description: Retrieves a Web Analytics site. + operationId: web-analytics-get-site + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumSiteResponseSingle' + description: Web Analytics site. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Web Analytics site + tags: + - Web Analytics + x-api-token-group: + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - site_info + method: get + put: + description: Updates an existing Web Analytics site. + operationId: web-analytics-update-site + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: site_id + in: path + required: true + description: The site ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/rumUpdateSiteRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumSiteResponseSingle' + description: Updated Web Analytics site. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Web Analytics site + tags: + - Web Analytics + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - site_info + method: update + /accounts/{account_id}/rum/v2/{ruleset_id}/rule: + post: + description: Creates a new rule in a Web Analytics ruleset. + operationId: web-analytics-create-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/rumCreateRuleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumRuleResponseSingle' + description: Created Web Analytics rule. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Web Analytics rule + tags: + - Web Analytics + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - rules + method: create + /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}: + delete: + description: Deletes an existing rule from a Web Analytics ruleset. + operationId: web-analytics-delete-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumRuleIdResponseSingle' + description: Deleted Web Analytics rule identifier. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Web Analytics rule + tags: + - Web Analytics + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - rules + method: delete + put: + description: Updates a rule in a Web Analytics ruleset. + operationId: web-analytics-update-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/rumCreateRuleRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumRuleResponseSingle' + description: Updated Web Analytics rule. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Web Analytics rule + tags: + - Web Analytics + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - rules + method: update + /accounts/{account_id}/rum/v2/{ruleset_id}/rules: + get: + description: Lists all the rules in a Web Analytics ruleset. + operationId: web-analytics-list-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumRulesResponseCollection' + description: List of Web Analytics rules in the ruleset. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List rules in Web Analytics ruleset + tags: + - Web Analytics + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - rules + method: list + post: + description: >- + Modifies one or more rules in a Web Analytics ruleset with a single + request. + operationId: web-analytics-modify-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: ruleset_id + in: path + required: true + description: The ruleset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/rumModifyRulesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/rumRulesResponseCollection' + description: List of modified Web Analytics rules. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Web Analytics rules + tags: + - Web Analytics + x-api-token-group: + - Account Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: true + x-stackql-sdk: + service: rum + resource_chain: + - rules + method: bulk_create +components: + schemas: + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + rumApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/rumSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/rumSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + rumAutoInstall: + description: >- + If enabled, the JavaScript snippet is automatically injected for + orange-clouded sites. + example: true + type: boolean + x-auditable: true + rumCreateRuleRequest: + properties: + host: + example: example.com + type: string + inclusive: + description: Whether the rule includes or excludes traffic from being measured. + example: true + type: boolean + is_paused: + description: Whether the rule is paused or not. + example: false + type: boolean + paths: + example: + - '*' + items: + type: string + type: array + type: object + rumCreateSiteRequest: + properties: + auto_install: + $ref: '#/components/schemas/rumAutoInstall' + host: + $ref: '#/components/schemas/rumHost' + zone_tag: + $ref: '#/components/schemas/rumZoneTag' + type: object + rumEnabled: + description: >- + Enables or disables RUM. This option can be used only when auto_install + is set to true. + example: true + type: boolean + x-auditable: true + rumHost: + description: The hostname to use for gray-clouded sites. + example: example.com + type: string + x-auditable: true + rumLite: + description: >- + If enabled, the JavaScript snippet will not be injected for visitors + from the EU. + type: boolean + x-auditable: true + rumMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + rumModifyRulesRequest: + properties: + delete_rules: + description: A list of rule identifiers to delete. + items: + $ref: '#/components/schemas/rumRuleIdentifier' + type: array + rules: + description: A list of rules to create or update. + items: + properties: + host: + example: example.com + type: string + id: + $ref: '#/components/schemas/rumRuleIdentifier' + inclusive: + example: true + type: boolean + is_paused: + example: false + type: boolean + paths: + example: + - '*' + items: + type: string + type: array + type: object + type: array + type: object + rumOrderBy: + description: The property used to sort the list of results. + enum: + - host + - created + example: host + type: string + rumPage: + description: Current page within the paginated list of results. + example: 1 + type: number + rumPerPage: + description: Number of items to return per page of results. + example: 10 + type: number + rumResultInfo: + properties: + count: + description: The total number of items on the current page. + example: 10 + type: integer + page: + description: Current page within the paginated list of results. + example: 1 + type: integer + per_page: + description: The maximum number of items to return per page of results. + example: 10 + type: integer + total_count: + description: The total number of items. + example: 25 + type: integer + total_pages: + description: The total number of pages. + example: 3 + nullable: true + type: integer + type: object + rumRule: + properties: + created: + $ref: '#/components/schemas/rumTimestamp' + host: + description: The hostname the rule will be applied to. + example: example.com + type: string + x-auditable: true + id: + $ref: '#/components/schemas/rumRuleIdentifier' + inclusive: + description: Whether the rule includes or excludes traffic from being measured. + example: true + type: boolean + x-auditable: true + is_paused: + description: Whether the rule is paused or not. + example: false + type: boolean + x-auditable: true + paths: + description: The paths the rule will be applied to. + example: + - '*' + items: + type: string + x-auditable: true + type: array + priority: + example: 1000 + type: number + x-auditable: true + type: object + rumRuleIdResponseSingle: + properties: + errors: + $ref: '#/components/schemas/rumMessages' + messages: + $ref: '#/components/schemas/rumMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/rumRuleIdentifier' + type: object + required: + - success + - errors + - messages + type: object + rumRuleIdentifier: + description: The Web Analytics rule identifier. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + type: string + x-auditable: true + rumRuleResponseSingle: + properties: + errors: + $ref: '#/components/schemas/rumMessages' + messages: + $ref: '#/components/schemas/rumMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + $ref: '#/components/schemas/rumRule' + required: + - success + - errors + - messages + type: object + rumRules: + description: A list of rules. + items: + $ref: '#/components/schemas/rumRule' + type: array + rumRulesResponseCollection: + properties: + errors: + $ref: '#/components/schemas/rumMessages' + messages: + $ref: '#/components/schemas/rumMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + properties: + rules: + $ref: '#/components/schemas/rumRules' + ruleset: + $ref: '#/components/schemas/rumRuleset' + type: object + required: + - success + - errors + - messages + type: object + rumRuleset: + properties: + enabled: + description: Whether the ruleset is enabled. + example: true + type: boolean + id: + $ref: '#/components/schemas/rumRulesetIdentifier' + zone_name: + example: example.com + type: string + zone_tag: + $ref: '#/components/schemas/rumZoneTag' + type: object + rumRulesetIdentifier: + description: The Web Analytics ruleset identifier. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + type: string + x-auditable: true + rumSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + rumSite: + properties: + auto_install: + $ref: '#/components/schemas/rumAutoInstall' + created: + $ref: '#/components/schemas/rumTimestamp' + rules: + $ref: '#/components/schemas/rumRules' + ruleset: + $ref: '#/components/schemas/rumRuleset' + site_tag: + $ref: '#/components/schemas/rumSiteTag' + site_token: + $ref: '#/components/schemas/rumSiteToken' + snippet: + $ref: '#/components/schemas/rumSnippet' + type: object + rumSiteResponseSingle: + properties: + errors: + $ref: '#/components/schemas/rumMessages' + messages: + $ref: '#/components/schemas/rumMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + $ref: '#/components/schemas/rumSite' + required: + - success + - errors + - messages + type: object + rumSiteTag: + description: The Web Analytics site identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + x-auditable: true + rumSiteTagResponseSingle: + properties: + errors: + $ref: '#/components/schemas/rumMessages' + messages: + $ref: '#/components/schemas/rumMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + properties: + site_tag: + $ref: '#/components/schemas/rumSiteTag' + type: object + required: + - success + - errors + - messages + type: object + rumSiteToken: + description: The Web Analytics site token. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + x-auditable: true + rumSitesResponseCollection: + properties: + errors: + $ref: '#/components/schemas/rumMessages' + messages: + $ref: '#/components/schemas/rumMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/rumSite' + type: array + result_info: + $ref: '#/components/schemas/rumResultInfo' + required: + - success + - errors + - messages + type: object + rumSnippet: + description: Encoded JavaScript snippet. + example: >- + + type: string + x-auditable: true + rumTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + rumUpdateSiteRequest: + properties: + auto_install: + $ref: '#/components/schemas/rumAutoInstall' + enabled: + $ref: '#/components/schemas/rumEnabled' + host: + $ref: '#/components/schemas/rumHost' + lite: + $ref: '#/components/schemas/rumLite' + zone_tag: + $ref: '#/components/schemas/rumZoneTag' + type: object + rumZoneTag: + description: The zone identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + site_info: + id: cloudflare.rum.site_info + name: site_info + title: Site Info + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rum~1site_info/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rum~1site_info~1list/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rum~1site_info~1{site_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rum~1site_info~1{site_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rum~1site_info~1{site_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/site_info/methods/get' + - $ref: '#/components/x-stackQL-resources/site_info/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/site_info/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/site_info/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/site_info/methods/update' + rum: + id: cloudflare.rum.rum + name: rum + title: Rum + methods: + create_rule_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rum~1v2~1{ruleset_id}~1rule/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_rules_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rum~1v2~1{ruleset_id}~1rules/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + rules: + id: cloudflare.rum.rules + name: rules + title: Rules + methods: + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rum~1v2~1{ruleset_id}~1rule~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1rum~1v2~1{ruleset_id}~1rule~1{rule_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1rum~1v2~1{ruleset_id}~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/rules/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/schema_validation.yaml b/providers/src/cloudflare/v00.00.00000/services/schema_validation.yaml new file mode 100644 index 00000000..5acd61df --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/schema_validation.yaml @@ -0,0 +1,2133 @@ +openapi: 3.0.3 +info: + title: schema_validation API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/schema_validation/schemas: + get: + description: >- + Lists all OpenAPI schemas uploaded to API Shield with pagination + support. + operationId: schema-validation-list-schemas-paginated + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - description: Omit the source-files of schemas and only retrieve their meta-data. + in: query + name: omit_source + schema: + default: false + type: boolean + - description: Filter for enabled schemas + in: query + name: validation_enabled + schema: + description: Flag whether schema is enabled for validation. + type: boolean + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldPublicSchema' + type: array + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all uploaded schemas + tags: + - Schema Validation + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: schema_validation + resource_chain: + - schemas + method: list + post: + description: >- + Uploads a new OpenAPI schema for API Shield schema validation. The + schema defines expected request/response formats for API endpoints. + operationId: schema-validation-create-schema + requestBody: + content: + application/json: + schema: + properties: + kind: + description: The kind of the schema + enum: + - openapi_v3 + type: string + name: + description: A human-readable name for the schema + type: string + source: + description: >- + The raw schema, e.g., the OpenAPI schema, either as JSON or + YAML + type: string + validation_enabled: + description: An indicator if this schema is enabled + type: boolean + required: + - name + - kind + - source + - validation_enabled + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + items: + properties: + code: + minimum: 1000 + type: integer + description: >- + A unique error code that describes the kind of issue + with the schema + documentation_url: + type: string + message: + type: string + description: A short text explaining the issue with the schema + source: + properties: + pointer: + type: string + locations: + description: >- + A list of JSON path expression(s) that describe + the location(s) of the issue within the provided + resource. See + [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) + for JSONPath specification. + items: + type: string + type: array + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + description: >- + A unique error code that describes the kind of issue + with the schema + documentation_url: + type: string + message: + type: string + description: A short text explaining the issue with the schema + source: + properties: + pointer: + type: string + locations: + description: >- + A list of JSON path expression(s) that describe + the location(s) of the issue within the provided + resource. See + [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) + for JSONPath specification. + items: + type: string + type: array + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldPublicSchema' + required: + - success + - errors + - messages + - result + - messages + description: Successfully uploaded the schema + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: >- + A unique error code that describes the kind of issue + with the schema + documentation_url: + type: string + message: + type: string + description: A short text explaining the issue with the schema + source: + properties: + pointer: + type: string + locations: + description: >- + A list of JSON path expression(s) that describe + the location(s) of the issue within the provided + resource. See + [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) + for JSONPath specification. + items: + type: string + type: array + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + items: + properties: + code: + minimum: 1000 + type: integer + description: >- + A unique error code that describes the kind of issue + with the schema + documentation_url: + type: string + message: + type: string + description: A short text explaining the issue with the schema + source: + properties: + pointer: + type: string + locations: + description: >- + A list of JSON path expression(s) that describe + the location(s) of the issue within the provided + resource. See + [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) + for JSONPath specification. + items: + type: string + type: array + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + description: Failed uploaded the schema + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload a schema + tags: + - Schema Validation + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: schema_validation + resource_chain: + - schemas + method: create + /zones/{zone_id}/schema_validation/schemas/hosts: + get: + description: Lists all unique hosts found in uploaded OpenAPI schemas for the zone. + operationId: schema-validation-list-schema-hosts + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldSchemaHosts' + type: array + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List hosts covered by uploaded schemas + tags: + - Schema Validation + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + /zones/{zone_id}/schema_validation/schemas/{schema_id}: + delete: + description: >- + Permanently removes an uploaded OpenAPI schema from API Shield. + Operations using this schema will lose their validation rules. + operationId: schema-validation-delete-schema + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + description: The ID of the schema that was just deleted + format: uuid + type: string + x-auditable: true + required: + - id + type: object + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a schema + tags: + - Schema Validation + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: The unique identifier of the schema + in: path + name: schema_id + schema: + type: string + $ref: '#/components/schemas/apiShieldSchemasUuid' + format: uuid + readOnly: true + required: true + x-stackql-sdk: + service: schema_validation + resource_chain: + - schemas + method: delete + get: + description: >- + Gets the contents and metadata of a specific OpenAPI schema uploaded to + API Shield. + operationId: schema-validation-get-schema + parameters: + - description: Omit the source-files of schemas and only retrieve their meta-data. + in: query + name: omit_source + schema: + default: false + type: boolean + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: The unique identifier of the schema + in: path + name: schema_id + schema: + type: string + $ref: '#/components/schemas/apiShieldSchemasUuid' + format: uuid + readOnly: true + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPublicSchemaSuccessResult' + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get details of a schema + tags: + - Schema Validation + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: schema_validation + resource_chain: + - schemas + method: get + patch: + description: >- + Modifies an existing OpenAPI schema in API Shield, updating the + validation rules for associated API operations. + operationId: schema-validation-edit-schema + requestBody: + content: + application/json: + schema: + properties: + validation_enabled: + description: Flag whether schema is enabled for validation. + type: boolean + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldPublicSchemaSuccessResult' + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit details of a schema to enable validation + tags: + - Schema Validation + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: The unique identifier of the schema + in: path + name: schema_id + schema: + type: string + $ref: '#/components/schemas/apiShieldSchemasUuid' + format: uuid + readOnly: true + required: true + x-stackql-sdk: + service: schema_validation + resource_chain: + - schemas + method: edit + /zones/{zone_id}/schema_validation/schemas/{schema_id}/operations: + get: + description: >- + Retrieves all operations from the schema. Operations that already exist + in API Shield Endpoint Management will be returned as full operations. + operationId: schema-validation-extract-operations-from-schema + parameters: + - description: >- + Add feature(s) to the results. The feature name that is given here + corresponds to the resulting feature object. Have a look at the + top-level object description for more details on the specific + meaning. + in: query + name: feature + schema: + items: + enum: + - thresholds + - parameter_schemas + - schema_info + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: host + schema: + description: Filter results to only include the specified hosts. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: method + schema: + description: Filter results to only include the specified HTTP methods. + items: + type: string + type: array + uniqueItems: true + explode: true + - in: query + name: endpoint + schema: + description: Filter results to only include endpoints containing this pattern. + type: string + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - description: >- + Filter results by whether operations exist in Web Asset Management + or not. `new` will just return operations from the schema that do + not exist otherwise. `existing` will just return operations from the + schema that already exist. + in: query + name: operation_status + schema: + enum: + - new + - existing + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: The unique identifier of the schema + in: path + name: schema_id + schema: + type: string + $ref: '#/components/schemas/apiShieldSchemasUuid' + format: uuid + readOnly: true + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + type: object + properties: + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + method: + $ref: '#/components/schemas/apiShieldMethod' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + features: + $ref: '#/components/schemas/apiShieldOperationFeatures' + required: + - endpoint + - host + - method + type: array + required: + - success + - errors + - messages + - result + description: All operations in the schema + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve all operations from the schema. + tags: + - Schema Validation + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + /zones/{zone_id}/schema_validation/settings: + get: + description: Retrieves the current global schema validation settings for a zone. + operationId: schema-validation-get-settings + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldGlobalSettings' + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get global schema validation settings + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + method: get + patch: + description: >- + Partially updates global schema validation settings for a zone using + PATCH semantics. + operationId: schema-validation-edit-settings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldGlobalSettingChangeBase' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldGlobalSettings' + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit global schema validation settings + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + method: edit + put: + description: >- + Fully updates global schema validation settings for a zone, replacing + existing configuration. + operationId: schema-validation-update-settings + requestBody: + content: + application/json: + schema: + type: object + $ref: '#/components/schemas/apiShieldGlobalSettingChangeBase' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldGlobalSettings' + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update global schema validation settings + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + method: update + /zones/{zone_id}/schema_validation/settings/operations: + get: + description: >- + Lists all per-operation schema validation settings configured for the + zone. + operationId: schema-validation-list-per-operation-settings + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldPerOperationSetting' + type: array + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List per-operation schema validation settings + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + - operations + method: list + patch: + description: >- + Updates schema validation settings for multiple API operations in a + single request. Efficient for applying consistent validation rules + across endpoints. + operationId: schema-validation-bulk-edit-per-operation-settings + requestBody: + content: + application/json: + schema: + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldPerOperationBulkSettings' + required: + - success + - errors + - messages + - result + description: Update multiple operation-level schema validation settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Bulk edit per-operation schema validation settings + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + - operations + method: bulk_edit + /zones/{zone_id}/schema_validation/settings/operations/{operation_id}: + delete: + description: >- + Removes custom schema validation settings for a specific API operation, + reverting to zone-level defaults. + operationId: schema-validation-delete-per-operation-setting + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + type: object + required: + - success + - errors + - messages + - result + description: Successfully deleted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete per-operation schema validation setting + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + - operations + method: delete + get: + description: >- + Retrieves the schema validation settings configured for a specific API + operation. + operationId: schema-validation-get-per-operation-setting + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldPerOperationSetting' + required: + - success + - errors + - messages + - result + description: Success + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get per-operation schema validation setting + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + - operations + method: get + put: + description: Fully updates schema validation settings for a specific API operation. + operationId: schema-validation-update-per-operation-setting + requestBody: + content: + application/json: + schema: + type: object + $ref: '#/components/schemas/apiShieldPerOperationSettingChangeBase' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldPerOperationSetting' + required: + - success + - errors + - messages + - result + description: Successfully updated + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update per-operation schema validation setting + tags: + - Schema Validation Settings + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Identifier for the operation + in: path + name: operation_id + schema: + $ref: '#/components/schemas/apiShieldUuid' + required: true + x-stackql-sdk: + service: schema_validation + resource_chain: + - settings + - operations + method: update +components: + schemas: + apiShieldApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/apiShieldMessages' + messages: + example: [] + $ref: '#/components/schemas/apiShieldMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + apiShieldAuthIdTokens: + description: The total number of auth-ids seen across this calculation. + readOnly: true + type: integer + x-auditable: true + apiShieldConfidenceIntervalsBounds: + description: Upper and lower bound for percentile estimate + properties: + lower: + description: Lower bound for percentile estimate + example: 20.5 + type: number + x-auditable: true + upper: + description: Upper bound for percentile estimate + example: 30.4 + type: number + x-auditable: true + readOnly: true + type: object + apiShieldDataPoints: + description: The number of data points used for the threshold suggestion calculation. + readOnly: true + type: integer + x-auditable: true + apiShieldEndpoint: + description: >- + The endpoint which can contain path parameter templates in curly braces, + each will be replaced from left to right with {varN}, starting with + {var1}, during insertion. This will further be Cloudflare-normalized + upon insertion. See: + https://developers.cloudflare.com/rules/normalization/how-it-works/. + example: /api/v1/users/{var1} + format: uri-template + maxLength: 4096 + type: string + x-auditable: true + apiShieldGlobalSettingChangeBase: + properties: + validation_default_mitigation_action: + description: >- + The default mitigation action used Mitigation actions are as + follows: - `"log"` - log request when request does not conform to + schema - `"block"` - deny access to the site when request does not + conform to schema - `"none"` - skip running schema validation + enum: + - none + - log + - block + example: block + type: string + x-auditable: true + validation_override_mitigation_action: + description: >- + When set, this overrides both zone level and operation level + mitigation actions. - `"none"` - skip running schema validation + entirely for the request - `null` - clears any existing override + enum: + - none + - null + nullable: true + type: string + x-auditable: true + type: object + apiShieldGlobalSettings: + properties: + validation_default_mitigation_action: + description: >- + The default mitigation action used Mitigation actions are as + follows: - `log` - log request when request does not conform to + schema - `block` - deny access to the site when request does not + conform to schema - `none` - skip running schema validation + enum: + - none + - log + - block + example: block + type: string + x-auditable: true + validation_override_mitigation_action: + description: >- + When not null, this overrides global both zone level and operation + level mitigation actions. This can serve as a quick way to disable + schema validation for the whole zone. - `"none"` will skip running + schema validation entirely for the request + enum: + - none + type: string + x-auditable: true + required: + - validation_default_mitigation_action + type: object + apiShieldHost: + description: RFC3986-compliant host. + example: www.example.com + format: hostname + maxLength: 255 + type: string + x-auditable: true + apiShieldMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + apiShieldMethod: + description: The HTTP method used to access the endpoint. + enum: + - GET + - POST + - HEAD + - OPTIONS + - PUT + - DELETE + - CONNECT + - PATCH + - TRACE + example: GET + type: string + x-auditable: true + apiShieldOperationFeatures: + readOnly: true + type: object + properties: + thresholds: + properties: + auth_id_tokens: + $ref: '#/components/schemas/apiShieldAuthIdTokens' + data_points: + $ref: '#/components/schemas/apiShieldDataPoints' + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + p50: + $ref: '#/components/schemas/apiShieldP50' + p90: + $ref: '#/components/schemas/apiShieldP90' + p99: + $ref: '#/components/schemas/apiShieldP99' + period_seconds: + $ref: '#/components/schemas/apiShieldPeriodSeconds' + requests: + $ref: '#/components/schemas/apiShieldRequests' + suggested_threshold: + $ref: '#/components/schemas/apiShieldSuggestedThreshold' + type: object + parameter_schemas: + properties: + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + parameter_schemas: + $ref: '#/components/schemas/apiShieldParameterSchemasDefinition' + type: object + api_routing: + description: API Routing settings on endpoint. + properties: + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + route: + description: Target route. + example: https://api.example.com/api/service + type: string + x-auditable: true + type: object + confidence_intervals: + properties: + last_updated: + $ref: '#/components/schemas/apiShieldTimestamp' + suggested_threshold: + properties: + confidence_intervals: + properties: + p90: + $ref: '#/components/schemas/apiShieldConfidenceIntervalsBounds' + p95: + $ref: '#/components/schemas/apiShieldConfidenceIntervalsBounds' + p99: + $ref: '#/components/schemas/apiShieldConfidenceIntervalsBounds' + type: object + mean: + description: Suggested threshold. + example: 25.5 + type: number + x-auditable: true + type: object + type: object + schema_info: + properties: + active_schema: + description: Schema active on endpoint. + properties: + created_at: + $ref: '#/components/schemas/apiShieldTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + is_learned: + description: True if schema is Cloudflare-provided. + example: true + type: boolean + x-auditable: true + name: + description: Schema file name. + example: >- + api-endpoints-8694824bf5c04d019edcbf399c03c103-api-discovery.example.com-thresholds.json + type: string + x-auditable: true + type: object + learned_available: + description: >- + True if a Cloudflare-provided learned schema is available for + this endpoint. + example: true + type: boolean + x-auditable: true + mitigation_action: + description: Action taken on requests failing validation. + enum: + - none + - log + - block + example: block + nullable: true + type: string + x-auditable: true + type: object + required: + - last_updated + example: + api_routing: + last_updated: '2014-01-01T05:20:00.12345Z' + route: https://api.example.com/api/service + apiShieldP50: + description: The p50 quantile of requests (in period_seconds). + readOnly: true + type: integer + x-auditable: true + apiShieldP90: + description: The p90 quantile of requests (in period_seconds). + readOnly: true + type: integer + x-auditable: true + apiShieldP99: + description: The p99 quantile of requests (in period_seconds). + readOnly: true + type: integer + x-auditable: true + apiShieldParameterSchemasDefinition: + description: An operation schema object containing a response. + example: + parameters: + - description: >- + Sufficient requests have been observed for this parameter to + provide high confidence in this parameter schema. + in: path + name: var1 + schema: + maximum: 10 + minimum: 1 + type: integer + responses: null + properties: + parameters: + description: An array containing the learned parameter schemas. + example: + - description: >- + Sufficient requests have been observed for this parameter to + provide high confidence in this parameter schema. + in: path + name: var1 + schema: + maximum: 10 + minimum: 1 + type: integer + items: + type: object + readOnly: true + type: array + responses: + description: >- + An empty response object. This field is required to yield a valid + operation schema. + nullable: true + readOnly: true + type: object + readOnly: true + type: object + apiShieldPerOperationBulkSettings: + description: Operation ID to per operation setting mapping + type: object + apiShieldPerOperationSetting: + properties: + mitigation_action: + description: >- + When set, this applies a mitigation action to this operation which + supersedes a global schema validation setting just for this + operation - `"log"` - log request when request does not conform to + schema for this operation - `"block"` - deny access to the site when + request does not conform to schema for this operation - `"none"` - + will skip mitigation for this operation + enum: + - log + - block + - none + example: block + type: string + x-auditable: true + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + required: + - operation_id + - mitigation_action + type: object + apiShieldPerOperationSettingChangeBase: + properties: + mitigation_action: + description: >- + When set, this applies a mitigation action to this operation - + `"log"` - log request when request does not conform to schema for + this operation - `"block"` - deny access to the site when request + does not conform to schema for this operation - `"none"` - will skip + mitigation for this operation - `null` - clears any mitigation + action + enum: + - log + - block + - none + - null + example: block + nullable: true + type: string + x-auditable: true + type: object + apiShieldPeriodSeconds: + description: The period over which this threshold is suggested. + readOnly: true + type: integer + x-auditable: true + apiShieldPublicSchema: + description: A schema used in schema validation + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + kind: + description: The kind of the schema + enum: + - openapi_v3 + example: openapi_v3 + readOnly: true + type: string + x-auditable: true + name: + description: A human-readable name for the schema + example: petstore schema + readOnly: true + type: string + x-auditable: true + schema_id: + type: string + x-auditable: true + $ref: '#/components/schemas/apiShieldSchemasUuid' + description: A unique identifier of this schema + format: uuid + readOnly: true + source: + description: The raw schema, e.g., the OpenAPI schema, either as JSON or YAML + example: + readOnly: true + type: string + x-auditable: true + validation_enabled: + description: An indicator if this schema is enabled + type: boolean + x-auditable: true + required: + - schema_id + - name + - kind + - source + - created_at + type: object + apiShieldPublicSchemaSuccessResult: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/apiShieldPublicSchema' + required: + - success + - errors + - messages + - result + apiShieldRequests: + description: The estimated number of requests covered by these calculations. + readOnly: true + type: integer + x-auditable: true + apiShieldSchemaHosts: + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + hosts: + description: Hosts serving the schema, e.g zone.host.com + items: + type: string + readOnly: true + type: array + x-auditable: true + name: + description: Name of the schema + example: petstore schema + readOnly: true + type: string + x-auditable: true + schema_id: + type: string + x-auditable: true + $ref: '#/components/schemas/apiShieldSchemasUuid' + description: A unique identifier of this schema + format: uuid + readOnly: true + required: + - schema_id + - name + - hosts + - created_at + type: object + apiShieldSchemasTimestamp: + $ref: '#/components/schemas/apiShieldTimestamp' + readOnly: true + type: string + x-auditable: true + apiShieldSchemasUuid: + minLength: 36 + type: string + x-auditable: true + $ref: '#/components/schemas/apiShieldUuid' + apiShieldSuggestedThreshold: + description: >- + The suggested threshold in requests done by the same auth_id or + period_seconds. + readOnly: true + type: integer + x-auditable: true + apiShieldTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + apiShieldUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + schemas: + id: cloudflare.schema_validation.schemas + name: schemas + title: Schemas + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1schema_validation~1schemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1schema_validation~1schemas/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1schemas~1{schema_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1schemas~1{schema_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1schemas~1{schema_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/schemas/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/schemas/methods/delete' + replace: [] + hosts: + id: cloudflare.schema_validation.hosts + name: hosts + title: Hosts + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1schema_validation~1schemas~1hosts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hosts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + schemas_operations: + id: cloudflare.schema_validation.schemas_operations + name: schemas_operations + title: Schemas Operations + methods: + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1schemas~1{schema_id}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/schemas_operations/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + settings: + id: cloudflare.schema_validation.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1schema_validation~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1schema_validation~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1schema_validation~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/edit' + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/update' + settings_operations: + id: cloudflare.schema_validation.settings_operations + name: settings_operations + title: Settings Operations + methods: + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1settings~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/settings_operations/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + operations: + id: cloudflare.schema_validation.operations + name: operations + title: Operations + methods: + bulk_edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1settings~1operations/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1settings~1operations~1{operation_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1settings~1operations~1{operation_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1schema_validation~1settings~1operations~1{operation_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/operations/methods/bulk_edit' + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/operations/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/secrets_store.yaml b/providers/src/cloudflare/v00.00.00000/services/secrets_store.yaml new file mode 100644 index 00000000..a33a0217 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/secrets_store.yaml @@ -0,0 +1,2126 @@ +openapi: 3.0.3 +info: + title: secrets_store API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/secrets_store/quota: + get: + description: Lists the number of secrets used in the account. + operationId: secrets-store-quota + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreQuotaResponse' + description: Usage and quota + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: List store secrets response failure + security: + - api_email: [] + api_key: [] + summary: View secret usage + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + - Secrets Store Read + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - quota + method: get + /accounts/{account_id}/secrets_store/stores: + get: + description: Lists all the stores in an account + operationId: secrets-store-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Direction to sort objects + in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + - description: Page number + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + - description: Order secrets by values in the given field + in: query + name: order + schema: + default: created + enum: + - name + - comment + - created + - modified + - status + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreStoresResponseCollection' + description: List account stores response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: List account stores response failure + security: + - api_email: [] + api_key: [] + summary: List account stores + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + - Secrets Store Read + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.list' + - '#com.cloudflare.api.account.secrets-store.secret.read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + method: list + post: + description: Creates a store in the account + operationId: secrets-store-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreCreateStoreObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreStoreResponse' + description: store details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Create store response failure + security: + - api_email: [] + api_key: [] + summary: Create a store + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + - '#com.cloudflare.api.account.secrets-store.secret.create' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + method: create + /accounts/{account_id}/secrets_store/stores/{store_id}: + delete: + description: Deletes a single store + operationId: secrets-store-delete-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDeleteResponse' + description: Store deleted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Delete store failure + security: + - api_email: [] + api_key: [] + summary: Delete a store + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + method: delete + get: + description: Returns details of a single store + operationId: secrets-store-get-store-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreStoreResponse' + description: store details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: failure + security: + - api_email: [] + api_key: [] + summary: Get a store by ID + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + - Secrets Store Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/secrets_store/stores/{store_id}/secrets: + delete: + description: Deletes one or more secrets + operationId: secrets-store-delete-bulk + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDeleteResponse' + description: Secrets deletion accepted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Delete secrets response failure + security: + - api_email: [] + api_key: [] + summary: Delete secrets + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + - '#com.cloudflare.api.account.secrets-store.secret.delete' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + - secrets + method: bulk_delete + get: + description: Lists all store secrets + operationId: secrets-store-secrets-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - description: Direction to sort objects + in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + - description: Page number + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + - description: >- + Search secrets using a filter string, filtering across name and + comment + in: query + name: search + schema: + type: string + - description: Order secrets by values in the given field + in: query + name: order + schema: + default: created + enum: + - name + - comment + - created + - modified + - status + type: string + - description: Only secrets with the given scopes will be returned + explode: false + in: query + name: scopes + schema: + items: + $ref: '#/components/schemas/secretsStoreScopes' + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretsResponseCollection' + description: List store secrets response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: List store secrets response failure + security: + - api_email: [] + api_key: [] + summary: List store secrets + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + - Secrets Store Read + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.list' + - '#com.cloudflare.api.account.secrets-store.secret.read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + - secrets + method: create + post: + description: Creates a secret in the account + operationId: secrets-store-secret-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/secretsStoreCreateSecretObject' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretsResponseCollection' + description: secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: List store secrets response failure + security: + - api_email: [] + api_key: [] + summary: Create a secret + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + - '#com.cloudflare.api.account.secrets-store.secret.create' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}: + delete: + description: Deletes a single secret + operationId: secrets-store-secret-delete-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDeleteResponse' + description: Secret deletion accepted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Delete secret failure + security: + - api_email: [] + api_key: [] + summary: Delete a secret + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + - secrets + method: delete + get: + description: Returns details of a single secret + operationId: secrets-store-get-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretResponse' + description: secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: failure + security: + - api_email: [] + api_key: [] + summary: Get a secret by ID + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + - Secrets Store Read + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + - secrets + method: get + patch: + description: Updates a single secret + operationId: secrets-store-patch-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStorePatchSecretObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretResponse' + description: secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: failure + security: + - api_email: [] + api_key: [] + summary: Patch a secret + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + - secrets + method: edit + /accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}/duplicate: + post: + description: Duplicates the secret, keeping the value + operationId: secrets-store-duplicate-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDuplicateSecretObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretResponse' + description: secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: failure + security: + - api_email: [] + api_key: [] + summary: Duplicate Secret + tags: + - Secrets Store + x-api-token-group: + - Secrets Store Write + x-cfPermissionsRequired: + enum: + - '#com.cloudflare.api.account.secrets-store.secret.read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: secrets_store + resource_chain: + - stores + - secrets + method: duplicate + /system/accounts/{account_tag}/stores: + get: + description: >- + Lists all stores in an account that are managed by the calling service. + Only returns stores where managed_by matches the authenticated service. + operationId: secrets-store-system-list + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - description: Direction to sort objects + in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + - description: Page number + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + - description: Order secrets by values in the given field + in: query + name: order + schema: + default: created + enum: + - name + - comment + - created + - modified + - status + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreStoresResponseCollection' + description: List account stores response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: List account stores response failure + security: + - api_email: [] + api_key: [] + summary: List account stores (System) + tags: + - Secrets Store + x-stability: internal + post: + description: >- + Creates a store in the account on behalf of the calling service. The + store will be marked as managed by the authenticated service. Requires + account_id in the request body. + operationId: secrets-store-system-create + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreCreateStoreObjectSystem' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreStoreResponse' + description: Store details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Create store failure + security: + - api_email: [] + api_key: [] + summary: Create a store (System) + tags: + - Secrets Store + x-stability: internal + /system/accounts/{account_tag}/stores/{store_id}: + delete: + description: >- + Deletes a store managed by the calling service. Returns 404 if the store + doesn't exist or is not managed by the authenticated service. + operationId: secrets-store-system-delete-by-id + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDeleteResponse' + description: Store deleted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Delete store failure + security: + - api_email: [] + api_key: [] + summary: Delete a store (System) + tags: + - Secrets Store + x-stability: internal + get: + description: >- + Returns details of a single store managed by the calling service. + Returns 404 if the store doesn't exist or is not managed by the + authenticated service. + operationId: secrets-store-system-get-store-by-id + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreStoreResponse' + description: Store details + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Get store failure + security: + - api_email: [] + api_key: [] + summary: Get a store by ID (System) + tags: + - Secrets Store + x-stability: internal + /system/accounts/{account_tag}/stores/{store_id}/secrets: + delete: + description: >- + Deletes one or more secrets from a store managed by the calling service. + Returns 404 if the store doesn't exist or is not managed by the + authenticated service. + operationId: secrets-store-system-delete-bulk + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDeleteResponse' + description: Secrets deletion accepted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Delete secrets failure + security: + - api_email: [] + api_key: [] + summary: Delete secrets (System) + tags: + - Secrets Store + x-stability: internal + get: + description: >- + Lists all secrets in a store managed by the calling service. Returns 404 + if the store doesn't exist or is not managed by the authenticated + service. + operationId: secrets-store-system-secrets-list + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - description: Direction to sort objects + in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + - description: Page number + in: query + name: page + schema: + minimum: 0 + multipleOf: 1 + type: integer + - description: Number of objects to return per page + in: query + name: per_page + schema: + maximum: 100 + minimum: 0 + multipleOf: 1 + type: integer + - description: >- + Search secrets using a filter string, filtering across name and + comment + in: query + name: search + schema: + type: string + - description: Order secrets by values in the given field + in: query + name: order + schema: + default: created + enum: + - name + - comment + - created + - modified + - status + type: string + - description: Only secrets with the given scopes will be returned + explode: false + in: query + name: scopes + schema: + items: + $ref: '#/components/schemas/secretsStoreScopes' + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretsResponseCollection' + description: List store secrets response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: List store secrets response failure + security: + - api_email: [] + api_key: [] + summary: List store secrets (System) + tags: + - Secrets Store + x-stability: internal + post: + description: >- + Creates one or more secrets in a store managed by the calling service. + Returns 404 if the store doesn't exist or is not managed by the + authenticated service. + operationId: secrets-store-system-secret-create + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/secretsStoreCreateSecretObject' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretsResponseCollection' + description: Secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Create secrets failure + security: + - api_email: [] + api_key: [] + summary: Create secrets (System) + tags: + - Secrets Store + x-stability: internal + /system/accounts/{account_tag}/stores/{store_id}/secrets/{secret_id}: + delete: + description: >- + Deletes a single secret from a store managed by the calling service. + Returns 404 if the store doesn't exist or is not managed by the + authenticated service. + operationId: secrets-store-system-secret-delete-by-id + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDeleteResponse' + description: Secret deletion accepted + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Delete secret failure + security: + - api_email: [] + api_key: [] + summary: Delete a secret (System) + tags: + - Secrets Store + x-stability: internal + get: + description: >- + Returns details of a single secret from a store managed by the calling + service. Returns 404 if the store doesn't exist or is not managed by the + authenticated service. + operationId: secrets-store-system-get-by-id + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretResponse' + description: Secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Get secret failure + security: + - api_email: [] + api_key: [] + summary: Get a secret by ID (System) + tags: + - Secrets Store + x-stability: internal + patch: + description: >- + Updates a single secret in a store managed by the calling service. + Returns 404 if the store doesn't exist or is not managed by the + authenticated service. + operationId: secrets-store-system-patch-by-id + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStorePatchSecretObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretResponse' + description: Secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Patch secret failure + security: + - api_email: [] + api_key: [] + summary: Patch a secret (System) + tags: + - Secrets Store + x-stability: internal + /system/accounts/{account_tag}/stores/{store_id}/secrets/{secret_id}/duplicate: + post: + description: >- + Duplicates a secret in a store managed by the calling service, keeping + the value. Returns 404 if the store doesn't exist or is not managed by + the authenticated service. + operationId: secrets-store-system-duplicate-by-id + parameters: + - description: >- + Account tag identifier (e.g., '12a6ed19f349896cfbd6694ba3de8d31'). + This is the account's external tag identifier, not the numeric + account ID. + in: path + name: account_tag + schema: + $ref: '#/components/schemas/secretsStoreAccountTag' + required: true + - name: store_id + in: path + required: true + description: The secrets store ID. + schema: + type: string + - name: secret_id + in: path + required: true + description: The secret ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreDuplicateSecretObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreSecretResponse' + description: Secret detail + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/secretsStoreApiResponseCommonFailure' + description: Duplicate secret failure + security: + - api_email: [] + api_key: [] + summary: Duplicate secret (System) + tags: + - Secrets Store + x-stability: internal +components: + schemas: + secretsStoreAccountIdentifier: + description: Account Identifier + example: 985e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + secretsStoreAccountTag: + description: Account tag identifier + example: 12a6ed19f349896cfbd6694ba3de8d31 + type: string + secretsStoreApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/secretsStoreMessages' + messages: + example: [] + $ref: '#/components/schemas/secretsStoreMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + secretsStoreComment: + description: Freeform text describing the secret + example: info about my secret + type: string + x-auditable: true + secretsStoreCreateSecretObject: + properties: + comment: + $ref: '#/components/schemas/secretsStoreComment' + name: + $ref: '#/components/schemas/secretsStoreSecretName' + scopes: + $ref: '#/components/schemas/secretsStoreScopes' + value: + $ref: '#/components/schemas/secretsStoreValue' + required: + - name + - value + - scopes + type: object + secretsStoreCreateStoreObject: + properties: + name: + $ref: '#/components/schemas/secretsStoreStoreName' + required: + - name + type: object + secretsStoreCreateStoreObjectSystem: + description: Request body for creating a store via system API routes + properties: + account_id: + description: >- + Account internal ID (numeric). Required for system API routes. This + value must remain consistent for all stores within an account + managed by the same service. + example: 12345 + format: int64 + type: integer + name: + $ref: '#/components/schemas/secretsStoreStoreName' + required: + - name + - account_id + type: object + secretsStoreCreated: + description: Whenthe secret was created. + example: '2023-09-21T18:56:32.624632Z' + format: date-time + readOnly: true + type: string + x-auditable: true + secretsStoreDeleteResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secretsStoreMessages' + messages: + $ref: '#/components/schemas/secretsStoreMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: Result is null for delete operations. + nullable: true + type: object + required: + - success + - errors + - messages + secretsStoreDuplicateSecretObject: + properties: + comment: + $ref: '#/components/schemas/secretsStoreComment' + name: + $ref: '#/components/schemas/secretsStoreSecretName' + scopes: + $ref: '#/components/schemas/secretsStoreScopes' + required: + - name + - scopes + type: object + secretsStoreIdentifier: + description: Secret identifier tag. + example: 3fd85f74b32742f1bff64a85009dda07 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + secretsStoreMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + secretsStoreModified: + description: When the secret was modified. + example: '2023-09-21T18:56:32.624632Z' + format: date-time + readOnly: true + type: string + x-auditable: true + secretsStorePatchSecretObject: + properties: + comment: + $ref: '#/components/schemas/secretsStoreComment' + scopes: + $ref: '#/components/schemas/secretsStoreScopes' + value: + $ref: '#/components/schemas/secretsStoreValue' + type: object + secretsStoreQuota: + description: The number of secrets the account is entitlted to use + example: 10 + type: number + x-auditable: true + secretsStoreQuotaResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secretsStoreMessages' + messages: + $ref: '#/components/schemas/secretsStoreMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + $ref: '#/components/schemas/secretsStoreSecretsUsageObject' + required: + - success + - errors + - messages + secretsStoreScopes: + description: The list of services that can use this secret. + example: + - workers + - ai_gateway + - dex + - access + items: + type: string + type: array + secretsStoreSecretName: + description: The name of the secret + example: MY_API_KEY + type: string + secretsStoreSecretObject: + properties: + comment: + $ref: '#/components/schemas/secretsStoreComment' + created: + $ref: '#/components/schemas/secretsStoreCreated' + id: + $ref: '#/components/schemas/secretsStoreIdentifier' + modified: + $ref: '#/components/schemas/secretsStoreModified' + name: + $ref: '#/components/schemas/secretsStoreSecretName' + scopes: + $ref: '#/components/schemas/secretsStoreScopes' + status: + $ref: '#/components/schemas/secretsStoreSecretStatus' + store_id: + $ref: '#/components/schemas/secretsStoreStoreIdentifier' + required: + - id + - name + - store_id + - created + - modified + - status + type: object + secretsStoreSecretResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secretsStoreMessages' + messages: + $ref: '#/components/schemas/secretsStoreMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + $ref: '#/components/schemas/secretsStoreSecretObject' + required: + - success + - errors + - messages + secretsStoreSecretStatus: + enum: + - pending + - active + - deleted + type: string + x-auditable: true + secretsStoreSecretsResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/secretsStoreMessages' + messages: + $ref: '#/components/schemas/secretsStoreMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/secretsStoreSecretObject' + type: array + required: + - success + - errors + - messages + secretsStoreSecretsUsageObject: + properties: + secrets: + $ref: '#/components/schemas/secretsStoreUsageQuotaObject' + required: + - secrets + type: object + secretsStoreStoreIdentifier: + description: Store Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + secretsStoreStoreName: + description: The name of the store + example: service_x_keys + type: string + secretsStoreStoreObject: + properties: + account_id: + $ref: '#/components/schemas/secretsStoreAccountIdentifier' + created: + $ref: '#/components/schemas/secretsStoreCreated' + id: + $ref: '#/components/schemas/secretsStoreStoreIdentifier' + modified: + $ref: '#/components/schemas/secretsStoreModified' + name: + $ref: '#/components/schemas/secretsStoreStoreName' + required: + - id + - name + - created + - modified + type: object + secretsStoreStoreResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/secretsStoreMessages' + messages: + $ref: '#/components/schemas/secretsStoreMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + $ref: '#/components/schemas/secretsStoreStoreObject' + required: + - success + - errors + - messages + secretsStoreStoresResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/secretsStoreMessages' + messages: + $ref: '#/components/schemas/secretsStoreMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/secretsStoreStoreObject' + type: array + required: + - success + - errors + - messages + secretsStoreUsage: + description: The number of secrets the account is currently using + example: 10 + type: number + x-auditable: true + secretsStoreUsageQuotaObject: + properties: + quota: + $ref: '#/components/schemas/secretsStoreQuota' + usage: + $ref: '#/components/schemas/secretsStoreUsage' + required: + - usage + - quota + type: object + secretsStoreValue: + description: >- + The value of the secret. Maximum 64 KiB (65,536 bytes). Note that this + is 'write only' - no API response will provide this value, it is only + used to create/modify secrets. + example: api-token-secret-123 + maxLength: 65536 + type: string + writeOnly: true + x-sensitive: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + quota: + id: cloudflare.secrets_store.quota + name: quota + title: Quota + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secrets_store~1quota/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quota/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + stores: + id: cloudflare.secrets_store.stores + name: stores + title: Stores + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secrets_store~1stores/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1secrets_store~1stores/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_system: + operation: + $ref: '#/paths/~1system~1accounts~1{account_tag}~1stores/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + secrets_store_system_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1system~1accounts~1{account_tag}~1stores/post' + response: + mediaType: application/json + openAPIDocKey: '200' + secrets_store_system_delete_by_id: + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_system: + operation: + $ref: '#/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stores/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/stores/methods/get_by_system' + - $ref: '#/components/x-stackQL-resources/stores/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/stores/methods/list_by_system' + insert: + - $ref: '#/components/x-stackQL-resources/stores/methods/create' + - $ref: >- + #/components/x-stackQL-resources/stores/methods/secrets_store_system_create + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/stores/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/stores/methods/secrets_store_system_delete_by_id + replace: [] + secrets: + id: cloudflare.secrets_store.secrets + name: secrets + title: Secrets + methods: + bulk_delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}~1secrets/delete + response: + mediaType: application/json + openAPIDocKey: '202' + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}~1secrets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + secrets_store_secret_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}~1secrets/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}~1secrets~1{secret_id}/delete + response: + mediaType: application/json + openAPIDocKey: '202' + get_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}~1secrets~1{secret_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}~1secrets~1{secret_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + duplicate_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1secrets_store~1stores~1{store_id}~1secrets~1{secret_id}~1duplicate/post + response: + mediaType: application/json + openAPIDocKey: '200' + secrets_store_system_delete_bulk: + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}~1secrets/delete + response: + mediaType: application/json + openAPIDocKey: '202' + list_by_system: + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}~1secrets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + secrets_store_system_secret_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}~1secrets/post + response: + mediaType: application/json + openAPIDocKey: '200' + secrets_store_system_secret_delete_by_id: + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}~1secrets~1{secret_id}/delete + response: + mediaType: application/json + openAPIDocKey: '202' + get_by_system: + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}~1secrets~1{secret_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + secrets_store_system_patch_by_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}~1secrets~1{secret_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + duplicate_by_system: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1system~1accounts~1{account_tag}~1stores~1{store_id}~1secrets~1{secret_id}~1duplicate/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secrets/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/secrets/methods/get_by_system' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list_by_system' + insert: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/duplicate_by_account + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/secrets_store_secret_create + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/secrets_store_system_secret_create + update: + - $ref: '#/components/x-stackQL-resources/secrets/methods/edit' + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/secrets_store_system_patch_by_id + delete: + - $ref: '#/components/x-stackQL-resources/secrets/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/secrets_store_system_secret_delete_by_id + - $ref: '#/components/x-stackQL-resources/secrets/methods/bulk_delete' + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/secrets_store_system_delete_bulk + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/security_center.yaml b/providers/src/cloudflare/v00.00.00000/services/security_center.yaml new file mode 100644 index 00000000..67fdacd2 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/security_center.yaml @@ -0,0 +1,2363 @@ +openapi: 3.0.3 +info: + title: security_center API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/security-center/insights/{issue_id}/context: + get: + description: >- + Returns the full context payload for an insight. This endpoint is used + for insights with large payloads that are not included inline in the + list response. + operationId: get-security-center-insight-context + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + type: object + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insight Context + tags: + - Security Center Insights + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - context + method: get + /accounts/{account_id}/security-center/insights: + get: + description: >- + Lists all Security Center insights for the account or zone, showing + security findings and recommendations. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: page + schema: + default: 1 + $ref: '#/components/schemas/securityCenterPage' + - in: query + name: per_page + schema: + default: 25 + $ref: '#/components/schemas/securityCenterPerPage' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + count: + $ref: '#/components/schemas/securityCenterCount' + issues: + items: + $ref: '#/components/schemas/securityCenterIssue' + type: array + page: + $ref: '#/components/schemas/securityCenterPage' + per_page: + $ref: '#/components/schemas/securityCenterPerPage' + type: object + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insights + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + method: list + operationId: get_accounts_account_id_security_center_insights + /zones/{zone_id}/security-center/insights: + get: + description: >- + Lists all Security Center insights for the account or zone, showing + security findings and recommendations. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: page + schema: + default: 1 + $ref: '#/components/schemas/securityCenterPage' + - in: query + name: per_page + schema: + default: 25 + $ref: '#/components/schemas/securityCenterPerPage' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + count: + $ref: '#/components/schemas/securityCenterCount' + issues: + items: + $ref: '#/components/schemas/securityCenterIssue' + type: array + page: + $ref: '#/components/schemas/securityCenterPage' + per_page: + $ref: '#/components/schemas/securityCenterPerPage' + type: object + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insights + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + method: list + operationId: get_zones_zone_id_security_center_insights + /accounts/{account_id}/security-center/insights/audit-log: + get: + description: >- + Lists audit log entries for all Security Center insights in the account + or zone, showing changes to insight status and classification. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Number of results per page. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 1 + type: integer + - description: >- + Opaque cursor for pagination. Use the cursor value from result_info + of the previous response. + in: query + name: cursor + schema: + type: string + - description: Filter by the field that was changed. + in: query + name: field_changed + schema: + enum: + - status + - user_classification + type: string + - description: Filter by the actor that made the change. + in: query + name: changed_by + schema: + type: string + - description: Filter entries changed at or after this timestamp (RFC 3339). + in: query + name: since + schema: + format: date-time + type: string + - description: Filter entries changed before this timestamp (RFC 3339). + in: query + name: before + schema: + format: date-time + type: string + - description: >- + Sort order for results. Use 'asc' for oldest first or 'desc' for + newest first. + in: query + name: order + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterAuditLogResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves account or zone Audit Log + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - audit_logs + method: list + operationId: get_accounts_account_id_security_center_insights_audit_log + /zones/{zone_id}/security-center/insights/audit-log: + get: + description: >- + Lists audit log entries for all Security Center insights in the account + or zone, showing changes to insight status and classification. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Number of results per page. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 1 + type: integer + - description: >- + Opaque cursor for pagination. Use the cursor value from result_info + of the previous response. + in: query + name: cursor + schema: + type: string + - description: Filter by the field that was changed. + in: query + name: field_changed + schema: + enum: + - status + - user_classification + type: string + - description: Filter by the actor that made the change. + in: query + name: changed_by + schema: + type: string + - description: Filter entries changed at or after this timestamp (RFC 3339). + in: query + name: since + schema: + format: date-time + type: string + - description: Filter entries changed before this timestamp (RFC 3339). + in: query + name: before + schema: + format: date-time + type: string + - description: >- + Sort order for results. Use 'asc' for oldest first or 'desc' for + newest first. + in: query + name: order + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterAuditLogResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves account or zone Audit Log + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - audit_logs + method: list + operationId: get_zones_zone_id_security_center_insights_audit_log + /accounts/{account_id}/security-center/insights/class: + get: + description: >- + Retrieves Security Center insight counts aggregated by classification + class. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insight Counts by Class + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - class_ + method: get + operationId: get_accounts_account_id_security_center_insights_class + /zones/{zone_id}/security-center/insights/class: + get: + description: >- + Retrieves Security Center insight counts aggregated by classification + class. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insight Counts by Class + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - class_ + method: get + operationId: get_zones_zone_id_security_center_insights_class + /accounts/{account_id}/security-center/insights/scans: + get: + description: >- + Returns the most recent on-demand scans for the account or zone, up to a + maximum of 5. Each scan includes its ID, start time, and current status. + This includes both account or zone-wide and zone-scoped scans. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/securityCenterScanStatusResponse' + type: array + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Recent account or zone Scans + tags: [] + operationId: get_accounts_account_id_security_center_insights_scans + post: + description: >- + Initiates an on-demand security scan for the entire account or zone, + scanning all zones associated with the account or zone. Rate limited to + 5 scans per account or zone per 24-hour window. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterNewScanRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/securityCenterNewScanResponse' + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Start On-Demand account or zone Scan + tags: [] + operationId: post_accounts_account_id_security_center_insights_scans + /zones/{zone_id}/security-center/insights/scans: + get: + description: >- + Returns the most recent on-demand scans for the account or zone, up to a + maximum of 5. Each scan includes its ID, start time, and current status. + This includes both account or zone-wide and zone-scoped scans. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/securityCenterScanStatusResponse' + type: array + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Recent account or zone Scans + tags: [] + operationId: get_zones_zone_id_security_center_insights_scans + post: + description: >- + Initiates an on-demand security scan for the entire account or zone, + scanning all zones associated with the account or zone. Rate limited to + 5 scans per account or zone per 24-hour window. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterNewScanRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/securityCenterNewScanResponse' + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Start On-Demand account or zone Scan + tags: [] + operationId: post_zones_zone_id_security_center_insights_scans + /accounts/{account_id}/security-center/insights/severity: + get: + description: >- + Retrieves Security Center insight counts aggregated by severity level + (critical, high, medium, low). + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insight Counts by Severity + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - severity + method: get + operationId: get_accounts_account_id_security_center_insights_severity + /zones/{zone_id}/security-center/insights/severity: + get: + description: >- + Retrieves Security Center insight counts aggregated by severity level + (critical, high, medium, low). + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insight Counts by Severity + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - severity + method: get + operationId: get_zones_zone_id_security_center_insights_severity + /accounts/{account_id}/security-center/insights/type: + get: + description: Retrieves Security Center insight counts aggregated by insight type. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insight Counts by Type + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - type + method: get + operationId: get_accounts_account_id_security_center_insights_type + /zones/{zone_id}/security-center/insights/type: + get: + description: Retrieves Security Center insight counts aggregated by insight type. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: dismissed + schema: + $ref: '#/components/schemas/securityCenterDismissed' + - in: query + name: issue_class + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject + schema: + $ref: '#/components/schemas/securityCenterSubjects' + - in: query + name: issue_class~neq + schema: + $ref: '#/components/schemas/securityCenterIssueClasses' + - in: query + name: issue_type~neq + schema: + $ref: '#/components/schemas/securityCenterIssueTypes' + - in: query + name: product~neq + schema: + $ref: '#/components/schemas/securityCenterProducts' + - in: query + name: severity~neq + schema: + $ref: '#/components/schemas/securityCenterSeverityQueryParam' + - in: query + name: subject~neq + schema: + $ref: '#/components/schemas/securityCenterSubjects' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterValueCountsResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Security Center Insight Counts by Type + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - type + method: get + operationId: get_zones_zone_id_security_center_insights_type + /accounts/{account_id}/security-center/insights/{issue_id}/audit-log: + get: + description: >- + Lists audit log entries for a specific Security Center insight, showing + changes to its status and classification over time. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + - description: Number of results per page. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 1 + type: integer + - description: >- + Opaque cursor for pagination. Use the cursor value from result_info + of the previous response. + in: query + name: cursor + schema: + type: string + - description: Filter by the field that was changed. + in: query + name: field_changed + schema: + enum: + - status + - user_classification + type: string + - description: Filter by the actor that made the change. + in: query + name: changed_by + schema: + type: string + - description: Filter entries changed at or after this timestamp (RFC 3339). + in: query + name: since + schema: + format: date-time + type: string + - description: Filter entries changed before this timestamp (RFC 3339). + in: query + name: before + schema: + format: date-time + type: string + - description: >- + Sort order for results. Use 'asc' for oldest first or 'desc' for + newest first. + in: query + name: order + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterAuditLogResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Issue Audit Log + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - audit_logs + method: list_by_insight + operationId: get_accounts_account_id_security_center_insights_issue_id_audit_log + /zones/{zone_id}/security-center/insights/{issue_id}/audit-log: + get: + description: >- + Lists audit log entries for a specific Security Center insight, showing + changes to its status and classification over time. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + - description: Number of results per page. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 1 + type: integer + - description: >- + Opaque cursor for pagination. Use the cursor value from result_info + of the previous response. + in: query + name: cursor + schema: + type: string + - description: Filter by the field that was changed. + in: query + name: field_changed + schema: + enum: + - status + - user_classification + type: string + - description: Filter by the actor that made the change. + in: query + name: changed_by + schema: + type: string + - description: Filter entries changed at or after this timestamp (RFC 3339). + in: query + name: since + schema: + format: date-time + type: string + - description: Filter entries changed before this timestamp (RFC 3339). + in: query + name: before + schema: + format: date-time + type: string + - description: >- + Sort order for results. Use 'asc' for oldest first or 'desc' for + newest first. + in: query + name: order + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterAuditLogResponse' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves Issue Audit Log + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - audit_logs + method: list_by_insight + operationId: get_zones_zone_id_security_center_insights_issue_id_audit_log + /accounts/{account_id}/security-center/insights/{issue_id}/classification: + patch: + description: >- + Updates the user classification for a Security Center insight. Valid + values are 'false_positive' or 'accept_risk'. To reset, set + classification to null. Cannot change directly between classification + values - must reset to null first. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterUserClassificationUpdate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseSingle' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Updates Security Center Insight Classification + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - classification + method: update + operationId: >- + patch_accounts_account_id_security_center_insights_issue_id_classification + /zones/{zone_id}/security-center/insights/{issue_id}/classification: + patch: + description: >- + Updates the user classification for a Security Center insight. Valid + values are 'false_positive' or 'accept_risk'. To reset, set + classification to null. Cannot change directly between classification + values - must reset to null first. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterUserClassificationUpdate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseSingle' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Updates Security Center Insight Classification + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + - classification + method: update + operationId: patch_zones_zone_id_security_center_insights_issue_id_classification + /accounts/{account_id}/security-center/insights/{issue_id}/dismiss: + put: + description: >- + Archives a Security Center insight for an account or zone, removing it + from the active insights list while preserving historical data. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + dismiss: + default: true + type: boolean + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseSingle' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Archives Security Center Insight + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + method: dismiss + operationId: put_accounts_account_id_security_center_insights_issue_id_dismiss + /zones/{zone_id}/security-center/insights/{issue_id}/dismiss: + put: + description: >- + Archives a Security Center insight for an account or zone, removing it + from the active insights list while preserving historical data. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: issue_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + properties: + dismiss: + default: true + type: boolean + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseSingle' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Archives Security Center Insight + tags: [] + x-stackql-sdk: + service: security_center + resource_chain: + - insights + method: dismiss + operationId: put_zones_zone_id_security_center_insights_issue_id_dismiss +components: + schemas: + securityCenterApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + securityCenterApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/securityCenterMessages' + messages: + example: [] + $ref: '#/components/schemas/securityCenterMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + securityCenterApiResponseSingle: + type: object + $ref: '#/components/schemas/securityCenterApiResponseCommon' + securityCenterAuditLog: + properties: + changed_at: + description: The timestamp when the change occurred. + format: date-time + type: string + x-auditable: true + changed_by: + description: >- + The actor that made the change. 'system' for automated changes, or a + user identifier. + example: system + type: string + x-auditable: true + current_value: + description: >- + The value of the field after the change. Null if the field was + cleared. + nullable: true + type: string + x-auditable: true + field_changed: + description: The field that was changed. + enum: + - status + - user_classification + type: string + x-auditable: true + id: + description: UUIDv7 identifier for the audit log entry, time-ordered. + format: uuid + type: string + x-auditable: true + issue_id: + description: The ID of the insight this audit log entry relates to. + type: string + x-auditable: true + previous_value: + description: >- + The value of the field before the change. Null if the field was not + previously set. + nullable: true + type: string + x-auditable: true + rationale: + description: Optional rationale provided for the change. + nullable: true + type: string + x-auditable: true + zone_id: + description: >- + The zone ID associated with the insight. Only present for zone-level + insights. + format: int64 + type: integer + x-auditable: true + type: object + securityCenterAuditLogResponse: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/securityCenterAuditLog' + type: array + result_info: + properties: + count: + description: The number of items in the current result set. + example: 25 + type: integer + cursor: + description: >- + Opaque cursor for the next page of results. Absent when there + are no more results. + type: string + per_page: + description: The requested number of items per page. + example: 25 + type: integer + type: object + required: + - success + - errors + - messages + type: object + securityCenterCount: + description: Indicates the total number of results. + example: 1 + type: integer + x-auditable: true + securityCenterDismissed: + example: false + type: boolean + x-auditable: true + securityCenterIssue: + properties: + dismissed: + example: false + type: boolean + x-auditable: true + has_extended_context: + description: >- + Indicates whether the insight has a large payload that requires + fetching via the context endpoint. + example: false + type: boolean + x-auditable: true + id: + type: string + x-auditable: true + issue_class: + $ref: '#/components/schemas/securityCenterIssueClass' + issue_type: + $ref: '#/components/schemas/securityCenterIssueType' + payload: + properties: + detection_method: + description: Describes the method used to detect insight. + example: >- + We detected security rules referencing multiple IP addresses + directly in the rules. + type: string + x-auditable: true + zone_tag: + type: string + x-auditable: true + type: object + resolve_link: + type: string + x-auditable: true + resolve_text: + type: string + x-auditable: true + severity: + enum: + - Low + - Moderate + - Critical + type: string + x-auditable: true + since: + format: date-time + type: string + x-auditable: true + status: + description: The current status of the insight. + enum: + - active + - resolved + example: active + type: string + x-auditable: true + subject: + $ref: '#/components/schemas/securityCenterSubject' + timestamp: + format: date-time + type: string + x-auditable: true + user_classification: + $ref: '#/components/schemas/securityCenterUserClassification' + type: object + securityCenterIssueClass: + example: always_use_https_not_enabled + type: string + x-auditable: true + securityCenterIssueClasses: + example: + - a_record_dangling + - always_use_https_not_enabled + items: + $ref: '#/components/schemas/securityCenterIssueClass' + type: array + securityCenterIssueType: + enum: + - compliance_violation + - email_security + - exposed_infrastructure + - insecure_configuration + - weak_authentication + - configuration_suggestion + type: string + x-auditable: true + securityCenterIssueTypes: + example: + - compliance_violation + - email_security + items: + $ref: '#/components/schemas/securityCenterIssueType' + type: array + securityCenterMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + securityCenterNewScanRequest: + description: >- + Request body for starting an on-demand scan. Specify issue_type or + issue_class to scope the scan, or provide an empty object to scan all + issue types. + type: object + properties: + issue_type: + $ref: '#/components/schemas/securityCenterIssueType' + issue_class: + $ref: '#/components/schemas/securityCenterIssueClass' + required: [] + securityCenterNewScanResponse: + properties: + scan_id: + description: An opaque identifier for the initiated scan. + example: d5e94e48-504f-4a7f-a8c4-e0dc2e05e5f2 + type: string + x-auditable: true + type: object + securityCenterPage: + description: Specifies the current page within paginated list of results. + example: 1 + type: integer + securityCenterPerPage: + description: Sets the number of results per page of results. + example: 25 + maximum: 1000 + minimum: 1 + type: integer + securityCenterProducts: + example: + - access + - dns + items: + type: string + x-auditable: true + type: array + securityCenterScanStatusResponse: + properties: + scan_id: + description: An opaque identifier for the scan. + example: d5e94e48-504f-4a7f-a8c4-e0dc2e05e5f2 + type: string + started_at: + description: The time at which the scan was started, in RFC 3339 format. + example: '2026-04-13T23:59:59Z' + format: date-time + type: string + status: + description: The current status of the scan. + enum: + - in_progress + - completed + type: string + required: + - scan_id + - started_at + - status + type: object + securityCenterSeverityQueryParam: + example: + - low + - moderate + items: + enum: + - low + - moderate + - critical + type: string + x-auditable: true + type: array + securityCenterSubject: + example: example.com + type: string + x-auditable: true + securityCenterSubjects: + items: + $ref: '#/components/schemas/securityCenterSubject' + type: array + securityCenterUserClassification: + description: >- + User-defined classification for the insight. Can be 'false_positive', + 'accept_risk', 'other', or null. + enum: + - false_positive + - accept_risk + - other + - null + example: false_positive + nullable: true + type: string + x-auditable: true + securityCenterUserClassificationUpdate: + properties: + classification: + $ref: '#/components/schemas/securityCenterUserClassification' + rationale: + description: >- + Rationale for the classification change. Required when + classification is 'accept_risk' or 'other'. + type: string + x-auditable: true + type: object + securityCenterValueCountsResponse: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/securityCenterValueCountsResponse_result_item' + type: array + required: + - success + - errors + - messages + type: object + securityCenterValueCountsResponse_result_item: + properties: + count: + example: 1 + type: integer + x-auditable: true + value: + type: string + x-auditable: true + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + context: + id: cloudflare.security_center.context + name: context + title: Context + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1{issue_id}~1context/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/context/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + insights: + id: cloudflare.security_center.insights + name: insights + title: Insights + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1security-center~1insights/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1insights/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + dismiss_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1{issue_id}~1dismiss/put + response: + mediaType: application/json + openAPIDocKey: '200' + dismiss_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1security-center~1insights~1{issue_id}~1dismiss/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/insights/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/insights/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/insights/methods/dismiss_by_account + - $ref: '#/components/x-stackQL-resources/insights/methods/dismiss_by_zone' + audit_logs_6f0256: + id: cloudflare.security_center.audit_logs_6f0256 + name: audit_logs_6f0256 + title: Audit Logs 6f0256 + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1audit-log/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/audit_logs_6f0256/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + audit_logs_bff19a: + id: cloudflare.security_center.audit_logs_bff19a + name: audit_logs_bff19a + title: Audit Logs Bff19a + methods: + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1security-center~1insights~1audit-log/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/audit_logs_bff19a/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + class: + id: cloudflare.security_center.class + name: class + title: Class + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1class/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1insights~1class/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/class/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/class/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + scans: + id: cloudflare.security_center.scans + name: scans + title: Scans + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1scans/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_accounts_account_id_security_center_insights_scans: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1scans/post + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1insights~1scans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_zones_zone_id_security_center_insights_scans: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1insights~1scans/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scans/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/scans/methods/list_by_zone' + insert: + - $ref: >- + #/components/x-stackQL-resources/scans/methods/post_accounts_account_id_security_center_insights_scans + - $ref: >- + #/components/x-stackQL-resources/scans/methods/post_zones_zone_id_security_center_insights_scans + update: [] + delete: [] + replace: [] + severity: + id: cloudflare.security_center.severity + name: severity + title: Severity + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1severity/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1security-center~1insights~1severity/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/severity/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/severity/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + type: + id: cloudflare.security_center.type + name: type + title: Type + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1type/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1insights~1type/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/type/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/type/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + audit_logs_8c2f64: + id: cloudflare.security_center.audit_logs_8c2f64 + name: audit_logs_8c2f64 + title: Audit Logs 8c2f64 + methods: + list_by_account: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1{issue_id}~1audit-log/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/audit_logs_8c2f64/methods/list_by_account + insert: [] + update: [] + delete: [] + replace: [] + audit_logs_e60d54: + id: cloudflare.security_center.audit_logs_e60d54 + name: audit_logs_e60d54 + title: Audit Logs E60d54 + methods: + list_by_zone: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1security-center~1insights~1{issue_id}~1audit-log/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/audit_logs_e60d54/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + classification: + id: cloudflare.security_center.classification + name: classification + title: Classification + methods: + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1security-center~1insights~1{issue_id}~1classification/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1security-center~1insights~1{issue_id}~1classification/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/classification/methods/update_by_account + - $ref: >- + #/components/x-stackQL-resources/classification/methods/update_by_zone + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/security_txt.yaml b/providers/src/cloudflare/v00.00.00000/services/security_txt.yaml new file mode 100644 index 00000000..44f4847e --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/security_txt.yaml @@ -0,0 +1,381 @@ +openapi: 3.0.3 +info: + title: security_txt API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/security-center/securitytxt: + delete: + description: >- + Removes the security.txt file configuration for a zone. The + /.well-known/security.txt endpoint will no longer be served. + operationId: delete-security-txt + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseSingle' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Deletes security.txt + tags: + - security.txt + x-api-token-group: + - Zone Settings Write + x-stackql-sdk: + service: security_txt + resource_chain: [] + method: delete + get: + description: >- + Retrieves the current security.txt file configuration for a zone, used + for security vulnerability reporting. + operationId: get-security-txt + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/securityCenterSecurityTxt' + required: + - success + - errors + - messages + type: object + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieves security.txt + tags: + - security.txt + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-stackql-sdk: + service: security_txt + resource_chain: [] + method: get + put: + description: >- + Updates the security.txt file configuration for a zone, which provides + security researchers with vulnerability reporting information. + operationId: update-security-txt + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterSecurityTxt' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseSingle' + description: The request was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/securityCenterApiResponseCommonFailure' + description: A client error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Updates security.txt + tags: + - security.txt + x-api-token-group: + - Zone Settings Write + x-stackql-sdk: + service: security_txt + resource_chain: [] + method: update +components: + schemas: + securityCenterApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/securityCenterMessages' + messages: + $ref: '#/components/schemas/securityCenterMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + securityCenterApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/securityCenterMessages' + messages: + example: [] + $ref: '#/components/schemas/securityCenterMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + securityCenterApiResponseSingle: + type: object + $ref: '#/components/schemas/securityCenterApiResponseCommon' + securityCenterMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + securityCenterSecurityTxt: + properties: + acknowledgments: + example: + - https://example.com/hall-of-fame.html + items: + format: uri + type: string + x-auditable: true + type: array + canonical: + example: + - https://www.example.com/.well-known/security.txt + items: + format: uri + type: string + x-auditable: true + type: array + contact: + example: + - mailto:security@example.com + - tel:+1-201-555-0123 + - https://example.com/security-contact.html + items: + format: uri + type: string + x-auditable: true + type: array + enabled: + example: true + type: boolean + x-auditable: true + encryption: + example: + - https://example.com/pgp-key.txt + - dns:5d2d37ab76d47d36._openpgpkey.example.com?type=OPENPGPKEY + - openpgp4fpr:5f2de5521c63a801ab59ccb603d49de44b29100f + items: + format: uri + type: string + type: array + expires: + format: date-time + type: string + x-auditable: true + hiring: + example: + - https://example.com/jobs.html + items: + format: uri + type: string + x-auditable: true + type: array + policy: + example: + - https://example.com/disclosure-policy.html + items: + format: uri + type: string + x-auditable: true + type: array + preferred_languages: + example: en, es, fr + type: string + x-auditable: true + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + securitytxt: + id: cloudflare.security_txt.securitytxt + name: securitytxt + title: Securitytxt + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1securitytxt/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1securitytxt/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1security-center~1securitytxt/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/securitytxt/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/securitytxt/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/securitytxt/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/snippets.yaml b/providers/src/cloudflare/v00.00.00000/services/snippets.yaml new file mode 100644 index 00000000..7dd52ae9 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/snippets.yaml @@ -0,0 +1,1422 @@ +openapi: 3.0.3 +info: + title: snippets API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /zones/{zone_id}/snippets: + get: + description: Fetches all snippets belonging to the zone. + operationId: listZoneSnippets + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + $ref: '#/components/schemas/snippetsPage' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/snippetsPerPage' + responses: + '200': + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + enum: + - [] + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain snippets. + title: Snippets + type: array + items: + $ref: '#/components/schemas/snippetsSnippet' + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - true + result_info: + $ref: '#/components/schemas/snippetsResultInfo' + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A snippets response. + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List zone snippets + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + - Snippets Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: [] + method: list + /zones/{zone_id}/snippets/snippet_rules: + delete: + description: Deletes all snippet rules belonging to the zone. + operationId: deleteZoneSnippetRules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + enum: + - [] + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + $ref: '#/components/schemas/snippetsSnippetRules' + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A snippet rules response. + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete zone snippet rules + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: + - rules + method: delete + get: + description: Fetches all snippet rules belonging to the zone. + operationId: listZoneSnippetRules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + enum: + - [] + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + $ref: '#/components/schemas/snippetsSnippetRules' + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A snippet rules response. + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List zone snippet rules + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + - Snippets Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: + - rules + method: list + put: + description: Updates all snippet rules belonging to the zone. + operationId: updateZoneSnippetRules + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + description: Define a snippet rules object. + properties: + rules: + $ref: '#/components/schemas/snippetsSnippetRules' + required: + - rules + title: Snippet Rules + type: object + responses: + '200': + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + enum: + - [] + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + $ref: '#/components/schemas/snippetsSnippetRules' + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A snippet rules response. + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update zone snippet rules + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: + - rules + method: update + /zones/{zone_id}/snippets/{snippet_name}: + delete: + description: Deletes a snippet belonging to the zone. + operationId: deleteZoneSnippet + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: snippet_name + in: path + required: true + description: The Cloudflare Snippet name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + enum: + - [] + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a null response. + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a zone snippet + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: [] + method: delete + get: + description: Fetches a snippet belonging to the zone. + operationId: getZoneSnippet + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: snippet_name + in: path + required: true + description: The Cloudflare Snippet name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + enum: + - [] + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + $ref: '#/components/schemas/snippetsSnippet' + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a snippet response. + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a zone snippet + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + - Snippets Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: [] + method: get + put: + description: Creates or updates a snippet belonging to the zone. + operationId: updateZoneSnippet + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: snippet_name + in: path + required: true + description: The Cloudflare Snippet name. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + description: Define a snippet object. + properties: + metadata: + description: Provide metadata about the snippet. + properties: + main_module: + $ref: '#/components/schemas/snippetsSnippetMainModule' + required: + - main_module + title: Metadata + type: object + required: + - metadata + - files + title: Snippet + type: object + responses: + '200': + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + enum: + - [] + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + $ref: '#/components/schemas/snippetsSnippet' + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a snippet response. + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a zone snippet + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: [] + method: update + /zones/{zone_id}/snippets/{snippet_name}/content: + get: + description: Fetches the content of a snippet belonging to the zone. + operationId: getZoneSnippetContent + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: snippet_name + in: path + required: true + description: The Cloudflare Snippet name. + schema: + type: string + responses: + '200': + content: + multipart/form-data: + schema: + type: object + properties: + contents: + type: string + description: Return snippet content. + headers: + cf-entrypoint: + schema: + $ref: '#/components/schemas/snippetsSnippetMainModule' + 4XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + 5XX: + content: + application/json: + schema: + description: Return all API responses using this object. + properties: + errors: + $ref: '#/components/schemas/snippetsErrors' + messages: + $ref: '#/components/schemas/snippetsMessages' + result: + description: Contain the response result. + title: Result + type: object + enum: + - null + nullable: true + x-auditable: true + success: + description: Indicate whether the API call was successful. + title: Success + type: boolean + x-auditable: true + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: Return a failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a zone snippet content + tags: + - Zone Snippets + x-api-token-group: + - Snippets Write + - Snippets Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: snippets + resource_chain: + - content + method: get +components: + schemas: + snippetsErrors: + description: Lists error messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Errors + type: array + snippetsMessage: + description: Describes an API message. + properties: + code: + description: Identify the message code. + example: 10000 + title: Code + type: integer + x-auditable: true + message: + description: Describes the message text. + example: something bad happened + minLength: 1 + title: Description + type: string + x-auditable: true + required: + - message + title: Message + type: object + snippetsMessages: + description: Contain warning messages. + items: + $ref: '#/components/schemas/snippetsMessage' + title: Messages + type: array + snippetsPage: + default: 1 + description: Specifies the current page number. + example: 1 + minimum: 1 + title: Page + type: integer + x-auditable: true + snippetsPerPage: + default: 25 + description: Specifies how many results to return per page. + example: 25 + minimum: 1 + title: Per Page + type: integer + x-auditable: true + snippetsResultInfo: + description: Additional information to navigate the results. + properties: + count: + description: Specify the number of results in the current page. + example: 25 + minimum: 0 + title: Count + type: integer + x-auditable: true + page: + $ref: '#/components/schemas/snippetsPage' + per_page: + $ref: '#/components/schemas/snippetsPerPage' + total_count: + description: Specify the total number of results. + example: 100 + minimum: 0 + title: Total Count + type: integer + x-auditable: true + total_pages: + description: Specify the total number of pages. + example: 10 + minimum: 1 + title: Total Pages + type: integer + x-auditable: true + required: + - page + - per_page + - total_pages + - count + - total_count + title: Result Info + type: object + snippetsSnippet: + description: Define a snippet. + properties: + created_on: + description: Indicates when the snippet was created. + example: '2000-01-01T00:00:00.000000Z' + format: date-time + title: Created On + type: string + x-auditable: true + readOnly: true + modified_on: + description: Indicates when the snippet was last modified. + example: '2000-01-01T00:00:00.000000Z' + format: date-time + title: Modified On + type: string + x-auditable: true + readOnly: true + snippet_name: + $ref: '#/components/schemas/snippetsSnippetName' + required: + - created_on + - modified_one + - snippet_name + title: Snippet + type: object + snippetsSnippetMainModule: + description: Specify the name of the file that contains the main module of the snippet. + example: main.js + minLength: 1 + title: Main Module + type: string + x-auditable: true + snippetsSnippetName: + description: Identify the snippet. + example: my_snippet + title: Snippet Name + type: string + x-auditable: true + snippetsSnippetRules: + description: Lists snippet rules. + items: + description: Define a snippet rule. + properties: + description: + default: '' + description: Provide an informative description of the rule. + example: Execute my_snippet when IP address is 1.1.1.1. + title: Description + type: string + x-auditable: true + enabled: + default: false + description: Indicate whether to execute the rule. + example: true + title: Enabled + type: boolean + x-auditable: true + expression: + description: Define the expression that determines which traffic matches the rule. + example: ip.src eq 1.1.1.1 + minLength: 1 + title: Expression + type: string + x-auditable: true + id: + description: Specify the unique ID of the rule. + example: 3a03d665bac047339bb530ecb439a90d + readOnly: true + title: ID + type: string + x-auditable: true + last_updated: + description: Specify the timestamp of when the rule was last modified. + example: '2000-01-01T00:00:00.000000Z' + format: date-time + readOnly: true + title: Last Updated + type: string + x-auditable: true + snippet_name: + $ref: '#/components/schemas/snippetsSnippetName' + required: + - id + - expression + - snippet_name + - last_updated + title: Snippet Rule + type: object + title: Snippet Rules + type: array + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + snippets: + id: cloudflare.snippets.snippets + name: snippets + title: Snippets + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets~1{snippet_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets~1{snippet_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets~1{snippet_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/snippets/methods/get' + - $ref: '#/components/x-stackQL-resources/snippets/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/snippets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/snippets/methods/update' + rules: + id: cloudflare.snippets.rules + name: rules + title: Rules + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets~1snippet_rules/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets~1snippet_rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets~1snippet_rules/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/rules/methods/update' + contents: + id: cloudflare.snippets.contents + name: contents + title: Contents + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1snippets~1{snippet_name}~1content/get' + response: + mediaType: multipart/form-data + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/contents/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/spectrum.yaml b/providers/src/cloudflare/v00.00.00000/services/spectrum.yaml index 4c141b1a..a7f3d623 100644 --- a/providers/src/cloudflare/v00.00.00000/services/spectrum.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/spectrum.yaml @@ -1,49 +1,529 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Spectrum Aggregate Analytics - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - spectrum + title: spectrum API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/spectrum/analytics/aggregate/current: + get: + description: >- + Retrieves analytics aggregated from the last minute of usage on Spectrum + applications underneath a given zone. + operationId: spectrum-aggregate-analytics-get-current-aggregated-analytics + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: appID + schema: + $ref: '#/components/schemas/spectrumAnalyticsAppIdParam' + - in: query + name: colo_name + schema: + description: Co-location identifier. + maxLength: 3 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumAnalyticsQueryResponseAggregate' + description: Get current aggregated analytics response + 4xx: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumAnalyticsApiResponseCommonFailure' + description: Get current aggregated analytics response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get current aggregated analytics + tags: + - Spectrum Analytics + x-api-token-group: + - Analytics Read + x-stackql-sdk: + service: spectrum + resource_chain: + - analytics + - aggregates + - currents + method: get + /zones/{zone_id}/spectrum/analytics/events/bytime: + get: + description: Retrieves a list of aggregate metrics grouped by time interval. + operationId: spectrum-analytics-(-by-time)-get-analytics-by-time + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: dimensions + schema: + $ref: '#/components/schemas/spectrumAnalyticsDimensions' + - in: query + name: sort + schema: + $ref: '#/components/schemas/spectrumAnalyticsSort' + - in: query + name: until + schema: + $ref: '#/components/schemas/spectrumAnalyticsUntil' + - in: query + name: metrics + schema: + $ref: '#/components/schemas/spectrumAnalyticsMetrics' + - in: query + name: filters + schema: + $ref: '#/components/schemas/spectrumAnalyticsFilters' + - in: query + name: since + schema: + $ref: '#/components/schemas/spectrumAnalyticsSince' + - in: query + name: time_delta + schema: + description: Used to select time series resolution. + enum: + - year + - quarter + - month + - week + - day + - hour + - dekaminute + - minute + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumAnalyticsQueryResponseSingle' + description: Get analytics by time response + 4xx: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumAnalyticsApiResponseCommonFailure' + description: Get analytics by time response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get analytics by time + tags: + - Spectrum Analytics + x-api-token-group: + - Analytics Read + x-stackql-sdk: + service: spectrum + resource_chain: + - analytics + - events + - bytimes + method: get + /zones/{zone_id}/spectrum/analytics/events/summary: + get: + description: >- + Retrieves a list of summarised aggregate metrics over a given time + period. + operationId: spectrum-analytics-(-summary)-get-analytics-summary + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: dimensions + schema: + $ref: '#/components/schemas/spectrumAnalyticsDimensions' + - in: query + name: sort + schema: + $ref: '#/components/schemas/spectrumAnalyticsSort' + - in: query + name: until + schema: + $ref: '#/components/schemas/spectrumAnalyticsUntil' + - in: query + name: metrics + schema: + $ref: '#/components/schemas/spectrumAnalyticsMetrics' + - in: query + name: filters + schema: + $ref: '#/components/schemas/spectrumAnalyticsFilters' + - in: query + name: since + schema: + $ref: '#/components/schemas/spectrumAnalyticsSince' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumAnalyticsQueryResponseSingle' + description: Get analytics summary response + 4xx: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumAnalyticsApiResponseCommonFailure' + description: Get analytics summary response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get analytics summary + tags: + - Spectrum Analytics + x-api-token-group: + - Analytics Read + x-stackql-sdk: + service: spectrum + resource_chain: + - analytics + - events + - summaries + method: get + /zones/{zone_id}/spectrum/apps: + get: + description: >- + Retrieves a list of currently existing Spectrum applications inside a + zone. + operationId: spectrum-applications-list-spectrum-applications + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + description: >- + Page number of paginated results. This parameter is required in + order to use other pagination parameters. If included in the + query, `result_info` will be present in the response. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Sets the maximum number of results per page. + maximum: 100 + minimum: 1 + type: number + - in: query + name: direction + schema: + default: asc + description: Sets the direction by which results are ordered. + enum: + - asc + - desc + type: string + - in: query + name: order + schema: + default: dns + description: Application field by which results are ordered. + enum: + - protocol + - app_id + - created_on + - modified_on + - dns + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigAppConfigCollection' + description: List Spectrum applications response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigApiResponseCommonFailure' + description: List Spectrum applications response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Spectrum applications + tags: + - Spectrum Applications + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-stackql-sdk: + service: spectrum + resource_chain: + - apps + method: list + post: + description: >- + Creates a new Spectrum application from a configuration using a name for + the origin. + operationId: >- + spectrum-applications-create-spectrum-application-using-a-name-for-the-origin + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigUpdateAppConfig' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigAppConfigSingle' + description: Create Spectrum application using a name for the origin response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigApiResponseCommonFailure' + description: >- + Create Spectrum application using a name for the origin response + failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Spectrum application using a name for the origin + tags: + - Spectrum Applications + x-api-token-group: + - Zone Settings Write + x-stackql-sdk: + service: spectrum + resource_chain: + - apps + method: create + /zones/{zone_id}/spectrum/apps/{app_id}: + delete: + description: Deletes a previously existing application. + operationId: spectrum-applications-delete-spectrum-application + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigApiResponseSingleId' + description: Delete Spectrum application response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigApiResponseCommonFailure' + description: Delete Spectrum application response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Spectrum application + tags: + - Spectrum Applications + x-api-token-group: + - Zone Settings Write + x-stackql-sdk: + service: spectrum + resource_chain: + - apps + method: delete + get: + description: >- + Gets the application configuration of a specific application inside a + zone. + operationId: spectrum-applications-get-spectrum-application-configuration + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigAppConfigSingle' + description: Get Spectrum application configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigApiResponseCommonFailure' + description: Get Spectrum application configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Spectrum application configuration + tags: + - Spectrum Applications + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-stackql-sdk: + service: spectrum + resource_chain: + - apps + method: get + put: + description: >- + Updates a previously existing application's configuration that uses a + name for the origin. + operationId: >- + spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigUpdateAppConfig' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigAppConfigSingle' + description: >- + Update Spectrum application configuration using a name for the + origin response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/spectrumConfigApiResponseCommonFailure' + description: >- + Update Spectrum application configuration using a name for the + origin response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Spectrum application configuration using a name for the origin + tags: + - Spectrum Applications + x-api-token-group: + - Zone Settings Write + x-stackql-sdk: + service: spectrum + resource_chain: + - apps + method: update components: schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - analytics-aggregate_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - type: object - type: array - api-response-common-failure: + spectrumAnalyticsApiResponseCommonFailure: properties: errors: - allOf: - - $ref: '#/components/schemas/messages' example: - code: 7003 message: No route for the URI minLength: 1 + $ref: '#/components/schemas/spectrumAnalyticsMessages' messages: - allOf: - - $ref: '#/components/schemas/messages' example: [] + $ref: '#/components/schemas/spectrumAnalyticsMessages' result: enum: - null nullable: true + type: object success: - description: Whether the API call was successful + description: Whether the API call was successful. enum: - false example: false @@ -54,179 +534,635 @@ components: - messages - result type: object - api-response-common: + spectrumAnalyticsAppIdParam: + description: >- + Comma-delimited list of Spectrum Application Id(s). If provided, the + response will be limited to Spectrum Application Id(s) that match. + example: ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f + type: string + spectrumAnalyticsColumn: properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result + dimensions: + items: + type: string + type: array + metrics: + type: array + items: + type: number type: object - messages: + spectrumAnalyticsDimensions: + description: >- + Can be used to break down the data by given attributes. Options are: + Dimension | Name | Example + --------------------------|---------------------------------|-------------------------- + event | Connection Event | connect, progress, disconnect, originError, + clientFiltered appID | Application ID | 40d67c87c6cd4b889a4fd57805225e85 + coloName | Colo Name | SFO ipVersion | IP version used by the client | + 4, 6. + example: + - event + - appID + items: + enum: + - event + - appID + - coloName + - ipVersion + type: string + type: array + spectrumAnalyticsFilters: + description: >- + Used to filter rows by one or more dimensions. Filters can be combined + using OR and AND boolean logic. AND takes precedence over OR in all the + expressions. The OR operator is defined using a comma (,) or OR keyword + surrounded by whitespace. The AND operator is defined using a semicolon + (;) or AND keyword surrounded by whitespace. Note that the semicolon is + a reserved character in URLs (rfc1738) and needs to be percent-encoded + as %3B. Comparison options are: Operator | Name | URL Encoded + --------------------------|---------------------------------|-------------------------- + == | Equals | %3D%3D != | Does not equals | !%3D \> | Greater Than | %3E + \< | Less Than | %3C \>= | Greater than or equal to | %3E%3D \<= | Less + than or equal to | %3C%3D + example: event==disconnect%20AND%20coloName!=SFO + type: string + spectrumAnalyticsIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + spectrumAnalyticsMessages: example: [] items: properties: code: minimum: 1000 type: integer + documentation_url: + type: string message: type: string + source: + properties: + pointer: + type: string + type: object required: - code - message type: object uniqueItems: true type: array - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - app_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - type: object - type: array - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' + spectrumAnalyticsMetrics: + description: >- + One or more metrics to compute. Options are: Metric | Name | Example | + Unit + --------------------------|-------------------------------------|--------------------------|-------------------------- + count | Count of total events | 1000 | Count bytesIngress | Sum of + ingress bytes | 1000 | Sum bytesEgress | Sum of egress bytes | 1000 | + Sum durationAvg | Average connection duration | 1.0 | Time in + milliseconds durationMedian | Median connection duration | 1.0 | Time in + milliseconds duration90th | 90th percentile connection duration | 1.0 | + Time in milliseconds duration99th | 99th percentile connection duration + | 1.0 | Time in milliseconds. + example: + - count + - bytesIngress + items: + enum: + - count + - bytesIngress + - bytesEgress + - durationAvg + - durationMedian + - duration90th + - duration99th + type: string + type: array + spectrumAnalyticsQuery: + properties: + dimensions: + $ref: '#/components/schemas/spectrumAnalyticsDimensions' + filters: + $ref: '#/components/schemas/spectrumAnalyticsFilters' + limit: + description: Limit number of returned metrics. + type: number + metrics: + $ref: '#/components/schemas/spectrumAnalyticsMetrics' + since: + $ref: '#/components/schemas/spectrumAnalyticsSince' + sort: + $ref: '#/components/schemas/spectrumAnalyticsSort' + until: + $ref: '#/components/schemas/spectrumAnalyticsUntil' + type: object + spectrumAnalyticsQueryResponseAggregate: type: object - result_info: properties: - count: - description: Total number of results for the requested service - example: 1 + errors: + $ref: '#/components/schemas/spectrumAnalyticsMessages' + messages: + $ref: '#/components/schemas/spectrumAnalyticsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: >- + #/components/schemas/spectrumAnalyticsQueryResponseAggregate_result_item + type: array + required: + - success + - errors + - messages + spectrumAnalyticsQueryResponseAggregate_result_item: + properties: + appID: + description: Application identifier. + $ref: '#/components/schemas/spectrumAnalyticsIdentifier' + bytesEgress: + description: Number of bytes sent type: number - page: - description: Current page within paginated list of results - example: 1 + bytesIngress: + description: Number of bytes received type: number - per_page: - description: Number of results per page of results - example: 20 + connections: + description: Number of connections type: number - total_count: - description: Total results available without any search parameters - example: 2000 + durationAvg: + description: Average duration of connections type: number + required: + - appID + - bytesIngress + - bytesEgress + - connections + - durationAvg + type: object + spectrumAnalyticsQueryResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/spectrumAnalyticsMessages' + messages: + $ref: '#/components/schemas/spectrumAnalyticsMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + data: + description: List of columns returned by the analytics query. + items: + $ref: '#/components/schemas/spectrumAnalyticsColumn' + type: array + data_lag: + description: >- + Number of seconds between current time and last processed event, + i.e. how many seconds of data could be missing. + example: 3 + minimum: 0 + type: number + max: + description: Maximum result for each selected metrics across all data. + $ref: '#/components/schemas/spectrumAnalyticsStat' + min: + description: Minimum result for each selected metrics across all data. + $ref: '#/components/schemas/spectrumAnalyticsStat' + query: + $ref: '#/components/schemas/spectrumAnalyticsQuery' + rows: + description: Total number of rows in the result. + example: 5 + minimum: 0 + type: number + time_intervals: + description: 'List of time interval buckets: [start, end]' + items: + items: + $ref: '#/components/schemas/spectrumAnalyticsTimestamp' + type: array + type: array + totals: + description: Total result for each selected metrics across all data. + $ref: '#/components/schemas/spectrumAnalyticsStat' + required: + - rows + - data + - data_lag + - min + - max + - totals + - query + type: object + required: + - success + - errors + - messages + spectrumAnalyticsSince: + description: >- + Start of time interval to query, defaults to `until` - 6 hours. + Timestamp must be in RFC3339 format and uses UTC unless otherwise + specified. + $ref: '#/components/schemas/spectrumAnalyticsTimestamp' + spectrumAnalyticsSort: + description: >- + The sort order for the result set; sort fields must be included in + `metrics` or `dimensions`. + example: + - +count + - '-bytesIngress' + items: + type: string + type: array + spectrumAnalyticsStat: + example: + bytesEgress: 100 + bytesIngress: 50 + type: object + spectrumAnalyticsTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + spectrumAnalyticsUntil: + description: >- + End of time interval to query, defaults to current time. Timestamp must + be in RFC3339 format and uses UTC unless otherwise specified. + $ref: '#/components/schemas/spectrumAnalyticsTimestamp' + spectrumConfigApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/spectrumConfigMessages' + messages: + example: [] + $ref: '#/components/schemas/spectrumConfigMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + spectrumConfigApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/spectrumConfigMessages' + messages: + $ref: '#/components/schemas/spectrumConfigMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/spectrumConfigIdentifier' + required: + - id + type: object + required: + - success + - errors + - messages + spectrumConfigAppConfig: + properties: + created_on: + $ref: '#/components/schemas/spectrumConfigCreated' + readOnly: true + id: + $ref: '#/components/schemas/spectrumConfigAppIdentifier' + modified_on: + $ref: '#/components/schemas/spectrumConfigModified' + readOnly: true + argo_smart_routing: + $ref: '#/components/schemas/spectrumConfigArgoSmartRouting' + dns: + $ref: '#/components/schemas/spectrumConfigDns' + edge_ips: + $ref: '#/components/schemas/spectrumConfigEdgeIps' + ip_firewall: + $ref: '#/components/schemas/spectrumConfigIpFirewall' + origin_direct: + $ref: '#/components/schemas/spectrumConfigOriginDirect' + origin_dns: + $ref: '#/components/schemas/spectrumConfigOriginDns' + origin_port: + $ref: '#/components/schemas/spectrumConfigOriginPort' + protocol: + $ref: '#/components/schemas/spectrumConfigProtocol' + proxy_protocol: + $ref: '#/components/schemas/spectrumConfigProxyProtocol' + tls: + $ref: '#/components/schemas/spectrumConfigTls' + traffic_type: + $ref: '#/components/schemas/spectrumConfigTrafficType' + required: + - id + - created_on + - modified_on + - protocol + - dns + - traffic_type + type: object + spectrumConfigAppConfigCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/spectrumConfigMessages' + messages: + $ref: '#/components/schemas/spectrumConfigMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + result: + type: array + items: + $ref: '#/components/schemas/spectrumConfigAppConfig' + required: + - success + - errors + - messages + spectrumConfigAppConfigSingle: type: object - argo_smart_routing: + properties: + errors: + $ref: '#/components/schemas/spectrumConfigMessages' + messages: + $ref: '#/components/schemas/spectrumConfigMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + properties: + created_on: + $ref: '#/components/schemas/spectrumConfigCreated' + readOnly: true + id: + $ref: '#/components/schemas/spectrumConfigAppIdentifier' + modified_on: + $ref: '#/components/schemas/spectrumConfigModified' + readOnly: true + argo_smart_routing: + $ref: '#/components/schemas/spectrumConfigArgoSmartRouting' + dns: + $ref: '#/components/schemas/spectrumConfigDns' + edge_ips: + $ref: '#/components/schemas/spectrumConfigEdgeIps' + ip_firewall: + $ref: '#/components/schemas/spectrumConfigIpFirewall' + origin_direct: + $ref: '#/components/schemas/spectrumConfigOriginDirect' + origin_dns: + $ref: '#/components/schemas/spectrumConfigOriginDns' + origin_port: + $ref: '#/components/schemas/spectrumConfigOriginPort' + protocol: + $ref: '#/components/schemas/spectrumConfigProtocol' + proxy_protocol: + $ref: '#/components/schemas/spectrumConfigProxyProtocol' + tls: + $ref: '#/components/schemas/spectrumConfigTls' + traffic_type: + $ref: '#/components/schemas/spectrumConfigTrafficType' + required: + - created_on + - dns + - id + - modified_on + - protocol + required: + - success + - errors + - messages + spectrumConfigAppIdentifier: + description: App identifier. + readOnly: true + $ref: '#/components/schemas/spectrumConfigIdentifier' + spectrumConfigArgoSmartRouting: default: false - description: |- - Enables Argo Smart Routing for this application. - Notes: Only available for TCP applications with traffic_type set to "direct". + description: >- + Enables Argo Smart Routing for this application. Notes: Only available + for TCP applications with traffic_type set to "direct". example: true type: boolean - dns: + spectrumConfigCreated: + description: When the Application was created. + readOnly: true + $ref: '#/components/schemas/spectrumConfigTimestamp' + spectrumConfigDns: description: The name and type of DNS record for the Spectrum application. properties: name: - $ref: '#/components/schemas/dns_name' + $ref: '#/components/schemas/spectrumConfigDnsName' type: - $ref: '#/components/schemas/dns_type' + $ref: '#/components/schemas/spectrumConfigDnsType' type: object - edge_ips: + spectrumConfigDnsName: + description: The name of the DNS record associated with the application. + example: ssh.example.com + format: hostname + type: string + spectrumConfigDnsTtl: + description: The TTL of our resolution of your DNS record in seconds. + minimum: 600 + type: integer + spectrumConfigDnsType: + description: The type of DNS record associated with the application. + enum: + - CNAME + - ADDRESS + example: CNAME + type: string + spectrumConfigEdgeIps: default: connectivity: all type: dynamic description: The anycast edge IP configuration for the hostname of this application. - oneOf: - - properties: - connectivity: - description: The IP versions supported for inbound connections on Spectrum anycast IPs. - enum: - - all - - ipv4 - - ipv6 - example: all - type: string - type: - description: The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names. - enum: - - dynamic - example: dynamic - type: string - type: object - - properties: - ips: - description: The array of customer owned IPs we broadcast via anycast for this hostname and application. - example: - - 192.0.2.1 - items: - description: Edge anycast IPs. - example: 192.0.2.1 - type: string - type: array - type: - description: The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names. - enum: - - static - example: static - type: string - type: object - ip_firewall: - description: |- - Enables IP Access Rules for this application. - Notes: Only available for TCP applications. - example: true + type: object + properties: + connectivity: + description: >- + The IP versions supported for inbound connections on Spectrum + anycast IPs. + enum: + - all + - ipv4 + - ipv6 + example: all + type: string + type: + description: >- + The type of edge IP configuration specified. Dynamically allocated + edge IPs use Spectrum anycast IPs in accordance with the + connectivity you specify. Only valid with CNAME DNS names. + enum: + - dynamic + example: dynamic + type: string + ips: + description: >- + The array of customer owned IPs we broadcast via anycast for this + hostname and application. + example: + - 192.0.2.1 + items: + description: Edge anycast IPs. + example: 192.0.2.1 + type: string + type: array + spectrumConfigIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + spectrumConfigIpFirewall: + default: false + description: >- + Enables IP Access Rules for this application. Notes: Only available for + TCP applications. + example: false type: boolean - origin_dns: + spectrumConfigMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + spectrumConfigModified: + description: When the Application was last modified. + readOnly: true + $ref: '#/components/schemas/spectrumConfigTimestamp' + spectrumConfigOriginDirect: + description: >- + List of origin IP addresses. Array may contain multiple IP addresses for + load balancing. + items: + example: tcp://127.0.0.1:8080 + format: URI + type: string + type: array + spectrumConfigOriginDns: description: The name and type of DNS record for the Spectrum application. properties: name: - $ref: '#/components/schemas/origin_dns_name' + $ref: '#/components/schemas/spectrumConfigOriginDnsName' ttl: - $ref: '#/components/schemas/dns_ttl' + $ref: '#/components/schemas/spectrumConfigDnsTtl' type: - $ref: '#/components/schemas/origin_dns_type' + $ref: '#/components/schemas/spectrumConfigOriginDnsType' type: object - origin_port: - anyOf: - - type: integer - - type: string - description: |- - The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `"1000-2000"`. - Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field. + spectrumConfigOriginDnsName: + description: The name of the DNS record associated with the origin. + example: origin.example.com + format: hostname + type: string + spectrumConfigOriginDnsType: + description: >- + The type of DNS record associated with the origin. "" is used to specify + a combination of A/AAAA records. + enum: + - '' + - A + - AAAA + - SRV + example: '' + type: string + spectrumConfigOriginPort: + description: >- + The destination port at the origin. Only specified in conjunction with + origin_dns. May use an integer to specify a single origin port, for + example `1000`, or a string to specify a range of origin ports, for + example `"1000-2000"`. Notes: If specifying a port range, the number of + ports in the range must match the number of ports specified in the + "protocol" field. example: 22 maximum: 65535 minimum: 1 - protocol: - description: 'The port configuration at Cloudflare’s edge. May specify a single port, for example `"tcp/1000"`, or a range of ports, for example `"tcp/1000-2000"`.' + type: integer + spectrumConfigProtocol: + description: >- + The port configuration at Cloudflare's edge. May specify a single port, + for example `"tcp/1000"`, or a range of ports, for example + `"tcp/1000-2000"`. example: tcp/22 type: string - proxy_protocol: + spectrumConfigProxyProtocol: default: 'off' - description: 'Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.' + description: >- + Enables Proxy Protocol to the origin. Refer to [Enable Proxy + protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) + for implementation details on PROXY Protocol V1, PROXY Protocol V2, and + Simple Proxy Protocol. enum: - 'off' - v1 @@ -234,609 +1170,217 @@ components: - simple example: 'off' type: string - tls: + spectrumConfigTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + spectrumConfigTls: + default: 'off' description: The type of TLS termination associated with the application. enum: - 'off' - flexible - full - strict - example: full + example: 'off' type: string - traffic_type: + spectrumConfigTrafficType: default: direct - description: 'Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application''s type is derived from the `protocol`. When set to "http" or "https", Spectrum will apply Cloudflare''s HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.' + description: >- + Determines how data travels from the edge to your origin. When set to + "direct", Spectrum will send traffic directly to your origin, and the + application's type is derived from the `protocol`. When set to "http" or + "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it + sends traffic to your origin, and the application type matches this + property exactly. enum: - direct - http - https example: direct type: string - response_single_origin_dns: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - argo_smart_routing: - $ref: '#/components/schemas/argo_smart_routing' - created_on: - $ref: '#/components/schemas/app_components-schemas-created' - dns: - $ref: '#/components/schemas/dns' - edge_ips: - $ref: '#/components/schemas/edge_ips' - id: - $ref: '#/components/schemas/app_id' - ip_firewall: - $ref: '#/components/schemas/ip_firewall' - modified_on: - $ref: '#/components/schemas/app_components-schemas-modified' - origin_dns: - $ref: '#/components/schemas/origin_dns' - origin_port: - $ref: '#/components/schemas/origin_port' - protocol: - $ref: '#/components/schemas/protocol' - proxy_protocol: - $ref: '#/components/schemas/proxy_protocol' - tls: - $ref: '#/components/schemas/tls' - traffic_type: - $ref: '#/components/schemas/traffic_type' - dns_name: - description: The name of the DNS record associated with the application. - example: ssh.example.com - format: hostname - type: string - dns_type: - description: The type of DNS record associated with the application. - enum: - - CNAME - - ADDRESS - example: CNAME - type: string - origin_dns_name: - description: The name of the DNS record associated with the origin. - example: origin.example.com - format: hostname - type: string - dns_ttl: - description: The TTL of our resolution of your DNS record in seconds. - minimum: 600 - type: integer - origin_dns_type: - description: The type of DNS record associated with the origin. "" is used to specify a combination of A/AAAA records. - enum: - - '' - - A - - AAAA - - SRV - example: '' - type: string - app_components-schemas-created: - description: When the Application was created. - example: '2014-01-02T02:20:00Z' - format: date-time - readOnly: true - type: string - app_id: - description: Application identifier. - example: ea95132c15732412d22c1476fa83f27a - maxLength: 32 - readOnly: true - type: string - app_components-schemas-modified: - description: When the Application was last modified. - example: '2014-01-02T02:20:00Z' - format: date-time - readOnly: true - type: string - schemas-response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - responses: {} + spectrumConfigUpdateAppConfig: + type: object + properties: + created_on: + $ref: '#/components/schemas/spectrumConfigCreated' + readOnly: true + id: + $ref: '#/components/schemas/spectrumConfigAppIdentifier' + modified_on: + $ref: '#/components/schemas/spectrumConfigModified' + readOnly: true + argo_smart_routing: + $ref: '#/components/schemas/spectrumConfigArgoSmartRouting' + dns: + $ref: '#/components/schemas/spectrumConfigDns' + edge_ips: + $ref: '#/components/schemas/spectrumConfigEdgeIps' + ip_firewall: + $ref: '#/components/schemas/spectrumConfigIpFirewall' + origin_direct: + $ref: '#/components/schemas/spectrumConfigOriginDirect' + origin_dns: + $ref: '#/components/schemas/spectrumConfigOriginDns' + origin_port: + $ref: '#/components/schemas/spectrumConfigOriginPort' + protocol: + $ref: '#/components/schemas/spectrumConfigProtocol' + proxy_protocol: + $ref: '#/components/schemas/spectrumConfigProxyProtocol' + tls: + $ref: '#/components/schemas/spectrumConfigTls' + traffic_type: + $ref: '#/components/schemas/spectrumConfigTrafficType' + required: + - created_on + - dns + - id + - modified_on + - protocol securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. api_key: in: header name: X-Auth-Key type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. api_token: scheme: bearer type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). x-stackQL-resources: - zones_analytics_aggregate_current: - id: cloudflare.spectrum.zones_analytics_aggregate_current - name: zones_analytics_aggregate_current - title: Zones Analytics Aggregate Current + currents: + id: cloudflare.spectrum.currents + name: currents + title: Currents methods: - aggregate_analytics_get_current_aggregated_analytics: - operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1analytics~1aggregate~1current/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _aggregate_analytics_get_current_aggregated_analytics: + list: operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1analytics~1aggregate~1current/get' + $ref: >- + #/paths/~1zones~1{zone_id}~1spectrum~1analytics~1aggregate~1current/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.result sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones_analytics_aggregate_current/methods/aggregate_analytics_get_current_aggregated_analytics' + - $ref: '#/components/x-stackQL-resources/currents/methods/list' insert: [] update: [] delete: [] - zones_analytics_events_bytime: - id: cloudflare.spectrum.zones_analytics_events_bytime - name: zones_analytics_events_bytime - title: Zones Analytics Events Bytime + replace: [] + bytimes: + id: cloudflare.spectrum.bytimes + name: bytimes + title: Bytimes methods: - analytics___by_time__get_analytics_by_time: - operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1analytics~1events~1bytime/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _analytics___by_time__get_analytics_by_time: + list: operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1analytics~1events~1bytime/get' + $ref: >- + #/paths/~1zones~1{zone_id}~1spectrum~1analytics~1events~1bytime/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.result.data sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones_analytics_events_bytime/methods/analytics___by_time__get_analytics_by_time' + - $ref: '#/components/x-stackQL-resources/bytimes/methods/list' insert: [] update: [] delete: [] - zones_analytics_events_summary: - id: cloudflare.spectrum.zones_analytics_events_summary - name: zones_analytics_events_summary - title: Zones Analytics Events Summary + replace: [] + summaries: + id: cloudflare.spectrum.summaries + name: summaries + title: Summaries methods: - analytics___summary__get_analytics_summary: - operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1analytics~1events~1summary/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _analytics___summary__get_analytics_summary: + list: operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1analytics~1events~1summary/get' + $ref: >- + #/paths/~1zones~1{zone_id}~1spectrum~1analytics~1events~1summary/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.result.data sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones_analytics_events_summary/methods/analytics___summary__get_analytics_summary' + - $ref: '#/components/x-stackQL-resources/summaries/methods/list' insert: [] update: [] delete: [] - zones_apps: - id: cloudflare.spectrum.zones_apps - name: zones_apps - title: Zones Apps + replace: [] + apps: + id: cloudflare.spectrum.apps + name: apps + title: Apps methods: - applications_list_spectrum_applications: - operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1apps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _applications_list_spectrum_applications: - operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1apps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - applications_create_spectrum_application_using_a_name_for_the_origin: + list: operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1apps/post' + $ref: '#/paths/~1zones~1{zone_id}~1spectrum~1apps/get' response: mediaType: application/json openAPIDocKey: '200' - applications_delete_spectrum_application: + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1apps~1{app_id}/delete' + $ref: '#/paths/~1zones~1{zone_id}~1spectrum~1apps/post' response: mediaType: application/json openAPIDocKey: '200' - applications_get_spectrum_application_configuration: + delete: operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1apps~1{app_id}/get' + $ref: '#/paths/~1zones~1{zone_id}~1spectrum~1apps~1{app_id}/delete' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ - _applications_get_spectrum_application_configuration: + get: operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1apps~1{app_id}/get' + $ref: '#/paths/~1zones~1{zone_id}~1spectrum~1apps~1{app_id}/get' response: mediaType: application/json openAPIDocKey: '200' - applications_update_spectrum_application_configuration_using_a_name_for_the_origin: + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1zones~1{zone}~1spectrum~1apps~1{app_id}/put' + $ref: '#/paths/~1zones~1{zone_id}~1spectrum~1apps~1{app_id}/put' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones_apps/methods/applications_list_spectrum_applications' - - $ref: '#/components/x-stackQL-resources/zones_apps/methods/applications_get_spectrum_application_configuration' + - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/zones_apps/methods/applications_create_spectrum_application_using_a_name_for_the_origin' + - $ref: '#/components/x-stackQL-resources/apps/methods/create' update: [] delete: - - $ref: '#/components/x-stackQL-resources/zones_apps/methods/applications_delete_spectrum_application' -paths: - '/zones/{zone}/spectrum/analytics/aggregate/current': - get: - description: Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone. - operationId: spectrum-aggregate-analytics-get-current-aggregated-analytics - parameters: - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/analytics-aggregate_components-schemas-response_collection' - description: Get current aggregated analytics response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/analytics-aggregate_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get current aggregated analytics response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get current aggregated analytics - tags: - - Spectrum Aggregate Analytics - '/zones/{zone}/spectrum/analytics/events/bytime': - get: - description: Retrieves a list of aggregate metrics grouped by time interval. - operationId: spectrum-analytics-(-by-time)-get-analytics-by-time - parameters: - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Get analytics by time response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get analytics by time response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get analytics by time - tags: - - Spectrum Analytics (By Time) - '/zones/{zone}/spectrum/analytics/events/summary': - get: - description: Retrieves a list of summarised aggregate metrics over a given time period. - operationId: spectrum-analytics-(-summary)-get-analytics-summary - parameters: - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Get analytics summary response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get analytics summary response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get analytics summary - tags: - - Spectrum Analytics (Summary) - '/zones/{zone}/spectrum/apps': - get: - description: Retrieves a list of currently existing Spectrum applications inside a zone. - operationId: spectrum-applications-list-spectrum-applications - parameters: - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/app_components-schemas-response_collection' - description: List Spectrum applications response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/app_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Spectrum applications response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Spectrum applications - tags: - - Spectrum Applications - post: - description: Creates a new Spectrum application from a configuration using a name for the origin. - operationId: spectrum-applications-create-spectrum-application-using-a-name-for-the-origin - parameters: - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - argo_smart_routing: - $ref: '#/components/schemas/argo_smart_routing' - dns: - $ref: '#/components/schemas/dns' - edge_ips: - $ref: '#/components/schemas/edge_ips' - ip_firewall: - $ref: '#/components/schemas/ip_firewall' - origin_dns: - $ref: '#/components/schemas/origin_dns' - origin_port: - $ref: '#/components/schemas/origin_port' - protocol: - $ref: '#/components/schemas/protocol' - proxy_protocol: - $ref: '#/components/schemas/proxy_protocol' - tls: - $ref: '#/components/schemas/tls' - traffic_type: - $ref: '#/components/schemas/traffic_type' - required: - - protocol - - dns - - origin_dns - - origin_port - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single_origin_dns' - description: Create Spectrum application using a name for the origin response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single_origin_dns' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Spectrum application using a name for the origin response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Spectrum application using a name for the origin - tags: - - Spectrum Applications - '/zones/{zone}/spectrum/apps/{app_id}': - delete: - description: Deletes a previously existing application. - operationId: spectrum-applications-delete-spectrum-application - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/app_id' - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/app_id' - type: object - type: object - description: Delete Spectrum application response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/app_id' - type: object - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Spectrum application response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Spectrum application - tags: - - Spectrum Applications - get: - description: Gets the application configuration of a specific application inside a zone. - operationId: spectrum-applications-get-spectrum-application-configuration - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/app_id' - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_single' - description: Get Spectrum application configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Spectrum application configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Spectrum application configuration - tags: - - Spectrum Applications - put: - description: Updates a previously existing application's configuration that uses a name for the origin. - operationId: spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin - parameters: - - in: path - name: app_id - required: true - schema: - $ref: '#/components/schemas/app_id' - - in: path - name: zone - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - argo_smart_routing: - $ref: '#/components/schemas/argo_smart_routing' - dns: - $ref: '#/components/schemas/dns' - edge_ips: - $ref: '#/components/schemas/edge_ips' - ip_firewall: - $ref: '#/components/schemas/ip_firewall' - origin_dns: - $ref: '#/components/schemas/origin_dns' - origin_port: - $ref: '#/components/schemas/origin_port' - protocol: - $ref: '#/components/schemas/protocol' - proxy_protocol: - $ref: '#/components/schemas/proxy_protocol' - tls: - $ref: '#/components/schemas/tls' - traffic_type: - $ref: '#/components/schemas/traffic_type' - required: - - protocol - - dns - - origin_dns - - origin_port - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single_origin_dns' - description: Update Spectrum application configuration using a name for the origin response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single_origin_dns' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Spectrum application configuration using a name for the origin response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Spectrum application configuration using a name for the origin - tags: - - Spectrum Applications + - $ref: '#/components/x-stackQL-resources/apps/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/apps/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/speed.yaml b/providers/src/cloudflare/v00.00.00000/services/speed.yaml new file mode 100644 index 00000000..d42f6a36 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/speed.yaml @@ -0,0 +1,1368 @@ +openapi: 3.0.3 +info: + title: speed API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/speed_api/availabilities: + get: + description: Retrieves quota for all plans, as well as the current zone quota. + operationId: speed-get-availabilities + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryAvailabilitiesResponse' + description: Page test availability. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get quota and availability + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - availabilities + method: list + /zones/{zone_id}/speed_api/pages: + get: + description: Lists all webpages which have been tested. + operationId: speed-list-pages + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryPagesResponseCollection' + description: List of pages. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List tested webpages + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - pages + method: list + /zones/{zone_id}/speed_api/pages/{url}/tests: + delete: + description: >- + Deletes all tests for a specific webpage from a specific region. Deleted + tests are still counted as part of the quota. + operationId: speed-delete-tests + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + - in: query + name: region + schema: + $ref: '#/components/schemas/observatoryRegion' + default: us-central1 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryCountResponse' + description: Number of deleted tests. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete all page tests + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - pages + - tests + method: delete + get: + description: Test history (list of tests) for a specific webpage. + operationId: speed-list-test-history + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + - in: query + name: page + schema: + default: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - in: query + name: region + schema: + $ref: '#/components/schemas/observatoryRegion' + default: us-central1 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryPageTestResponseCollection' + description: List of test history for a page. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List page test history + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - pages + - tests + method: list + post: + description: Starts a test for a specific webpage, in a specific region. + operationId: speed-create-test + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + requestBody: + content: + application/json: + schema: + properties: + region: + $ref: '#/components/schemas/observatoryRegion' + default: us-central1 + type: string + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryPageTestResponseSingle' + description: Page test details. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Start page test + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - pages + - tests + method: create + /zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}: + get: + description: Retrieves the result of a specific test. + operationId: speed-get-test + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + - in: path + name: test_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryPageTestResponseSingle' + description: Page test result. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a page test result + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - pages + - tests + method: get + /zones/{zone_id}/speed_api/pages/{url}/trend: + get: + description: Lists the core web vital metrics trend over time for a specific page. + operationId: speed-list-page-trend + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + - in: query + name: region + schema: + $ref: '#/components/schemas/observatoryRegion' + - in: query + name: deviceType + schema: + $ref: '#/components/schemas/observatoryDeviceType' + - in: query + name: start + schema: + $ref: '#/components/schemas/observatoryTimestamp' + - in: query + name: end + schema: + $ref: '#/components/schemas/observatoryTimestamp' + - description: The timezone of the start and end timestamps. + in: query + name: tz + schema: + type: string + - description: A comma-separated list of metrics to include in the results. + in: query + name: metrics + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryTrendResponse' + description: Page trend. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List core web vital metrics trend + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - pages + method: trend + /zones/{zone_id}/speed_api/schedule/{url}: + delete: + description: Deletes a scheduled test for a page. + operationId: speed-delete-test-schedule + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + - in: query + name: region + schema: + $ref: '#/components/schemas/observatoryRegion' + default: us-central1 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryCountResponse' + description: Number of deleted tests. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete scheduled page test + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - schedule + method: delete + get: + description: Retrieves the test schedule for a page in a specific region. + operationId: speed-get-scheduled-test + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + - in: query + name: region + schema: + $ref: '#/components/schemas/observatoryRegion' + default: us-central1 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryScheduleResponseSingle' + description: Page test schedule. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a page test schedule + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - schedule + method: get + post: + description: Creates a scheduled test for a page. + operationId: speed-create-scheduled-test + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: url + schema: + $ref: '#/components/schemas/observatoryUrl' + required: true + - in: query + name: region + schema: + $ref: '#/components/schemas/observatoryRegion' + default: us-central1 + type: string + x-stainless-terraform-configurability: computed_optional + - description: >- + The frequency of the scheduled test. Defaults to WEEKLY for free + plans, DAILY for paid plans. + in: query + name: frequency + schema: + $ref: '#/components/schemas/observatoryScheduleFrequency' + x-stainless-terraform-configurability: computed_optional + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryCreateScheduleResponse' + description: Page test schedule. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/observatoryApiResponseCommonFailure' + description: Failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create scheduled page test + tags: + - Observatory + x-api-token-group: + - Zone Settings Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: speed + resource_chain: + - schedule + method: create +components: + schemas: + observatoryApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/observatorySchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/observatorySchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + observatoryAvailabilities: + properties: + quota: + properties: + plan: + description: Cloudflare plan. + example: free + type: string + x-auditable: true + quotasPerPlan: + description: The number of tests available per plan. + properties: + value: + $ref: '#/components/schemas/observatoryPlanPropertiesInfo' + type: object + remainingSchedules: + description: The number of remaining schedules available. + example: 1 + type: number + x-auditable: true + remainingTests: + description: The number of remaining tests available. + example: 30 + type: number + x-auditable: true + scheduleQuotasPerPlan: + description: The number of schedules available per plan. + properties: + value: + $ref: '#/components/schemas/observatoryPlanPropertiesInfo' + type: object + type: object + regions: + items: + $ref: '#/components/schemas/observatoryLabeledRegion' + type: array + regionsPerPlan: + description: Available regions. + properties: + business: + items: + $ref: '#/components/schemas/observatoryLabeledRegion' + type: array + enterprise: + items: + $ref: '#/components/schemas/observatoryLabeledRegion' + type: array + free: + items: + $ref: '#/components/schemas/observatoryLabeledRegion' + type: array + pro: + items: + $ref: '#/components/schemas/observatoryLabeledRegion' + type: array + type: object + type: object + observatoryAvailabilitiesResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/observatoryAvailabilities' + required: + - success + - errors + - messages + observatoryCountResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + properties: + count: + description: Number of items affected. + example: 1 + type: number + x-auditable: true + x-stainless-naming: + terraform: + property_name: item_count + type: object + required: + - success + - errors + - messages + observatoryCreateScheduleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + properties: + schedule: + $ref: '#/components/schemas/observatorySchedule' + test: + $ref: '#/components/schemas/observatoryPageTest' + type: object + required: + - success + - errors + - messages + observatoryDeviceType: + description: The type of device. + enum: + - DESKTOP + - MOBILE + example: DESKTOP + type: string + x-auditable: true + observatoryLabeledRegion: + description: A test region with a label. + properties: + label: + example: Iowa, USA + type: string + x-auditable: true + value: + $ref: '#/components/schemas/observatoryRegion' + type: object + observatoryLighthouseErrorCode: + description: The error code of the Lighthouse result. + enum: + - NOT_REACHABLE + - DNS_FAILURE + - NOT_HTML + - LIGHTHOUSE_TIMEOUT + - UNKNOWN + example: NOT_REACHABLE + type: string + x-auditable: true + observatoryLighthouseReport: + description: The Lighthouse report. + properties: + cls: + description: Cumulative Layout Shift. + example: 100 + type: number + x-auditable: true + deviceType: + $ref: '#/components/schemas/observatoryDeviceType' + error: + properties: + code: + $ref: '#/components/schemas/observatoryLighthouseErrorCode' + detail: + description: Detailed error message. + example: 'Details: net::ERR_CONNECTION_CLOSED' + type: string + x-auditable: true + finalDisplayedUrl: + description: The final URL displayed to the user. + example: example.com + type: string + x-auditable: true + type: object + fcp: + description: First Contentful Paint. + example: 100 + type: number + x-auditable: true + jsonReportUrl: + description: The URL to the full Lighthouse JSON report. + type: string + x-auditable: true + lcp: + description: Largest Contentful Paint. + example: 100 + type: number + x-auditable: true + performanceScore: + description: The Lighthouse performance score. + example: 90 + type: number + x-auditable: true + si: + description: Speed Index. + example: 100 + type: number + x-auditable: true + state: + $ref: '#/components/schemas/observatoryLighthouseState' + tbt: + description: Total Blocking Time. + example: 100 + type: number + x-auditable: true + ttfb: + description: Time To First Byte. + example: 100 + type: number + x-auditable: true + tti: + description: Time To Interactive. + example: 100 + type: number + x-auditable: true + type: object + observatoryLighthouseState: + description: The state of the Lighthouse report. + enum: + - RUNNING + - COMPLETE + - FAILED + example: COMPLETE + type: string + x-auditable: true + observatoryMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + observatoryPageTest: + properties: + date: + $ref: '#/components/schemas/observatoryTimestamp' + desktopReport: + $ref: '#/components/schemas/observatoryLighthouseReport' + id: + $ref: '#/components/schemas/observatoryUuid' + mobileReport: + $ref: '#/components/schemas/observatoryLighthouseReport' + region: + $ref: '#/components/schemas/observatoryLabeledRegion' + scheduleFrequency: + $ref: '#/components/schemas/observatoryScheduleFrequency' + url: + $ref: '#/components/schemas/observatoryUrl' + type: object + observatoryPageTestResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + items: + $ref: '#/components/schemas/observatoryPageTest' + type: array + result_info: + $ref: '#/components/schemas/observatoryResultInfo' + required: + - success + - errors + - messages + observatoryPageTestResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/observatoryPageTest' + required: + - success + - errors + - messages + observatoryPagesResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + items: + $ref: >- + #/components/schemas/observatoryPagesResponseCollection_result_item + type: array + required: + - success + - errors + - messages + observatoryPagesResponseCollection_result_item: + properties: + region: + $ref: '#/components/schemas/observatoryLabeledRegion' + scheduleFrequency: + $ref: '#/components/schemas/observatoryScheduleFrequency' + tests: + items: + $ref: '#/components/schemas/observatoryPageTest' + type: array + url: + $ref: '#/components/schemas/observatoryUrl' + type: object + observatoryPlanPropertiesInfo: + description: Counts per account plan. + properties: + business: + example: 1 + type: integer + x-auditable: true + enterprise: + example: 1 + type: integer + x-auditable: true + free: + example: 1 + type: integer + x-auditable: true + pro: + example: 1 + type: integer + x-auditable: true + type: object + observatoryRegion: + description: A test region. + enum: + - asia-east1 + - asia-northeast1 + - asia-northeast2 + - asia-south1 + - asia-southeast1 + - australia-southeast1 + - europe-north1 + - europe-southwest1 + - europe-west1 + - europe-west2 + - europe-west3 + - europe-west4 + - europe-west8 + - europe-west9 + - me-west1 + - southamerica-east1 + - us-central1 + - us-east1 + - us-east4 + - us-south1 + - us-west1 + example: us-central1 + type: string + x-auditable: true + observatoryResultInfo: + properties: + count: + example: 5 + type: integer + x-auditable: true + page: + example: 1 + type: integer + x-auditable: true + per_page: + example: 5 + type: integer + x-auditable: true + total_count: + example: 3 + type: integer + x-auditable: true + type: object + observatorySchedule: + description: The test schedule. + properties: + frequency: + $ref: '#/components/schemas/observatoryScheduleFrequency' + region: + $ref: '#/components/schemas/observatoryRegion' + url: + $ref: '#/components/schemas/observatoryUrl' + type: object + observatoryScheduleFrequency: + description: The frequency of the test. + enum: + - DAILY + - WEEKLY + example: DAILY + type: string + x-auditable: true + observatoryScheduleResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/observatorySchedule' + required: + - success + - errors + - messages + observatorySchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + observatoryTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + observatoryTrend: + properties: + cls: + description: Cumulative Layout Shift trend. + items: + nullable: true + type: number + x-auditable: true + type: array + fcp: + description: First Contentful Paint trend. + items: + nullable: true + type: number + x-auditable: true + type: array + lcp: + description: Largest Contentful Paint trend. + items: + nullable: true + type: number + x-auditable: true + type: array + performanceScore: + description: The Lighthouse score trend. + items: + nullable: true + type: number + x-auditable: true + type: array + si: + description: Speed Index trend. + items: + nullable: true + type: number + x-auditable: true + type: array + tbt: + description: Total Blocking Time trend. + items: + nullable: true + type: number + x-auditable: true + type: array + ttfb: + description: Time To First Byte trend. + items: + nullable: true + type: number + x-auditable: true + type: array + tti: + description: Time To Interactive trend. + items: + nullable: true + type: number + x-auditable: true + type: array + type: object + observatoryTrendResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/observatoryMessages' + messages: + $ref: '#/components/schemas/observatoryMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/observatoryTrend' + required: + - success + - errors + - messages + observatoryUrl: + description: A URL. + example: example.com + type: string + x-auditable: true + observatoryUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + availabilities: + id: cloudflare.speed.availabilities + name: availabilities + title: Availabilities + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1availabilities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/availabilities/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + speed_api_pages: + id: cloudflare.speed.speed_api_pages + name: speed_api_pages + title: Speed Api Pages + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1pages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/speed_api_pages/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + tests: + id: cloudflare.speed.tests + name: tests + title: Tests + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1pages~1{url}~1tests/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1pages~1{url}~1tests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1pages~1{url}~1tests/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1speed_api~1pages~1{url}~1tests~1{test_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tests/methods/get' + - $ref: '#/components/x-stackQL-resources/tests/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tests/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tests/methods/delete' + replace: [] + pages_trend: + id: cloudflare.speed.pages_trend + name: pages_trend + title: Pages Trend + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1pages~1{url}~1trend/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pages_trend/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + schedule: + id: cloudflare.speed.schedule + name: schedule + title: Schedule + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1schedule~1{url}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1schedule~1{url}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1speed_api~1schedule~1{url}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schedule/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/schedule/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/schedule/methods/delete' + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/ssl.yaml b/providers/src/cloudflare/v00.00.00000/services/ssl.yaml new file mode 100644 index 00000000..8c736692 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/ssl.yaml @@ -0,0 +1,2294 @@ +openapi: 3.0.3 +info: + title: ssl API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/ssl/analyze: + post: + description: >- + Returns the set of hostnames, the signature algorithm, and the + expiration date of the certificate. + operationId: analyze-certificate-analyze-certificate + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + bundle_method: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBundleMethod' + certificate: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificate' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificateAnalyzeResponse + description: Analyze Certificate response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Analyze Certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Analyze Certificate + tags: + - Analyze Certificate + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - analyze + method: create + /zones/{zone_id}/ssl/certificate_packs: + get: + description: For a given zone, list all active certificate packs. + operationId: certificate-packs-list-certificate-packs + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of certificate packs per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: status + schema: + description: Include Certificate Packs of all statuses, not just active ones. + enum: + - all + type: string + - in: query + name: deploy + schema: + description: Specify the deployment environment for the certificate packs. + enum: + - staging + - production + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePackResponseCollection + description: List Certificate Packs response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePack + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Certificate Packs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Certificate Packs + tags: + - Certificate Packs + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - certificate_packs + method: list + /zones/{zone_id}/ssl/certificate_packs/order: + post: + description: For a given zone, order an advanced certificate pack. + operationId: certificate-packs-order-advanced-certificate-manager-certificate-pack + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateAuthority + cloudflare_branding: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCloudflareBranding + hosts: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasHosts' + type: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesAdvancedType' + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethod + validity_days: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidityDays' + required: + - type + - hosts + - validation_method + - validity_days + - certificate_authority + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesAdvancedCertificatePackResponseSingle + description: Order Advanced Certificate Manager Certificate Pack response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: A certificate pack with all its properties. + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateAuthority + certificates: + description: Array of certificates in this pack. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePackCertificate + type: array + cloudflare_branding: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCloudflareBranding + dcv_delegation_records: + description: DCV Delegation records for domain validation. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationRecord + readOnly: true + type: array + hosts: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasHosts + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + primary_certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPrimary + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePacksComponentsSchemasStatus + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasType + validation_errors: + description: >- + Domain validation errors that have been received by + the certificate authority (CA). + items: + properties: + message: + description: A domain validation error. + type: string + x-auditable: true + type: object + type: array + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethod + validation_records: + description: Certificates' validation records. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationRecord + type: array + validity_days: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidityDays + required: + - id + - type + - hosts + - certificates + - status + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Order Advanced Certificate Manager Certificate Pack response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Order Advanced Certificate Manager Certificate Pack + tags: + - Certificate Packs + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - certificate_packs + method: create + /zones/{zone_id}/ssl/certificate_packs/quota: + get: + description: For a given zone, list certificate pack quotas. + operationId: certificate-packs-get-certificate-pack-quotas + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePackQuotaResponse + description: Get Certificate Pack Quotas response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + advanced: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesQuota' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Certificate Pack Quotas response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Certificate Pack Quotas + tags: + - Certificate Packs + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - certificate_packs + - quota + method: get + /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}: + delete: + description: For a given zone, delete an advanced certificate pack. + operationId: certificate-packs-delete-advanced-certificate-manager-certificate-pack + parameters: + - in: path + name: certificate_pack_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesDeleteAdvancedCertificatePackResponseSingle + description: Delete Advanced Certificate Manager Certificate Pack response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/identifier' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: >- + Delete Advanced Certificate Manager Certificate Pack response + failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Advanced Certificate Manager Certificate Pack + tags: + - Certificate Packs + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - certificate_packs + method: delete + get: + description: For a given zone, get a certificate pack. + operationId: certificate-packs-get-certificate-pack + parameters: + - in: path + name: certificate_pack_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePackResponseSingle + description: Get Certificate Pack response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: A certificate pack with all its properties. + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateAuthority + certificates: + description: Array of certificates in this pack. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePackCertificate + type: array + cloudflare_branding: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCloudflareBranding + dcv_delegation_records: + description: DCV Delegation records for domain validation. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationRecord + readOnly: true + type: array + hosts: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasHosts + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + primary_certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPrimary + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePacksComponentsSchemasStatus + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasType + validation_errors: + description: >- + Domain validation errors that have been received by + the certificate authority (CA). + items: + properties: + message: + description: A domain validation error. + type: string + x-auditable: true + type: object + type: array + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethod + validation_records: + description: Certificates' validation records. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationRecord + type: array + validity_days: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidityDays + required: + - id + - type + - hosts + - certificates + - status + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Certificate Pack response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Certificate Pack + tags: + - Certificate Packs + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - certificate_packs + method: get + patch: + description: >- + For a given zone, restart validation or add cloudflare branding for an + advanced certificate pack. The former is only a validation operation for + a Certificate Pack in a validation_timed_out status. + operationId: >- + certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack + parameters: + - in: path + name: certificate_pack_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + cloudflare_branding: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCloudflareBranding + type: object + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesAdvancedCertificatePackResponseSingle + description: >- + Restart Validation for Advanced Certificate Manager Certificate Pack + response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: A certificate pack with all its properties. + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateAuthority + certificates: + description: Array of certificates in this pack. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePackCertificate + type: array + cloudflare_branding: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCloudflareBranding + dcv_delegation_records: + description: DCV Delegation records for domain validation. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationRecord + readOnly: true + type: array + hosts: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasHosts + id: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesIdentifier + primary_certificate: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesPrimary + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePacksComponentsSchemasStatus + type: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasType + validation_errors: + description: >- + Domain validation errors that have been received by + the certificate authority (CA). + items: + properties: + message: + description: A domain validation error. + type: string + x-auditable: true + type: object + type: array + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethod + validation_records: + description: Certificates' validation records. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationRecord + type: array + validity_days: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidityDays + required: + - id + - type + - hosts + - certificates + - status + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: >- + Restart Validation for Advanced Certificate Manager Certificate Pack + response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: >- + Restart Validation or Update Advanced Certificate Manager Certificate + Pack + tags: + - Certificate Packs + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - certificate_packs + method: edit + /zones/{zone_id}/ssl/recommendation: + get: + deprecated: true + description: Retrieve the SSL/TLS Recommender's recommendation for a zone. + operationId: ssl/-tls-mode-recommendation-ssl/-tls-recommendation + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/cacheApiResponseSingleId' + description: SSL/TLS Recommendation response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/cacheApiResponseCommonFailure' + description: SSL/TLS Recommendation response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: SSL/TLS Recommendation + tags: + - SSL/TLS Mode Recommendation + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: >- + SSL/TLS Recommender has been decommissioned in favor of Automatic + SSL/TLS + x-stackql-sdk: + service: ssl + resource_chain: + - recommendations + method: get + /zones/{zone_id}/ssl/universal/settings: + get: + description: Get Universal SSL Settings for a Zone. + operationId: universal-ssl-settings-for-a-zone-universal-ssl-settings-details + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSslUniversalSettingsResponse + description: Universal SSL Settings Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasEnabled + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Universal SSL Settings Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Universal SSL Settings Details + tags: + - Universal SSL Settings for a Zone + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - universal + - settings + method: get + patch: + description: Patch Universal SSL Settings for a Zone. + operationId: universal-ssl-settings-for-a-zone-edit-universal-ssl-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUniversal' + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSslUniversalSettingsResponse + description: Edit Universal SSL Settings response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + enabled: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasEnabled + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit Universal SSL Settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Universal SSL Settings + tags: + - Universal SSL Settings for a Zone + x-api-token-group: + - SSL and Certificates Write + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - universal + - settings + method: edit + /zones/{zone_id}/ssl/verification: + get: + description: Get SSL Verification Info for a Zone. + operationId: ssl-verification-ssl-verification-details + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: retry + schema: + description: Immediately retry SSL Verification. + enum: + - true + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSslVerificationResponseCollection + description: SSL Verification Details response + 4XX: + content: + application/json: + schema: + properties: + result: + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesVerification + type: array + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: SSL Verification Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: SSL Verification Details + tags: + - SSL Verification + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - verification + method: get + /zones/{zone_id}/ssl/verification/{certificate_pack_id}: + patch: + description: >- + Edit SSL validation method for a certificate pack. A PATCH request will + request an immediate validation check on any certificate, and return the + updated status. If a validation method is provided, the validation will + be immediately attempted using that method. + operationId: ssl-verification-edit-ssl-certificate-pack-validation-method + parameters: + - in: path + name: certificate_pack_id + schema: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertPackUuid' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesComponentsSchemasValidationMethod + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSslValidationMethodResponseCollection + description: Edit SSL Certificate Pack Validation Method response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethodComponentsSchemasStatus + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethodDefinition + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Edit SSL Certificate Pack Validation Method response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit SSL Certificate Pack Validation Method + tags: + - SSL Verification + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + - SSL and Certificates Write + - SSL and Certificates Read + x-cfPermissionsRequired: + enum: + - '#ssl:read' + - '#ssl:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: ssl + resource_chain: + - verification + method: edit +components: + schemas: + cacheApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/cacheMessages' + messages: + example: [] + $ref: '#/components/schemas/cacheMessages' + result: + $ref: '#/components/schemas/cacheResult' + success: + description: Indicates the API call's success or failure. + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + cacheApiResponseSingleId: + properties: + errors: + $ref: '#/components/schemas/cacheMessages' + messages: + $ref: '#/components/schemas/cacheMessages' + result: + $ref: '#/components/schemas/cacheResult' + success: + description: Indicates the API call's success or failure. + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + cacheMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + cacheResult: + properties: + editable: + description: Whether this setting can be updated or not. + readOnly: true + type: boolean + id: + example: ssl_automatic_mode + readOnly: true + type: string + modified_on: + description: Last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + next_scheduled_scan: + description: Next time this zone will be scanned by the Automatic SSL/TLS. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + value: + description: Current setting of the automatic SSL/TLS. + enum: + - auto + - custom + example: auto + readOnly: true + type: string + required: + - id + - modified_on + - value + - editable + type: object + identifier: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + enum: + - null + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + tlsCertificatesAndHostnamesAdvancedCertificatePackResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificatePack' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesAdvancedType: + description: Type of certificate pack. + enum: + - advanced + example: advanced + type: string + x-auditable: true + tlsCertificatesAndHostnamesBrandCheck: + description: Certificate Authority is manually reviewing the order. + example: false + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesBundleMethod: + $ref: '#/components/schemas/unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1' + tlsCertificatesAndHostnamesCertPackUuid: + description: Certificate Pack UUID. + example: a77f8bd7-3b47-46b4-a6f1-75cf98109948 + type: string + x-auditable: true + tlsCertificatesAndHostnamesCertificate: + description: The zone's SSL certificate or certificate and the intermediate(s). + example: | + -----BEGIN CERTIFICATE----- + MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV + BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX + aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF + MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 + ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB + CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 + CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB + KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 + 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI + dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 + izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 + 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI + GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV + BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF + MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 + 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP + Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG + SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq + 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw + YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= + -----END CERTIFICATE----- + type: string + tlsCertificatesAndHostnamesCertificateAnalyzeResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCertificatePack: + description: A certificate pack with all its properties. + properties: + certificate_authority: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasCertificateAuthority + certificates: + description: Array of certificates in this pack. + items: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePackCertificate + type: array + cloudflare_branding: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCloudflareBranding' + dcv_delegation_records: + description: DCV Delegation records for domain validation. + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidationRecord' + readOnly: true + type: array + hosts: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasHosts' + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + primary_certificate: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesPrimary' + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesCertificatePacksComponentsSchemasStatus + type: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasType' + validation_errors: + description: >- + Domain validation errors that have been received by the certificate + authority (CA). + items: + properties: + message: + description: A domain validation error. + example: SERVFAIL looking up CAA for app.example.com + type: string + x-auditable: true + type: object + type: array + validation_method: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidationMethod' + validation_records: + description: Certificates' validation records. + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidationRecord' + type: array + validity_days: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesValidityDays' + required: + - id + - type + - hosts + - certificates + - status + type: object + tlsCertificatesAndHostnamesCertificatePackCertificate: + description: An individual certificate within a certificate pack. + properties: + bundle_method: + description: Certificate bundle method. + example: ubiquitous + type: string + x-auditable: true + expires_on: + description: When the certificate from the authority expires. + example: '2024-01-01T00:00:00Z' + format: date-time + type: string + x-auditable: true + geo_restrictions: + description: Specify the region where your private key can be held locally. + properties: + label: + enum: + - us + - eu + - highest_security + example: us + type: string + x-auditable: true + type: object + hosts: + description: Hostnames covered by this certificate. + example: + - example.com + - '*.example.com' + items: + type: string + type: array + x-auditable: true + id: + description: Certificate identifier. + example: 7e7b8deba8538af625850b7b2530034c + type: string + x-auditable: true + issuer: + description: The certificate authority that issued the certificate. + example: Let's Encrypt + type: string + x-auditable: true + modified_on: + description: When the certificate was last modified. + example: '2014-01-01T05:20:00Z' + format: date-time + type: string + x-auditable: true + readOnly: true + priority: + description: The order/priority in which the certificate will be used. + type: number + x-auditable: true + signature: + description: The type of hash used for the certificate. + example: ECDSAWithSHA256 + type: string + x-auditable: true + status: + description: Certificate status. + example: active + type: string + x-auditable: true + uploaded_on: + description: When the certificate was uploaded to Cloudflare. + example: '2014-01-01T05:20:00Z' + format: date-time + type: string + x-auditable: true + zone_id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + required: + - id + - hosts + - status + type: object + tlsCertificatesAndHostnamesCertificatePackQuotaResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + advanced: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesQuota' + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCertificatePackResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificatePack' + type: array + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCertificatePackResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificatePack' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesCertificatePacksComponentsSchemasStatus: + description: Status of certificate pack. + enum: + - initializing + - pending_validation + - deleted + - pending_issuance + - pending_deployment + - pending_deletion + - pending_expiration + - expired + - active + - initializing_timed_out + - validation_timed_out + - issuance_timed_out + - deployment_timed_out + - deletion_timed_out + - pending_cleanup + - staging_deployment + - staging_active + - deactivating + - inactive + - backup_issued + - holding_deployment + example: initializing + type: string + x-auditable: true + tlsCertificatesAndHostnamesCertificateStatus: + description: Current status of certificate. + enum: + - initializing + - authorizing + - active + - expired + - issuing + - timing_out + - pending_deployment + example: active + type: string + x-auditable: true + tlsCertificatesAndHostnamesCloudflareBranding: + description: >- + Whether or not to add Cloudflare Branding for the order. This will add a + subdomain of sni.cloudflaressl.com as the Common Name if set to true. + example: false + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesComponentsSchemasValidationMethod: + properties: + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethodDefinition + required: + - validation_method + type: object + tlsCertificatesAndHostnamesDeleteAdvancedCertificatePackResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesIdentifier' + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tlsCertificatesAndHostnamesMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tlsCertificatesAndHostnamesPrimary: + description: Identifier of the primary certificate in a pack. + example: 7e7b8deba8538af625850b7b2530034c + type: string + x-auditable: true + tlsCertificatesAndHostnamesQuota: + properties: + allocated: + description: Quantity Allocated. + type: integer + x-auditable: true + used: + description: Quantity Used. + type: integer + x-auditable: true + type: object + tlsCertificatesAndHostnamesSchemasCertificateAuthority: + description: >- + Certificate Authority selected for the order. For information on any + certificate authority specific details or restrictions [see this page + for more + details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities) + enum: + - google + - lets_encrypt + - ssl_com + example: lets_encrypt + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasEnabled: + description: >- + Disabling Universal SSL removes any currently active Universal SSL + certificates for your zone from the edge and prevents any future + Universal SSL certificates from being ordered. If there are no advanced + certificates or custom certificates uploaded for the domain, visitors + will be unable to access the domain over HTTPS. By disabling Universal + SSL, you understand that the following Cloudflare settings and + preferences will result in visitors being unable to visit your domain + unless you have uploaded a custom certificate or purchased an advanced + certificate. * HSTS * Always Use HTTPS * Opportunistic Encryption * + Onion Routing * Any Page Rules redirecting traffic to HTTPS Similarly, + any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is + enabled will result in users being unable to visit your site without a + valid certificate at Cloudflare's edge. If you do not have a valid + custom or advanced certificate at Cloudflare's edge and are unsure if + any of the above Cloudflare settings are enabled, or if any HTTP + redirects exist at your origin, we advise leaving Universal SSL enabled + for your domain. + example: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesSchemasHosts: + description: >- + Comma separated list of valid host names for the certificate packs. Must + contain the zone apex, may not contain more than 50 hosts, and may not + be empty. + example: + - example.com + - '*.example.com' + - www.example.com + items: + type: string + x-auditable: true + type: array + x-stainless-collection-type: set + x-stainless-terraform-configurability: computed_optional + tlsCertificatesAndHostnamesSchemasSignature: + description: Certificate's signature algorithm. + enum: + - ECDSAWithSHA256 + - SHA1WithRSA + - SHA256WithRSA + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasType: + description: Type of certificate pack. + enum: + - mh_custom + - managed_hostname + - sni_custom + - universal + - advanced + - total_tls + - keyless + - legacy_custom + example: universal + type: string + x-auditable: true + tlsCertificatesAndHostnamesSchemasValidationMethod: + description: Validation method in use for a certificate pack order. + enum: + - http + - cname + - txt + example: txt + type: string + x-auditable: true + tlsCertificatesAndHostnamesSslUniversalSettingsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesUniversal' + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesSslValidationMethodResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + messages: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + status: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethodComponentsSchemasStatus + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesValidationMethodDefinition + type: object + required: + - success + - errors + - messages + tlsCertificatesAndHostnamesSslVerificationResponseCollection: + properties: + result: + items: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesVerification' + type: array + type: object + tlsCertificatesAndHostnamesUniversal: + properties: + enabled: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasEnabled' + type: object + tlsCertificatesAndHostnamesValidationMethod: + description: Validation Method selected for the order. + enum: + - txt + - http + - email + example: txt + type: string + x-auditable: true + tlsCertificatesAndHostnamesValidationMethodComponentsSchemasStatus: + description: Result status. + example: pending_validation + type: string + x-auditable: true + tlsCertificatesAndHostnamesValidationMethodDefinition: + description: Desired validation method. + enum: + - http + - cname + - txt + - email + example: txt + type: string + x-auditable: true + tlsCertificatesAndHostnamesValidationRecord: + description: Certificate's required validation record. + properties: + cname: + description: The CNAME record hostname for DCV delegation. + example: _acme-challenge.example.com + readOnly: true + type: string + x-auditable: true + cname_target: + description: The CNAME record target value for DCV delegation. + example: dcv.cloudflare.com + readOnly: true + type: string + x-auditable: true + emails: + description: >- + The set of email addresses that the certificate authority (CA) will + use to complete domain validation. + example: + - administrator@example.com + - webmaster@example.com + items: + type: string + x-auditable: true + type: array + http_body: + description: >- + The content that the certificate authority (CA) will expect to find + at the http_url during the domain validation. + example: ca3-574923932a82475cb8592200f1a2a23d + type: string + http_url: + description: The url that will be checked during domain validation. + example: >- + http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt + type: string + status: + description: Status of the validation record. + example: pending + readOnly: true + type: string + txt_name: + description: >- + The hostname that the certificate authority (CA) will check for a + TXT record during domain validation . + example: _acme-challenge.app.example.com + type: string + x-auditable: true + txt_value: + description: >- + The TXT record that the certificate authority (CA) will check during + domain validation. + example: 810b7d5f01154524b961ba0cd578acc2 + type: string + type: object + tlsCertificatesAndHostnamesValidityDays: + description: Validity Days selected for the order. + enum: + - 14 + - 30 + - 90 + - 365 + type: integer + x-auditable: true + tlsCertificatesAndHostnamesVerification: + properties: + brand_check: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesBrandCheck' + cert_pack_uuid: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertPackUuid' + certificate_status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesCertificateStatus' + signature: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesSchemasSignature' + validation_method: + $ref: >- + #/components/schemas/tlsCertificatesAndHostnamesSchemasValidationMethod + verification_info: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesVerificationInfo' + verification_status: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesVerificationStatus' + verification_type: + $ref: '#/components/schemas/tlsCertificatesAndHostnamesVerificationType' + required: + - certificate_status + type: object + tlsCertificatesAndHostnamesVerificationInfo: + description: Certificate's required verification information. + properties: + record_name: + description: Name of CNAME record. + enum: + - record_name + - http_url + - cname + - txt_name + format: hostname + type: string + x-auditable: true + record_target: + description: Target of CNAME record. + enum: + - record_value + - http_body + - cname_target + - txt_value + format: hostname + type: string + x-auditable: true + type: object + tlsCertificatesAndHostnamesVerificationStatus: + description: >- + Status of the required verification information, omitted if verification + status is unknown. + example: true + type: boolean + x-auditable: true + tlsCertificatesAndHostnamesVerificationType: + description: Method of verification. + enum: + - cname + - meta tag + example: cname + type: string + x-auditable: true + unnamedSchemaRef16aca57bde2963201c7e6e895436c1c1: + default: ubiquitous + description: >- + A ubiquitous bundle has the highest probability of being verified + everywhere, even by clients using outdated or unusual trust stores. An + optimal bundle uses the shortest chain and newest intermediates. And the + force bundle verifies the chain, but does not otherwise modify it. + enum: + - ubiquitous + - optimal + - force + example: ubiquitous + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + ssl: + id: cloudflare.ssl.ssl + name: ssl + title: Ssl + methods: + create_analyze: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1analyze/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + certificate_packs: + id: cloudflare.ssl.certificate_packs + name: certificate_packs + title: Certificate Packs + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1certificate_packs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1certificate_packs~1order/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1ssl~1certificate_packs~1{certificate_pack_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1ssl~1certificate_packs~1{certificate_pack_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1ssl~1certificate_packs~1{certificate_pack_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/certificate_packs/methods/get' + - $ref: '#/components/x-stackQL-resources/certificate_packs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/certificate_packs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/certificate_packs/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/certificate_packs/methods/delete' + replace: [] + quota: + id: cloudflare.ssl.quota + name: quota + title: Quota + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1certificate_packs~1quota/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quota/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + recommendations: + id: cloudflare.ssl.recommendations + name: recommendations + title: Recommendations + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1recommendation/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recommendations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + settings: + id: cloudflare.ssl.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1universal~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1universal~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/edit' + delete: [] + replace: [] + verification: + id: cloudflare.ssl.verification + name: verification + title: Verification + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1ssl~1verification/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1ssl~1verification~1{certificate_pack_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/verification/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/verification/methods/edit' + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/ssl_tls.yaml b/providers/src/cloudflare/v00.00.00000/services/ssl_tls.yaml deleted file mode 100644 index 174a4d59..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/ssl_tls.yaml +++ /dev/null @@ -1,1799 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Custom SSL for a Zone - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - ssl_tls - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - certificate_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/custom-certificate' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - custom-certificate: - properties: - bundle_method: - $ref: '#/components/schemas/bundle_method' - expires_on: - $ref: '#/components/schemas/components-schemas-expires_on' - geo_restrictions: - $ref: '#/components/schemas/geo_restrictions' - hosts: - $ref: '#/components/schemas/hosts' - id: - $ref: '#/components/schemas/custom-certificate_components-schemas-identifier' - issuer: - $ref: '#/components/schemas/issuer' - keyless_server: - $ref: '#/components/schemas/keyless-certificate' - modified_on: - $ref: '#/components/schemas/components-schemas-modified_on' - policy: - $ref: '#/components/schemas/policy' - priority: - $ref: '#/components/schemas/schemas-priority' - signature: - $ref: '#/components/schemas/signature' - status: - $ref: '#/components/schemas/custom-certificate_components-schemas-status' - uploaded_on: - $ref: '#/components/schemas/uploaded_on' - zone_id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - - hosts - - issuer - - signature - - status - - bundle_method - - zone_id - - uploaded_on - - modified_on - - expires_on - - priority - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - bundle_method: - default: ubiquitous - description: 'A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.' - enum: - - ubiquitous - - optimal - - force - example: ubiquitous - type: string - components-schemas-expires_on: - description: When the certificate from the authority expires. - example: '2016-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - geo_restrictions: - description: 'Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.' - properties: - label: - enum: - - us - - eu - - highest_security - example: us - type: object - hosts: - items: - description: The valid hosts for the certificates. - example: example.com - maxLength: 253 - readOnly: true - type: string - type: array - custom-certificate_components-schemas-identifier: - description: Custom certificate identifier tag. - example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 - maxLength: 36 - readOnly: true - type: string - issuer: - description: The certificate authority that issued the certificate. - example: GlobalSign - readOnly: true - type: string - keyless-certificate: - allOf: - - $ref: '#/components/schemas/keyless-certificate_components-schemas-base' - components-schemas-modified_on: - description: When the certificate was last modified. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - policy: - description: 'Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as ''country: IN'', as well as ''region: EU'' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.' - example: '(country: US) or (region: EU)' - type: string - schemas-priority: - default: 20 - description: 'The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping ''legacy_custom'' certificates, but ''legacy_custom'' certificates will always supercede ''sni_custom'' certificates.' - example: 1 - type: number - signature: - description: The type of hash used for the certificate. - example: SHA256WithRSA - readOnly: true - type: string - custom-certificate_components-schemas-status: - description: Status of the zone's custom SSL. - enum: - - active - - expired - - deleted - - pending - - initializing - example: active - readOnly: true - uploaded_on: - description: When the certificate was uploaded to Cloudflare. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - keyless-certificate_components-schemas-base: - properties: - created_on: - description: When the Keyless SSL was created. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - enabled: - $ref: '#/components/schemas/schemas-enabled' - host: - $ref: '#/components/schemas/schemas-host' - id: - $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier' - modified_on: - description: When the Keyless SSL was last modified. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - name: - $ref: '#/components/schemas/keyless-certificate_components-schemas-name' - permissions: - description: Available permissions for the Keyless SSL for the current user requesting the item. - example: - - '#ssl:read' - - '#ssl:edit' - items: {} - readOnly: true - type: array - port: - $ref: '#/components/schemas/schemas-port' - status: - $ref: '#/components/schemas/keyless-certificate_components-schemas-status' - required: - - id - - name - - host - - port - - status - - enabled - - permissions - - created_on - - modified_on - type: object - schemas-enabled: - description: Whether or not the Keyless SSL is on or off. - example: false - readOnly: true - type: boolean - schemas-host: - description: The keyless SSL name. - example: example.com - format: hostname - maxLength: 253 - type: string - keyless-certificate_components-schemas-identifier: - description: Keyless certificate identifier tag. - example: 4d2844d2ce78891c34d0b6c0535a291e - maxLength: 32 - readOnly: true - type: string - keyless-certificate_components-schemas-name: - description: The keyless SSL name. - example: example.com Keyless SSL - maxLength: 180 - readOnly: true - type: string - schemas-port: - default: 24008 - description: The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server. - example: 24008 - maxLength: 65535 - type: number - keyless-certificate_components-schemas-status: - description: Status of the Keyless SSL. - enum: - - active - - deleted - example: active - readOnly: true - type: string - certificate: - description: The zone's SSL certificate or certificate and the intermediate(s). - example: | - -----BEGIN CERTIFICATE----- - MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV - BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX - aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF - MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 - ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB - CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 - CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB - KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 - 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI - dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 - izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 - 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI - GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV - BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF - MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 - 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP - Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG - SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq - 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw - YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= - -----END CERTIFICATE----- - type: string - private_key: - description: The zone's private key. - example: | - -----BEGIN RSA PRIVATE KEY----- - MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG - dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn - abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid - tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py - FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE - ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb - HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ - axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb - +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g - +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv - KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 - 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo - /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu - iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 - N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe - VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB - vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U - lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR - 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 - mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX - dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe - PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS - fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W - qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T - lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi - -----END RSA PRIVATE KEY----- - type: string - custom-certificate_components-schemas-type: - default: legacy_custom - description: The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake. - enum: - - legacy_custom - - sni_custom - example: sni_custom - type: string - certificate_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - certificate_response_id_only: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/custom-certificate_components-schemas-identifier' - type: object - keyless_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/keyless-certificate' - type: array - schemas-certificate: - description: The zone's SSL certificate or SSL certificate and intermediate(s). - example: '-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----' - type: string - keyless_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - keyless_response_single_id: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier' - type: object - ssl_verification_response_collection: - allOf: - - properties: - result: - items: - $ref: '#/components/schemas/verification' - type: array - verification: - properties: - brand_check: - $ref: '#/components/schemas/brand_check' - cert_pack_uuid: - $ref: '#/components/schemas/cert_pack_uuid' - certificate_status: - $ref: '#/components/schemas/certificate_status' - signature: - $ref: '#/components/schemas/schemas-signature' - validation_method: - $ref: '#/components/schemas/schemas-validation_method' - verification_info: - $ref: '#/components/schemas/verification_info' - verification_status: - $ref: '#/components/schemas/verification_status' - verification_type: - $ref: '#/components/schemas/verification_type' - required: - - certificate_status - type: object - brand_check: - description: Certificate Authority is manually reviewing the order. - example: false - type: boolean - cert_pack_uuid: - description: Certificate Pack UUID. - example: a77f8bd7-3b47-46b4-a6f1-75cf98109948 - type: string - certificate_status: - description: Current status of certificate. - enum: - - initializing - - authorizing - - active - - expired - - issuing - - timing_out - - pending_deployment - example: active - type: string - schemas-signature: - description: Certificate's signature algorithm. - enum: - - ECDSAWithSHA256 - - SHA1WithRSA - - SHA256WithRSA - type: string - schemas-validation_method: - description: Validation method in use for a certificate pack order. - enum: - - http - - cname - - txt - example: txt - type: string - verification_info: - description: Certificate's required verification information. - enum: - - record_name - - record_value - - http_url - - http_body - - cname - - cname_target - - txt_name - - txt_value - properties: - record_name: - description: Name of CNAME record. - example: b3b90cfedd89a3e487d3e383c56c4267.example.com - format: hostname - type: string - record_target: - description: Target of CNAME record. - example: 6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com - format: hostname - type: string - type: object - verification_status: - description: 'Status of the required verification information, omitted if verification status is unknown.' - example: true - type: boolean - verification_type: - description: Method of verification. - enum: - - cname - - meta tag - example: cname - type: string - components-schemas-validation_method: - properties: - validation_method: - $ref: '#/components/schemas/validation_method_definition' - required: - - validation_method - type: object - ssl_validation_method_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - status: - $ref: '#/components/schemas/validation_method_components-schemas-status' - validation_method: - $ref: '#/components/schemas/validation_method_definition' - validation_method_definition: - description: Desired validation method. - enum: - - http - - cname - - txt - - email - example: txt - type: string - validation_method_components-schemas-status: - description: Result status. - example: pending_validation - type: string - schemas-id: - description: Identifier of a recommedation result. - example: ssl_recommendation - type: string - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - components-schemas-value: - enum: - - flexible - - full - - strict - example: strict - type: string - total_tls_settings_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - certificate_authority: - $ref: '#/components/schemas/schemas-certificate_authority' - enabled: - $ref: '#/components/schemas/total-tls_components-schemas-enabled' - validity_days: - $ref: '#/components/schemas/schemas-validity_days' - schemas-certificate_authority: - description: The Certificate Authority that Total TLS certificates will be issued through. - enum: - - google - - lets_encrypt - example: google - type: string - total-tls_components-schemas-enabled: - description: 'If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.' - example: true - type: boolean - schemas-validity_days: - description: The validity period in days for the certificates ordered via Total TLS. - enum: - - 90 - type: integer - ssl_universal_settings_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/universal' - universal: - properties: - enabled: - $ref: '#/components/schemas/components-schemas-enabled' - type: object - components-schemas-enabled: - description: |- - Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no dedicated certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS. - - By disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased a dedicated certificate. - - * HSTS - * Always Use HTTPS - * Opportunistic Encryption - * Onion Routing - * Any Page Rules redirecting traffic to HTTPS - - Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge. - - If you do not have a valid custom or dedicated certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain. - example: true - type: boolean - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_custom_certificates: - id: cloudflare.ssl_tls.zones_custom_certificates - name: zones_custom_certificates - title: Zones Custom Certificates - methods: - custom_ssl_for_a_zone_list_ssl_configurations: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _custom_ssl_for_a_zone_list_ssl_configurations: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_ssl_for_a_zone_create_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates/post' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_ssl_for_a_zone_delete_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_ssl_for_a_zone_ssl_configuration_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _custom_ssl_for_a_zone_ssl_configuration_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_ssl_for_a_zone_edit_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - custom_ssl_for_a_zone_re_prioritize_ssl_certificates: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1custom_certificates~1prioritize/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_custom_certificates/methods/custom_ssl_for_a_zone_list_ssl_configurations' - - $ref: '#/components/x-stackQL-resources/zones_custom_certificates/methods/custom_ssl_for_a_zone_ssl_configuration_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_custom_certificates/methods/custom_ssl_for_a_zone_create_ssl_configuration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_custom_certificates/methods/custom_ssl_for_a_zone_delete_ssl_configuration' - zones_keyless_certificates: - id: cloudflare.ssl_tls.zones_keyless_certificates - name: zones_keyless_certificates - title: Zones Keyless Certificates - methods: - keyless_ssl_for_a_zone_list_keyless_ssl_configurations: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1keyless_certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _keyless_ssl_for_a_zone_list_keyless_ssl_configurations: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1keyless_certificates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - keyless_ssl_for_a_zone_create_keyless_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1keyless_certificates/post' - response: - mediaType: application/json - openAPIDocKey: '200' - keyless_ssl_for_a_zone_delete_keyless_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1keyless_certificates~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - keyless_ssl_for_a_zone_get_keyless_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1keyless_certificates~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _keyless_ssl_for_a_zone_get_keyless_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1keyless_certificates~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - keyless_ssl_for_a_zone_edit_keyless_ssl_configuration: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1keyless_certificates~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_keyless_certificates/methods/keyless_ssl_for_a_zone_list_keyless_ssl_configurations' - - $ref: '#/components/x-stackQL-resources/zones_keyless_certificates/methods/keyless_ssl_for_a_zone_get_keyless_ssl_configuration' - insert: - - $ref: '#/components/x-stackQL-resources/zones_keyless_certificates/methods/keyless_ssl_for_a_zone_create_keyless_ssl_configuration' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_keyless_certificates/methods/keyless_ssl_for_a_zone_delete_keyless_ssl_configuration' - zones_ssl_verification: - id: cloudflare.ssl_tls.zones_ssl_verification - name: zones_ssl_verification - title: Zones Ssl Verification - methods: - ssl_verification_ssl_verification_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1verification/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _ssl_verification_ssl_verification_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1verification/get' - response: - mediaType: application/json - openAPIDocKey: '200' - ssl_verification_edit_ssl_certificate_pack_validation_method: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1verification~1{cert_pack_uuid}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_ssl_verification/methods/ssl_verification_ssl_verification_details' - insert: [] - update: [] - delete: [] - zones_ssl_recommendation: - id: cloudflare.ssl_tls.zones_ssl_recommendation - name: zones_ssl_recommendation - title: Zones Ssl Recommendation - methods: - ssl__tls_mode_recommendation_ssl__tls_recommendation: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1recommendation/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _ssl__tls_mode_recommendation_ssl__tls_recommendation: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1recommendation/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_acm_total_tls: - id: cloudflare.ssl_tls.zones_acm_total_tls - name: zones_acm_total_tls - title: Zones Acm Total Tls - methods: - total_tls_total_tls_settings_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1acm~1total_tls/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _total_tls_total_tls_settings_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1acm~1total_tls/get' - response: - mediaType: application/json - openAPIDocKey: '200' - total_tls_enable_or_disable_total_tls: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1acm~1total_tls/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_acm_total_tls/methods/total_tls_total_tls_settings_details' - insert: [] - update: [] - delete: [] - zones_ssl_universal_settings: - id: cloudflare.ssl_tls.zones_ssl_universal_settings - name: zones_ssl_universal_settings - title: Zones Ssl Universal Settings - methods: - universal_ssl_settings_for_a_zone_universal_ssl_settings_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1universal~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _universal_ssl_settings_for_a_zone_universal_ssl_settings_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1universal~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - universal_ssl_settings_for_a_zone_edit_universal_ssl_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1ssl~1universal~1settings/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_ssl_universal_settings/methods/universal_ssl_settings_for_a_zone_universal_ssl_settings_details' - insert: [] - update: [] - delete: [] -paths: - '/zones/{zone_identifier}/custom_certificates': - get: - description: 'List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping ''legacy_custom'' certificates, but ''legacy_custom'' certificates will always supercede ''sni_custom'' certificates.' - operationId: custom-ssl-for-a-zone-list-ssl-configurations - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_collection' - description: List SSL Configurations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List SSL Configurations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List SSL Configurations - tags: - - Custom SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - post: - description: Upload a new SSL certificate for a zone. - operationId: custom-ssl-for-a-zone-create-ssl-configuration - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - bundle_method: - $ref: '#/components/schemas/bundle_method' - certificate: - $ref: '#/components/schemas/certificate' - geo_restrictions: - $ref: '#/components/schemas/geo_restrictions' - policy: - $ref: '#/components/schemas/policy' - private_key: - $ref: '#/components/schemas/private_key' - type: - $ref: '#/components/schemas/custom-certificate_components-schemas-type' - required: - - certificate - - private_key - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_single' - description: Create SSL Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create SSL Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create SSL Configuration - tags: - - Custom SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/custom_certificates/prioritize': - put: - description: 'If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping ''legacy_custom'' certificates.' - operationId: custom-ssl-for-a-zone-re-prioritize-ssl-certificates - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - certificates: - description: Array of ordered certificates. - example: - - id: 5a7805061c76ada191ed06f989cc3dac - priority: 2 - - id: 9a7806061c88ada191ed06f989cc3dac - priority: 1 - items: - properties: - id: - $ref: '#/components/schemas/custom-certificate_components-schemas-identifier' - priority: - $ref: '#/components/schemas/schemas-priority' - type: object - type: array - required: - - certificates - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_collection' - description: Re-prioritize SSL Certificates response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Re-prioritize SSL Certificates response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Re-prioritize SSL Certificates - tags: - - Custom SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/custom_certificates/{identifier}': - delete: - description: Remove a SSL certificate from a zone. - operationId: custom-ssl-for-a-zone-delete-ssl-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-certificate_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_id_only' - description: Delete SSL Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_id_only' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete SSL Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete SSL Configuration - tags: - - Custom SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - get: - operationId: custom-ssl-for-a-zone-ssl-configuration-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-certificate_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_single' - description: SSL Configuration Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: SSL Configuration Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: SSL Configuration Details - tags: - - Custom SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - patch: - description: 'Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.' - operationId: custom-ssl-for-a-zone-edit-ssl-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/custom-certificate_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - bundle_method: - $ref: '#/components/schemas/bundle_method' - certificate: - $ref: '#/components/schemas/certificate' - geo_restrictions: - $ref: '#/components/schemas/geo_restrictions' - policy: - $ref: '#/components/schemas/policy' - private_key: - $ref: '#/components/schemas/private_key' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/certificate_response_single' - description: Edit SSL Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/certificate_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit SSL Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit SSL Configuration - tags: - - Custom SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/keyless_certificates': - get: - description: List all Keyless SSL configurations for a given zone. - operationId: keyless-ssl-for-a-zone-list-keyless-ssl-configurations - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keyless_response_collection' - description: List Keyless SSL Configurations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keyless_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Keyless SSL Configurations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Keyless SSL Configurations - tags: - - Keyless SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - operationId: keyless-ssl-for-a-zone-create-keyless-ssl-configuration - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - bundle_method: - $ref: '#/components/schemas/bundle_method' - certificate: - $ref: '#/components/schemas/schemas-certificate' - host: - $ref: '#/components/schemas/schemas-host' - name: - $ref: '#/components/schemas/keyless-certificate_components-schemas-name' - port: - $ref: '#/components/schemas/schemas-port' - required: - - host - - port - - certificate - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keyless_response_single' - description: Create Keyless SSL Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keyless_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Keyless SSL Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Keyless SSL Configuration - tags: - - Keyless SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/keyless_certificates/{identifier}': - delete: - operationId: keyless-ssl-for-a-zone-delete-keyless-ssl-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keyless_response_single_id' - description: Delete Keyless SSL Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keyless_response_single_id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Keyless SSL Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Keyless SSL Configuration - tags: - - Keyless SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Get details for one Keyless SSL configuration. - operationId: keyless-ssl-for-a-zone-get-keyless-ssl-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keyless_response_single' - description: Get Keyless SSL Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keyless_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Keyless SSL Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Keyless SSL Configuration - tags: - - Keyless SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: 'This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port,certificate,enabled.' - operationId: keyless-ssl-for-a-zone-edit-keyless-ssl-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - enabled: - $ref: '#/components/schemas/schemas-enabled' - host: - $ref: '#/components/schemas/schemas-host' - name: - $ref: '#/components/schemas/keyless-certificate_components-schemas-name' - port: - $ref: '#/components/schemas/schemas-port' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/keyless_response_single' - description: Edit Keyless SSL Configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/keyless_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Keyless SSL Configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit Keyless SSL Configuration - tags: - - Keyless SSL for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/ssl/verification': - get: - description: Get SSL Verification Info for a Zone. - operationId: ssl-verification-ssl-verification-details - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ssl_verification_response_collection' - description: SSL Verification Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ssl_verification_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: SSL Verification Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: SSL Verification Details - tags: - - SSL Verification - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/ssl/verification/{cert_pack_uuid}': - patch: - description: 'Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.' - operationId: ssl-verification-edit-ssl-certificate-pack-validation-method - parameters: - - in: path - name: cert_pack_uuid - required: true - schema: - $ref: '#/components/schemas/cert_pack_uuid' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-validation_method' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ssl_validation_method_response_collection' - description: Edit SSL Certificate Pack Validation Method response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ssl_validation_method_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit SSL Certificate Pack Validation Method response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit SSL Certificate Pack Validation Method - tags: - - SSL Verification - x-cfPermissionsRequired: - enum: - - '#ssl:read' - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/ssl/recommendation': - get: - description: Retrieve the SSL/TLS Recommender's recommendation for a zone. - operationId: ssl/-tls-mode-recommendation-ssl/-tls-recommendation - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/schemas-id' - modified_on: - $ref: '#/components/schemas/timestamp' - value: - $ref: '#/components/schemas/components-schemas-value' - description: SSL/TLS Recommendation response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/schemas-id' - modified_on: - $ref: '#/components/schemas/timestamp' - value: - $ref: '#/components/schemas/components-schemas-value' - - $ref: '#/components/schemas/api-response-common-failure' - description: SSL/TLS Recommendation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: SSL/TLS Recommendation - tags: - - SSL/TLS Mode Recommendation - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/acm/total_tls': - get: - description: Get Total TLS Settings for a Zone. - operationId: total-tls-total-tls-settings-details - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/total_tls_settings_response' - description: Total TLS Settings Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/total_tls_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Total TLS Settings Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Total TLS Settings Details - tags: - - Total TLS - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Set Total TLS Settings or disable the feature for a Zone. - operationId: total-tls-enable-or-disable-total-tls - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - certificate_authority: - $ref: '#/components/schemas/schemas-certificate_authority' - enabled: - $ref: '#/components/schemas/total-tls_components-schemas-enabled' - required: - - enabled - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/total_tls_settings_response' - description: Enable or Disable Total TLS response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/total_tls_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Enable or Disable Total TLS response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Enable or Disable Total TLS - tags: - - Total TLS - x-cfPermissionsRequired: - enum: - - '#ssl:read' - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/ssl/universal/settings': - get: - description: Get Universal SSL Settings for a Zone. - operationId: universal-ssl-settings-for-a-zone-universal-ssl-settings-details - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ssl_universal_settings_response' - description: Universal SSL Settings Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ssl_universal_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Universal SSL Settings Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Universal SSL Settings Details - tags: - - Universal SSL Settings for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Patch Universal SSL Settings for a Zone. - operationId: universal-ssl-settings-for-a-zone-edit-universal-ssl-settings - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/universal' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ssl_universal_settings_response' - description: Edit Universal SSL Settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ssl_universal_settings_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Universal SSL Settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit Universal SSL Settings - tags: - - Universal SSL Settings for a Zone - x-cfPermissionsRequired: - enum: - - '#ssl:read' - - '#ssl:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true diff --git a/providers/src/cloudflare/v00.00.00000/services/streams.yaml b/providers/src/cloudflare/v00.00.00000/services/streams.yaml new file mode 100644 index 00000000..f1c0d6d1 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/streams.yaml @@ -0,0 +1,4556 @@ +openapi: 3.0.3 +info: + title: streams API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/stream: + get: + description: Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters. + operationId: stream-videos-list-videos + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: status + schema: + $ref: '#/components/schemas/streamMediaState' + - in: query + name: creator + schema: + $ref: '#/components/schemas/streamCreator' + - in: query + name: type + schema: + $ref: '#/components/schemas/streamType' + - in: query + name: asc + schema: + $ref: '#/components/schemas/streamAsc' + - in: query + name: video_name + schema: + $ref: '#/components/schemas/streamVideoName' + - in: query + name: search + schema: + $ref: '#/components/schemas/streamSearch' + - in: query + name: start + schema: + $ref: '#/components/schemas/streamStart' + - in: query + name: end + schema: + $ref: '#/components/schemas/streamEnd' + - in: query + name: include_counts + schema: + $ref: '#/components/schemas/streamIncludeCounts' + - description: Filter by video ID(s). Can be a single ID or a comma-separated list of IDs. + in: query + name: id + schema: + type: string + - description: Filter by video name/UID(s). Can be a single name or a comma-separated list. + in: query + name: name + schema: + type: string + - description: Filter by live input ID to find videos associated with a specific live stream. + in: query + name: live_input_id + schema: + type: string + - description: Alias for 'end'. Returns videos created before this date/time (RFC 3339 format). + in: query + name: before + schema: + format: date-time + type: string + - description: Alias for 'start'. Returns videos created after this date/time (RFC 3339 format). + in: query + name: after + schema: + format: date-time + type: string + - description: Maximum number of videos to return (default 1000, max 1000). + in: query + name: limit + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamVideoResponseCollection' + description: List videos response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List videos response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List videos + tags: + - Stream Videos + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: [] + method: list + post: + description: Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details. + operationId: stream-videos-initiate-video-uploads-using-tus + parameters: + - in: header + name: Tus-Resumable + schema: + $ref: '#/components/schemas/streamTusResumable' + - in: header + name: Upload-Creator + schema: + $ref: '#/components/schemas/streamCreator' + - in: header + name: Upload-Length + schema: + $ref: '#/components/schemas/streamUploadLength' + - in: header + name: Upload-Metadata + schema: + $ref: '#/components/schemas/streamUploadMetadata' + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: direct_user + schema: + $ref: '#/components/schemas/streamDirectUser' + responses: + '201': + description: Initiate video uploads using TUS response. Returns a 201 Created status with Location header for TUS uploads. + headers: + Location: + description: The URL where the upload should be sent. + schema: + type: string + Stream-Media-ID: + description: The unique identifier for the video being uploaded. + schema: + type: string + Tus-Resumable: + description: The TUS protocol version. + schema: + type: string + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Initiate video uploads using TUS response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Initiate video uploads using TUS + tags: + - Stream Videos + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: [] + method: create + /accounts/{account_id}/stream/clip: + post: + description: Clips a video based on the specified start and end times provided in seconds. + operationId: stream-video-clipping-clip-videos-given-a-start-and-end-time + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamVideoClipStandard' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamClipResponseSingle' + description: Clip videos given a start and end time response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Clip videos given a start and end time response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Clip videos given a start and end time + tags: + - Stream Video Clipping + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - clip + method: create + /accounts/{account_id}/stream/copy: + post: + description: Uploads a video to Stream from a provided URL. + operationId: stream-videos-upload-videos-from-a-url + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: Upload-Creator + schema: + $ref: '#/components/schemas/streamCreator' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamVideoCopyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamVideoResponseSingle' + description: Upload videos from a URL response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Upload videos from a URL response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload videos from a URL + tags: + - Stream Videos + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - copy + method: create + /accounts/{account_id}/stream/direct_upload: + post: + description: Creates a direct upload that allows video uploads without an API key. + operationId: stream-videos-upload-videos-via-direct-upload-ur-ls + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: header + name: Upload-Creator + schema: + $ref: '#/components/schemas/streamCreator' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamDirectUploadRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDirectUploadResponse' + description: Upload videos via direct upload URLs response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Upload videos via direct upload URLs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload videos via direct upload URLs + tags: + - Stream Videos + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - direct_upload + method: create + /accounts/{account_id}/stream/keys: + get: + description: Lists the video ID and creation date and time when a signing key was created. + operationId: stream-signing-keys-list-signing-keys + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamKeyResponseCollection' + description: List signing keys response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List signing keys response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List signing keys + tags: + - Stream Signing Keys + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - keys + method: get + post: + description: Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video. + operationId: stream-signing-keys-create-signing-keys + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamKeyGenerationResponse' + description: Create signing keys response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create signing keys response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create signing keys + tags: + - Stream Signing Keys + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - keys + method: create + /accounts/{account_id}/stream/keys/{identifier}: + delete: + description: Deletes signing keys and revokes all signed URLs generated with the key. + operationId: stream-signing-keys-delete-signing-keys + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDeletedResponse' + description: Delete signing keys response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Delete signing keys response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete signing keys + tags: + - Stream Signing Keys + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - keys + method: delete + /accounts/{account_id}/stream/live_inputs: + get: + description: Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input. + operationId: stream-live-inputs-list-live-inputs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: include_counts + schema: + $ref: '#/components/schemas/streamIncludeCounts' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLiveInputResponseCollection' + description: List live inputs response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List live inputs response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List live inputs + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + method: list + post: + description: Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream. + operationId: stream-live-inputs-create-a-live-input + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamCreateInputRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLiveInputResponseSingle' + description: Create a live input response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create a live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a live input + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + method: create + /accounts/{account_id}/stream/live_inputs/{live_input_identifier}: + delete: + description: Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls. + operationId: stream-live-inputs-delete-a-live-input + parameters: + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: {} + description: Delete a live input response. + 4XX: + content: + application/json: {} + description: Delete a live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a live input + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + method: delete + get: + description: Retrieves details of an existing live input. + operationId: stream-live-inputs-retrieve-a-live-input + parameters: + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLiveInputResponseSingle' + description: Retrieve a live input response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Retrieve a live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve a live input + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + method: get + put: + description: Updates a specified live input. + operationId: stream-live-inputs-update-a-live-input + parameters: + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamUpdateInputRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLiveInputResponseSingle' + description: Update a live input response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Update a live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a live input + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + method: update + /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/disable: + post: + description: Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls until enabled. + operationId: stream-live-inputs-disable-a-live-input + parameters: + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLiveInputResponseSingle' + description: Disable a live input response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Disable a live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Disable a live input + tags: + - Stream Live Inputs + /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/enable: + post: + description: Allows a live input to be streamed to and makes the live input accessible to any future API calls. + operationId: stream-live-inputs-enable-a-live-input + parameters: + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLiveInputResponseSingle' + description: Enable a live input response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Enable a live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Enable a live input + tags: + - Stream Live Inputs + /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs: + get: + description: Retrieves all outputs associated with a specified live input. + operationId: stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input + parameters: + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamOutputResponseCollection' + description: List all outputs associated with a specified live input response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List all outputs associated with a specified live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all outputs associated with a specified live input + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + - outputs + method: list + post: + description: "Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input \u2014 one live input can have many outputs." + operationId: stream-live-inputs-create-a-new-output,-connected-to-a-live-input + parameters: + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamCreateOutputRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamOutputResponseSingle' + description: Create a new output, connected to a live input response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create a new output, connected to a live input response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new output, connected to a live input + tags: + - Stream Live Inputs + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + - outputs + method: create + /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}: + delete: + description: Deletes an output and removes it from the associated live input. + operationId: stream-live-inputs-delete-an-output + parameters: + - in: path + name: output_identifier + schema: + $ref: '#/components/schemas/streamOutputIdentifier' + required: true + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: {} + description: Delete an output response. + 4XX: + content: + application/json: {} + description: Delete an output response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an output + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + - outputs + method: delete + put: + description: Updates the state of an output. + operationId: stream-live-inputs-update-an-output + parameters: + - in: path + name: output_identifier + schema: + $ref: '#/components/schemas/streamOutputIdentifier' + required: true + - in: path + name: live_input_identifier + schema: + $ref: '#/components/schemas/streamLiveInputIdentifier' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamUpdateOutputRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamOutputResponseSingle' + description: Update an output response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Update an output response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an output + tags: + - Stream Live Inputs + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - live_inputs + - outputs + method: update + /accounts/{account_id}/stream/storage-usage: + get: + description: Returns information about an account's storage use. + operationId: stream-videos-storage-usage + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: creator + schema: + $ref: '#/components/schemas/streamCreator' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamStorageUseResponse' + description: Returns information about an account's storage use response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Returns information about an account's storage use response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Storage use + tags: + - Stream Videos + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - videos + method: storage_usage + /accounts/{account_id}/stream/watermarks: + get: + description: Lists all watermark profiles for an account. + operationId: stream-watermark-profile-list-watermark-profiles + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamWatermarkResponseCollection' + description: List watermark profiles response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List watermark profiles response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List watermark profiles + tags: + - Stream Watermark Profile + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - watermarks + method: list + post: + description: Creates watermark profiles using a single `HTTP POST multipart/form-data` request. + operationId: stream-watermark-profile-create-watermark-profiles-via-basic-upload + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + $ref: '#/components/schemas/streamName' + opacity: + $ref: '#/components/schemas/streamOpacity' + padding: + $ref: '#/components/schemas/streamPadding' + position: + $ref: '#/components/schemas/streamPosition' + scale: + $ref: '#/components/schemas/streamScale' + url: + description: URL of the watermark image to copy. + format: uri + type: string + type: object + multipart/form-data: + schema: + $ref: '#/components/schemas/streamWatermarkBasicUpload' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamWatermarkResponseSingle' + description: Create watermark profiles via basic upload response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create watermark profiles via basic upload response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create watermark profiles via basic upload + tags: + - Stream Watermark Profile + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - watermarks + method: create + /accounts/{account_id}/stream/watermarks/{identifier}: + delete: + description: Deletes a watermark profile. + operationId: stream-watermark-profile-delete-watermark-profiles + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + type: string + x-auditable: true + required: + - success + - errors + - messages + description: Delete watermark profiles response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Delete watermark profiles response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete watermark profiles + tags: + - Stream Watermark Profile + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - watermarks + method: delete + get: + description: Retrieves details for a single watermark profile. + operationId: stream-watermark-profile-watermark-profile-details + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamWatermarkResponseSingle' + description: Watermark profile details response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Watermark profile details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Watermark profile details + tags: + - Stream Watermark Profile + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - watermarks + method: get + /accounts/{account_id}/stream/webhook: + delete: + description: Deletes a webhook. + operationId: stream-webhook-delete-webhooks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDeletedResponse' + description: Delete webhooks response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Delete webhooks response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete webhooks + tags: + - Stream Webhook + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - webhooks + method: delete + get: + description: Retrieves a list of webhooks. + operationId: stream-webhook-view-webhooks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamWebhookResponseSingle' + description: View webhooks response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: View webhooks response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: View webhooks + tags: + - Stream Webhook + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - webhooks + method: get + put: + description: Creates a webhook notification. + operationId: stream-webhook-create-webhooks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamWebhookRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamWebhookResponseSingle' + description: Create webhooks response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create webhooks response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create webhooks + tags: + - Stream Webhook + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - webhooks + method: update + /accounts/{account_id}/stream/{identifier}: + delete: + description: Deletes a video and its copies from Cloudflare Stream. + operationId: stream-videos-delete-video + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + description: Delete video response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Delete video response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete video + tags: + - Stream Videos + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: [] + method: delete + get: + description: Fetches details for a single video. + operationId: stream-videos-retrieve-video-details + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamVideoResponseSingle' + description: Retrieve video details response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Retrieve video details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve video details + tags: + - Stream Videos + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: [] + method: get + post: + description: Edit details for a single video. + operationId: stream-videos-update-video-details + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamVideoUpdate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamVideoResponseSingle' + description: Edit video details response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Edit video details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit video details + tags: + - Stream Videos + x-stackql-sdk: + service: stream + resource_chain: [] + method: edit + /accounts/{account_id}/stream/{identifier}/audio: + get: + description: Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload. + operationId: list-audio-tracks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamListAudioTrackResponse' + description: Lists additional audio tracks on a video. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Lists additional audio tracks on a video response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List additional audio tracks on a video + tags: + - Stream Audio Tracks + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - audio_tracks + method: get + /accounts/{account_id}/stream/{identifier}/audio/copy: + post: + description: Adds an additional audio track to a video using the provided audio track URL. + operationId: add-audio-track + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamCopyAudioTrack' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamAddAudioTrackResponse' + description: Add audio tracks to a video. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Add audio tracks to a video response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add audio tracks to a video + tags: + - Stream Audio Tracks + x-stackql-sdk: + service: stream + resource_chain: + - audio_tracks + method: copy + /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}: + delete: + description: Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion. + operationId: delete-audio-tracks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - in: path + name: audio_identifier + schema: + $ref: '#/components/schemas/streamAudioIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDeletedResponse' + description: Deletes additional audio tracks on a video. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamDeletedResponse' + description: Deletes additional audio tracks on a video response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete additional audio tracks on a video + tags: + - Stream Audio Tracks + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - audio_tracks + method: delete + patch: + description: Edits additional audio tracks on a video. Editing the default status of an audio track to `true` will mark all other audio tracks on the video default status to `false`. + operationId: edit-audio-tracks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - in: path + name: audio_identifier + schema: + $ref: '#/components/schemas/streamAudioIdentifier' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamEditAudioTrack' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamAddAudioTrackResponse' + description: Edits additional audio tracks on a video. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Edits additional audio tracks on a video response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit additional audio tracks on a video + tags: + - Stream Audio Tracks + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - audio_tracks + method: edit + /accounts/{account_id}/stream/{identifier}/captions: + get: + description: Lists the available captions or subtitles for a specific video. + operationId: stream-subtitles/-captions-list-captions-or-subtitles + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLanguageResponseCollection' + description: List captions or subtitles response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List captions or subtitles response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List captions or subtitles + tags: + - Stream Subtitles/Captions + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - captions + method: get + /accounts/{account_id}/stream/{identifier}/captions/{language}: + delete: + description: Removes the captions or subtitles from a video. + operationId: stream-subtitles/-captions-delete-captions-or-subtitles + parameters: + - in: path + name: language + schema: + $ref: '#/components/schemas/streamLanguage' + required: true + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + type: string + x-auditable: true + required: + - success + - errors + - messages + type: object + description: Delete captions or subtitles response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Delete captions or subtitles response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete captions or subtitles + tags: + - Stream Subtitles/Captions + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - captions + - language + method: delete + get: + description: Lists the captions or subtitles for provided language. + operationId: stream-subtitles/-captions-get-caption-or-subtitle-for-language + parameters: + - in: path + name: language + schema: + $ref: '#/components/schemas/streamLanguage' + required: true + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLanguageResponseSingle' + description: List captions or subtitles response for a provided language. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List captions or subtitles response for a provided language. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List captions or subtitles for a provided language + tags: + - Stream Subtitles/Captions + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - captions + - language + method: get + put: + description: Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed. + operationId: stream-subtitles/-captions-upload-captions-or-subtitles + parameters: + - in: path + name: language + schema: + $ref: '#/components/schemas/streamLanguage' + required: true + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/streamCaptionBasicUpload' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLanguageResponseSingle' + description: Upload captions or subtitles response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Upload captions or subtitles response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload captions or subtitles + tags: + - Stream Subtitles/Captions + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - captions + - language + method: update + /accounts/{account_id}/stream/{identifier}/captions/{language}/generate: + post: + description: Generate captions or subtitles for provided language via AI. + operationId: stream-subtitles/-captions-generate-caption-or-subtitle-for-language + parameters: + - in: path + name: language + schema: + $ref: '#/components/schemas/streamLanguage' + required: true + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamLanguageResponseSingle' + description: Generate captions or subtitles response for a provided language. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Generate captions or subtitles response for a provided language. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Generate captions or subtitles for a provided language via AI + tags: + - Stream Subtitles/Captions + x-stackql-sdk: + service: stream + resource_chain: + - captions + - language + method: create + /accounts/{account_id}/stream/{identifier}/captions/{language}/vtt: + get: + description: Return WebVTT captions for a provided language. + operationId: stream-subtitles/-captions-get-vtt-caption-or-subtitle + parameters: + - in: path + name: language + schema: + $ref: '#/components/schemas/streamLanguage' + required: true + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + text/vtt: + schema: + type: object + properties: + contents: + type: string + description: Return WebVTT caption or subtitle response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Return WebVTT caption or subtitle response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Return WebVTT captions for a provided language + tags: + - Stream Subtitles/Captions + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - captions + - language + - vtt + method: get + /accounts/{account_id}/stream/{identifier}/downloads: + delete: + description: Delete the downloads for a video. Use `/downloads/{download_type}` instead for type-specific downloads. Available types are `default` and `audio`. + operationId: stream-m-p-4-downloads-delete-downloads + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDeletedResponse' + description: Delete downloads response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Delete downloads response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete downloads + tags: + - Stream MP4 Downloads + x-api-token-group: + - Stream Write + x-stackql-sdk: + service: stream + resource_chain: + - downloads + method: delete + get: + description: Lists the downloads created for a video. + operationId: stream-m-p-4-downloads-list-downloads + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDownloadsResponse' + description: List downloads response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: List downloads response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List downloads + tags: + - Stream MP4 Downloads + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - downloads + method: get + post: + description: Creates a download for a video when a video is ready to view. Use `/downloads/{download_type}` instead for type-specific downloads. Available types are `default` and `audio`. + operationId: stream-m-p-4-downloads-create-downloads + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDownloadsResponse' + description: Create downloads response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create downloads response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create downloads + tags: + - Stream MP4 Downloads + x-stackql-sdk: + service: stream + resource_chain: + - downloads + method: create + /accounts/{account_id}/stream/{identifier}/downloads/{download_type}: + delete: + description: Delete specific type of download. For backwards-compatibility, DELETE requests to /downloads will delete the default download. + operationId: stream-downloads-delete-type-specific-downloads + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: download_type + schema: + $ref: '#/components/schemas/streamDownloadType' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDeletedResponse' + description: Delete downloads response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Delete downloads response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete download + tags: + - Stream MP4 Downloads + x-api-token-group: + - Stream Write + post: + description: Creates a download for a video of specified type. For backwards-compatibility, POST requests to /downloads will enable the default download. + operationId: stream-downloads-create-type-specific-downloads + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: download_type + schema: + $ref: '#/components/schemas/streamDownloadType' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamDownloadsResponse' + description: Create download of specified type response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create downloads of specified type response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create download + tags: + - Stream MP4 Downloads + /accounts/{account_id}/stream/{identifier}/embed: + get: + description: Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body. + operationId: stream-videos-retreieve-embed-code-html + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + text/html: + schema: + type: object + properties: + contents: + type: string + description: Retreieve embed Code HTML response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Retreieve embed Code HTML response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve embed Code HTML + tags: + - Stream Videos + x-api-token-group: + - Stream Write + - Stream Read + x-stackql-sdk: + service: stream + resource_chain: + - embed + method: get + /accounts/{account_id}/stream/{identifier}/token: + post: + description: Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values. + operationId: stream-videos-create-signed-url-tokens-for-videos + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/streamSignedTokenRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/streamSignedTokenResponse' + description: Create signed URL tokens for videos response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/streamApiResponseCommonFailure' + description: Create signed URL tokens for videos response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create signed URL tokens for videos + tags: + - Stream Videos + x-stackql-sdk: + service: stream + resource_chain: + - token + method: create +components: + schemas: + streamAccessRules: + description: Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects. + properties: + action: + description: The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule. + enum: + - allow + - block + example: allow + type: string + x-auditable: true + country: + description: An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests. + items: + type: string + x-auditable: true + type: array + ip: + description: An array of IPv4 or IPV6 addresses or CIDRs used to match requests. + items: + type: string + x-auditable: true + type: array + type: + description: Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules. + enum: + - any + - ip.src + - ip.geoip.country + example: ip.src + type: string + x-auditable: true + type: object + streamAddAudioTrackResponse: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamAdditionalAudio' + required: + - success + - errors + - messages + type: object + streamAdditionalAudio: + properties: + default: + $ref: '#/components/schemas/streamAudioDefault' + label: + $ref: '#/components/schemas/streamAudioLabel' + status: + $ref: '#/components/schemas/streamAudioState' + uid: + $ref: '#/components/schemas/streamIdentifier' + type: object + streamAllowedOrigins: + description: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin. + example: + - example.com + items: + type: string + x-auditable: true + type: array + streamApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/streamMessages' + messages: + example: [] + $ref: '#/components/schemas/streamMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + streamAsc: + default: false + description: Lists videos in ascending order of creation. + example: true + type: boolean + streamAudioDefault: + default: false + description: Denotes whether the audio track will be played by default in a player. + type: boolean + x-auditable: true + streamAudioIdentifier: + description: The unique identifier for an additional audio track. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + type: string + x-auditable: true + streamAudioLabel: + description: A string to uniquely identify the track amongst other audio track labels for the specified video. + example: director commentary + type: string + x-auditable: true + streamAudioState: + description: Specifies the processing status of the video. + enum: + - queued + - ready + - error + type: string + x-auditable: true + streamCaptionBasicUpload: + properties: + file: + description: The WebVTT file containing the caption or subtitle content. + example: '@/Users/kyle/Desktop/tr.vtt' + type: string + x-auditable: true + required: + - file + type: object + streamCaptionStatus: + description: The status of a generated caption. + enum: + - ready + - inprogress + - error + type: string + x-auditable: true + streamCaptions: + properties: + generated: + $ref: '#/components/schemas/streamGeneratedCaption' + label: + $ref: '#/components/schemas/streamLabel' + language: + $ref: '#/components/schemas/streamLanguage' + status: + $ref: '#/components/schemas/streamCaptionStatus' + type: object + streamClipResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamVideos' + required: + - success + - errors + - messages + streamClippedFromVideoUid: + description: The unique video identifier (UID). + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + streamCopyAudioTrack: + properties: + label: + $ref: '#/components/schemas/streamAudioLabel' + url: + description: An audio track URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file. + example: https://www.examplestorage.com/audio_file.mp3 + format: uri + type: string + x-auditable: true + required: + - label + type: object + streamCreateInputRequest: + properties: + defaultCreator: + $ref: '#/components/schemas/streamLiveInputDefaultCreator' + deleteRecordingAfterDays: + $ref: '#/components/schemas/streamLiveInputRecordingDeletion' + enabled: + $ref: '#/components/schemas/streamLiveInputEnabled' + meta: + $ref: '#/components/schemas/streamLiveInputMetadata' + recording: + $ref: '#/components/schemas/streamLiveInputRecordingSettings' + type: object + streamCreateOutputRequest: + properties: + enabled: + $ref: '#/components/schemas/streamOutputEnabled' + streamKey: + $ref: '#/components/schemas/streamOutputStreamKey' + url: + $ref: '#/components/schemas/streamOutputUrl' + required: + - url + - streamKey + type: object + streamCreated: + description: The date and time the media item was created. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamCreator: + description: A user-defined identifier for the media creator. + example: creator-id_abcde12345 + maxLength: 64 + type: string + x-auditable: true + streamDeletedResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + example: ok + type: string + required: + - success + - errors + - messages + streamDirectUploadRequest: + properties: + allowedOrigins: + $ref: '#/components/schemas/streamAllowedOrigins' + creator: + $ref: '#/components/schemas/streamCreator' + expiry: + description: The date and time after upload when videos will not be accepted. + example: '2021-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + maxDurationSeconds: + $ref: '#/components/schemas/streamMaxDurationSeconds' + meta: + $ref: '#/components/schemas/streamMediaMetadata' + requireSignedURLs: + $ref: '#/components/schemas/streamRequireSignedURLs' + scheduledDeletion: + $ref: '#/components/schemas/streamScheduledDeletion' + thumbnailTimestampPct: + $ref: '#/components/schemas/streamThumbnailTimestampPct' + watermark: + $ref: '#/components/schemas/streamWatermarkAtUpload_2' + required: + - maxDurationSeconds + type: object + streamDirectUploadResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + scheduledDeletion: + $ref: '#/components/schemas/streamScheduledDeletion' + uid: + $ref: '#/components/schemas/streamIdentifier' + uploadURL: + description: The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request. + example: www.example.com/samplepath + type: string + watermark: + $ref: '#/components/schemas/streamWatermarks' + type: object + required: + - success + - errors + - messages + streamDirectUser: + default: false + description: Provisions a URL to let your end users upload videos directly to Cloudflare Stream without exposing your API token to clients. + example: true + type: boolean + x-auditable: true + streamDownloadPercentComplete: + description: Indicates the progress as a percentage between 0 and 100. + maximum: 100 + minimum: 0 + type: number + x-auditable: true + streamDownloadStatus: + description: The status of a generated download. + enum: + - ready + - inprogress + - error + type: string + x-auditable: true + streamDownloadType: + default: default + description: 'The type of downloads available are: `default`, `audio`.' + enum: + - default + - audio + example: audio + type: string + x-auditable: true + streamDownloadUrl: + description: The URL to access the generated download. + example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/downloads/default.mp4 + format: uri + type: string + x-auditable: true + streamDownloadedFrom: + description: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null. + example: https://company.com/logo.png + type: string + x-auditable: true + streamDownloads: + properties: + percentComplete: + $ref: '#/components/schemas/streamDownloadPercentComplete' + status: + $ref: '#/components/schemas/streamDownloadStatus' + url: + $ref: '#/components/schemas/streamDownloadUrl' + required: + - status + - percentComplete + type: object + streamDownloadsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: An object with download type keys. Each key is optional and only present if that download type has been created. + properties: + audio: + description: The audio-only download. Only present if this download type has been created. + $ref: '#/components/schemas/streamDownloads' + default: + description: The default video download. Only present if this download type has been created. + $ref: '#/components/schemas/streamDownloads' + type: object + required: + - success + - errors + - messages + streamDuration: + description: The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready. + type: number + x-auditable: true + streamEditAudioTrack: + properties: + default: + $ref: '#/components/schemas/streamAudioDefault' + label: + $ref: '#/components/schemas/streamAudioLabel' + type: object + streamEnd: + description: Lists videos created before the specified date. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + streamEndTimeSeconds: + description: Specifies the end time for the video clip in seconds. + type: integer + x-auditable: true + streamErrorReasonCode: + description: Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use. + example: ERR_NON_VIDEO + type: string + x-auditable: true + streamErrorReasonText: + description: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state. + example: The file was not recognized as a valid video file. + type: string + x-auditable: true + streamGeneratedCaption: + description: Whether the caption was generated via AI. + example: true + type: boolean + x-auditable: true + streamHeight: + description: The height of the image in pixels. + type: integer + x-auditable: true + streamIdentifier: + description: A Cloudflare-generated unique identifier for a media item. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + type: string + x-auditable: true + streamIncludeCounts: + default: false + description: Includes the total number of videos associated with the submitted query parameters. + example: true + type: boolean + streamInput: + properties: + height: + description: The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready. + type: integer + x-auditable: true + width: + description: The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready. + type: integer + x-auditable: true + type: object + streamInputRtmps: + description: Details for streaming to an live input using RTMPS. + properties: + streamKey: + $ref: '#/components/schemas/streamInputRtmpsStreamKey' + url: + $ref: '#/components/schemas/streamInputRtmpsUrl' + type: object + streamInputRtmpsStreamKey: + description: The secret key to use when streaming via RTMPS to a live input. + example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada + type: string + x-sensitive: true + streamInputRtmpsUrl: + description: The RTMPS URL you provide to the broadcaster, which they stream live video to. + example: rtmps://live.cloudflare.com:443/live/ + type: string + x-sensitive: true + streamInputSrt: + description: Details for streaming to a live input using SRT. + properties: + passphrase: + $ref: '#/components/schemas/streamInputSrtStreamPassphrase' + streamId: + $ref: '#/components/schemas/streamInputSrtStreamId' + url: + $ref: '#/components/schemas/streamInputSrtUrl' + type: object + streamInputSrtStreamId: + description: The identifier of the live input to use when streaming via SRT. + example: f256e6ea9341d51eea64c9454659e576 + type: string + x-auditable: true + streamInputSrtStreamPassphrase: + description: The secret key to use when streaming via SRT to a live input. + example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada + type: string + x-sensitive: true + streamInputSrtUrl: + description: The SRT URL you provide to the broadcaster, which they stream live video to. + example: srt://live.cloudflare.com:778 + type: string + x-sensitive: true + streamInputWebrtc: + description: Details for streaming to a live input using WebRTC. + properties: + url: + $ref: '#/components/schemas/streamInputWebrtcUrl' + type: object + streamInputWebrtcUrl: + description: The WebRTC URL you provide to the broadcaster, which they stream live video to. + example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish + type: string + x-sensitive: true + streamJwk: + description: The signing key in JWK format. + example: eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0= + type: string + x-sensitive: true + streamKeyGenerationResponse: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamKeys' + required: + - success + - errors + - messages + type: object + streamKeyResponseCollection: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/streamKeyResponseCollection_result_item' + type: array + required: + - success + - errors + - messages + type: object + streamKeyResponseCollection_result_item: + properties: + created: + $ref: '#/components/schemas/streamSigningKeyCreated' + id: + $ref: '#/components/schemas/streamSchemasIdentifier' + key_id: + description: The unique identifier for the signing key. + example: e9db990a82666dd571c77f944a5c5c8d + type: string + type: object + streamKeys: + properties: + created: + $ref: '#/components/schemas/streamSigningKeyCreated' + id: + $ref: '#/components/schemas/streamSchemasIdentifier' + jwk: + $ref: '#/components/schemas/streamJwk' + pem: + $ref: '#/components/schemas/streamPem' + type: object + streamLabel: + description: The language label displayed in the native language to users. + example: "T\xFCrk\xE7e" + type: string + x-auditable: true + streamLanguage: + description: The language tag in BCP 47 format. + example: tr + type: string + x-auditable: true + streamLanguageResponseCollection: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/streamCaptions' + type: array + required: + - success + - errors + - messages + type: object + streamLanguageResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamCaptions' + required: + - success + - errors + - messages + streamListAudioTrackResponse: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + audio: + description: Array of audio tracks for the video. + items: + $ref: '#/components/schemas/streamAdditionalAudio' + type: array + type: object + required: + - success + - errors + - messages + type: object + streamLiveInput: + description: The live input ID used to upload a video with Stream Live. + example: fc0a8dc887b16759bfd9ad922230a014 + maxLength: 32 + type: string + x-auditable: true + streamLiveInputCreated: + description: The date and time the live input was created. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamLiveInputDefaultCreator: + description: Sets the creator ID asssociated with this live input. + type: string + x-auditable: true + streamLiveInputEnabled: + default: true + description: Indicates whether the live input is enabled and can accept streams. + example: true + type: boolean + x-auditable: true + streamLiveInputIdentifier: + description: A unique identifier for a live input. + example: 66be4bf738797e01e1fca35a7bdecdcd + maxLength: 32 + type: string + x-auditable: true + streamLiveInputMetadata: + description: A user modifiable key-value store used to reference other systems of record for managing live inputs. + example: + name: test stream 1 + type: object + streamLiveInputModified: + description: The date and time the live input was last modified. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamLiveInputObjectWithoutUrl: + properties: + created: + $ref: '#/components/schemas/streamLiveInputCreated' + deleteRecordingAfterDays: + $ref: '#/components/schemas/streamLiveInputRecordingDeletion' + enabled: + $ref: '#/components/schemas/streamLiveInputEnabled' + meta: + $ref: '#/components/schemas/streamLiveInputMetadata' + modified: + $ref: '#/components/schemas/streamLiveInputModified' + uid: + $ref: '#/components/schemas/streamLiveInputIdentifier' + type: object + streamLiveInputRecordingAllowedOrigins: + description: Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use `*` for wildcard subdomains. An empty array allows videos to be viewed on any origin. + example: + - example.com + items: + type: string + x-auditable: true + type: array + streamLiveInputRecordingDeletion: + description: Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. + example: 45 + minimum: 30 + type: number + x-auditable: true + streamLiveInputRecordingHideLiveViewerCount: + default: false + description: Disables reporting the number of live viewers when this property is set to `true`. + example: true + type: boolean + x-auditable: true + streamLiveInputRecordingMode: + default: 'off' + description: Specifies the recording behavior for the live input. Set this value to `off` to prevent a recording. Set the value to `automatic` to begin a recording and transition to on-demand after Stream Live stops receiving input. + enum: + - 'off' + - automatic + example: automatic + type: string + x-auditable: true + streamLiveInputRecordingRequireSignedURLs: + default: false + description: Indicates if a video using the live input has the `requireSignedURLs` property set. Also enforces access controls on any video recording of the livestream with the live input. + example: true + type: boolean + x-auditable: true + streamLiveInputRecordingSettings: + description: Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied. + example: + hideLiveViewerCount: false + mode: 'off' + requireSignedURLs: false + timeoutSeconds: 0 + properties: + allowedOrigins: + $ref: '#/components/schemas/streamLiveInputRecordingAllowedOrigins' + hideLiveViewerCount: + $ref: '#/components/schemas/streamLiveInputRecordingHideLiveViewerCount' + mode: + $ref: '#/components/schemas/streamLiveInputRecordingMode' + requireSignedURLs: + $ref: '#/components/schemas/streamLiveInputRecordingRequireSignedURLs' + timeoutSeconds: + $ref: '#/components/schemas/streamLiveInputRecordingTimeoutSeconds' + type: object + streamLiveInputRecordingTimeoutSeconds: + default: 0 + description: Determines the amount of time a live input configured in `automatic` mode should wait before a recording transitions from live to on-demand. `0` is recommended for most use cases and indicates the platform default should be used. + type: integer + x-auditable: true + streamLiveInputResponseCollection: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + liveInputs: + items: + $ref: '#/components/schemas/streamLiveInputObjectWithoutUrl' + type: array + range: + description: The total number of remaining live inputs based on cursor position. + example: 1000 + type: integer + total: + description: The total number of live inputs that match the provided filters. + example: 35586 + type: integer + type: object + required: + - success + - errors + - messages + type: object + streamLiveInputResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamLiveInput_2' + required: + - success + - errors + - messages + streamLiveInputStatus: + description: The connection status of a live input. + enum: + - null + - connected + - reconnected + - reconnecting + - client_disconnect + - ttl_exceeded + - failed_to_connect + - failed_to_reconnect + - new_configuration_accepted + nullable: true + type: string + x-auditable: true + streamLiveInput_2: + description: Details about a live input. + properties: + created: + $ref: '#/components/schemas/streamLiveInputCreated' + deleteRecordingAfterDays: + $ref: '#/components/schemas/streamLiveInputRecordingDeletion' + enabled: + $ref: '#/components/schemas/streamLiveInputEnabled' + meta: + $ref: '#/components/schemas/streamLiveInputMetadata' + modified: + $ref: '#/components/schemas/streamLiveInputModified' + recording: + $ref: '#/components/schemas/streamLiveInputRecordingSettings' + rtmps: + $ref: '#/components/schemas/streamInputRtmps' + rtmpsPlayback: + $ref: '#/components/schemas/streamPlaybackRtmps' + srt: + $ref: '#/components/schemas/streamInputSrt' + srtPlayback: + $ref: '#/components/schemas/streamPlaybackSrt' + status: + $ref: '#/components/schemas/streamLiveInputStatus' + uid: + $ref: '#/components/schemas/streamLiveInputIdentifier' + webRTC: + $ref: '#/components/schemas/streamInputWebrtc' + webRTCPlayback: + $ref: '#/components/schemas/streamPlaybackWebrtc' + type: object + streamMaxDurationSeconds: + description: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown. + maximum: 36000 + minimum: 1 + type: integer + x-auditable: true + streamMediaMetadata: + description: A user modifiable key-value store used to reference other systems of record for managing videos. + example: + name: video12345.mp4 + type: object + streamMediaState: + description: Specifies the processing status for all quality levels for a video. + enum: + - pendingupload + - downloading + - queued + - inprogress + - ready + - error + - live-inprogress + example: inprogress + type: string + x-auditable: true + streamMediaStatus: + description: Specifies a detailed status for a video. If the `state` is `inprogress` or `error`, the `step` field returns `encoding` or `manifest`. If the `state` is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the approximate percent of completion. If the `state` is `error`, `errorReasonCode` and `errorReasonText` provide additional details. + properties: + errorReasonCode: + $ref: '#/components/schemas/streamErrorReasonCode' + errorReasonText: + $ref: '#/components/schemas/streamErrorReasonText' + pctComplete: + $ref: '#/components/schemas/streamPctComplete' + state: + $ref: '#/components/schemas/streamMediaState' + type: object + streamMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + streamModified: + description: The date and time the media item was last modified. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamName: + default: '' + description: A short description of the watermark profile. + example: Marketing Videos + type: string + x-auditable: true + streamNotificationUrl: + description: The URL where webhooks will be sent. + example: https://example.com + format: uri + type: string + x-auditable: true + streamOneTimeUploadExpiry: + description: The date and time when the video upload URL is no longer valid for direct user uploads. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamOpacity: + default: 1 + description: The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque. + example: 0.75 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + streamOutput: + properties: + enabled: + $ref: '#/components/schemas/streamOutputEnabled' + streamKey: + $ref: '#/components/schemas/streamOutputStreamKey' + uid: + $ref: '#/components/schemas/streamOutputIdentifier' + url: + $ref: '#/components/schemas/streamOutputUrl' + type: object + streamOutputEnabled: + default: true + description: When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch. + example: true + type: boolean + x-auditable: true + streamOutputIdentifier: + description: A unique identifier for the output. + example: baea4d9c515887b80289d5c33cf01145 + maxLength: 32 + type: string + x-auditable: true + streamOutputResponseCollection: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/streamOutput' + type: array + required: + - success + - errors + - messages + type: object + streamOutputResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamOutput' + required: + - success + - errors + - messages + streamOutputStreamKey: + description: The streamKey used to authenticate against an output's target. + example: uzya-f19y-g2g9-a2ee-51j2 + type: string + x-sensitive: true + streamOutputUrl: + description: The URL an output uses to restream. + example: rtmp://a.rtmp.youtube.com/live2 + type: string + x-sensitive: true + streamPadding: + default: 0.05 + description: The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm. + example: 0.1 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + streamPctComplete: + description: Indicates the progress as a percentage between 0 and 100. + example: '45' + type: string + x-auditable: true + streamPem: + description: The signing key in PEM format. + example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo= + type: string + x-sensitive: true + streamPlayback: + properties: + dash: + description: DASH Media Presentation Description for the video. + example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd + type: string + x-auditable: true + hls: + description: The HLS manifest for the video. + example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8 + type: string + x-auditable: true + type: object + streamPlaybackRtmps: + description: Details for playback from an live input using RTMPS. + properties: + streamKey: + $ref: '#/components/schemas/streamPlaybackRtmpsStreamKey' + url: + $ref: '#/components/schemas/streamPlaybackRtmpsUrl' + type: object + streamPlaybackRtmpsStreamKey: + description: The secret key to use for playback via RTMPS. + example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada + type: string + x-sensitive: true + streamPlaybackRtmpsUrl: + description: The URL used to play live video over RTMPS. + example: rtmps://live.cloudflare.com:443/live/ + type: string + x-sensitive: true + streamPlaybackSrt: + description: Details for playback from an live input using SRT. + properties: + passphrase: + $ref: '#/components/schemas/streamPlaybackSrtStreamPassphrase' + streamId: + $ref: '#/components/schemas/streamPlaybackSrtStreamId' + url: + $ref: '#/components/schemas/streamPlaybackSrtUrl' + type: object + streamPlaybackSrtStreamId: + description: The identifier of the live input to use for playback via SRT. + example: f256e6ea9341d51eea64c9454659e576 + type: string + x-auditable: true + streamPlaybackSrtStreamPassphrase: + description: The secret key to use for playback via SRT. + example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada + type: string + x-sensitive: true + streamPlaybackSrtUrl: + description: The URL used to play live video over SRT. + example: rtmps://live.cloudflare.com:443/live/ + type: string + x-sensitive: true + streamPlaybackWebrtc: + description: Details for playback from a live input using WebRTC. + properties: + url: + $ref: '#/components/schemas/streamPlaybackWebrtcUrl' + type: object + streamPlaybackWebrtcUrl: + description: The URL used to play live video over WebRTC. + example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play + type: string + x-sensitive: true + streamPosition: + default: upperRight + description: 'The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.' + example: center + type: string + x-auditable: true + streamPreview: + description: The video's preview page URI. This field is omitted until encoding is complete. + example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch + format: uri + type: string + x-auditable: true + streamReadyToStream: + description: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress. + example: true + type: boolean + x-auditable: true + streamReadyToStreamAt: + description: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamRequireSignedURLs: + default: false + description: Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video. + example: true + type: boolean + x-auditable: true + streamScale: + default: 0.15 + description: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video. + example: 0.1 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + streamScheduledDeletion: + description: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamSchemasIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + streamSearch: + description: Provides a partial word match of the `name` key in the `meta` field. Slow for medium to large video libraries. May be unavailable for very large libraries. + example: puppy.mp4 + type: string + x-auditable: true + streamSignedTokenRequest: + properties: + accessRules: + description: The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated. + example: + - action: block + country: + - US + - MX + type: ip.geoip.country + - action: allow + ip: + - 93.184.216.0/24 + - 2400:cb00::/32 + type: ip.src + - action: block + type: any + items: + $ref: '#/components/schemas/streamAccessRules' + type: array + downloadable: + default: false + description: The optional boolean value that enables using signed tokens to access MP4 download links for a video. + type: boolean + x-auditable: true + exp: + description: The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing. + type: integer + flags: + description: Optional flags for the signed token. + properties: + original: + default: false + description: Whether to return the original video without transformations. + type: boolean + type: object + id: + description: The optional ID of a Stream signing key. If present, the `pem` field is also required. + example: ab0d4ef71g4425f8dcba9041231813000 + type: string + x-auditable: true + nbf: + description: The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing. + type: integer + x-auditable: true + pem: + description: The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required. + example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo= + type: string + x-sensitive: true + type: object + streamSignedTokenResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + token: + description: The signed token used with the signed URLs feature. + example: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A + type: string + x-sensitive: true + type: object + required: + - success + - errors + - messages + streamSigningKeyCreated: + description: The date and time a signing key was created. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamSize: + description: The size of the media item in bytes. + example: 4190963 + type: number + x-auditable: true + streamStart: + description: Lists videos created after the specified date. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + streamStartTimeSeconds: + description: Specifies the start time for the video clip in seconds. + type: integer + x-auditable: true + streamStorageUseResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + creator: + $ref: '#/components/schemas/streamCreator' + totalStorageMinutes: + description: The total minutes of video content stored in the account. May contain decimal values. + format: float + type: number + totalStorageMinutesLimit: + description: The storage capacity alloted for the account. + type: integer + videoCount: + description: The total count of videos associated with the account. + type: integer + type: object + required: + - success + - errors + - messages + streamThumbnailTimestampPct: + default: 0 + description: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video. + example: 0.529241 + maximum: 1 + minimum: 0 + type: number + x-auditable: true + streamThumbnailUrl: + description: The media item's thumbnail URI. This field is omitted until encoding is complete. + example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg + format: uri + type: string + x-auditable: true + streamTusResumable: + description: 'Specifies the TUS protocol version. This value must be included in every upload request. Notes: The only supported version of TUS protocol is 1.0.0.' + enum: + - 1.0.0 + example: 1.0.0 + type: string + x-auditable: true + streamType: + description: Specifies whether the video is `vod` or `live`. + example: live + type: string + x-auditable: true + streamUpdateInputRequest: + properties: + defaultCreator: + $ref: '#/components/schemas/streamLiveInputDefaultCreator' + deleteRecordingAfterDays: + $ref: '#/components/schemas/streamLiveInputRecordingDeletion' + enabled: + $ref: '#/components/schemas/streamLiveInputEnabled' + meta: + $ref: '#/components/schemas/streamLiveInputMetadata' + recording: + $ref: '#/components/schemas/streamLiveInputRecordingSettings' + type: object + streamUpdateOutputRequest: + properties: + enabled: + $ref: '#/components/schemas/streamOutputEnabled' + required: + - enabled + type: object + streamUploadLength: + description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer. + minimum: 0 + type: integer + x-auditable: true + streamUploadMetadata: + description: 'Comma-separated key-value pairs following the TUS protocol specification. Values are Base-64 encoded. Supported keys: `name`, `requiresignedurls`, `allowedorigins`, `thumbnailtimestamppct`, `watermark`, `scheduleddeletion`, `maxdurationseconds`.' + example: name aGVsbG8gd29ybGQ=, requiresignedurls, allowedorigins ZXhhbXBsZS5jb20sdGVzdC5jb20= + type: string + x-auditable: true + streamUploaded: + description: The date and time the media item was uploaded. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamVideoClipStandard: + properties: + allowedOrigins: + $ref: '#/components/schemas/streamAllowedOrigins' + clippedFromVideoUID: + $ref: '#/components/schemas/streamClippedFromVideoUid' + creator: + $ref: '#/components/schemas/streamCreator' + endTimeSeconds: + $ref: '#/components/schemas/streamEndTimeSeconds' + input: + description: A video's URL. Preferred over 'url'. + example: https://example.com/myvideo.mp4 + format: uri + type: string + meta: + $ref: '#/components/schemas/streamMediaMetadata' + name: + description: A name for the video. + example: myvideo.mp4 + type: string + requireSignedURLs: + $ref: '#/components/schemas/streamRequireSignedURLs' + scheduledDeletion: + $ref: '#/components/schemas/streamScheduledDeletion' + startTimeSeconds: + $ref: '#/components/schemas/streamStartTimeSeconds' + thumbnailTimestampPct: + $ref: '#/components/schemas/streamThumbnailTimestampPct' + url: + description: A video's URL (legacy field, use 'input' instead). + example: https://example.com/myvideo.mp4 + format: uri + type: string + watermark: + $ref: '#/components/schemas/streamWatermarkAtUpload' + required: + - clippedFromVideoUID + - startTimeSeconds + - endTimeSeconds + type: object + streamVideoCopyRequest: + description: Copy upload request. Provide `input` (preferred) or `url` (deprecated). + properties: + allowedOrigins: + $ref: '#/components/schemas/streamAllowedOrigins' + creator: + $ref: '#/components/schemas/streamCreator' + input: + description: A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file. This is the preferred field over `url`. + example: https://example.com/myvideo.mp4 + format: uri + type: string + meta: + $ref: '#/components/schemas/streamMediaMetadata' + name: + description: A video's name. Used for legacy compatibility. + example: myvideo.mp4 + type: string + requireSignedURLs: + $ref: '#/components/schemas/streamRequireSignedURLs' + scheduledDeletion: + $ref: '#/components/schemas/streamScheduledDeletion' + thumbnailTimestampPct: + $ref: '#/components/schemas/streamThumbnailTimestampPct' + url: + description: A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file. This field is deprecated in favor of `input`. + example: https://example.com/myvideo.mp4 + format: uri + type: string + watermark: + $ref: '#/components/schemas/streamWatermarkAtUpload_2' + type: object + required: [] + streamVideoName: + description: Provides a fast, exact string match on the `name` key in the `meta` field. + example: puppy.mp4 + type: string + x-auditable: true + streamVideoResponseCollection: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/streamVideos' + type: array + range: + description: The total number of remaining videos based on cursor position. + example: 1000 + type: integer + total: + description: The total number of videos that match the provided filters. + example: 35586 + type: integer + required: + - success + - errors + - messages + type: object + streamVideoResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamVideos' + required: + - success + - errors + - messages + streamVideoUpdate: + properties: + allowedOrigins: + $ref: '#/components/schemas/streamAllowedOrigins' + creator: + $ref: '#/components/schemas/streamCreator' + maxDurationSeconds: + $ref: '#/components/schemas/streamMaxDurationSeconds' + meta: + $ref: '#/components/schemas/streamMediaMetadata' + publicDetails: + description: Public details for the video including title, share link, channel link, and logo. + properties: + channel_link: + nullable: true + type: string + logo: + nullable: true + type: string + share_link: + nullable: true + type: string + title: + nullable: true + type: string + type: object + requireSignedURLs: + $ref: '#/components/schemas/streamRequireSignedURLs' + scheduledDeletion: + $ref: '#/components/schemas/streamScheduledDeletion' + thumbnailTimestampPct: + $ref: '#/components/schemas/streamThumbnailTimestampPct' + uid: + description: The unique identifier for the video. Can be used to verify the video being updated. + example: ea95132c15732412d22c1476fa83f27a + type: string + uploadExpiry: + $ref: '#/components/schemas/streamOneTimeUploadExpiry' + type: object + streamVideos: + properties: + allowedOrigins: + $ref: '#/components/schemas/streamAllowedOrigins' + clippedFrom: + description: The unique identifier of the source video this video was clipped from. + example: ea95132c15732412d22c1476fa83f27a + type: string + created: + $ref: '#/components/schemas/streamCreated' + creator: + $ref: '#/components/schemas/streamCreator' + duration: + $ref: '#/components/schemas/streamDuration' + input: + $ref: '#/components/schemas/streamInput' + liveInput: + $ref: '#/components/schemas/streamLiveInput' + maxDurationSeconds: + $ref: '#/components/schemas/streamMaxDurationSeconds' + maxSizeBytes: + description: The maximum size in bytes for the video upload. + format: int64 + type: integer + meta: + $ref: '#/components/schemas/streamMediaMetadata' + modified: + $ref: '#/components/schemas/streamModified' + playback: + $ref: '#/components/schemas/streamPlayback' + preview: + $ref: '#/components/schemas/streamPreview' + publicDetails: + description: Public details for the video including title, share link, channel link, and logo. + properties: + channel_link: + nullable: true + type: string + logo: + nullable: true + type: string + media_id: + type: integer + share_link: + nullable: true + type: string + title: + nullable: true + type: string + type: object + readyToStream: + $ref: '#/components/schemas/streamReadyToStream' + readyToStreamAt: + $ref: '#/components/schemas/streamReadyToStreamAt' + requireSignedURLs: + $ref: '#/components/schemas/streamRequireSignedURLs' + scheduledDeletion: + $ref: '#/components/schemas/streamScheduledDeletion' + size: + $ref: '#/components/schemas/streamSize' + status: + $ref: '#/components/schemas/streamMediaStatus' + thumbnail: + $ref: '#/components/schemas/streamThumbnailUrl' + thumbnailTimestampPct: + $ref: '#/components/schemas/streamThumbnailTimestampPct' + uid: + $ref: '#/components/schemas/streamIdentifier' + uploadExpiry: + $ref: '#/components/schemas/streamOneTimeUploadExpiry' + uploaded: + $ref: '#/components/schemas/streamUploaded' + watermark: + $ref: '#/components/schemas/streamWatermarks' + type: object + streamWatermarkAtUpload: + properties: + uid: + description: The unique identifier for the watermark profile. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + type: string + x-auditable: true + type: object + streamWatermarkAtUpload_2: + properties: + uid: + description: The unique identifier for the watermark profile. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + type: string + x-auditable: true + type: object + streamWatermarkBasicUpload: + properties: + file: + description: The image file to upload. + example: '@/Users/rchen/Downloads/watermark.png' + type: string + x-auditable: true + name: + $ref: '#/components/schemas/streamName' + opacity: + $ref: '#/components/schemas/streamOpacity' + padding: + $ref: '#/components/schemas/streamPadding' + position: + $ref: '#/components/schemas/streamPosition' + scale: + $ref: '#/components/schemas/streamScale' + required: + - file + type: object + streamWatermarkCreated: + description: The date and a time a watermark profile was created. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + x-auditable: true + streamWatermarkIdentifier: + description: The unique identifier for a watermark profile. + example: ea95132c15732412d22c1476fa83f27a + maxLength: 32 + type: string + x-auditable: true + streamWatermarkResponseCollection: + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/streamWatermarks' + type: array + required: + - success + - errors + - messages + type: object + streamWatermarkResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/streamWatermarks' + required: + - success + - errors + - messages + streamWatermarkSize: + description: The size of the image in bytes. + example: 29472 + type: number + x-auditable: true + streamWatermarks: + properties: + created: + $ref: '#/components/schemas/streamWatermarkCreated' + downloadedFrom: + $ref: '#/components/schemas/streamDownloadedFrom' + height: + $ref: '#/components/schemas/streamHeight' + name: + $ref: '#/components/schemas/streamName' + opacity: + $ref: '#/components/schemas/streamOpacity' + padding: + $ref: '#/components/schemas/streamPadding' + position: + $ref: '#/components/schemas/streamPosition' + scale: + $ref: '#/components/schemas/streamScale' + size: + $ref: '#/components/schemas/streamWatermarkSize' + uid: + $ref: '#/components/schemas/streamWatermarkIdentifier' + width: + $ref: '#/components/schemas/streamWidth' + type: object + streamWebhookRequest: + properties: + notificationUrl: + $ref: '#/components/schemas/streamNotificationUrl' + notification_url: + description: The URL where webhooks will be sent. + example: https://example.com + format: uri + type: string + x-auditable: true + type: object + required: [] + streamWebhookResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/streamMessages' + messages: + $ref: '#/components/schemas/streamMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + modified: + description: The date and time the webhook was last modified. + example: '2014-01-02T02:20:00Z' + format: date-time + type: string + notificationUrl: + description: The URL where webhooks will be sent. + example: https://example.com + format: uri + type: string + notification_url: + description: The URL where webhooks will be sent. + example: https://example.com + format: uri + type: string + secret: + description: The secret used to verify webhook signatures. + type: string + x-sensitive: true + type: object + required: + - success + - errors + - messages + streamWidth: + description: The width of the image in pixels. + type: integer + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + streams: + id: cloudflare.streams.streams + name: streams + title: Streams + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream/post' + response: + mediaType: application/json + openAPIDocKey: '201' + create_clip: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1clip/post' + response: + mediaType: application/json + openAPIDocKey: '200' + copy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_direct_upload: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1direct_upload/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1token/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/streams/methods/get' + - $ref: '#/components/x-stackQL-resources/streams/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/edit' + - $ref: '#/components/x-stackQL-resources/streams/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete' + replace: [] + keys: + id: cloudflare.streams.keys + name: keys + title: Keys + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1keys/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1keys~1{identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + replace: [] + live_inputs: + id: cloudflare.streams.live_inputs + name: live_inputs + title: Live Inputs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}~1disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}~1enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/live_inputs/methods/get' + - $ref: '#/components/x-stackQL-resources/live_inputs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/live_inputs/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/live_inputs/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/live_inputs/methods/update' + outputs: + id: cloudflare.streams.outputs + name: outputs + title: Outputs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}~1outputs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}~1outputs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}~1outputs~1{output_identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1live_inputs~1{live_input_identifier}~1outputs~1{output_identifier}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/outputs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/outputs/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/outputs/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/outputs/methods/update' + videos: + id: cloudflare.streams.videos + name: videos + title: Videos + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1storage-usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/videos/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + watermarks: + id: cloudflare.streams.watermarks + name: watermarks + title: Watermarks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1watermarks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1watermarks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1watermarks~1{identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1watermarks~1{identifier}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/watermarks/methods/get' + - $ref: '#/components/x-stackQL-resources/watermarks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/watermarks/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/watermarks/methods/delete' + replace: [] + webhooks: + id: cloudflare.streams.webhooks + name: webhooks + title: Webhooks + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1webhook/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1webhook/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1webhook/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/update' + audio_tracks: + id: cloudflare.streams.audio_tracks + name: audio_tracks + title: Audio Tracks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1audio/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.audio + copy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1audio~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1audio~1{audio_identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1audio~1{audio_identifier}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audio_tracks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/audio_tracks/methods/copy' + update: + - $ref: '#/components/x-stackQL-resources/audio_tracks/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/audio_tracks/methods/delete' + replace: [] + captions: + id: cloudflare.streams.captions + name: captions + title: Captions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1captions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/captions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + language: + id: cloudflare.streams.language + name: language + title: Language + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1captions~1{language}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1captions~1{language}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1captions~1{language}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1captions~1{language}~1generate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/language/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/language/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/language/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/language/methods/update' + vtts: + id: cloudflare.streams.vtts + name: vtts + title: Vtts + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1captions~1{language}~1vtt/get' + response: + mediaType: text/vtt + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vtts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + downloads: + id: cloudflare.streams.downloads + name: downloads + title: Downloads + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1downloads/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1downloads/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1downloads/post' + response: + mediaType: application/json + openAPIDocKey: '200' + stream_downloads_delete_type_specific_downloads: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1downloads~1{download_type}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + stream_downloads_create_type_specific_downloads: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1downloads~1{download_type}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/downloads/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/downloads/methods/stream_downloads_create_type_specific_downloads' + - $ref: '#/components/x-stackQL-resources/downloads/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/downloads/methods/stream_downloads_delete_type_specific_downloads' + - $ref: '#/components/x-stackQL-resources/downloads/methods/delete' + replace: [] + embeds: + id: cloudflare.streams.embeds + name: embeds + title: Embeds + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1stream~1{identifier}~1embed/get' + response: + mediaType: text/html + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/embeds/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/teamnet.yaml b/providers/src/cloudflare/v00.00.00000/services/teamnet.yaml deleted file mode 100644 index 9c4d40a0..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/teamnet.yaml +++ /dev/null @@ -1,765 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Tunnel Route - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - teamnet - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - route_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/teamnet' - type: array - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - teamnet: - properties: - comment: - $ref: '#/components/schemas/comment' - created_at: - description: 'Timestamps when the route was created, formatted in RFC 3339.' - deleted_at: - description: 'If present, indicates route was deleted at the given date (formatted in RFC 3339). If absent, route has not been deleted.' - example: '2021-01-25T18:22:34.317854Z' - format: date-time - nullable: true - readOnly: true - type: string - network: - description: CIDR notation of the IPv4 or IPv6 range of the network the route connects to. - tunnel_id: - description: UUID of the Tunnel the route belongs to. - tunnel_name: - description: User-friendly name of the Tunnel the route belongs to. - virtual_network_id: - description: UUID of the virtual network this route belongs to. - required: - - network - - tunnel_id - - comment - - created_at - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - comment: - description: Optional remark describing the route. Empty if none. - example: Example comment for this route - type: string - teamnet_components-schemas-ip: - example: 10.1.0.137 - type: string - route_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - ip_network_encoded: - example: 172.16.0.0%2F16 - type: string - vnet_id: - description: UUID of the virtual network. - example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - readOnly: true - type: string - vnet_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/virtual-network' - type: array - type: object - virtual-network: - properties: - comment: - $ref: '#/components/schemas/schemas-comment' - created_at: - description: 'Timestamp of when the virtual network was created, formatted in RFC 3339.' - deleted_at: - description: 'If present, indicates that the virtual network was deleted at the given date (formatted in RFC 3339). If absent, the virtual network has not been deleted.' - example: '2021-01-25T18:22:34.317854Z' - format: date-time - nullable: true - readOnly: true - type: string - id: - $ref: '#/components/schemas/vnet_id' - is_default_network: - $ref: '#/components/schemas/is_default_network' - name: - $ref: '#/components/schemas/vnet_name' - required: - - id - - name - - is_default_network - - comment - - created_at - type: object - schemas-comment: - description: Optional remark describing the virtual network. Empty if none. - example: Staging VPC for data science - type: string - is_default_network: - description: 'Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.' - example: true - type: boolean - vnet_name: - description: A user-friendly name chosen when the virtual network is created. Cannot be empty. - example: us-east-1-vpc - type: string - vnet_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_routes: - id: cloudflare.teamnet.accounts_routes - name: accounts_routes - title: Accounts Routes - methods: - tunnel_route_list_tunnel_routes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1routes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _tunnel_route_list_tunnel_routes: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1routes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_routes/methods/tunnel_route_list_tunnel_routes' - insert: [] - update: [] - delete: [] - accounts_routes_ip: - id: cloudflare.teamnet.accounts_routes_ip - name: accounts_routes_ip - title: Accounts Routes Ip - methods: - tunnel_route_get_tunnel_route_by_ip: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1routes~1ip~1{ip}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _tunnel_route_get_tunnel_route_by_ip: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1routes~1ip~1{ip}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_routes_ip/methods/tunnel_route_get_tunnel_route_by_ip' - insert: [] - update: [] - delete: [] - accounts_routes_network: - id: cloudflare.teamnet.accounts_routes_network - name: accounts_routes_network - title: Accounts Routes Network - methods: - tunnel_route_delete_route: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1routes~1network~1{ip_network_encoded}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_route_update_route: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1routes~1network~1{ip_network_encoded}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_route_create_route: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1routes~1network~1{ip_network_encoded}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/accounts_routes_network/methods/tunnel_route_create_route' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_routes_network/methods/tunnel_route_delete_route' - accounts_virtual_networks: - id: cloudflare.teamnet.accounts_virtual_networks - name: accounts_virtual_networks - title: Accounts Virtual Networks - methods: - tunnel_virtual_network_list_virtual_networks: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1virtual_networks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _tunnel_virtual_network_list_virtual_networks: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1virtual_networks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_virtual_network_create_virtual_network: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1virtual_networks/post' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_virtual_network_delete_virtual_network: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1virtual_networks~1{vnet_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - tunnel_virtual_network_update_virtual_network: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1teamnet~1virtual_networks~1{vnet_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_virtual_networks/methods/tunnel_virtual_network_list_virtual_networks' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_virtual_networks/methods/tunnel_virtual_network_create_virtual_network' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_virtual_networks/methods/tunnel_virtual_network_delete_virtual_network' -paths: - '/accounts/{account_identifier}/teamnet/routes': - get: - description: 'List, search and filter an account''s tunnel routes.' - operationId: tunnel-route-list-tunnel-routes - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_response_collection' - description: List Tunnel Routes response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Tunnel Routes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Tunnel Routes - tags: - - Tunnel Route - '/accounts/{account_identifier}/teamnet/routes/ip/{ip}': - get: - description: Find the Tunnel Route that encompasses the given IP. - operationId: tunnel-route-get-tunnel-route-by-ip - parameters: - - in: path - name: ip - required: true - schema: - $ref: '#/components/schemas/teamnet_components-schemas-ip' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_response_single' - description: Get Tunnel Route by IP response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Tunnel Route by IP response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Tunnel Route by IP - tags: - - Tunnel Route - '/accounts/{account_identifier}/teamnet/routes/network/{ip_network_encoded}': - delete: - description: Delete an existing route from the account's routing table. - operationId: tunnel-route-delete-route - parameters: - - in: path - name: ip_network_encoded - required: true - schema: - $ref: '#/components/schemas/ip_network_encoded' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - virtual_network_id: - $ref: '#/components/schemas/vnet_id' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_response_single' - description: Delete Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Route - tags: - - Tunnel Route - patch: - description: Update an existing route in the account's routing table for the given tunnel. - operationId: tunnel-route-update-route - parameters: - - in: path - name: ip_network_encoded - required: true - schema: - $ref: '#/components/schemas/ip_network_encoded' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - comment: - $ref: '#/components/schemas/comment' - network: - description: New CIDR of this route. - tunnel_id: - description: UUID of the tunnel this route should belong to. - virtual_network_id: - description: UUID of the virtual network to which this route belongs to. - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_response_single' - description: Update Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Route - tags: - - Tunnel Route - post: - description: Add a new route to the account's routing table for the given tunnel. - operationId: tunnel-route-create-route - parameters: - - in: path - name: ip_network_encoded - required: true - schema: - $ref: '#/components/schemas/ip_network_encoded' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - comment: - $ref: '#/components/schemas/comment' - tunnel_id: - description: UUID of the tunnel for which this route is being added. - virtual_network_id: - description: optional UUID of the virtual network for which this route is being added; uses the default virtual network of the account if none is provided. - required: - - tunnel_id - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route_response_single' - description: Create Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Route - tags: - - Tunnel Route - '/accounts/{account_identifier}/teamnet/virtual_networks': - get: - description: 'List, search and filter an account''s virtual networks.' - operationId: tunnel-virtual-network-list-virtual-networks - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/vnet_response_collection' - description: List Virtual Networks response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/vnet_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Virtual Networks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Virtual Networks - tags: - - Tunnel Virtual Network - post: - description: Add a new virtual network to the account. - operationId: tunnel-virtual-network-create-virtual-network - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - comment: - $ref: '#/components/schemas/schemas-comment' - is_default: - $ref: '#/components/schemas/is_default_network' - name: - $ref: '#/components/schemas/vnet_name' - required: - - name - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/vnet_response_single' - description: Create Virtual Network response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/vnet_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Virtual Network response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Virtual Network - tags: - - Tunnel Virtual Network - '/accounts/{account_identifier}/teamnet/virtual_networks/{vnet_id}': - delete: - description: Delete an existing virtual network from the account. - operationId: tunnel-virtual-network-delete-virtual-network - parameters: - - in: path - name: vnet_id - required: true - schema: - $ref: '#/components/schemas/vnet_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/vnet_response_single' - description: Delete Virtual Network response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/vnet_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Virtual Network response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Virtual Network - tags: - - Tunnel Virtual Network - patch: - description: Update an existing virtual network in the account. - operationId: tunnel-virtual-network-update-virtual-network - parameters: - - in: path - name: vnet_id - required: true - schema: - $ref: '#/components/schemas/vnet_id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - comment: - $ref: '#/components/schemas/schemas-comment' - is_default_network: - $ref: '#/components/schemas/is_default_network' - name: - $ref: '#/components/schemas/vnet_name' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/vnet_response_single' - description: Update Virtual Network response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/vnet_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Virtual Network response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Virtual Network - tags: - - Tunnel Virtual Network diff --git a/providers/src/cloudflare/v00.00.00000/services/tenants.yaml b/providers/src/cloudflare/v00.00.00000/services/tenants.yaml new file mode 100644 index 00000000..ba5b2119 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/tenants.yaml @@ -0,0 +1,698 @@ +openapi: 3.0.3 +info: + title: tenants API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /tenants/{tenant_id}: + get: + description: Retrieves a Tenant by Tenant ID. + operationId: Tenants_retrieveTenant + parameters: + - in: path + name: tenant_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiTenant' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Get tenant + tags: + - Tenants + /tenants/{tenant_id}/account_types: + get: + description: List of account types available for the Tenant to provision accounts. + operationId: Tenants_validAccountTypes + parameters: + - in: path + name: tenant_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + type: string + type: array + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: Get tenant account types + tags: + - Tenants + /tenants/{tenant_id}/accounts: + get: + description: List of accounts for the Tenant. + operationId: Tenants_listAccounts + parameters: + - in: path + name: tenant_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiAccount' + type: array + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: List tenant accounts + tags: + - Tenants + /tenants/{tenant_id}/entitlements: + get: + description: List of innate entitlements available for the Tenant. + operationId: Tenants_listEntitlements + parameters: + - in: path + name: tenant_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + $ref: '#/components/schemas/organizationsApiInnateEntitlements' + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: List tenant entitlements + tags: + - Tenants + /tenants/{tenant_id}/memberships: + get: + description: List of active members (Cloudflare users) for the Tenant. + operationId: Tenants_listMemberships + parameters: + - in: path + name: tenant_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiTenantMembership' + type: array + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: List tenant memberships + tags: + - Tenants +components: + schemas: + organizationsApiAccount: + properties: + created_on: + format: date-time + type: string + readOnly: true + id: + type: string + name: + nullable: true + type: string + settings: + properties: + abuse_contact_email: + nullable: true + type: string + access_approval_expiry: + format: date-time + nullable: true + type: string + api_access_enabled: + nullable: true + type: boolean + default_nameservers: + deprecated: true + description: >- + Use [DNS + Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) + instead. Deprecated. + nullable: true + type: string + enforce_twofactor: + nullable: true + type: boolean + use_account_custom_ns_by_default: + deprecated: true + description: >- + Use [DNS + Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) + instead. Deprecated. + nullable: true + type: boolean + required: + - enforce_twofactor + - api_access_enabled + - access_approval_expiry + - abuse_contact_email + - use_account_custom_ns_by_default + - default_nameservers + type: object + type: + enum: + - standard + - enterprise + type: string + required: + - id + - name + - type + - settings + - created_on + type: object + organizationsApiBoolAllocation: + properties: + type: + enum: + - bool + type: string + value: + type: boolean + required: + - type + - value + type: object + organizationsApiEntitlement: + properties: + allocation: + type: object + properties: + type: + enum: + - max_count + type: string + value: + type: integer + required: + - type + feature: + $ref: '#/components/schemas/organizationsApiFeature' + required: + - feature + - allocation + type: object + organizationsApiFeature: + properties: + key: + type: string + required: + - key + type: object + organizationsApiInnateEntitlements: + properties: + allow_add_subdomain: + $ref: '#/components/schemas/organizationsApiBoolAllocation' + allow_auto_accept_invites: + $ref: '#/components/schemas/organizationsApiBoolAllocation' + cname_setup_allowed: + $ref: '#/components/schemas/organizationsApiBoolAllocation' + custom_entitlements: + items: + $ref: '#/components/schemas/organizationsApiEntitlement' + nullable: true + type: array + mhs_certificate_count: + $ref: '#/components/schemas/organizationsApiMaxCountAllocation' + partial_setup_allowed: + $ref: '#/components/schemas/organizationsApiBoolAllocation' + required: + - allow_add_subdomain + - cname_setup_allowed + - partial_setup_allowed + - allow_auto_accept_invites + - mhs_certificate_count + - custom_entitlements + type: object + organizationsApiMaxCountAllocation: + properties: + type: + enum: + - max_count + type: string + value: + type: integer + required: + - type + - value + type: object + organizationsApiTenant: + properties: + cdate: + format: date-time + type: string + customer_id: + type: string + edate: + format: date-time + type: string + tenant_contacts: + properties: + email: + type: string + website: + type: string + type: object + tenant_labels: + items: + type: string + type: array + tenant_metadata: + properties: + dns: + properties: + ns_pool: + properties: + primary: + type: string + secondary: + type: string + type: object + required: + - ns_pool + type: object + type: object + tenant_name: + type: string + tenant_network: + type: object + tenant_status: + type: string + tenant_tag: + type: string + tenant_type: + type: string + tenant_units: + items: + $ref: '#/components/schemas/organizationsApiTenantUnit' + type: array + required: + - tenant_tag + - tenant_name + - tenant_labels + - tenant_type + - tenant_status + - tenant_metadata + - tenant_contacts + - cdate + - edate + - tenant_network + - tenant_units + type: object + organizationsApiTenantMembership: + properties: + user_email: + type: string + user_name: + type: string + user_tag: + type: string + required: + - user_tag + - user_email + - user_name + type: object + organizationsApiTenantUnit: + properties: + unit_memberships: + items: + type: object + type: array + unit_metadata: + type: object + unit_name: + type: string + unit_status: + type: string + unit_tag: + type: string + required: + - unit_tag + - unit_name + - unit_status + - unit_metadata + - unit_memberships + type: object + organizationsApiV4ErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + type: object + success: + enum: + - false + type: boolean + required: + - success + - errors + - messages + type: object + organizationsApiV4Message: + $ref: '#/components/schemas/responseInfo' + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + tenants: + id: cloudflare.tenants.tenants + name: tenants + title: Tenants + methods: + get: + operation: + $ref: '#/paths/~1tenants~1{tenant_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tenants/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + account_types: + id: cloudflare.tenants.account_types + name: account_types + title: Account Types + methods: + list: + operation: + $ref: '#/paths/~1tenants~1{tenant_id}~1account_types/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/account_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + accounts: + id: cloudflare.tenants.accounts + name: accounts + title: Accounts + methods: + list: + operation: + $ref: '#/paths/~1tenants~1{tenant_id}~1accounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + entitlements: + id: cloudflare.tenants.entitlements + name: entitlements + title: Entitlements + methods: + list: + operation: + $ref: '#/paths/~1tenants~1{tenant_id}~1entitlements/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + memberships: + id: cloudflare.tenants.memberships + name: memberships + title: Memberships + methods: + list: + operation: + $ref: '#/paths/~1tenants~1{tenant_id}~1memberships/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/memberships/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/token_validation.yaml b/providers/src/cloudflare/v00.00.00000/services/token_validation.yaml new file mode 100644 index 00000000..b5548993 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/token_validation.yaml @@ -0,0 +1,1908 @@ +openapi: 3.0.3 +info: + title: token_validation API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/token_validation/config: + get: + description: Lists all token validation configurations for this zone + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-config-list + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldTokenConfiguration' + type: array + required: + - success + - errors + - messages + - result + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List token validation configurations + tags: + - Token Validation Token Configuration + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: token_validation + resource_chain: + - configuration + method: list + post: + description: Create a new Token Validation configuration + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-config-create + requestBody: + content: + application/json: + schema: + properties: + credentials: + $ref: '#/components/schemas/apiShieldCredentials' + description: + $ref: '#/components/schemas/apiShieldDescription' + title: + $ref: '#/components/schemas/apiShieldTitle' + token_sources: + $ref: '#/components/schemas/apiShieldTokenSources' + token_type: + $ref: '#/components/schemas/apiShieldTokenType' + required: + - title + - description + - token_sources + - token_type + - credentials + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldTokenConfiguration' + required: + - success + - errors + - messages + - result + type: object + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new Token Validation configuration + tags: + - Token Validation Token Configuration + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: token_validation + resource_chain: + - configuration + method: create + /zones/{zone_id}/token_validation/config/{config_id}: + delete: + description: Delete Token Configuration + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-config-delete + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + type: object + required: + - success + - errors + - messages + - result + type: object + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Token Configuration + tags: + - Token Validation Token Configuration + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Token Configuration ID + in: path + name: config_id + schema: + $ref: '#/components/schemas/apiShieldSchemasUuid' + required: true + x-stackql-sdk: + service: token_validation + resource_chain: + - configuration + method: delete + get: + description: Get a single Token Configuration + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-config-get + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldTokenConfiguration' + required: + - success + - errors + - messages + - result + type: object + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a single Token Configuration + tags: + - Token Validation Token Configuration + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Token Configuration ID + in: path + name: config_id + schema: + $ref: '#/components/schemas/apiShieldSchemasUuid' + required: true + x-stackql-sdk: + service: token_validation + resource_chain: + - configuration + method: get + patch: + description: Edit fields of an existing Token Configuration + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-config-edit + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/apiShieldDescription' + title: + $ref: '#/components/schemas/apiShieldTitle' + token_sources: + $ref: '#/components/schemas/apiShieldTokenSources' + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + description: + $ref: '#/components/schemas/apiShieldDescription' + id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + title: + $ref: '#/components/schemas/apiShieldTitle' + token_sources: + $ref: '#/components/schemas/apiShieldTokenSources' + type: object + required: + - success + - errors + - messages + - result + type: object + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit an existing Token Configuration + tags: + - Token Validation Token Configuration + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Token Configuration ID + in: path + name: config_id + schema: + $ref: '#/components/schemas/apiShieldSchemasUuid' + required: true + x-stackql-sdk: + service: token_validation + resource_chain: + - configuration + method: edit + /zones/{zone_id}/token_validation/config/{config_id}/credentials: + put: + description: Update Token Configuration credentials + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-config-credentials-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldCredentials' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + keys: + items: + $ref: '#/components/schemas/apiShieldCredentialsJWTKey' + maxItems: 4 + minItems: 1 + type: array + required: + - success + - errors + - messages + - keys + type: object + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Token Configuration credentials + tags: + - Token Validation Token Configuration + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Token Configuration ID + in: path + name: config_id + schema: + $ref: '#/components/schemas/apiShieldSchemasUuid' + required: true + x-stackql-sdk: + service: token_validation + resource_chain: + - configuration + - credentials + method: update + /zones/{zone_id}/token_validation/rules: + get: + description: List token validation rules + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-list + parameters: + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Select rules using any of these token configurations. + in: query + name: token_configuration + schema: + items: + $ref: '#/components/schemas/apiShieldSchemasUuid' + type: array + explode: true + - in: query + name: action + schema: + $ref: '#/components/schemas/apiShieldAction' + - in: query + name: enabled + schema: + $ref: '#/components/schemas/apiShieldEnabled' + - description: Select rules with these IDs. + in: query + name: id + schema: + $ref: '#/components/schemas/apiShieldSchemasUuid' + - description: Select rules with these IDs. + in: query + name: rule_id + schema: + $ref: '#/components/schemas/apiShieldSchemasUuid' + - description: Select rules with this host in `include`. + in: query + name: host + schema: + $ref: '#/components/schemas/apiShieldHost' + - description: Select rules with this host in `include`. + in: query + name: hostname + schema: + $ref: '#/components/schemas/apiShieldHost' + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldRule' + type: array + required: + - success + - errors + - messages + - result + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List token validation rules + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + x-stackql-sdk: + service: token_validation + resource_chain: + - rules + method: list + post: + description: Create a token validation rule. + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldCreateSingleRuleRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldRule' + required: + - success + - errors + - messages + - result + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a token validation rule + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + x-stackql-sdk: + service: token_validation + resource_chain: + - rules + method: create + /zones/{zone_id}/token_validation/rules/bulk: + patch: + description: >- + Edit token validation rules. A request can update multiple Token + Validation Rules. Rules can be re-ordered using the `position` field. + Returns all updated rules. + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-bulk-edit + requestBody: + content: + application/json: + schema: + items: + properties: + id: + description: Rule ID this patch applies to + format: uuid + maxLength: 36 + type: string + x-auditable: true + action: + $ref: '#/components/schemas/apiShieldAction' + description: + $ref: '#/components/schemas/apiShieldSchemasDescription' + enabled: + $ref: '#/components/schemas/apiShieldEnabled' + expression: + $ref: '#/components/schemas/apiShieldExpression' + selector: + $ref: '#/components/schemas/apiShieldSelector' + title: + $ref: '#/components/schemas/apiShieldSchemasTitle' + position: + $ref: '#/components/schemas/apiShieldPosition' + required: + - id + type: object + type: array + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldRule' + type: array + required: + - success + - errors + - messages + - result + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Bulk edit token validation rules + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + post: + description: >- + Create zone token validation rules. A request can create multiple Token + Validation Rules. + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-bulk-create + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/apiShieldCreateSingleRuleRequest' + type: array + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/apiShieldRule' + type: array + required: + - success + - errors + - messages + - result + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Bulk create token validation rules + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + /zones/{zone_id}/token_validation/rules/preview: + post: + description: >- + Preview operations covered by a Token Validation rule. The API will + return all operations on a zone annotated with an additional `state` + field. Operations with an `included` `state` will be covered by a Token + Validation Rule. + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-preview + parameters: + - description: Maximum number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: state + schema: + items: + $ref: '#/components/schemas/apiShieldSelectorOperationState' + type: array + explode: true + - description: Filter operations by host. + in: query + name: host + schema: + items: + $ref: '#/components/schemas/apiShieldHost' + type: array + explode: true + - description: Filter operations by host. + in: query + name: hostname + schema: + items: + $ref: '#/components/schemas/apiShieldHost' + type: array + explode: true + - description: Filter operations by method. + in: query + name: method + schema: + items: + $ref: '#/components/schemas/apiShieldMethod' + type: array + explode: true + - description: Filter operations by endpoint. Allows substring matching. + in: query + name: endpoint + schema: + items: + $ref: '#/components/schemas/apiShieldEndpoint' + type: array + explode: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldSelector' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + properties: + available_hosts: + description: All hostnames on zone used by operations + items: + $ref: '#/components/schemas/apiShieldHost' + type: array + uniqueItems: true + excluded: + description: Number of operations with `excluded` `state` + type: integer + x-auditable: true + ignored: + description: Number of operations with `ignored` `state` + type: integer + x-auditable: true + included: + description: Number of operations with `included` `state` + type: integer + x-auditable: true + operations: + items: + properties: + endpoint: + $ref: '#/components/schemas/apiShieldEndpoint' + host: + $ref: '#/components/schemas/apiShieldHost' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + method: + $ref: '#/components/schemas/apiShieldMethod' + operation_id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + state: + $ref: >- + #/components/schemas/apiShieldSelectorOperationState + type: object + type: array + selected_hosts: + description: Hostnames of `included` operations + items: + $ref: '#/components/schemas/apiShieldHost' + type: array + uniqueItems: true + total: + description: Number of operations on zone + type: integer + x-auditable: true + type: object + required: + - success + - errors + - messages + - result + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Preview operations covered by a Token Validation rule + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + /zones/{zone_id}/token_validation/rules/{rule_id}: + delete: + description: Delete a zone token validation rule. + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-delete + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseSingleObj' + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a zone token validation rule + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + x-stackql-sdk: + service: token_validation + resource_chain: + - rules + method: delete + get: + description: Get a zone token validation rule. + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-get + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldRule' + required: + - success + - errors + - messages + - result + type: object + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a zone token validation rule + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Account API Gateway Read + - Domain API Gateway + - Domain API Gateway Read + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + x-stackql-sdk: + service: token_validation + resource_chain: + - rules + method: get + patch: + description: Edit a zone token validation rule. + externalDocs: + description: Learn more about JSON Web Tokens Validation. + url: https://developers.cloudflare.com/api-shield/security/jwt-validation/ + operationId: token-validation-rules-edit + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldEditSingleRuleRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/apiShieldRule' + required: + - success + - errors + - messages + - result + description: OK + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/apiShieldApiResponseCommonFailure' + description: Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit a zone token validation rule + tags: + - Token Validation Token Rules + x-api-token-group: + - Account API Gateway + - Domain API Gateway + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + x-stackql-sdk: + service: token_validation + resource_chain: + - rules + method: edit +components: + schemas: + apiShieldAction: + description: >- + Action to take on requests that match operations included in `selector` + and fail `expression`. + enum: + - log + - block + example: log + type: string + x-auditable: true + apiShieldApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/apiShieldMessages' + messages: + example: [] + $ref: '#/components/schemas/apiShieldMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + apiShieldApiResponseSingleObj: + properties: + errors: + $ref: '#/components/schemas/apiShieldMessages' + messages: + $ref: '#/components/schemas/apiShieldMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + type: object + apiShieldCreateSingleRuleRequest: + description: >- + A Token Validation rule that can enforce security policies using JWT + Tokens. + type: object + $ref: '#/components/schemas/apiShieldRuleProperties' + apiShieldCredentials: + properties: + keys: + items: + $ref: '#/components/schemas/apiShieldCredentialsJWTKey' + maxItems: 4 + minItems: 1 + type: array + required: + - keys + type: object + apiShieldCredentialsJWTKey: + description: JSON representation of a JWKS key. + example: + alg: ES256 + crv: P-256 + kid: 38013f13-c266-4eec-a72a-92ec92779f21 + kty: EC + x: KN53JRwN3wCjm2o39bvZUX2VdrsHzS8pxOAGjm8m7EQ + 'y': lnkkzIxaveggz-HFhcMWW15nxvOj0Z_uQsXbpK0GFcY + type: object + properties: + kid: + description: Key ID + type: string + x-auditable: true + alg: + description: Algorithm + enum: + - RS256 + - RS384 + - RS512 + - PS256 + - PS384 + - PS512 + type: string + x-auditable: true + e: + description: RSA exponent + type: string + x-auditable: false + kty: + description: Key Type + enum: + - RSA + type: string + x-auditable: true + 'n': + description: RSA modulus + type: string + x-auditable: false + x: + description: X EC coordinate + type: string + x-auditable: false + 'y': + description: Y EC coordinate + type: string + x-auditable: false + crv: + description: Curve + enum: + - P-256 + type: string + x-auditable: true + required: + - alg + - kid + - kty + apiShieldDescription: + example: Long description for Token Validation Configuration + maxLength: 500 + type: string + x-auditable: true + apiShieldEditSingleRuleRequest: + properties: + action: + $ref: '#/components/schemas/apiShieldAction' + description: + $ref: '#/components/schemas/apiShieldSchemasDescription' + enabled: + $ref: '#/components/schemas/apiShieldEnabled' + expression: + $ref: '#/components/schemas/apiShieldExpression' + selector: + $ref: '#/components/schemas/apiShieldSelector' + title: + $ref: '#/components/schemas/apiShieldSchemasTitle' + position: + $ref: '#/components/schemas/apiShieldPosition' + type: object + apiShieldEnabled: + description: Toggle rule on or off. + example: true + type: boolean + x-auditable: true + apiShieldEndpoint: + description: >- + The endpoint which can contain path parameter templates in curly braces, + each will be replaced from left to right with {varN}, starting with + {var1}, during insertion. This will further be Cloudflare-normalized + upon insertion. See: + https://developers.cloudflare.com/rules/normalization/how-it-works/. + example: /api/v1/users/{var1} + format: uri-template + maxLength: 4096 + type: string + x-auditable: true + apiShieldExpression: + description: >- + Rule expression. Requests that fail to match this expression will be + subject to `action`. For details on expressions, see the [Cloudflare + Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/). + example: >- + is_jwt_valid("52973293-cb04-4a97-8f55-e7d2ad1107dd") or + is_jwt_valid("46eab8d1-6376-45e3-968f-2c649d77d423") + type: string + x-auditable: true + apiShieldHost: + description: RFC3986-compliant host. + example: www.example.com + format: hostname + maxLength: 255 + type: string + x-auditable: true + apiShieldMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + apiShieldMethod: + description: The HTTP method used to access the endpoint. + enum: + - GET + - POST + - HEAD + - OPTIONS + - PUT + - DELETE + - CONNECT + - PATCH + - TRACE + example: GET + type: string + x-auditable: true + apiShieldPosition: + description: Update rule order among zone rules. + type: object + writeOnly: true + properties: + index: + description: Move rule to this position + example: 2 + minimum: 1 + type: integer + x-auditable: true + before: + description: Move rule to before rule with this ID. + example: 0d9bf70c-92e1-4bb3-9411-34a3bcc59003 + format: uuid + maxLength: 36 + type: string + x-auditable: true + after: + description: Move rule to after rule with this ID. + example: 0d9bf70c-92e1-4bb3-9411-34a3bcc59003 + format: uuid + maxLength: 36 + type: string + x-auditable: true + required: + - index + apiShieldRule: + description: >- + A Token Validation rule that can enforce security policies using JWT + Tokens. + properties: + action: + $ref: '#/components/schemas/apiShieldAction' + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/apiShieldSchemasDescription' + enabled: + $ref: '#/components/schemas/apiShieldEnabled' + expression: + $ref: '#/components/schemas/apiShieldExpression' + id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + selector: + $ref: '#/components/schemas/apiShieldSelector' + title: + $ref: '#/components/schemas/apiShieldSchemasTitle' + required: + - title + - description + - action + - enabled + - expression + - selector + type: object + apiShieldRuleProperties: + properties: + action: + $ref: '#/components/schemas/apiShieldAction' + description: + $ref: '#/components/schemas/apiShieldSchemasDescription' + enabled: + $ref: '#/components/schemas/apiShieldEnabled' + expression: + $ref: '#/components/schemas/apiShieldExpression' + selector: + $ref: '#/components/schemas/apiShieldSelector' + title: + $ref: '#/components/schemas/apiShieldSchemasTitle' + type: object + apiShieldSchemasDescription: + description: A human-readable description that gives more details than `title`. + example: Long description for Token Validation Rule + maxLength: 500 + type: string + x-auditable: true + apiShieldSchemasTimestamp: + $ref: '#/components/schemas/apiShieldTimestamp' + readOnly: true + type: string + x-auditable: true + apiShieldSchemasTitle: + description: A human-readable name for the rule. + example: Example Token Validation Rule + maxLength: 50 + type: string + x-auditable: true + apiShieldSchemasUuid: + minLength: 36 + type: string + x-auditable: true + $ref: '#/components/schemas/apiShieldUuid' + apiShieldSelector: + description: >- + Select operations covered by this rule. For details on selectors, see + the [Cloudflare + Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/). + properties: + exclude: + description: Ignore operations that were otherwise included by `include`. + items: + $ref: '#/components/schemas/apiShieldSelectorExclude' + nullable: true + type: array + include: + description: Select all matching operations. + items: + $ref: '#/components/schemas/apiShieldSelectorInclude' + nullable: true + type: array + type: object + apiShieldSelectorExclude: + properties: + operation_ids: + description: Excluded operation IDs. + example: + - f9c5615e-fe15-48ce-bec6-cfc1946f1bec + - 56828eae-035a-4396-ba07-51c66d680a04 + items: + $ref: '#/components/schemas/apiShieldSchemasUuid' + type: array + type: object + apiShieldSelectorInclude: + properties: + host: + description: Included hostnames. + example: + - v1.example.com + - v2.example.com + items: + $ref: '#/components/schemas/apiShieldHost' + type: array + type: object + apiShieldSelectorOperationState: + description: >- + Details how `selector` interacted with an operation: - `included` + operations are included by `selector` and will be covered by the Token + Validation Rule - `excluded` operations are excluded by `selector` and + will not be covered by the Token Validation Rule - `ignored` operations + are not included by `selector` and will not be covered by the Token + Validation Rule + enum: + - included + - excluded + - ignored + example: included + type: string + x-auditable: true + apiShieldTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + apiShieldTitle: + example: Example Token Validation Configuration + maxLength: 50 + type: string + x-auditable: true + apiShieldTokenConfiguration: + properties: + created_at: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + readOnly: true + credentials: + $ref: '#/components/schemas/apiShieldCredentials' + description: + $ref: '#/components/schemas/apiShieldDescription' + id: + $ref: '#/components/schemas/apiShieldSchemasUuid' + last_updated: + $ref: '#/components/schemas/apiShieldSchemasTimestamp' + title: + $ref: '#/components/schemas/apiShieldTitle' + token_sources: + $ref: '#/components/schemas/apiShieldTokenSources' + token_type: + $ref: '#/components/schemas/apiShieldTokenType' + required: + - id + - title + - description + - token_sources + - token_type + - credentials + - created_at + - last_updated + type: object + apiShieldTokenSources: + example: + - http.request.headers["x-auth"][0] + - http.request.cookies["Authorization"][0] + items: + type: string + description: HTTP request header (must be lowercase) + example: http.request.headers["x-auth"][0] + maxItems: 4 + minItems: 1 + type: array + apiShieldTokenType: + enum: + - JWT + example: JWT + type: string + x-auditable: true + apiShieldUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + configuration: + id: cloudflare.token_validation.configuration + name: configuration + title: Configuration + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1config/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1token_validation~1config~1{config_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1token_validation~1config~1{config_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1token_validation~1config~1{config_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configuration/methods/get' + - $ref: '#/components/x-stackQL-resources/configuration/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/configuration/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/configuration/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/configuration/methods/delete' + replace: [] + token_validation: + id: cloudflare.token_validation.token_validation + name: token_validation + title: Token Validation + methods: + update_credentials: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1token_validation~1config~1{config_id}~1credentials/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + rules: + id: cloudflare.token_validation.rules + name: rules + title: Rules + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + preview: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1preview/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1token_validation~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1token_validation~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get' + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete' + replace: [] + bulk: + id: cloudflare.token_validation.bulk + name: bulk + title: Bulk + methods: + token_validation_rules_bulk_edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1bulk/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + token_validation_rules_bulk_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1token_validation~1rules~1bulk/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/bulk/methods/token_validation_rules_bulk_create + update: + - $ref: >- + #/components/x-stackQL-resources/bulk/methods/token_validation_rules_bulk_edit + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/turnstile.yaml b/providers/src/cloudflare/v00.00.00000/services/turnstile.yaml new file mode 100644 index 00000000..48cba402 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/turnstile.yaml @@ -0,0 +1,896 @@ +openapi: 3.0.3 +info: + title: turnstile API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/challenges/widgets: + get: + description: Lists all turnstile widgets of an account. + operationId: accounts-turnstile-widgets-list + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/turnstileMessages' + messages: + $ref: '#/components/schemas/turnstileMessages' + success: + description: Whether the API call was successful + type: boolean + result_info: + $ref: '#/components/schemas/turnstileResultInfo' + result: + items: + $ref: '#/components/schemas/turnstileWidgetList' + type: array + required: + - success + - errors + - messages + description: List Turnstile Widgets + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/turnstileApiResponseCommonFailure' + description: List Turnstile Widgets Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Turnstile Widgets + tags: + - Turnstile + x-api-token-group: + - Turnstile Sites Write + - Turnstile Sites Read + - Account Settings Write + - Account Settings Read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 25 + description: Number of items per page. + maximum: 1000 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Field to order widgets by. + enum: + - id + - sitekey + - name + - created_on + - modified_on + type: string + - in: query + name: direction + schema: + description: Direction to order widgets. + enum: + - asc + - desc + type: string + - description: >- + Filter widgets by field using case-insensitive substring matching. + Format: `field:value` Supported fields: - `name` - Filter by widget + name (e.g., `filter=name:login-form`) - `sitekey` - Filter by + sitekey (e.g., `filter=sitekey:0x4AAA`) Returns 400 Bad Request if + the field is unsupported or format is invalid. An empty filter value + returns all results. + in: query + name: filter + schema: + type: string + x-stackql-sdk: + service: turnstile + resource_chain: + - widgets + method: list + post: + description: Lists challenge widgets. + operationId: accounts-turnstile-widget-create + requestBody: + content: + application/json: + schema: + properties: + bot_fight_mode: + $ref: '#/components/schemas/turnstileBotFightMode' + clearance_level: + $ref: '#/components/schemas/turnstileClearanceLevel' + domains: + $ref: '#/components/schemas/turnstileDomains' + ephemeral_id: + $ref: '#/components/schemas/turnstileEphemeralId' + mode: + $ref: '#/components/schemas/turnstileWidgetMode' + name: + $ref: '#/components/schemas/turnstileName' + offlabel: + $ref: '#/components/schemas/turnstileOfflabel' + region: + $ref: '#/components/schemas/turnstileRegion' + required: + - name + - mode + - domains + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/turnstileMessages' + messages: + $ref: '#/components/schemas/turnstileMessages' + success: + description: Whether the API call was successful + type: boolean + result_info: + $ref: '#/components/schemas/turnstileResultInfo' + result: + $ref: '#/components/schemas/turnstileWidgetDetail' + required: + - success + - errors + - messages + description: Create Turnstile Widget Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/turnstileApiResponseCommonFailure' + description: Create Turnstile Widget Response Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Turnstile Widget + tags: + - Turnstile + x-api-token-group: + - Turnstile Sites Write + - Account Settings Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 25 + description: Number of items per page. + maximum: 1000 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Field to order widgets by. + enum: + - id + - sitekey + - name + - created_on + - modified_on + type: string + - in: query + name: direction + schema: + description: Direction to order widgets. + enum: + - asc + - desc + type: string + - description: >- + Filter widgets by field using case-insensitive substring matching. + Format: `field:value` Supported fields: - `name` - Filter by widget + name (e.g., `filter=name:login-form`) - `sitekey` - Filter by + sitekey (e.g., `filter=sitekey:0x4AAA`) Returns 400 Bad Request if + the field is unsupported or format is invalid. An empty filter value + returns all results. + in: query + name: filter + schema: + type: string + x-stackql-sdk: + service: turnstile + resource_chain: + - widgets + method: create + /accounts/{account_id}/challenges/widgets/{sitekey}: + delete: + description: Destroy a Turnstile Widget. + operationId: accounts-turnstile-widget-delete + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/turnstileMessages' + messages: + $ref: '#/components/schemas/turnstileMessages' + success: + description: Whether the API call was successful + type: boolean + result: + $ref: '#/components/schemas/turnstileWidgetDetail' + required: + - success + - errors + - messages + description: Delete Turnstile Widget Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/turnstileApiResponseCommonFailure' + description: Delete Turnstile Widget Response Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Turnstile Widget + tags: + - Turnstile + x-api-token-group: + - Turnstile Sites Write + - Account Settings Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sitekey + schema: + $ref: '#/components/schemas/turnstileSitekey' + required: true + x-stackql-sdk: + service: turnstile + resource_chain: + - widgets + method: delete + get: + description: Show a single challenge widget configuration. + operationId: accounts-turnstile-widget-get + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/turnstileMessages' + messages: + $ref: '#/components/schemas/turnstileMessages' + success: + description: Whether the API call was successful + type: boolean + result: + $ref: '#/components/schemas/turnstileWidgetDetail' + required: + - success + - errors + - messages + description: Turnstile Widget Details Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/turnstileApiResponseCommonFailure' + description: Turnstile Widget Details Response Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Turnstile Widget Details + tags: + - Turnstile + x-api-token-group: + - Turnstile Sites Write + - Turnstile Sites Read + - Account Settings Write + - Account Settings Read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sitekey + schema: + $ref: '#/components/schemas/turnstileSitekey' + required: true + x-stackql-sdk: + service: turnstile + resource_chain: + - widgets + method: get + put: + description: Update the configuration of a widget. + operationId: accounts-turnstile-widget-update + requestBody: + content: + application/json: + schema: + properties: + bot_fight_mode: + $ref: '#/components/schemas/turnstileBotFightMode' + clearance_level: + $ref: '#/components/schemas/turnstileClearanceLevel' + domains: + $ref: '#/components/schemas/turnstileDomains' + ephemeral_id: + $ref: '#/components/schemas/turnstileEphemeralId' + mode: + $ref: '#/components/schemas/turnstileWidgetMode' + name: + $ref: '#/components/schemas/turnstileName' + offlabel: + $ref: '#/components/schemas/turnstileOfflabel' + region: + $ref: '#/components/schemas/turnstileRegion' + required: + - name + - mode + - domains + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/turnstileMessages' + messages: + $ref: '#/components/schemas/turnstileMessages' + success: + description: Whether the API call was successful + type: boolean + result: + $ref: '#/components/schemas/turnstileWidgetDetail' + required: + - success + - errors + - messages + description: Update Turnstile Widget Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/turnstileApiResponseCommonFailure' + description: Update Turnstile Widget Response Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Turnstile Widget + tags: + - Turnstile + x-api-token-group: + - Turnstile Sites Write + - Account Settings Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sitekey + schema: + $ref: '#/components/schemas/turnstileSitekey' + required: true + x-stackql-sdk: + service: turnstile + resource_chain: + - widgets + method: update + /accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret: + post: + description: >- + Generate a new secret key for this widget. If `invalidate_immediately` + is set to `false`, the previous secret remains valid for 2 hours. Note + that secrets cannot be rotated again during the grace period. + operationId: accounts-turnstile-widget-rotate-secret + requestBody: + content: + application/json: + schema: + properties: + invalidate_immediately: + $ref: '#/components/schemas/turnstileInvalidateImmediately' + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/turnstileMessages' + messages: + $ref: '#/components/schemas/turnstileMessages' + success: + description: Whether the API call was successful + type: boolean + result: + $ref: '#/components/schemas/turnstileWidgetDetail' + required: + - success + - errors + - messages + description: Rotate Secret Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/turnstileApiResponseCommonFailure' + description: Rotate Secret Response Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Rotate Secret for a Turnstile Widget + tags: + - Turnstile + x-api-token-group: + - Turnstile Sites Write + - Account Settings Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: sitekey + schema: + $ref: '#/components/schemas/turnstileSitekey' + required: true + x-stackql-sdk: + service: turnstile + resource_chain: + - widgets + method: rotate_secret +components: + schemas: + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + turnstileApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/turnstileMessages' + messages: + example: [] + $ref: '#/components/schemas/turnstileMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + turnstileBotFightMode: + description: >- + If bot_fight_mode is set to `true`, Cloudflare issues computationally + expensive challenges in response to malicious bots (ENT only). + example: false + type: boolean + x-auditable: true + turnstileClearanceLevel: + description: >- + If Turnstile is embedded on a Cloudflare site and the widget should + grant challenge clearance, this setting can determine the clearance + level to be set + enum: + - no_clearance + - jschallenge + - managed + - interactive + example: interactive + type: string + x-auditable: true + turnstileCreatedOn: + description: When the widget was created. + example: '2014-01-01T05:20:00.123123Z' + format: date-time + readOnly: true + type: string + turnstileDomains: + example: + - 203.0.113.1 + - cloudflare.com + - blog.example.com + items: + description: >- + Hosts as a hostname or IPv4/IPv6 address represented by strings. The + widget will only work on these domains, and their subdomains. + example: 203.0.113.1 + type: string + x-auditable: true + maxLength: 10 + type: array + turnstileEphemeralId: + description: Return the Ephemeral ID in /siteverify (ENT only). + example: false + type: boolean + x-auditable: true + turnstileInvalidateImmediately: + default: false + description: >- + If `invalidate_immediately` is set to `false`, the previous secret will + remain valid for two hours. Otherwise, the secret is immediately + invalidated, and requests using it will be rejected. + type: boolean + x-auditable: true + turnstileMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + turnstileModifiedOn: + description: When the widget was modified. + example: '2014-01-01T05:20:00.123123Z' + format: date-time + readOnly: true + type: string + turnstileName: + description: >- + Human readable widget name. Not unique. Cloudflare suggests that you set + this to a meaningful string to make it easier to identify your widget, + and where it is used. + example: blog.cloudflare.com login form + maxLength: 254 + minLength: 1 + type: string + x-auditable: true + turnstileOfflabel: + description: Do not show any Cloudflare branding on the widget (ENT only). + example: false + type: boolean + x-auditable: true + turnstileRegion: + default: world + description: >- + Region where this widget can be used. This cannot be changed after + creation. + enum: + - world + - china + type: string + x-auditable: true + turnstileResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + required: + - page + - per_page + - count + - total_count + type: object + turnstileSecret: + description: Secret key for this widget. + example: 0x4AAF00AAAABn0R22HWm098HVBjhdsYUc + type: string + x-sensitive: true + turnstileSitekey: + description: Widget item identifier tag. + example: 0x4AAF00AAAABn0R22HWm-YUc + maxLength: 32 + type: string + x-auditable: true + turnstileWidgetDetail: + description: A Turnstile widget's detailed configuration + properties: + bot_fight_mode: + $ref: '#/components/schemas/turnstileBotFightMode' + clearance_level: + $ref: '#/components/schemas/turnstileClearanceLevel' + created_on: + $ref: '#/components/schemas/turnstileCreatedOn' + readOnly: true + domains: + $ref: '#/components/schemas/turnstileDomains' + ephemeral_id: + $ref: '#/components/schemas/turnstileEphemeralId' + mode: + $ref: '#/components/schemas/turnstileWidgetMode' + modified_on: + $ref: '#/components/schemas/turnstileModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/turnstileName' + offlabel: + $ref: '#/components/schemas/turnstileOfflabel' + region: + $ref: '#/components/schemas/turnstileRegion' + secret: + $ref: '#/components/schemas/turnstileSecret' + sitekey: + $ref: '#/components/schemas/turnstileSitekey' + required: + - sitekey + - secret + - created_on + - modified_on + - name + - domains + - mode + - region + - bot_fight_mode + - offlabel + - clearance_level + - ephemeral_id + type: object + turnstileWidgetList: + description: A Turnstile Widgets configuration as it appears in listings + properties: + bot_fight_mode: + $ref: '#/components/schemas/turnstileBotFightMode' + clearance_level: + $ref: '#/components/schemas/turnstileClearanceLevel' + created_on: + $ref: '#/components/schemas/turnstileCreatedOn' + readOnly: true + domains: + $ref: '#/components/schemas/turnstileDomains' + ephemeral_id: + $ref: '#/components/schemas/turnstileEphemeralId' + mode: + $ref: '#/components/schemas/turnstileWidgetMode' + modified_on: + $ref: '#/components/schemas/turnstileModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/turnstileName' + offlabel: + $ref: '#/components/schemas/turnstileOfflabel' + region: + $ref: '#/components/schemas/turnstileRegion' + sitekey: + $ref: '#/components/schemas/turnstileSitekey' + required: + - sitekey + - created_on + - modified_on + - name + - domains + - mode + - region + - bot_fight_mode + - offlabel + - clearance_level + - ephemeral_id + type: object + turnstileWidgetMode: + description: Widget Mode + enum: + - non-interactive + - invisible + - managed + example: invisible + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + widgets: + id: cloudflare.turnstile.widgets + name: widgets + title: Widgets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1challenges~1widgets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1challenges~1widgets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1challenges~1widgets~1{sitekey}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1challenges~1widgets~1{sitekey}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1challenges~1widgets~1{sitekey}/put + response: + mediaType: application/json + openAPIDocKey: '200' + rotate_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1challenges~1widgets~1{sitekey}~1rotate_secret/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/widgets/methods/get' + - $ref: '#/components/x-stackQL-resources/widgets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/widgets/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/widgets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/widgets/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/url_normalization.yaml b/providers/src/cloudflare/v00.00.00000/services/url_normalization.yaml new file mode 100644 index 00000000..a283988e --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/url_normalization.yaml @@ -0,0 +1,514 @@ +openapi: 3.0.3 +info: + title: url_normalization API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/url_normalization: + delete: + description: Deletes the URL Normalization settings. + operationId: deleteUrlNormalization + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '204': + description: An empty response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete URL Normalization settings + tags: + - URL Normalization + x-api-token-group: + - Response Compression Write + - Config Settings Write + - Dynamic URL Redirects Write + - Cache Settings Write + - Custom Errors Write + - Origin Write + - Managed headers Write + - Zone Transform Rules Write + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - HTTP DDoS Managed Ruleset Write + - Sanitize Write + - Transform Rules Write + - Select Configuration Write + - Bot Management Write + - Zone WAF Write + - Account WAF Write + - Account Rulesets Write + - Logs Write + - Logs Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_normalization + resource_chain: [] + method: delete + get: + description: Fetches the current URL Normalization settings. + operationId: getUrlNormalization + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + $ref: '#/components/schemas/rulesetsUrlNormalization' + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A URL Normalization response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get URL Normalization settings + tags: + - URL Normalization + x-api-token-group: + - Response Compression Write + - Response Compression Read + - Config Settings Write + - Config Settings Read + - Dynamic URL Redirects Write + - Dynamic URL Redirects Read + - Cache Settings Write + - Cache Settings Read + - Custom Errors Write + - Custom Errors Read + - Origin Write + - Origin Read + - Managed headers Write + - Managed headers Read + - Zone Transform Rules Write + - Zone Transform Rules Read + - Mass URL Redirects Write + - Mass URL Redirects Read + - Magic Firewall Write + - Magic Firewall Read + - L4 DDoS Managed Ruleset Write + - L4 DDoS Managed Ruleset Read + - HTTP DDoS Managed Ruleset Write + - HTTP DDoS Managed Ruleset Read + - Sanitize Write + - Sanitize Read + - Transform Rules Write + - Transform Rules Read + - Select Configuration Write + - Select Configuration Read + - Bot Management Write + - Bot Management Read + - Zone WAF Write + - Zone WAF Read + - Account WAF Write + - Account WAF Read + - Account Rulesets Read + - Account Rulesets Write + - Logs Write + - Logs Read + - Logs Write + - Logs Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_normalization + resource_chain: [] + method: get + put: + description: Updates the URL Normalization settings. + operationId: updateUrlNormalization + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/rulesetsUrlNormalization' + responses: + '200': + content: + application/json: + schema: + description: A response object. + properties: + errors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + enum: + - [] + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + $ref: '#/components/schemas/rulesetsUrlNormalization' + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - true + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A URL Normalization response. + 4XX: + content: + application/json: + schema: + description: A response object. + properties: + errors: + $ref: '#/components/schemas/rulesetsErrors' + messages: + $ref: '#/components/schemas/rulesetsMessages' + result: + description: A result. + title: Result + enum: + - null + type: string + success: + description: Whether the API call was successful. + title: Success + type: boolean + enum: + - false + required: + - result + - success + - errors + - messages + title: Response + type: object + description: A failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update URL Normalization settings + tags: + - URL Normalization + x-api-token-group: + - Response Compression Write + - Config Settings Write + - Dynamic URL Redirects Write + - Cache Settings Write + - Custom Errors Write + - Origin Write + - Managed headers Write + - Zone Transform Rules Write + - Mass URL Redirects Write + - Magic Firewall Write + - L4 DDoS Managed Ruleset Write + - HTTP DDoS Managed Ruleset Write + - Sanitize Write + - Transform Rules Write + - Select Configuration Write + - Bot Management Write + - Zone WAF Write + - Account WAF Write + - Account Rulesets Write + - Logs Write + - Logs Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_normalization + resource_chain: [] + method: update +components: + schemas: + rulesetsErrors: + description: A list of error messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Errors + type: array + uniqueItems: true + rulesetsMessage: + description: A message. + properties: + code: + description: A unique code for this message. + example: 10000 + title: Code + type: integer + message: + description: A text description of this message. + example: something bad happened + minLength: 1 + title: Description + type: string + source: + description: The source of this message. + properties: + pointer: + description: A JSON pointer to the field that is the source of the message. + example: /rules/0/action + minLength: 1 + title: Pointer + type: string + required: + - pointer + title: Source + type: object + required: + - message + title: Message + type: object + rulesetsMessages: + description: A list of warning messages. + items: + $ref: '#/components/schemas/rulesetsMessage' + title: Messages + type: array + uniqueItems: true + rulesetsUrlNormalization: + description: A URL Normalization object. + properties: + scope: + description: The scope of the URL normalization. + enum: + - incoming + - both + - none + example: incoming + title: Scope + type: string + type: + description: The type of URL normalization performed by Cloudflare. + enum: + - cloudflare + - rfc3986 + example: cloudflare + title: Type + type: string + required: + - type + - scope + title: URL Normalization + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + url_normalization: + id: cloudflare.url_normalization.url_normalization + name: url_normalization + title: Url Normalization + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1url_normalization/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1url_normalization/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1url_normalization/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/url_normalization/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/url_normalization/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/url_normalization/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/url_scanner.yaml b/providers/src/cloudflare/v00.00.00000/services/url_scanner.yaml new file mode 100644 index 00000000..31bf758b --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/url_scanner.yaml @@ -0,0 +1,6839 @@ +openapi: 3.0.3 +info: + title: url_scanner API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/urlscanner/response/{response_id}: + get: + deprecated: true + description: Returns the plain response of the network request. + operationId: urlscanner-get-response-text + parameters: + - description: Response hash. + in: path + name: response_id + schema: + description: Response hash. + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + text/plain: + schema: + type: object + properties: + contents: + type: string + description: When `har.log.entries[].response._cf.contentAvailable` is `true`, use `response._cf.hash` value to fetch the raw response. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Invalid params. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Scan not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get raw response + tags: + - URL Scanner (Deprecated) + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/responses/methods/get/) instead. + /accounts/{account_id}/urlscanner/scan: + get: + deprecated: true + description: Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path.
A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by `scanId`. Please take into account that older scans may be removed from the search index at an unspecified time. + operationId: urlscanner-search-scans + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Scan UUID. + in: query + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + - description: Limit the number of objects in the response. + in: query + name: limit + schema: + description: Limit the number of objects in the response. + type: integer + - description: Pagination cursor to get the next set of results. + in: query + name: next_cursor + schema: + description: Pagination cursor to get the next set of results. + type: string + - description: Filter scans requested after date (inclusive). + in: query + name: date_start + schema: + description: Filter scans requested after date (inclusive). + format: date-time + type: string + - description: Filter scans requested before date (inclusive). + in: query + name: date_end + schema: + description: Filter scans requested before date (inclusive). + format: date-time + type: string + - description: Filter scans by URL of _any_ request made by the webpage + in: query + name: url + schema: + description: Filter scans by URL of _any_ request made by the webpage + type: string + - description: Filter scans by hostname of _any_ request made by the webpage. + in: query + name: hostname + schema: + description: Filter scans by hostname of _any_ request made by the webpage. + type: string + - description: Filter scans by url path of _any_ request made by the webpage. + in: query + name: path + schema: + description: Filter scans by url path of _any_ request made by the webpage. + type: string + - description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage. + in: query + name: ip + schema: + description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage. + type: string + - description: Filter scans by hash of any html/js/css request made by the webpage. + in: query + name: hash + schema: + description: Filter scans by hash of any html/js/css request made by the webpage. + type: string + - description: Filter scans by submitted or scanned URL + in: query + name: page_url + schema: + description: Filter scans by submitted or scanned URL + type: string + - description: Filter scans by main page hostname (domain of effective URL). + in: query + name: page_hostname + schema: + description: Filter scans by main page hostname (domain of effective URL). + type: string + - description: Filter scans by exact match of effective URL path (also supports suffix search). + in: query + name: page_path + schema: + description: Filter scans by exact match of effective URL path (also supports suffix search). + type: string + - description: Filter scans by main page Autonomous System Number (ASN). + in: query + name: page_asn + schema: + description: Filter scans by main page Autonomous System Number (ASN). + type: string + - description: Filter scans by main page IP address (IPv4 or IPv6). + in: query + name: page_ip + schema: + description: Filter scans by main page IP address (IPv4 or IPv6). + type: string + - description: Return only scans created by account. + in: query + name: account_scans + schema: + description: Return only scans created by account. + type: boolean + - description: Filter scans by malicious verdict. + in: query + name: is_malicious + schema: + description: Filter scans by malicious verdict. + type: boolean + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + tasks: + items: + properties: + country: + description: Alpha-2 country code + type: string + success: + description: Whether scan was successful or not + type: boolean + time: + description: When scan was submitted (UTC) + format: date-time + type: string + url: + description: Scan url (after redirects) + type: string + uuid: + description: Scan id + format: uuid + type: string + visibility: + description: Submitted visibility status. + enum: + - public + - unlisted + type: string + required: + - uuid + - url + - success + - time + - country + - visibility + type: object + type: array + required: + - tasks + type: object + success: + description: Whether search request was successful or not + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: Search results + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Invalid params. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search URL scans + tags: + - URL Scanner (Deprecated) + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/list/) instead. + post: + deprecated: true + description: Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/. + operationId: urlscanner-create-scan + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + country: + description: Country to geo egress from + enum: + - AF + - AL + - DZ + - AD + - AO + - AG + - AR + - AM + - AU + - AT + - AZ + - BH + - BD + - BB + - BY + - BE + - BZ + - BJ + - BM + - BT + - BO + - BA + - BW + - BR + - BN + - BG + - BF + - BI + - KH + - CM + - CA + - CV + - KY + - CF + - TD + - CL + - CN + - CO + - KM + - CG + - CR + - CI + - HR + - CU + - CY + - CZ + - CD + - DK + - DJ + - DM + - DO + - EC + - EG + - SV + - GQ + - ER + - EE + - SZ + - ET + - FJ + - FI + - FR + - GA + - GE + - DE + - GH + - GR + - GL + - GD + - GT + - GN + - GW + - GY + - HT + - HN + - HU + - IS + - IN + - ID + - IR + - IQ + - IE + - IL + - IT + - JM + - JP + - JO + - KZ + - KE + - KI + - KW + - KG + - LA + - LV + - LB + - LS + - LR + - LY + - LI + - LT + - LU + - MO + - MG + - MW + - MY + - MV + - ML + - MR + - MU + - MX + - FM + - MD + - MC + - MN + - MS + - MA + - MZ + - MM + - NA + - NR + - NP + - NL + - NZ + - NI + - NE + - NG + - KP + - MK + - 'NO' + - OM + - PK + - PS + - PA + - PG + - PY + - PE + - PH + - PL + - PT + - QA + - RO + - RU + - RW + - SH + - KN + - LC + - VC + - WS + - SM + - ST + - SA + - SN + - RS + - SC + - SL + - SK + - SI + - SB + - SO + - ZA + - KR + - SS + - ES + - LK + - SD + - SR + - SE + - CH + - SY + - TW + - TJ + - TZ + - TH + - BS + - GM + - TL + - TG + - TO + - TT + - TN + - TR + - TM + - UG + - UA + - AE + - GB + - US + - UY + - UZ + - VU + - VE + - VN + - YE + - ZM + - ZW + type: string + customHeaders: + description: Set custom headers. + type: object + screenshotsResolutions: + default: + - desktop + description: Take multiple screenshots targeting different device types. + items: + default: desktop + description: Device resolutions. + enum: + - desktop + - mobile + - tablet + type: string + type: array + url: + type: string + visibility: + default: Public + description: The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material. + enum: + - Public + - Unlisted + type: string + required: + - url + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + time: + description: Time when url was submitted for scanning. + format: date-time + type: string + url: + description: Canonical form of submitted URL. Use this if you want to later search by URL. + type: string + uuid: + description: Scan ID. + format: uuid + type: string + visibility: + description: Submitted visibility status. + enum: + - public + - unlisted + type: string + required: + - visibility + - uuid + - url + - time + type: object + success: + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: Scan request accepted successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Invalid params. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + tasks: + items: + properties: + clientLocation: + description: Submitter location + type: string + clientType: + enum: + - Site + - Automatic + - Api + type: string + effectiveUrl: + description: URL of the primary request, after all HTTP redirects + type: string + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + scannedFrom: + properties: + colo: + description: IATA code of Cloudflare datacenter + type: string + required: + - colo + type: object + status: + enum: + - Queued + - InProgress + - InPostProcessing + - Finished + type: string + success: + type: boolean + time: + type: string + timeEnd: + type: string + url: + description: Submitted URL + type: string + uuid: + description: Scan ID + type: string + visibility: + enum: + - Public + - Unlisted + type: string + required: + - uuid + - url + - status + - success + - errors + - time + - timeEnd + - visibility + - clientLocation + - clientType + - effectiveUrl + - scannedFrom + type: object + type: array + required: + - tasks + type: object + success: + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: 'Scan request denied: hostname was recently scanned.' + '429': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + type: boolean + required: + - messages + - errors + - success + type: object + description: 'Scan request denied: rate limited.' + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create URL Scan + tags: + - URL Scanner (Deprecated) + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/create/) instead. + /accounts/{account_id}/urlscanner/scan/{scan_id}: + get: + deprecated: true + description: Get URL scan by uuid + operationId: urlscanner-get-scan + parameters: + - description: Scan UUID. + in: path + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Whether to return full report (scan summary and network log). + in: query + name: full + schema: + description: Whether to return full report (scan summary and network log). + type: boolean + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + scan: + properties: + asns: + description: Dictionary of Autonomous System Numbers where ASN's are the keys + properties: + asn: + description: ASN's contacted + properties: + asn: + type: string + description: + type: string + location_alpha2: + type: string + name: + type: string + org_name: + type: string + required: + - asn + - name + - description + - org_name + - location_alpha2 + type: object + type: object + certificates: + items: + properties: + issuer: + type: string + subjectName: + type: string + validFrom: + type: number + validTo: + type: number + required: + - issuer + - subjectName + - validFrom + - validTo + type: object + type: array + domains: + properties: + example.com: + properties: + categories: + properties: + content: + items: + $ref: '#/components/schemas/unnamedSchemaRef6d7a78acccfc753a8e931b1c4e72b6a6' + type: array + inherited: + properties: + content: + items: + $ref: '#/components/schemas/unnamedSchemaRef6d7a78acccfc753a8e931b1c4e72b6a6' + type: array + from: + type: string + risks: + items: + $ref: '#/components/schemas/unnamedSchemaRef6d7a78acccfc753a8e931b1c4e72b6a6' + type: array + type: object + risks: + items: + $ref: '#/components/schemas/unnamedSchemaRef6d7a78acccfc753a8e931b1c4e72b6a6' + type: array + required: + - inherited + type: object + dns: + items: + properties: + address: + type: string + dnssec_valid: + type: boolean + name: + type: string + type: + type: string + required: + - name + - address + - type + - dnssec_valid + type: object + type: array + name: + type: string + rank: + properties: + bucket: + type: string + name: + type: string + rank: + description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/ + type: integer + required: + - name + - bucket + type: object + type: + type: string + required: + - name + - type + - categories + - dns + - rank + type: object + type: object + geo: + properties: + continents: + items: + description: GeoIP continent location + type: string + type: array + locations: + items: + description: GeoIP country location + type: string + type: array + required: + - locations + - continents + type: object + ips: + properties: + ip: + properties: + asn: + type: string + asnDescription: + type: string + asnLocationAlpha2: + type: string + asnName: + type: string + asnOrgName: + type: string + continent: + type: string + geonameId: + type: string + ip: + type: string + ipVersion: + type: string + latitude: + type: string + locationAlpha2: + type: string + locationName: + type: string + longitude: + type: string + subdivision1Name: + type: string + subdivision2Name: + type: string + required: + - ip + - ipVersion + - locationAlpha2 + - locationName + - subdivision1Name + - subdivision2Name + - latitude + - longitude + - continent + - geonameId + - asn + - asnName + - asnOrgName + - asnDescription + - asnLocationAlpha2 + type: object + type: object + links: + properties: + link: + properties: + href: + description: Outgoing link detected in the DOM + type: string + text: + type: string + required: + - href + - text + type: object + type: object + meta: + properties: + processors: + properties: + categories: + properties: + content: + items: + $ref: '#/components/schemas/unnamedSchemaRef6d7a78acccfc753a8e931b1c4e72b6a6' + type: array + risks: + items: + properties: + id: + type: integer + name: + type: string + super_category_id: + type: integer + required: + - id + - super_category_id + - name + type: object + type: array + required: + - content + - risks + type: object + phishing: + items: + type: string + type: array + rank: + properties: + bucket: + type: string + name: + type: string + rank: + description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/ + type: integer + required: + - name + - bucket + type: object + tech: + items: + properties: + categories: + items: + properties: + groups: + items: + type: integer + type: array + id: + type: integer + name: + type: string + priority: + type: integer + slug: + type: string + required: + - id + - slug + - groups + - name + - priority + type: object + type: array + confidence: + type: integer + description: + type: string + evidence: + properties: + impliedBy: + items: + type: string + type: array + patterns: + items: + properties: + confidence: + type: integer + excludes: + items: + type: string + type: array + implies: + items: + type: string + type: array + match: + type: string + name: + description: Header or Cookie name when set + type: string + regex: + type: string + type: + type: string + value: + type: string + version: + type: string + required: + - type + - regex + - value + - match + - name + - confidence + - version + - implies + - excludes + type: object + type: array + required: + - patterns + - impliedBy + type: object + icon: + type: string + name: + type: string + slug: + type: string + website: + type: string + required: + - name + - slug + - categories + - confidence + - icon + - website + - evidence + type: object + type: array + required: + - tech + - categories + - rank + - phishing + type: object + required: + - processors + type: object + page: + properties: + asn: + type: string + asnLocationAlpha2: + type: string + asnname: + type: string + console: + items: + properties: + category: + type: string + text: + type: string + type: + type: string + url: + type: string + required: + - type + - text + - category + type: object + type: array + cookies: + items: + properties: + domain: + type: string + expires: + type: number + httpOnly: + type: boolean + name: + type: string + path: + type: string + priority: + type: string + sameParty: + type: boolean + secure: + type: boolean + session: + type: boolean + size: + type: number + sourcePort: + type: number + sourceScheme: + type: string + value: + type: string + required: + - name + - value + - domain + - path + - expires + - size + - httpOnly + - secure + - session + - sameParty + - sourceScheme + - sourcePort + type: object + type: array + country: + type: string + countryLocationAlpha2: + type: string + domain: + type: string + headers: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + ip: + type: string + js: + properties: + variables: + items: + properties: + name: + type: string + type: + type: string + required: + - name + - type + type: object + type: array + required: + - variables + type: object + securityViolations: + items: + properties: + category: + type: string + text: + type: string + url: + type: string + required: + - text + - category + - url + type: object + type: array + status: + type: number + subdivision1Name: + type: string + subdivision2name: + type: string + url: + type: string + required: + - url + - domain + - country + - countryLocationAlpha2 + - subdivision1Name + - subdivision2name + - ip + - asn + - asnname + - asnLocationAlpha2 + - cookies + - headers + - status + - js + - console + - securityViolations + type: object + performance: + items: + properties: + connectEnd: + type: number + connectStart: + type: number + decodedBodySize: + type: number + domComplete: + type: number + domContentLoadedEventEnd: + type: number + domContentLoadedEventStart: + type: number + domInteractive: + type: number + domainLookupEnd: + type: number + domainLookupStart: + type: number + duration: + type: number + encodedBodySize: + type: number + entryType: + type: string + fetchStart: + type: number + initiatorType: + type: string + loadEventEnd: + type: number + loadEventStart: + type: number + name: + type: string + nextHopProtocol: + type: string + redirectCount: + type: number + redirectEnd: + type: number + redirectStart: + type: number + requestStart: + type: number + responseEnd: + type: number + responseStart: + type: number + secureConnectionStart: + type: number + startTime: + type: number + transferSize: + type: number + type: + type: string + unloadEventEnd: + type: number + unloadEventStart: + type: number + workerStart: + type: number + required: + - name + - entryType + - startTime + - duration + - initiatorType + - nextHopProtocol + - workerStart + - redirectStart + - redirectEnd + - fetchStart + - domainLookupStart + - domainLookupEnd + - connectStart + - connectEnd + - secureConnectionStart + - requestStart + - responseStart + - responseEnd + - transferSize + - encodedBodySize + - decodedBodySize + - unloadEventStart + - unloadEventEnd + - domInteractive + - domContentLoadedEventStart + - domContentLoadedEventEnd + - domComplete + - loadEventStart + - loadEventEnd + - type + - redirectCount + type: object + type: array + task: + properties: + clientLocation: + description: Submitter location + type: string + clientType: + enum: + - Site + - Automatic + - Api + type: string + effectiveUrl: + description: URL of the primary request, after all HTTP redirects + type: string + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + scannedFrom: + properties: + colo: + description: IATA code of Cloudflare datacenter + type: string + required: + - colo + type: object + status: + enum: + - Queued + - InProgress + - InPostProcessing + - Finished + type: string + success: + type: boolean + time: + type: string + timeEnd: + type: string + url: + description: Submitted URL + type: string + uuid: + description: Scan ID + type: string + visibility: + enum: + - Public + - Unlisted + type: string + required: + - uuid + - url + - status + - success + - errors + - time + - timeEnd + - visibility + - clientLocation + - clientType + - effectiveUrl + - scannedFrom + type: object + verdicts: + properties: + overall: + properties: + categories: + items: + properties: + id: + type: number + name: + type: string + super_category_id: + type: number + required: + - id + - super_category_id + - name + type: object + type: array + malicious: + description: At least one of our subsystems marked the site as potentially malicious at the time of the scan. + type: boolean + phishing: + items: + type: string + type: array + required: + - malicious + - categories + - phishing + type: object + required: + - overall + type: object + required: + - task + - meta + - page + - geo + - certificates + - performance + - verdicts + type: object + required: + - scan + type: object + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: Scan has finished. It may or may not have been successful. + '202': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + scan: + properties: + task: + $ref: '#/components/schemas/unnamedSchemaRef3750739f772bbdf0bb00d6634ccc0631' + required: + - task + type: object + required: + - scan + type: object + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.' + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Invalid params. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Scan not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get URL scan + tags: + - URL Scanner (Deprecated) + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/get/) instead. + /accounts/{account_id}/urlscanner/scan/{scan_id}/har: + get: + deprecated: true + description: Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/. + operationId: urlscanner-get-scan-har + parameters: + - description: Scan UUID. + in: path + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + har: + properties: + log: + properties: + creator: + properties: + comment: + type: string + name: + type: string + version: + type: string + required: + - name + - version + - comment + type: object + entries: + items: + properties: + _initialPriority: + type: string + x-stainless-naming: + python: + argument_name: initial_priority + method_argument: initial_priority + property_name: initial_priority + _initiator_type: + type: string + x-stainless-naming: + python: + argument_name: initiator_type + method_argument: initiator_type + property_name: initiator_type + _priority: + type: string + x-stainless-naming: + python: + argument_name: priority + method_argument: priority + property_name: priority + _requestId: + type: string + x-stainless-naming: + python: + argument_name: request_id + method_argument: request_id + property_name: request_id + _requestTime: + type: number + x-stainless-naming: + python: + argument_name: request_time + method_argument: request_time + property_name: request_time + _resourceType: + type: string + x-stainless-naming: + python: + argument_name: resource_type + method_argument: resource_type + property_name: resource_type + cache: + type: object + connection: + type: string + pageref: + type: string + request: + properties: + bodySize: + type: number + headers: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + headersSize: + type: number + httpVersion: + type: string + method: + type: string + url: + type: string + required: + - method + - url + - headersSize + - bodySize + - headers + - httpVersion + type: object + response: + properties: + _transferSize: + type: number + x-stainless-naming: + python: + argument_name: transfer_size + method_argument: transfer_size + property_name: transfer_size + bodySize: + type: number + content: + properties: + compression: + type: integer + mimeType: + type: string + size: + type: number + required: + - mimeType + - size + type: object + headers: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + headersSize: + type: number + httpVersion: + type: string + redirectURL: + type: string + status: + type: number + statusText: + type: string + required: + - httpVersion + - redirectURL + - status + - statusText + - content + - headersSize + - bodySize + - headers + - _transferSize + type: object + serverIPAddress: + type: string + startedDateTime: + type: string + time: + type: number + required: + - cache + - startedDateTime + - _requestId + - _initialPriority + - _priority + - pageref + - request + - time + - _initiator_type + - _resourceType + - response + - connection + - serverIPAddress + - _requestTime + type: object + type: array + pages: + items: + properties: + id: + type: string + pageTimings: + properties: + onContentLoad: + type: number + onLoad: + type: number + required: + - onLoad + - onContentLoad + type: object + startedDateTime: + type: string + title: + type: string + required: + - id + - startedDateTime + - title + - pageTimings + type: object + type: array + version: + type: string + required: + - version + - creator + - pages + - entries + type: object + required: + - log + type: object + required: + - har + type: object + success: + description: Whether search request was successful or not + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: Returns the scan's har. + '202': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + scan: + properties: + task: + $ref: '#/components/schemas/unnamedSchemaRef3750739f772bbdf0bb00d6634ccc0631' + required: + - task + type: object + required: + - scan + type: object + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.' + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Invalid params. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Scan not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get URL scan's HAR + tags: + - URL Scanner (Deprecated) + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/har/) instead. + /accounts/{account_id}/urlscanner/scan/{scan_id}/screenshot: + get: + deprecated: true + description: Get scan's screenshot by resolution (desktop/mobile/tablet). + operationId: urlscanner-get-scan-screenshot + parameters: + - description: Scan UUID. + in: path + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Target device type. + in: query + name: resolution + schema: + default: desktop + description: Target device type. + enum: + - desktop + - mobile + - tablet + type: string + responses: + '200': + content: + image/png: + schema: + type: object + properties: + contents: + type: string + description: Returns the scan's requested screenshot. + '202': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + properties: + scan: + properties: + task: + $ref: '#/components/schemas/unnamedSchemaRef3750739f772bbdf0bb00d6634ccc0631' + required: + - task + type: object + required: + - scan + type: object + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + - result + type: object + description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.' + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Invalid params. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + description: Whether request was successful or not + type: boolean + required: + - messages + - errors + - success + type: object + description: Scan not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get screenshot + tags: + - URL Scanner (Deprecated) + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stainless-deprecation-message: Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/screenshot/) instead. + /accounts/{account_id}/urlscanner/v2/bulk: + post: + description: Submit URLs to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/ and take into account scans submitted in bulk have lower priority and may take longer to finish. + operationId: urlscanner-create-scan-bulk-v2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + description: List of urls to scan (up to a 100). + items: + properties: + agentReadiness: + description: Enable agent readiness checks. + type: boolean + customHeaders: + description: Set custom headers. + type: object + customagent: + maxLength: 4096 + type: string + referer: + maxLength: 4096 + type: string + screenshotsResolutions: + default: + - desktop + description: Take multiple screenshots targeting different device types. + items: + default: desktop + description: Device resolutions. + enum: + - desktop + - mobile + - tablet + type: string + type: array + url: + type: string + visibility: + default: Public + description: The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material. + enum: + - Public + - Unlisted + type: string + required: + - url + type: object + type: array + responses: + '200': + content: + application/json: + schema: + items: + properties: + api: + description: URL to api report. + type: string + options: + properties: + useragent: + type: string + type: object + result: + description: URL to report. + type: string + url: + description: Submitted URL + type: string + uuid: + description: Scan ID. + format: uuid + type: string + visibility: + description: Submitted visibility status. + enum: + - public + - unlisted + type: string + required: + - uuid + - result + - api + - visibility + - url + type: object + type: array + description: Scan bulk request accepted successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + '429': + content: + application/json: + schema: + properties: + description: + type: string + errors: + items: + properties: + detail: + type: string + status: + type: number + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + type: number + required: + - message + - status + - errors + type: object + description: 'Scan request denied: rate limited.' + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Bulk create URL Scans + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - scans + method: bulk_create + /accounts/{account_id}/urlscanner/v2/dom/{scan_id}: + get: + description: Returns a plain text response, with the scan's DOM content as rendered by Chrome. + operationId: urlscanner-get-scan-dom-v2 + parameters: + - description: Scan UUID. + in: path + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + text/plain: + schema: + type: object + properties: + contents: + type: string + description: Returns a plain text response, with the scan's DOM content as rendered by Chrome. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + description: Scan not found or in progress. + type: string + status: + description: Status code. + type: integer + task: + properties: + status: + type: string + time: + type: string + url: + type: string + uuid: + type: string + visibility: + type: string + required: + - uuid + - url + - time + - status + - visibility + type: object + required: + - message + - status + - errors + - task + type: object + description: Scan not found or in progress. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get URL scan's DOM + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - scans + method: dom + /accounts/{account_id}/urlscanner/v2/har/{scan_id}: + get: + description: Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/. + operationId: urlscanner-get-scan-har-v2 + parameters: + - description: Scan UUID. + in: path + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + log: + properties: + creator: + properties: + comment: + type: string + name: + type: string + version: + type: string + required: + - name + - version + - comment + type: object + entries: + items: + properties: + _initialPriority: + type: string + x-stainless-naming: + python: + argument_name: initial_priority + method_argument: initial_priority + property_name: initial_priority + _initiator_type: + type: string + x-stainless-naming: + python: + argument_name: initiator_type + method_argument: initiator_type + property_name: initiator_type + _priority: + type: string + x-stainless-naming: + python: + argument_name: priority + method_argument: priority + property_name: priority + _requestId: + type: string + x-stainless-naming: + python: + argument_name: request_id + method_argument: request_id + property_name: request_id + _requestTime: + type: number + x-stainless-naming: + python: + argument_name: request_time + method_argument: request_time + property_name: request_time + _resourceType: + type: string + x-stainless-naming: + python: + argument_name: resource_type + method_argument: resource_type + property_name: resource_type + cache: + type: object + connection: + type: string + pageref: + type: string + request: + properties: + bodySize: + type: number + headers: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + headersSize: + type: number + httpVersion: + type: string + method: + type: string + url: + type: string + required: + - method + - url + - headersSize + - bodySize + - headers + - httpVersion + type: object + response: + properties: + _transferSize: + type: number + x-stainless-naming: + python: + argument_name: transfer_size + method_argument: transfer_size + property_name: transfer_size + bodySize: + type: number + content: + properties: + compression: + type: integer + mimeType: + type: string + size: + type: number + required: + - mimeType + - size + type: object + headers: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + headersSize: + type: number + httpVersion: + type: string + redirectURL: + type: string + status: + type: number + statusText: + type: string + required: + - httpVersion + - redirectURL + - status + - statusText + - content + - headersSize + - bodySize + - headers + - _transferSize + type: object + serverIPAddress: + type: string + startedDateTime: + type: string + time: + type: number + required: + - cache + - startedDateTime + - _requestId + - _initialPriority + - _priority + - pageref + - request + - time + - _initiator_type + - _resourceType + - response + - connection + - serverIPAddress + - _requestTime + type: object + type: array + pages: + items: + properties: + id: + type: string + pageTimings: + properties: + onContentLoad: + type: number + onLoad: + type: number + required: + - onLoad + - onContentLoad + type: object + startedDateTime: + type: string + title: + type: string + required: + - id + - startedDateTime + - title + - pageTimings + type: object + type: array + version: + type: string + required: + - version + - creator + - pages + - entries + type: object + required: + - log + type: object + description: Returns the scan's har. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + description: Scan not found or in progress. + type: string + status: + description: Status code. + type: integer + task: + properties: + status: + type: string + time: + type: string + url: + type: string + uuid: + type: string + visibility: + type: string + required: + - uuid + - url + - time + - status + - visibility + type: object + required: + - message + - status + - errors + - task + type: object + description: Scan not found or in progress. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get URL scan's HAR + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - scans + method: har + /accounts/{account_id}/urlscanner/v2/responses/{response_id}: + get: + description: Returns the raw response of the network request. Find the `response_id` in the `data.requests.response.hash`. + operationId: urlscanner-get-response-v2 + parameters: + - description: Response hash. + in: path + name: response_id + schema: + description: Response hash. + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + text/plain: + schema: + type: object + properties: + contents: + type: string + description: Get the raw response by its hash. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get raw response + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - responses + method: get + /accounts/{account_id}/urlscanner/v2/result/{scan_id}: + get: + description: Get URL scan by uuid + operationId: urlscanner-get-scan-v2 + parameters: + - description: Scan UUID. + in: path + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + data: + properties: + console: + items: + properties: + message: + properties: + level: + type: string + source: + type: string + text: + type: string + url: + type: string + required: + - source + - level + - text + - url + type: object + required: + - message + type: object + type: array + cookies: + items: + properties: + domain: + type: string + expires: + type: number + httpOnly: + type: boolean + name: + type: string + path: + type: string + priority: + type: string + sameParty: + type: boolean + secure: + type: boolean + session: + type: boolean + size: + type: number + sourcePort: + type: number + sourceScheme: + type: string + value: + type: string + required: + - name + - value + - domain + - path + - expires + - size + - httpOnly + - secure + - session + - priority + - sameParty + - sourceScheme + - sourcePort + type: object + type: array + globals: + items: + properties: + prop: + type: string + type: + type: string + required: + - prop + - type + type: object + type: array + links: + items: + properties: + href: + type: string + text: + type: string + required: + - href + - text + type: object + type: array + performance: + items: + properties: + duration: + type: number + entryType: + type: string + name: + type: string + startTime: + type: number + required: + - name + - entryType + - startTime + - duration + type: object + type: array + requests: + items: + properties: + request: + properties: + documentURL: + type: string + frameId: + type: string + hasUserGesture: + type: boolean + initiator: + properties: + host: + type: string + type: + type: string + url: + type: string + required: + - type + - url + - host + type: object + loaderId: + type: string + primaryRequest: + type: boolean + redirectHasExtraInfo: + type: boolean + redirectResponse: + properties: + charset: + type: string + headers: + type: object + mimeType: + type: string + protocol: + type: string + remoteIPAddress: + type: string + remotePort: + type: number + securityHeaders: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + securityState: + type: string + status: + type: number + statusText: + type: string + url: + type: string + required: + - url + - status + - statusText + - mimeType + - charset + - remoteIPAddress + - remotePort + - protocol + - securityState + - securityHeaders + type: object + request: + properties: + headers: + type: object + initialPriority: + type: string + isSameSite: + type: boolean + method: + type: string + mixedContentType: + type: string + referrerPolicy: + type: string + url: + type: string + required: + - url + - method + - mixedContentType + - initialPriority + - referrerPolicy + - isSameSite + type: object + requestId: + type: string + type: + type: string + wallTime: + type: number + required: + - requestId + - documentURL + - request + - wallTime + - initiator + - redirectHasExtraInfo + - type + - hasUserGesture + type: object + requests: + items: + properties: + documentURL: + type: string + frameId: + type: string + hasUserGesture: + type: boolean + initiator: + properties: + type: + type: string + required: + - type + type: object + loaderId: + type: string + redirectHasExtraInfo: + type: boolean + request: + properties: + headers: + properties: + name: + type: string + required: + - name + type: object + initialPriority: + type: string + isSameSite: + type: boolean + method: + type: string + mixedContentType: + type: string + referrerPolicy: + type: string + url: + type: string + required: + - url + - method + - headers + - mixedContentType + - initialPriority + - referrerPolicy + - isSameSite + type: object + requestId: + type: string + type: + type: string + wallTime: + type: number + required: + - requestId + - loaderId + - frameId + - documentURL + - wallTime + - request + - type + - initiator + - hasUserGesture + - redirectHasExtraInfo + type: object + x-stainless-typescript-use-array-suffix: true + type: array + response: + properties: + asn: + properties: + asn: + type: string + country: + type: string + description: + type: string + ip: + type: string + name: + type: string + org: + type: string + required: + - ip + - asn + - country + - description + - name + - org + type: object + contentAvailable: + type: boolean + dataLength: + type: number + encodedDataLength: + type: number + geoip: + properties: + city: + type: string + country: + type: string + country_name: + type: string + geonameId: + type: string + ll: + items: + type: number + type: array + region: + type: string + required: + - country + - region + - city + - ll + - country_name + - geonameId + type: object + hasExtraInfo: + type: boolean + hash: + type: string + requestId: + type: string + response: + properties: + charset: + type: string + headers: + type: object + mimeType: + type: string + protocol: + type: string + remoteIPAddress: + type: string + remotePort: + type: number + securityDetails: + properties: + certificateId: + type: number + certificateTransparencyCompliance: + type: string + cipher: + type: string + encryptedClientHello: + type: boolean + issuer: + type: string + keyExchange: + type: string + keyExchangeGroup: + type: string + protocol: + type: string + sanList: + items: + type: string + type: array + serverSignatureAlgorithm: + type: number + subjectName: + type: string + validFrom: + type: number + validTo: + type: number + required: + - protocol + - keyExchange + - keyExchangeGroup + - cipher + - certificateId + - subjectName + - sanList + - issuer + - validFrom + - validTo + - certificateTransparencyCompliance + - serverSignatureAlgorithm + - encryptedClientHello + type: object + securityHeaders: + items: + properties: + name: + type: string + value: + type: string + required: + - name + - value + type: object + type: array + securityState: + type: string + status: + type: number + statusText: + type: string + url: + type: string + required: + - url + - status + - statusText + - mimeType + - charset + - remoteIPAddress + - remotePort + - protocol + - securityState + - securityDetails + - securityHeaders + type: object + size: + type: number + type: + type: string + required: + - encodedDataLength + - dataLength + - requestId + - type + - response + - hasExtraInfo + - size + - asn + - geoip + type: object + required: + - request + - response + type: object + type: array + required: + - requests + - cookies + - console + - links + - globals + - performance + type: object + lists: + properties: + asns: + items: + type: string + type: array + certificates: + items: + properties: + issuer: + type: string + subjectName: + type: string + validFrom: + type: number + validTo: + type: number + required: + - issuer + - subjectName + - validFrom + - validTo + type: object + type: array + continents: + items: + type: string + type: array + countries: + items: + type: string + type: array + domains: + items: + type: string + type: array + hashes: + items: + type: string + type: array + ips: + items: + type: string + type: array + linkDomains: + items: + type: string + type: array + servers: + items: + type: string + type: array + urls: + items: + type: string + type: array + required: + - ips + - countries + - continents + - asns + - domains + - servers + - urls + - linkDomains + - certificates + - hashes + type: object + meta: + properties: + processors: + properties: + agentReadiness: + properties: + checks: + properties: + botAccessControl: + properties: + contentSignals: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + robotsTxtAiRules: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + webBotAuth: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + required: + - robotsTxtAiRules + - contentSignals + - webBotAuth + type: object + commerce: + properties: + acp: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + ap2: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + ucp: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + x402: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + required: + - ucp + - x402 + - acp + - ap2 + type: object + contentAccessibility: + properties: + markdownNegotiation: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + required: + - markdownNegotiation + type: object + discoverability: + properties: + linkHeaders: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + robotsTxt: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + sitemap: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + required: + - robotsTxt + - sitemap + - linkHeaders + type: object + discovery: + properties: + a2aAgentCard: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + agentSkills: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + apiCatalog: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + mcpServerCard: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + oauthDiscovery: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + oauthProtectedResource: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + webMcp: + properties: + details: + type: object + durationMs: + type: number + evidence: + items: + properties: + action: + type: string + finding: + properties: + outcome: + type: string + summary: + type: string + required: + - outcome + - summary + type: object + label: + type: string + request: + properties: + headers: + type: object + method: + type: string + url: + type: string + required: + - url + - method + type: object + response: + properties: + bodyPreview: + type: string + bodySize: + type: integer + headers: + type: object + redirectedTo: + type: string + status: + type: integer + statusText: + type: string + required: + - status + - statusText + type: object + required: + - action + - label + type: object + type: array + message: + type: string + status: + type: string + required: + - status + type: object + required: + - apiCatalog + - oauthDiscovery + - oauthProtectedResource + - mcpServerCard + - a2aAgentCard + - agentSkills + - webMcp + type: object + required: + - discoverability + - contentAccessibility + - botAccessControl + - discovery + - commerce + type: object + commerceSignals: + items: + type: string + type: array + isCommerce: + type: boolean + level: + type: integer + levelName: + type: string + nextLevel: + properties: + name: + type: string + requirements: + items: + properties: + check: + type: string + description: + type: string + prompt: + type: string + skillUrl: + type: string + specUrls: + items: + type: string + type: array + required: + - check + - description + - specUrls + - prompt + - skillUrl + type: object + type: array + target: + type: integer + required: + - target + - name + - requirements + type: object + required: + - level + - levelName + - checks + type: object + asn: + properties: + data: + items: + properties: + asn: + type: string + country: + type: string + description: + type: string + ip: + type: string + name: + type: string + required: + - ip + - asn + - country + - description + - name + type: object + type: array + required: + - data + type: object + dns: + properties: + data: + items: + properties: + address: + type: string + dnssec_valid: + type: boolean + name: + type: string + type: + type: string + required: + - name + - address + - type + - dnssec_valid + type: object + type: array + required: + - data + type: object + domainCategories: + properties: + data: + items: + properties: + inherited: + type: object + isPrimary: + type: boolean + name: + type: string + required: + - name + - isPrimary + - inherited + type: object + type: array + required: + - data + type: object + geoip: + properties: + data: + items: + properties: + geoip: + properties: + city: + type: string + country: + type: string + country_name: + type: string + ll: + items: + type: number + type: array + region: + type: string + required: + - country + - region + - city + - ll + - country_name + type: object + ip: + type: string + required: + - ip + - geoip + type: object + type: array + required: + - data + type: object + phishing: + properties: + data: + items: + type: string + type: array + required: + - data + type: object + phishing_v2: + properties: + data: + items: + type: string + type: array + required: + - data + type: object + radarRank: + properties: + data: + items: + properties: + bucket: + type: string + hostname: + type: string + rank: + type: number + required: + - hostname + - bucket + type: object + type: array + required: + - data + type: object + robotsTxt: + properties: + data: + items: + properties: + hash: + type: string + rules: + properties: + '*': + properties: + allow: + items: + type: string + type: array + contentSignal: + properties: + ai-input: + type: string + ai-train: + type: string + search: + type: string + type: object + crawlDelay: + type: number + disallow: + items: + type: string + type: array + required: + - allow + - disallow + type: object + required: + - '*' + type: object + sitemaps: + items: + type: string + type: array + required: + - rules + - sitemaps + type: object + type: array + required: + - data + type: object + urlCategories: + properties: + data: + items: + properties: + content: + items: + properties: + id: + type: number + name: + type: string + super_category_id: + type: number + required: + - id + - name + - super_category_id + type: object + type: array + inherited: + properties: + content: + items: + properties: + id: + type: number + name: + type: string + super_category_id: + type: number + required: + - id + - name + - super_category_id + type: object + type: array + from: + type: string + risks: + items: + properties: + id: + type: number + name: + type: string + super_category_id: + type: number + required: + - id + - name + - super_category_id + type: object + type: array + required: + - from + - content + - risks + type: object + name: + type: string + risks: + items: + properties: + id: + type: number + name: + type: string + super_category_id: + type: number + required: + - id + - name + - super_category_id + type: object + type: array + required: + - name + - content + - risks + - inherited + type: object + type: array + required: + - data + type: object + wappa: + properties: + data: + items: + properties: + app: + type: string + categories: + items: + properties: + name: + type: string + priority: + type: number + required: + - name + - priority + type: object + type: array + confidence: + items: + properties: + confidence: + type: number + name: + type: string + pattern: + type: string + patternType: + type: string + required: + - confidence + - pattern + - patternType + - name + type: object + type: array + confidenceTotal: + type: number + icon: + type: string + website: + type: string + required: + - confidence + - confidenceTotal + - app + - icon + - website + - categories + type: object + type: array + required: + - data + type: object + required: + - geoip + - asn + - wappa + - domainCategories + - dns + - radarRank + - phishing + type: object + required: + - processors + type: object + page: + properties: + apexDomain: + type: string + asn: + type: string + asnname: + type: string + city: + type: string + country: + type: string + domain: + type: string + ip: + type: string + mimeType: + type: string + screenshot: + properties: + dhash: + type: string + mm3Hash: + type: number + name: + type: string + phash: + type: string + required: + - phash + - dhash + - mm3Hash + - name + type: object + server: + type: string + status: + type: string + title: + type: string + tlsAgeDays: + type: number + tlsIssuer: + type: string + tlsValidDays: + type: number + tlsValidFrom: + type: string + url: + type: string + required: + - asn + - asnname + - city + - country + - domain + - ip + - server + - url + - mimeType + - apexDomain + - status + - title + - tlsIssuer + - tlsValidFrom + - tlsAgeDays + - tlsValidDays + type: object + scanner: + properties: + colo: + type: string + country: + type: string + required: + - country + - colo + type: object + stats: + properties: + IPv6Percentage: + type: number + domainStats: + items: + properties: + count: + type: number + countries: + items: + type: string + type: array + domain: + type: string + encodedSize: + type: number + index: + type: number + initiators: + items: + type: string + type: array + ips: + items: + type: string + type: array + redirects: + type: number + size: + type: number + required: + - count + - ips + - domain + - size + - encodedSize + - countries + - index + - initiators + - redirects + type: object + type: array + ipStats: + items: + properties: + asn: + properties: + asn: + type: string + country: + type: string + description: + type: string + ip: + type: string + name: + type: string + org: + type: string + required: + - ip + - asn + - country + - description + - name + - org + type: object + count: + type: number + countries: + items: + type: string + type: array + domains: + items: + type: string + type: array + encodedSize: + type: number + geoip: + properties: + city: + type: string + country: + type: string + country_name: + type: string + ll: + items: + type: number + type: array + region: + type: string + required: + - country + - region + - city + - ll + - country_name + type: object + index: + type: number + ip: + type: string + ipv6: + type: boolean + redirects: + type: number + requests: + type: number + size: + type: number + required: + - requests + - domains + - ip + - size + - encodedSize + - countries + - index + - ipv6 + - redirects + - geoip + - asn + type: object + type: array + malicious: + type: number + protocolStats: + items: + properties: + count: + type: number + countries: + items: + type: string + type: array + encodedSize: + type: number + ips: + items: + type: string + type: array + protocol: + type: string + size: + type: number + required: + - count + - size + - encodedSize + - ips + - countries + - protocol + type: object + type: array + resourceStats: + items: + properties: + compression: + type: number + count: + type: number + countries: + items: + type: string + type: array + encodedSize: + type: number + ips: + items: + type: string + type: array + percentage: + type: number + size: + type: number + type: + type: string + required: + - count + - size + - encodedSize + - ips + - countries + - compression + - percentage + - type + type: object + type: array + securePercentage: + type: number + secureRequests: + type: number + serverStats: + items: + properties: + count: + type: number + countries: + items: + type: string + type: array + encodedSize: + type: number + ips: + items: + type: string + type: array + server: + type: string + size: + type: number + required: + - count + - size + - encodedSize + - ips + - countries + - server + type: object + type: array + tlsStats: + items: + properties: + count: + type: number + countries: + items: + type: string + type: array + encodedSize: + type: number + ips: + items: + type: string + type: array + protocols: + properties: + TLS 1.3 / AES_128_GCM: + type: number + required: + - TLS 1.3 / AES_128_GCM + type: object + securityState: + type: string + size: + type: number + required: + - count + - size + - encodedSize + - ips + - countries + - protocols + - securityState + type: object + type: array + totalLinks: + type: number + uniqASNs: + type: number + uniqCountries: + type: number + required: + - IPv6Percentage + - domainStats + - ipStats + - malicious + - protocolStats + - resourceStats + - secureRequests + - tlsStats + - serverStats + - securePercentage + - totalLinks + - uniqCountries + - uniqASNs + type: object + task: + properties: + apexDomain: + type: string + domURL: + type: string + domain: + type: string + method: + type: string + options: + properties: + customHeaders: + description: Custom headers set. + type: object + screenshotsResolutions: + items: + type: string + type: array + type: object + reportURL: + type: string + screenshotURL: + type: string + source: + type: string + success: + type: boolean + time: + type: string + url: + type: string + uuid: + type: string + visibility: + type: string + required: + - uuid + - url + - time + - visibility + - source + - method + - domain + - apexDomain + - reportURL + - screenshotURL + - domURL + - options + - success + type: object + verdicts: + properties: + overall: + properties: + categories: + items: + type: string + type: array + hasVerdicts: + type: boolean + malicious: + type: boolean + tags: + items: + type: string + type: array + required: + - malicious + - hasVerdicts + - categories + - tags + type: object + required: + - overall + type: object + required: + - data + - page + - lists + - meta + - scanner + - stats + - task + - verdicts + type: object + description: Scan has finished. It may or may not have been successful. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + description: Scan not found or in progress. + type: string + status: + description: Status code. + type: integer + task: + properties: + status: + type: string + time: + type: string + url: + type: string + uuid: + type: string + visibility: + type: string + required: + - uuid + - url + - time + - status + - visibility + type: object + required: + - message + - status + - errors + - task + type: object + description: Scan not found or in progress. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get URL scan + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - scans + method: get + /accounts/{account_id}/urlscanner/v2/scan: + post: + description: Submit a URL to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/. + operationId: urlscanner-create-scan-v2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + agentReadiness: + description: Enable agent readiness checks. + type: boolean + country: + description: Country to geo egress from + enum: + - AF + - AL + - DZ + - AD + - AO + - AG + - AR + - AM + - AU + - AT + - AZ + - BH + - BD + - BB + - BY + - BE + - BZ + - BJ + - BM + - BT + - BO + - BA + - BW + - BR + - BN + - BG + - BF + - BI + - KH + - CM + - CA + - CV + - KY + - CF + - TD + - CL + - CN + - CO + - KM + - CG + - CR + - CI + - HR + - CU + - CY + - CZ + - CD + - DK + - DJ + - DM + - DO + - EC + - EG + - SV + - GQ + - ER + - EE + - SZ + - ET + - FJ + - FI + - FR + - GA + - GE + - DE + - GH + - GR + - GL + - GD + - GT + - GN + - GW + - GY + - HT + - HN + - HU + - IS + - IN + - ID + - IR + - IQ + - IE + - IL + - IT + - JM + - JP + - JO + - KZ + - KE + - KI + - KW + - KG + - LA + - LV + - LB + - LS + - LR + - LY + - LI + - LT + - LU + - MO + - MG + - MW + - MY + - MV + - ML + - MR + - MU + - MX + - FM + - MD + - MC + - MN + - MS + - MA + - MZ + - MM + - NA + - NR + - NP + - NL + - NZ + - NI + - NE + - NG + - KP + - MK + - 'NO' + - OM + - PK + - PS + - PA + - PG + - PY + - PE + - PH + - PL + - PT + - QA + - RO + - RU + - RW + - SH + - KN + - LC + - VC + - WS + - SM + - ST + - SA + - SN + - RS + - SC + - SL + - SK + - SI + - SB + - SO + - ZA + - KR + - SS + - ES + - LK + - SD + - SR + - SE + - CH + - SY + - TW + - TJ + - TZ + - TH + - BS + - GM + - TL + - TG + - TO + - TT + - TN + - TR + - TM + - UG + - UA + - AE + - GB + - US + - UY + - UZ + - VU + - VE + - VN + - YE + - ZM + - ZW + type: string + customHeaders: + description: Set custom headers. + type: object + customagent: + maxLength: 4096 + type: string + referer: + maxLength: 4096 + type: string + screenshotsResolutions: + default: + - desktop + description: Take multiple screenshots targeting different device types. + items: + default: desktop + description: Device resolutions. + enum: + - desktop + - mobile + - tablet + type: string + type: array + url: + type: string + visibility: + default: Public + description: The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material. + enum: + - Public + - Unlisted + type: string + required: + - url + type: object + responses: + '200': + content: + application/json: + schema: + properties: + api: + description: URL to api report. + type: string + message: + type: string + options: + properties: + useragent: + type: string + type: object + result: + description: Public URL to report. + type: string + url: + description: Canonical form of submitted URL. Use this if you want to later search by URL. + type: string + x-auditable: true + uuid: + description: Scan ID. + format: uuid + type: string + x-auditable: true + visibility: + description: Submitted visibility status. + enum: + - public + - unlisted + type: string + required: + - message + - uuid + - result + - api + - visibility + - url + type: object + description: Scan request accepted successfully. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + '409': + content: + application/json: + schema: + properties: + description: + type: string + errors: + items: + properties: + detail: + type: string + status: + type: number + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + type: number + required: + - message + - status + - errors + type: object + description: 'Scan request denied: hostname was recently scanned.' + '429': + content: + application/json: + schema: + properties: + description: + type: string + errors: + items: + properties: + detail: + type: string + status: + type: number + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + type: number + required: + - message + - status + - errors + type: object + description: 'Scan request denied: rate limited.' + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create URL Scan + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - scans + method: create + /accounts/{account_id}/urlscanner/v2/screenshots/{scan_id}.png: + get: + description: Get scan's screenshot by resolution (desktop/mobile/tablet). + operationId: urlscanner-get-scan-screenshot-v2 + parameters: + - description: Scan UUID. + in: path + name: scan_id + schema: + description: Scan UUID. + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Target device type. + in: query + name: resolution + schema: + default: desktop + description: Target device type. + enum: + - desktop + - mobile + - tablet + type: string + responses: + '200': + content: + image/png: + schema: + type: object + properties: + contents: + type: string + description: Returns the scan's requested screenshot. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + description: Scan not found or in progress. + type: string + status: + description: Status code. + type: integer + task: + properties: + status: + type: string + time: + type: string + url: + type: string + uuid: + type: string + visibility: + type: string + required: + - uuid + - url + - time + - status + - visibility + type: object + required: + - message + - status + - errors + - task + type: object + description: Scan not found or in progress. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get screenshot + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - scans + method: screenshot + /accounts/{account_id}/urlscanner/v2/search: + get: + description: 'Use a subset of ElasticSearch Query syntax to filter scans. Some example queries:

- ''path:"/bundles/jquery.js"'': Searches for scans who requested resources with the given path.
- ''page.asn:AS24940 AND hash:xxx'': Websites hosted in AS24940 where a resource with the given hash was downloaded.
- ''page.domain:microsoft* AND verdicts.malicious:true AND NOT page.domain:microsoft.com'': malicious scans whose hostname starts with "microsoft".
- ''apikey:me AND date:[2025-01 TO 2025-02]'': my scans from 2025 January to 2025 February.' + operationId: urlscanner-search-scans-v2 + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Limit the number of objects in the response. + in: query + name: size + schema: + description: Limit the number of objects in the response. + type: integer + - description: Filter scans + in: query + name: q + schema: + description: Filter scans + type: string + responses: + '200': + content: + application/json: + schema: + properties: + results: + items: + properties: + _id: + type: string + page: + properties: + asn: + type: string + country: + type: string + ip: + type: string + url: + type: string + required: + - country + - ip + - url + - asn + type: object + result: + type: string + stats: + properties: + dataLength: + type: number + requests: + type: number + uniqCountries: + type: number + uniqIPs: + type: number + required: + - uniqIPs + - uniqCountries + - dataLength + - requests + type: object + task: + properties: + time: + type: string + url: + type: string + uuid: + type: string + visibility: + type: string + required: + - visibility + - time + - uuid + - url + type: object + verdicts: + properties: + malicious: + type: boolean + required: + - malicious + type: object + required: + - task + - stats + - page + - verdicts + - _id + - result + type: object + type: array + required: + - results + type: object + description: Search results + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + status: + description: Status code. + type: integer + title: + type: string + required: + - title + - detail + - status + type: object + type: array + message: + type: string + status: + description: Status code. + type: integer + required: + - message + - status + - errors + type: object + description: Invalid input. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search URL scans + tags: + - URL Scanner + x-api-token-group: + - URL Scanner Write + - URL Scanner Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: url_scanner + resource_chain: + - scans + method: list +components: + schemas: + unnamedSchemaRef3750739f772bbdf0bb00d6634ccc0631: + properties: + effectiveUrl: + example: http://example.com/ + type: string + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + location: + example: PT + type: string + region: + example: enam + type: string + status: + example: InProgress + type: string + success: + example: true + type: boolean + time: + example: '2023-05-03T17:05:04.843Z' + type: string + url: + example: http://example.com + type: string + uuid: + example: 2ee568d0-bf70-4827-b922-b7088c0f056f + type: string + visibility: + example: Public + type: string + required: + - uuid + - url + - status + - success + - errors + - time + - visibility + - location + - region + - effectiveUrl + type: object + unnamedSchemaRef6d7a78acccfc753a8e931b1c4e72b6a6: + properties: + id: + example: 155 + type: integer + name: + example: Technology + type: string + super_category_id: + type: integer + required: + - id + - name + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + urlscanner_response: + id: cloudflare.url_scanner.urlscanner_response + name: urlscanner_response + title: Urlscanner Response + methods: + get_response: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1response~1{response_id}/get' + response: + mediaType: text/plain + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/urlscanner_response/methods/get_response' + insert: [] + update: [] + delete: [] + replace: [] + scan: + id: cloudflare.url_scanner.scan + name: scan + title: Scan + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1scan/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.tasks + urlscanner_create_scan: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1scan/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1scan~1{scan_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scan/methods/get' + - $ref: '#/components/x-stackQL-resources/scan/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scan/methods/urlscanner_create_scan' + update: [] + delete: [] + replace: [] + har: + id: cloudflare.url_scanner.har + name: har + title: Har + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1scan~1{scan_id}~1har/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/har/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + screenshots: + id: cloudflare.url_scanner.screenshots + name: screenshots + title: Screenshots + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1scan~1{scan_id}~1screenshot/get' + response: + mediaType: image/png + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/screenshots/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + urlscanner: + id: cloudflare.url_scanner.urlscanner + name: urlscanner + title: Urlscanner + methods: + bulk_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1bulk/post' + response: + mediaType: application/json + openAPIDocKey: '200' + scan_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1scan/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + v2_dom: + id: cloudflare.url_scanner.v2_dom + name: v2_dom + title: V2 Dom + methods: + get_dom_v2: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1dom~1{scan_id}/get' + response: + mediaType: text/plain + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2_dom/methods/get_dom_v2' + insert: [] + update: [] + delete: [] + replace: [] + v2_har: + id: cloudflare.url_scanner.v2_har + name: v2_har + title: V2 Har + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1har~1{scan_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2_har/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + v2_responses: + id: cloudflare.url_scanner.v2_responses + name: v2_responses + title: V2 Responses + methods: + get_responses_v2: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1responses~1{response_id}/get' + response: + mediaType: text/plain + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2_responses/methods/get_responses_v2' + insert: [] + update: [] + delete: [] + replace: [] + v2_result: + id: cloudflare.url_scanner.v2_result + name: v2_result + title: V2 Result + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1result~1{scan_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2_result/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + screenshots_scan_id_png: + id: cloudflare.url_scanner.screenshots_scan_id_png + name: screenshots_scan_id_png + title: Screenshots Scan Id Png + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1screenshots~1{scan_id}.png/get' + response: + mediaType: image/png + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/screenshots_scan_id_png/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + v2_search: + id: cloudflare.url_scanner.v2_search + name: v2_search + title: V2 Search + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1urlscanner~1v2~1search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2_search/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/user.yaml b/providers/src/cloudflare/v00.00.00000/services/user.yaml new file mode 100644 index 00000000..241cdf22 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/user.yaml @@ -0,0 +1,3726 @@ +openapi: 3.0.3 +info: + title: user API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /user: + get: + operationId: user-user-details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleUserResponse' + description: User Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: User Details response failure + security: + - api_email: [] + api_key: [] + summary: User Details + tags: + - User + x-api-token-group: + - User Details Write + - User Details Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.user.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: [] + method: get + patch: + description: Edit part of your user details. + operationId: user-edit-user + requestBody: + content: + application/json: + schema: + properties: + country: + $ref: '#/components/schemas/iamCountry' + first_name: + $ref: '#/components/schemas/iamFirstName' + last_name: + $ref: '#/components/schemas/iamLastName' + telephone: + $ref: '#/components/schemas/iamTelephone' + zipcode: + $ref: '#/components/schemas/iamZipcode' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleUserResponse' + description: Edit User response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Edit User response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit User + tags: + - User + x-api-token-group: + - User Details Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.user.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: [] + method: edit + /user/audit_logs: + get: + description: >- + Gets a list of audit logs for a user account. Can be filtered by who + made the change, on which zone, and the timeframe of the change. + operationId: audit-logs-get-user-audit-logs + parameters: + - in: query + name: id + schema: + description: Finds a specific log by its ID. + type: string + - in: query + name: export + schema: + description: Indicates that this request is an export of logs in CSV format. + type: boolean + - in: query + name: action.type + schema: + description: Filters by the action type. + type: string + - in: query + name: actor.ip + schema: + description: >- + Filters by the IP address of the request that made the change by + specific IP address or valid CIDR Range. + type: string + - in: query + name: actor.email + schema: + description: Filters by the email address of the actor that made the change. + format: email + type: string + - in: query + name: since + schema: + type: string + format: date + description: >- + Limits the returned results to logs newer than the specified date. + A `full-date` that conforms to RFC3339. + - in: query + name: before + schema: + type: string + format: date + description: >- + Limits the returned results to logs older than the specified date. + A `full-date` that conforms to RFC3339. + - in: query + name: zone.name + schema: + description: Filters by the name of the zone associated to the change. + type: string + - in: query + name: direction + schema: + default: desc + description: Changes the direction of the chronological sorting. + enum: + - desc + - asc + type: string + - in: query + name: per_page + schema: + default: 100 + description: Sets the number of results to return per page. + maximum: 1000 + minimum: 1 + type: number + - in: query + name: page + schema: + default: 1 + description: Defines which page of results to return. + minimum: 1 + type: number + - in: query + name: hide_user_logs + schema: + default: false + description: Indicates whether or not to hide user level audit logs. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/aaaAuditLogsResponseCollection_2' + description: Get user audit logs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/result' + description: Get user audit logs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get user audit logs + tags: + - Audit Logs + x-api-token-group: + - Account Settings Write + - Account Settings Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - audit_logs + method: list + /user/billing/history: + get: + deprecated: true + description: Accesses your billing history object. + operationId: user-billing-history-(-deprecated)-billing-history-details + parameters: + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of items per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Field to order billing history by. + enum: + - type + - occurred_at + - action + type: string + - in: query + name: occurred_at + schema: + $ref: '#/components/schemas/billSubsApiOccurredAt' + - in: query + name: type + schema: + description: The billing item type. + maxLength: 30 + type: string + - in: query + name: action + schema: + description: The billing item action. + maxLength: 30 + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billSubsApiBillingHistoryCollection' + description: Billing History Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiBillingHistory' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Billing History Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Billing History Details + tags: + - User Billing History + x-api-token-group: + - Billing Write + - Billing Read + x-cfPermissionsRequired: + enum: + - '#billing:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - billing + - history + method: list + /user/billing/profile: + get: + deprecated: true + description: Accesses your billing profile object. + operationId: user-billing-profile-(-deprecated)-billing-profile-details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billSubsApiBillingResponseSingle' + description: Billing Profile Details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + properties: + account_type: + type: string + address: + type: string + address2: + type: string + balance: + type: string + card_expiry_month: + type: integer + card_expiry_year: + type: integer + card_number: + type: string + city: + type: string + company: + type: string + country: + type: string + created_on: + format: date-time + type: string + readOnly: true + device_data: + type: string + edited_on: + format: date-time + type: string + enterprise_billing_email: + type: string + x-auditable: true + enterprise_primary_email: + type: string + x-auditable: true + first_name: + type: string + id: + $ref: >- + #/components/schemas/billSubsApiComponentsSchemasIdentifier + is_partner: + type: boolean + last_name: + type: string + next_bill_date: + format: date-time + type: string + payment_address: + type: string + payment_address2: + type: string + payment_city: + type: string + payment_country: + type: string + payment_email: + type: string + payment_first_name: + type: string + payment_gateway: + type: string + payment_last_name: + type: string + payment_nonce: + type: string + payment_state: + type: string + payment_zipcode: + type: string + primary_email: + type: string + x-auditable: true + state: + type: string + tax_id_type: + type: string + telephone: + type: string + use_legacy: + type: boolean + validation_code: + type: string + vat: + type: string + zipcode: + type: string + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Billing Profile Details response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Billing Profile Details + tags: + - User Billing Profile + x-api-token-group: + - Billing Write + - Billing Read + x-cfPermissionsRequired: + enum: + - '#billing:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - billing + - profile + method: get + /user/invites: + get: + description: Lists all invitations associated with my user. + operationId: user'-s-invites-list-invitations + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSchemasCollectionInviteResponse' + description: List Invitations response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Invitations response failure + security: + - api_email: [] + api_key: [] + summary: List Invitations + tags: + - User's Invites + x-api-token-group: + - Memberships Write + - Memberships Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: user + resource_chain: + - invites + method: list + /user/invites/{invite_id}: + get: + description: Gets the details of an invitation. + operationId: user'-s-invites-invitation-details + parameters: + - in: path + name: invite_id + schema: + $ref: '#/components/schemas/iamInviteComponentsSchemasIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleInviteResponse' + description: Invitation Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Invitation Details response failure + security: + - api_email: [] + api_key: [] + summary: Invitation Details + tags: + - User's Invites + x-api-token-group: + - Memberships Write + - Memberships Read + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: user + resource_chain: + - invites + method: get + patch: + description: Responds to an invitation. + operationId: user'-s-invites-respond-to-invitation + parameters: + - in: path + name: invite_id + schema: + $ref: '#/components/schemas/iamInviteComponentsSchemasIdentifier' + required: true + requestBody: + content: + application/json: + schema: + properties: + status: + description: >- + Status of your response to the invitation (rejected or + accepted). + enum: + - accepted + - rejected + type: string + required: + - status + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleInviteResponse' + description: Respond to Invitation response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Respond to Invitation response failure + security: + - api_email: [] + api_key: [] + summary: Respond to Invitation + tags: + - User's Invites + x-api-token-group: + - Memberships Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: user + resource_chain: + - invites + method: edit + /user/load_balancing_analytics/events: + get: + description: List origin health changes. + operationId: load-balancer-healthcheck-events-list-healthcheck-events + parameters: + - in: query + name: until + schema: + $ref: '#/components/schemas/loadBalancingUntil' + - in: query + name: pool_name + schema: + $ref: '#/components/schemas/loadBalancingPoolName' + - in: query + name: origin_healthy + schema: + $ref: '#/components/schemas/loadBalancingOriginHealthy_2' + - in: query + name: pool_id + schema: + $ref: '#/components/schemas/loadBalancingSchemasIdentifier' + - in: query + name: since + schema: + description: >- + Start date and time of requesting data period in the ISO8601 + format. + format: date-time + type: string + - in: query + name: origin_name + schema: + description: The name for the origin to filter. + type: string + - in: query + name: pool_healthy + schema: + default: true + description: >- + If true, filter events where the pool status is healthy. If false, + filter events where the pool status is unhealthy. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/loadBalancingComponentsSchemasResponseCollection + description: List Healthcheck Events response. + 4XX: + content: + application/json: + schema: + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingAnalytics' + type: array + enum: + - null + description: List Healthcheck Events response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Healthcheck Events + tags: + - Load Balancer Healthcheck Events + x-api-token-group: + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + /user/organizations: + get: + deprecated: true + description: Lists organizations the user is associated with. + operationId: user'-s-organizations-list-organizations + parameters: + - in: query + name: name + schema: + $ref: '#/components/schemas/iamSchemasName' + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of organizations per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Field to order organizations by. + enum: + - id + - name + - status + type: string + - in: query + name: direction + schema: + description: Direction to order organizations. + enum: + - asc + - desc + type: string + - in: query + name: match + schema: + default: all + description: Whether to match all search requirements or at least one (any). + enum: + - any + - all + type: string + - in: query + name: status + schema: + description: >- + Whether the user is a member of the organization or has an + inivitation pending. + enum: + - member + - invited + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamCollectionOrganizationResponse' + description: List Organizations response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Organizations response failure + security: + - api_email: [] + api_key: [] + summary: List Organizations + tags: + - User's Organizations + x-api-token-group: + - Memberships Write + - Memberships Read + x-cfDeprecation: + description: >- + This endpoint and its related APIs are deprecated in favor of the + `/accounts` equivalent APIs, which have a broader range of features + and are backwards compatible with these API. + display: true + eol: '2020-02-04' + id: org_deprecation + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: user + resource_chain: + - organizations + method: list + /user/organizations/{organization_id}: + delete: + deprecated: true + description: Removes association to an organization. + operationId: user'-s-organizations-leave-organization + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + type: object + description: Leave Organization response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Leave Organization response failure + security: + - api_email: [] + api_key: [] + summary: Leave Organization + tags: + - User's Organizations + x-cfDeprecation: + description: >- + This endpoint and its related APIs are deprecated in favor of the + `/accounts` equivalent APIs, which have a broader range of features + and are backwards compatible with these API. + display: true + eol: '2020-02-04' + id: org_deprecation + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: user + resource_chain: + - organizations + method: delete + get: + deprecated: true + description: Gets a specific organization the user is associated with. + operationId: user'-s-organizations-organization-details + parameters: + - name: organization_id + in: path + required: true + description: The organization ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleOrganizationResponse' + description: Organization Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Organization Details response failure + security: + - api_email: [] + api_key: [] + summary: Organization Details + tags: + - User's Organizations + x-cfDeprecation: + description: >- + This endpoint and its related APIs are deprecated in favor of the + `/accounts` equivalent APIs, which have a broader range of features + and are backwards compatible with these API. + display: true + eol: '2020-02-04' + id: org_deprecation + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: user + resource_chain: + - organizations + method: get + /user/subscriptions: + get: + description: Lists all of a user's subscriptions. + operationId: user-subscription-get-user-subscriptions + responses: + '200': + content: + application/json: + schema: + $ref: >- + #/components/schemas/billSubsApiUserSubscriptionResponseCollection + description: Get User Subscriptions response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiSubscription' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get User Subscriptions response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get User Subscriptions + tags: + - User Subscription + x-api-token-group: + - Billing Write + - Billing Read + x-cfPermissionsRequired: + enum: + - '#billing:read' + x-stackql-sdk: + service: user + resource_chain: + - subscriptions + method: get + /user/subscriptions/{identifier}: + delete: + description: Deletes a user's subscription. + operationId: user-subscription-delete-user-subscription + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + subscription_id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + type: object + description: Delete User Subscription response + 4XX: + content: + application/json: + schema: + properties: + subscription_id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + errors: + minLength: 1 + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + type: boolean + type: object + required: + - success + - errors + - messages + - result + description: Delete User Subscription response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete User Subscription + tags: + - User Subscription + x-api-token-group: + - Billing Write + x-cfPermissionsRequired: + enum: + - '#billing:edit' + x-stackql-sdk: + service: user + resource_chain: + - subscriptions + method: delete + put: + description: Updates a user's subscriptions. + operationId: user-subscription-update-user-subscription + parameters: + - name: identifier + in: path + required: true + description: Resource identifier. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/billSubsApiSubscriptionV2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billSubsApiUserSubscriptionResponseSingle' + description: Update User Subscription response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + type: object + enum: + - null + nullable: true + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update User Subscription response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update User Subscription + tags: + - User Subscription + x-api-token-group: + - Billing Write + x-cfPermissionsRequired: + enum: + - '#billing:read' + - '#billing:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - subscriptions + method: update + /user/tokens: + get: + description: List all access tokens you created. + operationId: user-api-tokens-list-tokens + parameters: + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Maximum number of results per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: direction + schema: + description: Direction to order results. + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamCollectionTokensResponse' + description: List Tokens response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Tokens response failure + security: + - api_token: [] + summary: List Tokens + tags: + - User API Tokens + x-api-token-group: + - API Tokens Write + - API Tokens Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.token.list + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + method: list + post: + description: Create a new access token. + operationId: user-api-tokens-create-token + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamCreatePayload' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleTokenCreateResponse' + description: Create Token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Create Token response failure + security: + - api_token: [] + summary: Create Token + tags: + - User API Tokens + x-api-token-group: + - API Tokens Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.token.create + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + method: create + /user/tokens/permission_groups: + get: + description: Find all available permission groups for API Tokens. + operationId: permission-groups-list-permission-groups + parameters: + - description: >- + Filter by the name of the permission group. The value must be + URL-encoded. + in: query + name: name + schema: + type: string + - description: >- + Filter by the scope of the permission group. The value must be + URL-encoded. + in: query + name: scope + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamPermissionsGroupResponseCollection' + description: List Token Permission Groups response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: List Token Permission Groups response failure + security: + - api_token: [] + summary: List Token Permission Groups + tags: + - User API Tokens + x-api-token-group: + - API Tokens Write + - API Tokens Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.token.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + - permission_groups + method: list + /user/tokens/verify: + get: + description: Test whether a token works. + operationId: user-api-tokens-verify-token + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamTokenVerifyResponseSingleSegment' + description: Verify Token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Verify Token response failure + security: + - api_token: [] + summary: Verify Token + tags: + - User API Tokens + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + method: verify + /user/tokens/{token_id}: + delete: + description: Destroy a token. + operationId: user-api-tokens-delete-token + parameters: + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseSingleId' + description: Delete Token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Delete Token response failure + security: + - api_token: [] + summary: Delete Token + tags: + - User API Tokens + x-api-token-group: + - API Tokens Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.token.delete + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + method: delete + get: + description: Get information about a specific token. + operationId: user-api-tokens-token-details + parameters: + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleTokenResponse' + description: Token Details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Token Details response failure + security: + - api_token: [] + summary: Token Details + tags: + - User API Tokens + x-api-token-group: + - API Tokens Write + - API Tokens Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.token.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + method: get + put: + description: Update an existing token. + operationId: user-api-tokens-update-token + parameters: + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/iamTokenBody' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamSingleTokenResponse' + description: Update Token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Update Token response failure + security: + - api_token: [] + summary: Update Token + tags: + - User API Tokens + x-api-token-group: + - API Tokens Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.token.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + method: update + /user/tokens/{token_id}/value: + put: + description: Roll the token secret. + operationId: user-api-tokens-roll-token + parameters: + - name: token_id + in: path + required: true + description: The API token ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/iamResponseSingleValue' + description: Roll Token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/iamApiResponseCommonFailure' + description: Roll Token response failure + security: + - api_token: [] + summary: Roll Token + tags: + - User API Tokens + x-api-token-group: + - API Tokens Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.token.update + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: user + resource_chain: + - tokens + - value + method: update + /users/tenants: + get: + description: Retrieves list of tenants the authenticated user / method has access to. + operationId: User_listUserTenants + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + type: object + maxItems: 0 + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + items: + $ref: '#/components/schemas/organizationsApiOrganization' + type: array + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: The request has succeeded. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/organizationsApiV4ErrorResponse' + description: An unexpected error response. + security: + - api_email: [] + api_key: [] + summary: List user tenants + tags: + - User +components: + schemas: + aaaAuditLogs: + properties: + action: + properties: + result: + description: A boolean that indicates if the action attempted was successful. + example: true + type: boolean + type: + description: A short string that describes the action that was performed. + example: change_setting + type: string + type: object + actor: + properties: + email: + description: The email of the user that performed the action. + example: michelle@example.com + format: email + type: string + id: + description: >- + The ID of the actor that performed the action. If a user + performed the action, this will be their User ID. + example: f6b5de0326bb5182b8a4840ee01ec774 + type: string + ip: + description: The IP address of the request that performed the action. + example: 198.41.129.166 + type: string + type: + description: >- + The type of actor, whether a User, Cloudflare Admin, or an + Automated System. + enum: + - user + - admin + - Cloudflare + example: user + type: string + type: object + id: + description: A string that uniquely identifies the audit log. + example: d5b0f326-1232-4452-8858-1089bd7168ef + type: string + interface: + description: The source of the event. + example: API + type: string + metadata: + description: >- + An object which can lend more context to the action being logged. + This is a flexible value and varies between different actions. + example: + name: security_level + type: firewall + value: high + zone_name: example.com + type: object + newValue: + description: The new value of the resource that was modified. + example: low + type: string + oldValue: + description: The value of the resource before it was modified. + example: high + type: string + owner: + properties: + id: + $ref: '#/components/schemas/aaaIdentifier' + type: object + resource: + properties: + id: + description: An identifier for the resource that was affected by the action. + example: 023e105f4ecef8ad9ca31a8372d0c353 + type: string + type: + description: >- + A short string that describes the resource that was affected by + the action. + example: zone + type: string + type: object + when: + description: >- + A UTC RFC3339 timestamp that specifies when the action being logged + occured. + example: '2017-04-26T17:31:07Z' + format: date-time + type: string + type: object + aaaAuditLogsResponseCollection_2: + type: object + properties: + errors: + $ref: '#/components/schemas/aaaMessages' + messages: + $ref: '#/components/schemas/aaaMessages' + result: + items: + $ref: '#/components/schemas/aaaAuditLogs' + type: array + success: + example: true + type: boolean + required: + - errors + - success + - messages + aaaIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + aaaMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + billSubsApiAction: + description: The billing item action. + example: subscription + maxLength: 30 + readOnly: true + type: string + x-auditable: true + billSubsApiAmount: + description: The amount associated with this billing item. + example: 20.99 + readOnly: true + type: number + x-auditable: true + billSubsApiBillingHistory: + properties: + action: + $ref: '#/components/schemas/billSubsApiAction' + amount: + $ref: '#/components/schemas/billSubsApiAmount' + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + description: + $ref: '#/components/schemas/billSubsApiDescription' + id: + $ref: '#/components/schemas/billSubsApiComponentsSchemasIdentifier' + occurred_at: + $ref: '#/components/schemas/billSubsApiOccurredAt' + type: + $ref: '#/components/schemas/billSubsApiType' + zone: + $ref: '#/components/schemas/billSubsApiSchemasZone' + required: + - id + - type + - action + - description + - occurred_at + - amount + - currency + - zone + type: object + billSubsApiBillingHistoryCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiBillingHistory' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + billSubsApiBillingResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + properties: + account_type: + example: type + type: string + address: + example: 123 Main Street + type: string + address2: + example: Apt 1 + type: string + balance: + example: '0' + type: string + card_expiry_month: + example: 12 + type: integer + card_expiry_year: + example: 2099 + type: integer + card_number: + example: '4242424242424242' + type: string + city: + example: Anytown + type: string + company: + example: Company + type: string + country: + example: Anycountry + type: string + created_on: + example: '2014-03-01T12:21:59.3456Z' + format: date-time + type: string + readOnly: true + device_data: + example: sample_data + type: string + edited_on: + example: '2014-03-01T12:21:59.3456Z' + format: date-time + type: string + enterprise_billing_email: + example: johndoe@gmail.com + type: string + x-auditable: true + enterprise_primary_email: + example: johndoe@gmail.com + type: string + x-auditable: true + first_name: + example: John + type: string + id: + $ref: '#/components/schemas/billSubsApiComponentsSchemasIdentifier' + is_partner: + example: false + type: boolean + last_name: + example: Doe + type: string + next_bill_date: + example: '2014-03-01T12:21:59.3456Z' + format: date-time + type: string + payment_address: + example: 123 Main Street + type: string + payment_address2: + example: Apt 1 + type: string + payment_city: + example: Anytown + type: string + payment_country: + example: Anycountry + type: string + payment_email: + example: johndoe@gmail.com + type: string + payment_first_name: + example: John + type: string + payment_gateway: + example: gateway + type: string + payment_last_name: + example: Doe + type: string + payment_nonce: + example: abc123 + type: string + payment_state: + example: state + type: string + payment_zipcode: + example: '12345' + type: string + primary_email: + example: johndoe@gmail.com + type: string + x-auditable: true + state: + example: AnyState + type: string + tax_id_type: + example: type + type: string + telephone: + example: '1234567899' + type: string + use_legacy: + example: false + type: boolean + validation_code: + example: '1111' + type: string + vat: + example: GB123456789 + type: string + zipcode: + example: '12345' + type: string + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + billSubsApiComponentsSchemasIdentifier: + description: Billing item identifier tag. + example: b69a9f3492637782896352daae219e7d + maxLength: 32 + readOnly: true + type: string + x-auditable: true + billSubsApiCurrency: + description: The monetary unit in which pricing information is displayed. + example: USD + readOnly: true + type: string + x-auditable: true + billSubsApiCurrentPeriodEnd: + description: The end of the current period and also when the next billing is due. + example: '2014-03-31T12:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + billSubsApiCurrentPeriodStart: + description: >- + When the current billing period started. May match initial_period_start + if this is the first period. + example: '2014-05-11T12:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + billSubsApiDescription: + description: The billing item description. + example: The billing item description + maxLength: 255 + readOnly: true + type: string + x-auditable: true + billSubsApiFrequency: + description: How often the subscription is renewed automatically. + enum: + - weekly + - monthly + - quarterly + - yearly + example: monthly + type: string + x-auditable: true + billSubsApiMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + billSubsApiOccurredAt: + description: When the billing item was created. + example: '2014-03-01T12:21:59.3456Z' + format: date-time + type: string + x-auditable: true + billSubsApiPrice: + description: The price of the subscription that will be billed, in US dollars. + example: 20 + readOnly: true + type: number + x-auditable: true + billSubsApiRatePlan_2: + description: The rate plan applied to the subscription. + properties: + currency: + description: The currency applied to the rate plan subscription. + example: USD + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + externally_managed: + description: Whether this rate plan is managed externally from Cloudflare. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + id: + description: The ID of the rate plan. + example: free + type: string + x-auditable: true + enum: + - free + - lite + - pro + - pro_plus + - business + - enterprise + - partners_free + - partners_pro + - partners_business + - partners_enterprise + is_contract: + description: >- + Whether a rate plan is enterprise-based (or newly adopted term + contract). + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + public_name: + description: The full name of the rate plan. + example: Business Plan + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + scope: + description: The scope that this rate plan applies to. + example: zone + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + sets: + description: >- + The list of sets this rate plan applies to. Returns array of + strings. + example: [] + items: + type: string + x-auditable: true + type: array + x-stainless-terraform-configurability: optional + type: object + billSubsApiResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + billSubsApiSchemasIdentifier: + description: Subscription identifier tag. + example: 506e3185e9c882d175a2d0cb0093d9f2 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + billSubsApiSchemasZone: + properties: + name: + readOnly: true + type: string + x-auditable: true + type: object + billSubsApiState: + description: The state that the subscription is in. + enum: + - Trial + - Provisioned + - Paid + - AwaitingPayment + - Cancelled + - Failed + - Expired + example: Paid + readOnly: true + type: string + x-auditable: true + billSubsApiSubscription: + type: object + $ref: '#/components/schemas/billSubsApiSubscriptionV2' + billSubsApiSubscriptionV2: + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + $ref: '#/components/schemas/billSubsApiFrequency' + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + type: object + billSubsApiType: + description: The billing item type. + example: charge + maxLength: 30 + readOnly: true + type: string + x-auditable: true + billSubsApiUserSubscriptionResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiSubscription' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + billSubsApiUserSubscriptionResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + iamApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/iamSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/iamSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + iamApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + required: + - id + type: object + required: + - success + - errors + - messages + iamCidrList: + description: List of IPv4/IPv6 CIDR addresses. + example: + - 199.27.128.0/21 + - 2400:cb00::/32 + items: + description: IPv4/IPv6 CIDR. + example: 199.27.128.0/21 + type: string + x-auditable: true + type: array + iamCollectionOrganizationResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamOrganization' + type: array + required: + - success + - errors + - messages + iamCollectionTokensResponse: + title: Response with a list of tokens + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamTokenBase' + type: array + required: + - success + - errors + - messages + iamCommonComponentsSchemasIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + minLength: 32 + type: string + x-auditable: true + iamComponentsSchemasStatus: + description: >- + Whether the user is a member of the organization or has an invitation + pending. + enum: + - member + - invited + example: member + type: string + x-auditable: true + iamCondition: + properties: + request_ip: + $ref: '#/components/schemas/iamRequestIp' + type: object + iamCountry: + description: The country in which the user lives. + example: US + maxLength: 30 + nullable: true + type: string + iamCreatePayload: + properties: + condition: + $ref: '#/components/schemas/iamCondition' + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + name: + $ref: '#/components/schemas/iamName' + not_before: + $ref: '#/components/schemas/iamNotBefore' + policies: + $ref: '#/components/schemas/iamTokenPolicies' + required: + - name + - policies + type: object + iamEffect: + description: Allow or deny operations against the resources. + enum: + - allow + - deny + example: allow + type: string + x-auditable: true + iamExpiresOn: + description: >- + The expiration time on or after which the JWT MUST NOT be accepted for + processing. + example: '2020-01-01T00:00:00Z' + format: date-time + type: string + x-auditable: true + iamFirstName: + description: User's first name + example: John + maxLength: 60 + nullable: true + type: string + x-auditable: true + iamInviteComponentsSchemasIdentifier: + description: Invite identifier tag. + example: 4f5f0c14a2a41d5063dd301b2f829f04 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + iamInvitedBy: + description: The email address of the user who created the invite. + example: user@example.com + maxLength: 90 + type: string + x-auditable: true + iamInvitedMemberEmail: + description: Email address of the user to add to the organization. + example: user@example.com + maxLength: 90 + type: string + x-auditable: true + iamInvitedOn: + description: When the invite was sent. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamIssuedOn: + description: The time on which the token was created. + example: '2018-07-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamLastName: + description: User's last name + example: Appleseed + maxLength: 60 + nullable: true + type: string + x-auditable: true + iamLastUsedOn: + description: Last time the token was used. + example: '2020-01-02T12:34:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamModifiedOn: + description: Last time the token was modified. + example: '2018-07-02T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamName: + description: Token name. + example: readonly token + maxLength: 120 + type: string + x-auditable: true + iamNotBefore: + description: The time before which the token MUST NOT be accepted for processing. + example: '2018-07-01T05:20:00Z' + format: date-time + type: string + x-auditable: true + iamOrganization: + properties: + id: + $ref: '#/components/schemas/iamCommonComponentsSchemasIdentifier' + name: + $ref: '#/components/schemas/iamSchemasName' + permissions: + $ref: '#/components/schemas/iamSchemasPermissions' + roles: + description: List of roles that a user has within an organization. + items: + example: All Privileges - Super Administrator + maxLength: 120 + type: string + x-auditable: true + readOnly: true + type: array + status: + $ref: '#/components/schemas/iamComponentsSchemasStatus' + type: object + iamPermissionGroup: + description: >- + A named group of permissions that map to a group of operations against + resources. + properties: + id: + description: Identifier of the permission group. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + type: string + x-auditable: true + meta: + description: Attributes associated to the permission group. + example: + label: load_balancer_admin + scopes: com.cloudflare.api.account + properties: + key: + type: string + x-auditable: true + value: + type: string + x-auditable: true + type: object + name: + description: Name of the permission group. + example: Load Balancer + readOnly: true + type: string + x-auditable: true + required: + - id + type: object + iamPermissionGroups: + description: A set of permission groups that are specified to the policy. + example: + - id: c8fed203ed3043cba015a93ad1616f1f + meta: + label: load_balancer_admin + scopes: com.cloudflare.api.account + name: Zone Read + - id: 82e64a83756745bbbb1c9c2701bf816b + meta: + label: fbm_user + scopes: com.cloudflare.api.account + name: Magic Network Monitoring + items: + $ref: '#/components/schemas/iamPermissionGroup' + type: array + iamPermissionsGroupResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + example: + - id: 7cf72faf220841aabcfdfab81c43c4f6 + name: Billing Read + scopes: + - com.cloudflare.api.account + - id: 9d24387c6e8544e2bc4024a03991339f + name: 'Load Balancing: Monitors and Pools Read' + scopes: + - com.cloudflare.api.account + - id: d2a1802cc9a34e30852f8b33869b2f3c + name: 'Load Balancing: Monitors and Pools Write' + scopes: + - com.cloudflare.api.account + - id: 8b47d2786a534c08a1f94ee8f9f599ef + name: Workers KV Storage Read + scopes: + - com.cloudflare.api.account + - id: f7f0eda5697f475c90846e879bab8666 + name: Workers KV Storage Write + scopes: + - com.cloudflare.api.account + - id: 1a71c399035b4950a1bd1466bbe4f420 + name: Workers Scripts Read + scopes: + - com.cloudflare.api.account + - id: e086da7e2179491d91ee5f35b3ca210a + name: Workers Scripts Write + scopes: + - com.cloudflare.api.account + items: + $ref: >- + #/components/schemas/iamPermissionsGroupResponseCollection_result_item + type: array + required: + - success + - errors + - messages + iamPermissionsGroupResponseCollection_result_item: + properties: + id: + description: Public ID. + type: string + x-auditable: true + name: + description: Permission Group Name + type: string + x-auditable: true + scopes: + description: Resources to which the Permission Group is scoped + items: + enum: + - com.cloudflare.api.account + - com.cloudflare.api.account.zone + - com.cloudflare.api.user + - com.cloudflare.edge.r2.bucket + type: string + x-auditable: true + type: array + type: object + iamPolicyIdentifier: + description: Policy identifier. + example: f267e341f3dd4697bd3b9f71dd96247f + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-always-send: true + iamPolicyWithPermissionGroupsAndResources: + properties: + effect: + $ref: '#/components/schemas/iamEffect' + id: + $ref: '#/components/schemas/iamPolicyIdentifier' + permission_groups: + $ref: '#/components/schemas/iamPermissionGroups' + resources: + $ref: '#/components/schemas/iamResources' + required: + - id + - effect + - permission_groups + - resources + title: Policy with Permission Groups and Resources + type: object + iamRequestIp: + description: Client IP restrictions. + example: + in: + - 123.123.123.0/24 + - 2606:4700::/32 + not_in: + - 123.123.123.100/24 + - 2606:4700:4700::/48 + properties: + in: + $ref: '#/components/schemas/iamCidrList' + not_in: + $ref: '#/components/schemas/iamCidrList' + type: object + iamResources: + description: A list of resource names that the policy applies to. + x-auditable: true + type: object + iamResponseSingleValue: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamValue' + required: + - success + - errors + - messages + iamResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + iamRoleNames: + description: List of role names the membership has for this account. + items: + example: Account Administrator + maxLength: 120 + type: string + x-auditable: true + readOnly: true + type: array + iamSchemasCollectionInviteResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/iamResultInfo' + result: + items: + $ref: '#/components/schemas/iamUserInvite' + type: array + required: + - success + - errors + - messages + iamSchemasExpiresOn: + description: When the invite is no longer active. + example: '2014-01-01T05:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + iamSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + iamSchemasName: + description: Organization name. + example: Cloudflare, Inc. + maxLength: 100 + type: string + x-auditable: true + iamSchemasPermissions: + description: Access permissions for this User. + items: + example: '#zones:read' + maxLength: 160 + type: string + x-auditable: true + readOnly: true + type: array + iamSingleInviteResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamUserInvite' + required: + - success + - errors + - messages + iamSingleOrganizationResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + iamSingleTokenCreateResponse: + title: Response of a create request with a single token + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamTokenWithValue' + required: + - success + - errors + - messages + iamSingleTokenResponse: + title: Response with a single token + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/iamTokenBase' + required: + - success + - errors + - messages + iamSingleUserResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + betas: + description: Lists the betas that the user is participating in. + items: + description: User feature flag + example: zone_level_access_beta + type: string + readOnly: true + type: array + country: + $ref: '#/components/schemas/iamCountry' + first_name: + $ref: '#/components/schemas/iamFirstName' + has_business_zones: + default: false + description: Indicates whether user has any business zones + readOnly: true + type: boolean + has_enterprise_zones: + default: false + description: Indicates whether user has any enterprise zones + readOnly: true + type: boolean + has_pro_zones: + default: false + description: Indicates whether user has any pro zones + readOnly: true + type: boolean + id: + description: Identifier of the user. + example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 + readOnly: true + type: string + last_name: + $ref: '#/components/schemas/iamLastName' + organizations: + items: + $ref: '#/components/schemas/iamOrganization' + type: array + suspended: + default: false + description: Indicates whether user has been suspended + readOnly: true + type: boolean + telephone: + $ref: '#/components/schemas/iamTelephone' + two_factor_authentication_enabled: + $ref: '#/components/schemas/iamTwoFactorAuthenticationEnabled' + two_factor_authentication_locked: + $ref: '#/components/schemas/iamTwoFactorAuthenticationLocked' + zipcode: + $ref: '#/components/schemas/iamZipcode' + type: object + required: + - success + - errors + - messages + iamTelephone: + description: User's telephone number + example: +1 123-123-1234 + maxLength: 20 + nullable: true + type: string + iamTokenBase: + properties: + condition: + $ref: '#/components/schemas/iamCondition' + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + id: + $ref: '#/components/schemas/iamTokenIdentifier' + issued_on: + $ref: '#/components/schemas/iamIssuedOn' + last_used_on: + $ref: '#/components/schemas/iamLastUsedOn' + modified_on: + $ref: '#/components/schemas/iamModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/iamName' + not_before: + $ref: '#/components/schemas/iamNotBefore' + policies: + $ref: '#/components/schemas/iamTokenPolicies' + status: + $ref: '#/components/schemas/iamTokenStatus' + type: object + iamTokenBody: + title: Token defined in a request body + $ref: '#/components/schemas/iamTokenBase' + type: object + iamTokenIdentifier: + description: Token identifier tag. + example: ed17574386854bf78a67040be0a770b0 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + iamTokenPolicies: + description: List of access policies assigned to the token. + items: + $ref: '#/components/schemas/iamPolicyWithPermissionGroupsAndResources' + type: array + iamTokenStatus: + description: Status of the token. + enum: + - active + - disabled + - expired + example: active + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + iamTokenVerifyResponseSingleSegment: + type: object + properties: + errors: + $ref: '#/components/schemas/iamSchemasMessages' + messages: + $ref: '#/components/schemas/iamSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + id: + $ref: '#/components/schemas/iamTokenIdentifier' + not_before: + $ref: '#/components/schemas/iamNotBefore' + status: + $ref: '#/components/schemas/iamTokenStatus' + required: + - id + - status + type: object + required: + - success + - errors + - messages + iamTokenWithValue: + title: Create token response, with the token value + properties: + condition: + $ref: '#/components/schemas/iamCondition' + expires_on: + $ref: '#/components/schemas/iamExpiresOn' + id: + $ref: '#/components/schemas/iamTokenIdentifier' + issued_on: + $ref: '#/components/schemas/iamIssuedOn' + last_used_on: + $ref: '#/components/schemas/iamLastUsedOn' + modified_on: + $ref: '#/components/schemas/iamModifiedOn' + readOnly: true + name: + $ref: '#/components/schemas/iamName' + not_before: + $ref: '#/components/schemas/iamNotBefore' + policies: + $ref: '#/components/schemas/iamTokenPolicies' + status: + $ref: '#/components/schemas/iamTokenStatus' + value: + $ref: '#/components/schemas/iamValue' + type: object + iamTwoFactorAuthenticationEnabled: + default: false + description: >- + Indicates whether two-factor authentication is enabled for the user + account. Does not apply to API authentication. + readOnly: true + type: boolean + iamTwoFactorAuthenticationLocked: + default: false + description: >- + Indicates whether two-factor authentication is required by one of the + accounts that the user is a member of. + readOnly: true + type: boolean + iamUserInvite: + properties: + expires_on: + $ref: '#/components/schemas/iamSchemasExpiresOn' + id: + $ref: '#/components/schemas/iamInviteComponentsSchemasIdentifier' + invited_by: + $ref: '#/components/schemas/iamInvitedBy' + invited_member_email: + $ref: '#/components/schemas/iamInvitedMemberEmail' + invited_member_id: + description: ID of the user to add to the organization. + example: 5a7805061c76ada191ed06f989cc3dac + maxLength: 32 + nullable: true + readOnly: true + type: string + x-auditable: true + invited_on: + $ref: '#/components/schemas/iamInvitedOn' + organization_id: + description: ID of the organization the user will be added to. + example: 5a7805061c76ada191ed06f989cc3dac + maxLength: 32 + readOnly: true + type: string + x-auditable: true + organization_is_enforcing_twofactor: + example: true + type: boolean + x-auditable: true + organization_name: + description: Organization name. + example: Cloudflare, Inc. + maxLength: 100 + readOnly: true + type: string + x-auditable: true + roles: + $ref: '#/components/schemas/iamRoleNames' + status: + description: Current status of the invitation. + enum: + - pending + - accepted + - rejected + - expired + example: accepted + x-auditable: true + type: string + required: + - invited_member_id + - organization_id + type: object + iamValue: + description: The token value. + example: 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T + maxLength: 80 + minLength: 40 + readOnly: true + type: string + x-sensitive: true + iamZipcode: + description: The zipcode or postal code where the user lives. + example: '12345' + maxLength: 20 + nullable: true + type: string + loadBalancingAddress: + description: >- + The IP address (IPv4 or IPv6) of the origin, or its publicly addressable + hostname. Hostnames entered here should resolve directly to the origin, + and not be a hostname proxied by Cloudflare. To set an internal/reserved + address, virtual_network_id must also be set. + example: 0.0.0.0 + type: string + x-auditable: true + loadBalancingAnalytics: + properties: + id: + default: 1 + type: integer + origins: + example: + - address: 198.51.100.4 + changed: true + enabled: true + failure_reason: No failures + healthy: true + ip: 198.51.100.4 + name: some-origin + items: + $ref: '#/components/schemas/loadBalancingOriginAnalytics' + type: array + pool: + example: + changed: true + healthy: true + id: 74bc6a8b9b0dda3d651707a2928bad0c + minimum_origins: 1 + name: some-pool + type: object + timestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + type: object + loadBalancingComponentsSchemasResponseCollection: + required: + - success + - errors + - messages + - result + type: object + properties: + errors: + $ref: '#/components/schemas/loadBalancingMessages' + messages: + $ref: '#/components/schemas/loadBalancingMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/loadBalancingResultInfo' + result: + items: + $ref: '#/components/schemas/loadBalancingAnalytics' + type: array + loadBalancingMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + loadBalancingOriginAnalytics: + properties: + address: + $ref: '#/components/schemas/loadBalancingAddress' + changed: + $ref: '#/components/schemas/loadBalancingOriginChanged' + enabled: + $ref: '#/components/schemas/loadBalancingSchemasEnabled' + failure_reason: + $ref: '#/components/schemas/loadBalancingOriginFailureReason' + healthy: + $ref: '#/components/schemas/loadBalancingOriginHealthy' + ip: + $ref: '#/components/schemas/loadBalancingOriginIp' + name: + $ref: '#/components/schemas/loadBalancingSchemasName' + type: object + loadBalancingOriginChanged: + description: Whether the origin has changed health status. + example: true + type: boolean + x-auditable: true + loadBalancingOriginFailureReason: + description: Failure reason for un-healthy origin health check. + example: No failures + type: string + x-auditable: true + loadBalancingOriginHealthy: + description: Whether the origin is reported as healthy. + example: true + type: boolean + x-auditable: true + loadBalancingOriginHealthy_2: + default: true + description: >- + If true, filter events where the origin status is healthy. If false, + filter events where the origin status is unhealthy. + example: true + type: boolean + x-auditable: true + loadBalancingOriginIp: + description: The IP address (IPv4 or IPv6) of the origin. + example: 198.51.100.4 + type: string + x-auditable: true + loadBalancingPoolName: + description: The name for the pool to filter. + example: primary-dc + type: string + x-auditable: true + loadBalancingResultInfo: + properties: + count: + description: Total number of results on the current page. + example: 20 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: Total number of pages available. + example: 100 + type: number + type: object + loadBalancingSchemasEnabled: + default: true + description: >- + Whether to enable (the default) this origin within the pool. Disabled + origins will not receive traffic and are excluded from health checks. + The origin will only be disabled for the current pool. + example: true + type: boolean + x-auditable: true + loadBalancingSchemasIdentifier: + example: 17b5962d775c646f3f9725cbc7a53df4 + type: string + x-auditable: true + loadBalancingSchemasName: + description: A human-identifiable name for the origin. + example: app-server-1 + type: string + x-auditable: true + loadBalancingUntil: + description: End date and time of requesting data period in the ISO8601 format. + example: '2016-11-11T13:00:00Z' + format: date-time + type: string + x-auditable: true + organizationsApiOrganization: + description: References an Organization in the Cloudflare data model. + properties: + create_time: + format: date-time + readOnly: true + type: string + id: + readOnly: true + $ref: '#/components/schemas/organizationsApiOrganizationID' + meta: + properties: + flags: + $ref: '#/components/schemas/organizationsApiOrganizationFlags' + managed_by: + type: string + readOnly: true + type: object + name: + type: string + parent: + properties: + id: + $ref: '#/components/schemas/organizationsApiOrganizationID' + name: + readOnly: true + type: string + required: + - id + - name + type: object + profile: + $ref: '#/components/schemas/organizationsApiProfile' + required: + - id + - name + - create_time + - meta + type: object + organizationsApiOrganizationFlags: + description: Enable features for Organizations. + properties: + account_creation: + type: string + account_deletion: + type: string + account_migration: + type: string + account_mobility: + type: string + sub_org_creation: + type: string + required: + - account_creation + - account_deletion + - account_migration + - account_mobility + - sub_org_creation + type: object + organizationsApiOrganizationID: + example: a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8 + title: Organization ID + type: string + organizationsApiProfile: + properties: + business_address: + type: string + business_email: + type: string + business_name: + type: string + business_phone: + type: string + external_metadata: + type: string + required: + - business_name + - business_email + - business_phone + - business_address + - external_metadata + type: object + organizationsApiV4ErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + messages: + items: + $ref: '#/components/schemas/organizationsApiV4Message' + type: array + result: + type: object + success: + enum: + - false + type: boolean + required: + - success + - errors + - messages + type: object + organizationsApiV4Message: + $ref: '#/components/schemas/responseInfo' + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + result: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/aaaMessages' + messages: + $ref: '#/components/schemas/aaaMessages' + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + result: + items: + $ref: '#/components/schemas/aaaAuditLogs' + type: array + required: + - errors + - messages + - success + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + user: + id: cloudflare.user.user + name: user + title: User + methods: + list: + operation: + $ref: '#/paths/~1user/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/user/methods/edit' + delete: [] + replace: [] + audit_logs: + id: cloudflare.user.audit_logs + name: audit_logs + title: Audit Logs + methods: + list: + operation: + $ref: '#/paths/~1user~1audit_logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + history: + id: cloudflare.user.history + name: history + title: History + methods: + list: + operation: + $ref: '#/paths/~1user~1billing~1history/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/history/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + profile: + id: cloudflare.user.profile + name: profile + title: Profile + methods: + list: + operation: + $ref: '#/paths/~1user~1billing~1profile/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/profile/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + invites: + id: cloudflare.user.invites + name: invites + title: Invites + methods: + list: + operation: + $ref: '#/paths/~1user~1invites/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1user~1invites~1{invite_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1invites~1{invite_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/invites/methods/get' + - $ref: '#/components/x-stackQL-resources/invites/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/invites/methods/edit' + delete: [] + replace: [] + events: + id: cloudflare.user.events + name: events + title: Events + methods: + list: + operation: + $ref: '#/paths/~1user~1load_balancing_analytics~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + organizations: + id: cloudflare.user.organizations + name: organizations + title: Organizations + methods: + list: + operation: + $ref: '#/paths/~1user~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: '#/paths/~1user~1organizations~1{organization_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1user~1organizations~1{organization_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/organizations/methods/get' + - $ref: '#/components/x-stackQL-resources/organizations/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/organizations/methods/delete' + replace: [] + subscriptions: + id: cloudflare.user.subscriptions + name: subscriptions + title: Subscriptions + methods: + list: + operation: + $ref: '#/paths/~1user~1subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1user~1subscriptions~1{identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1subscriptions~1{identifier}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/update' + user_tokens: + id: cloudflare.user.user_tokens + name: user_tokens + title: User Tokens + methods: + list: + operation: + $ref: '#/paths/~1user~1tokens/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_tokens/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tokens: + id: cloudflare.user.tokens + name: tokens + title: Tokens + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1tokens/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1user~1tokens~1{token_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1user~1tokens~1{token_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1tokens~1{token_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + update_value: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1tokens~1{token_id}~1value/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/tokens/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tokens/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/tokens/methods/update' + permission_groups: + id: cloudflare.user.permission_groups + name: permission_groups + title: Permission Groups + methods: + list: + operation: + $ref: '#/paths/~1user~1tokens~1permission_groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tokens_verify: + id: cloudflare.user.tokens_verify + name: tokens_verify + title: Tokens Verify + methods: + list: + operation: + $ref: '#/paths/~1user~1tokens~1verify/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens_verify/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tenants: + id: cloudflare.user.tenants + name: tenants + title: Tenants + methods: + list: + operation: + $ref: '#/paths/~1users~1tenants/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tenants/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/users.yaml b/providers/src/cloudflare/v00.00.00000/services/users.yaml deleted file mode 100644 index 248660ed..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/users.yaml +++ /dev/null @@ -1,2736 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Permission Groups - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - users - version: 4.0.0 -components: - schemas: - schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - example: - - id: 7cf72faf220841aabcfdfab81c43c4f6 - name: Billing Read - scopes: - - com.cloudflare.api.account - - id: 9d24387c6e8544e2bc4024a03991339f - name: 'Load Balancing: Monitors and Pools Read' - scopes: - - com.cloudflare.api.account - - id: d2a1802cc9a34e30852f8b33869b2f3c - name: 'Load Balancing: Monitors and Pools Write' - scopes: - - com.cloudflare.api.account - - id: 8b47d2786a534c08a1f94ee8f9f599ef - name: Workers KV Storage Read - scopes: - - com.cloudflare.api.account - - id: f7f0eda5697f475c90846e879bab8666 - name: Workers KV Storage Write - scopes: - - com.cloudflare.api.account - - id: 1a71c399035b4950a1bd1466bbe4f420 - name: Workers Scripts Read - scopes: - - com.cloudflare.api.account - - id: e086da7e2179491d91ee5f35b3ca210a - name: Workers Scripts Write - scopes: - - com.cloudflare.api.account - items: - type: object - type: array - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - single_user_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - country: - description: The country in which the user lives. - example: US - maxLength: 30 - nullable: true - type: string - first_name: - description: User's first name - example: John - maxLength: 60 - nullable: true - type: string - last_name: - description: User's last name - example: Appleseed - maxLength: 60 - nullable: true - type: string - telephone: - description: User's telephone number - example: +1 123-123-1234 - maxLength: 20 - nullable: true - type: string - zipcode: - description: The zipcode or postal code where the user lives. - example: '12345' - maxLength: 20 - nullable: true - type: string - response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - type: object - type: array - type: object - create_payload: - properties: - condition: - $ref: '#/components/schemas/condition' - expires_on: - $ref: '#/components/schemas/expires_on' - name: - $ref: '#/components/schemas/name' - not_before: - $ref: '#/components/schemas/not_before' - policies: - $ref: '#/components/schemas/policies' - required: - - name - - policies - type: object - response_create: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - type: object - - properties: - value: - $ref: '#/components/schemas/value' - type: object - type: object - condition: - properties: - request.ip: - $ref: '#/components/schemas/request.ip' - type: object - expires_on: - description: The expiration time on or after which the JWT MUST NOT be accepted for processing. - example: '2020-01-01T00:00:00Z' - format: date-time - type: string - name: - description: Token name. - example: readonly token - maxLength: 120 - type: string - not_before: - description: The time before which the token MUST NOT be accepted for processing. - example: '2018-07-01T05:20:00Z' - format: date-time - type: string - policies: - description: List of access policies assigned to the token. - items: - $ref: '#/components/schemas/access-policy' - type: array - value: - description: The token value. - example: 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T - maxLength: 80 - minLength: 40 - readOnly: true - type: string - request.ip: - description: Client IP restrictions. - example: - in: - - 123.123.123.0/24 - - '2606:4700::/32' - not_in: - - 123.123.123.100/24 - - '2606:4700:4700::/48' - properties: - in: - $ref: '#/components/schemas/cidr_list' - not_in: - $ref: '#/components/schemas/cidr_list' - type: object - access-policy: - oneOf: - - $ref: '#/components/schemas/policy_with_permission_groups' - type: object - cidr_list: - description: List of IPv4/IPv6 CIDR addresses. - example: - - 199.27.128.0/21 - - '2400:cb00::/32' - items: - description: IPv4/IPv6 CIDR. - example: 199.27.128.0/21 - type: string - type: array - policy_with_permission_groups: - properties: - effect: - $ref: '#/components/schemas/effect' - id: - $ref: '#/components/schemas/identifier' - permission_groups: - $ref: '#/components/schemas/permission_groups' - resources: - $ref: '#/components/schemas/resources' - required: - - id - - effect - - resources - - permission_groups - title: policy_with_permission_groups - effect: - description: Allow or deny operations against the resources. - enum: - - allow - - deny - example: allow - type: string - identifier: - description: Policy identifier. - example: f267e341f3dd4697bd3b9f71dd96247f - readOnly: true - type: string - permission_groups: - description: A set of permission groups that are specified to the policy. - example: - - id: c8fed203ed3043cba015a93ad1616f1f - name: Zone Read - - id: 82e64a83756745bbbb1c9c2701bf816b - name: DNS Read - items: - $ref: '#/components/schemas/permission_group' - type: array - resources: - description: A list of resource names that the policy applies to. - example: - com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43: '*' - com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4: '*' - type: object - permission_group: - description: A named group of permissions that map to a group of operations against resources. - properties: - id: - description: Identifier of the group. - example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 - readOnly: true - type: string - name: - description: Name of the group. - example: Load Balancers Write - readOnly: true - type: string - required: - - id - type: object - response_single_segment: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - expires_on: - $ref: '#/components/schemas/expires_on' - id: - $ref: '#/components/schemas/components-schemas-identifier' - not_before: - $ref: '#/components/schemas/not_before' - status: - $ref: '#/components/schemas/status' - required: - - id - - status - type: object - components-schemas-identifier: - description: Token identifier tag. - example: ed17574386854bf78a67040be0a770b0 - maxLength: 32 - readOnly: true - type: string - status: - description: Status of the token. - enum: - - active - - disabled - - expired - example: active - type: string - schemas-identifier: {} - api-response-single-id: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - type: object - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - schemas-token: - allOf: - - $ref: '#/components/schemas/token' - token: - properties: - condition: - $ref: '#/components/schemas/condition' - expires_on: - $ref: '#/components/schemas/expires_on' - id: - $ref: '#/components/schemas/components-schemas-identifier' - issued_on: - $ref: '#/components/schemas/issued_on' - modified_on: - $ref: '#/components/schemas/modified_on' - name: - $ref: '#/components/schemas/name' - not_before: - $ref: '#/components/schemas/not_before' - policies: - $ref: '#/components/schemas/policies' - status: - $ref: '#/components/schemas/status' - required: - - id - - name - - status - - policies - type: object - issued_on: - description: The time on which the token was created. - example: '2018-07-01T05:20:00Z' - format: date-time - readOnly: true - type: string - modified_on: - description: Last time the token was modified. - example: '2018-07-02T05:20:00Z' - format: date-time - readOnly: true - type: string - response_single_value: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/value' - type: object - firewalluablock_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/ua-rules' - type: array - type: object - ua-rules: - allOf: - - $ref: '#/components/schemas/firewalluablock' - firewalluablock: - properties: - configuration: - $ref: '#/components/schemas/components-schemas-configuration' - description: - $ref: '#/components/schemas/ua-rules_components-schemas-description' - id: - $ref: '#/components/schemas/ua-rules_components-schemas-id' - mode: - $ref: '#/components/schemas/ua-rules_components-schemas-mode' - paused: - $ref: '#/components/schemas/components-schemas-paused' - components-schemas-configuration: - description: The configuration object for the current rule. - properties: - target: - description: The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules. - example: ua - type: string - value: - description: The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value. - example: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4' - type: string - type: object - ua-rules_components-schemas-description: - description: An informative summary of the rule. - example: Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack - maxLength: 1024 - type: string - ua-rules_components-schemas-id: - description: The unique identifier of the User Agent Blocking rule. - example: 372e67954025e0ba6aaa6d586b9e0b59 - maxLength: 32 - readOnly: true - type: string - ua-rules_components-schemas-mode: - description: The action to apply to a matched request. - enum: - - block - - challenge - - js_challenge - - managed_challenge - example: js_challenge - maxLength: 12 - components-schemas-paused: - description: 'When true, indicates that the rule is currently paused.' - example: false - type: boolean - firewalluablock_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - billing_history_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/billing-history' - type: array - billing-history: - properties: - action: - $ref: '#/components/schemas/action' - amount: - $ref: '#/components/schemas/amount' - currency: - $ref: '#/components/schemas/currency' - description: - $ref: '#/components/schemas/schemas-description' - id: - $ref: '#/components/schemas/billing-history_components-schemas-identifier' - occurred_at: - $ref: '#/components/schemas/occurred_at' - type: - $ref: '#/components/schemas/type' - zone: - $ref: '#/components/schemas/schemas-zone' - required: - - id - - type - - action - - description - - occurred_at - - amount - - currency - - zone - type: object - action: - description: The billing item action. - example: subscription - maxLength: 30 - readOnly: true - type: string - amount: - description: The amount associated with this billing item. - example: 20.99 - readOnly: true - type: number - currency: - description: The monetary unit in which pricing information is displayed. - example: USD - readOnly: true - type: string - schemas-description: - description: The billing item description. - example: The billing item description - maxLength: 255 - readOnly: true - type: string - billing-history_components-schemas-identifier: - description: Billing item identifier tag. - example: b69a9f3492637782896352daae219e7d - maxLength: 32 - readOnly: true - type: string - occurred_at: - description: When the billing item was created. - example: '2014-03-01T12:21:59.3456Z' - format: date-time - readOnly: true - type: string - type: - description: The billing item type. - example: charge - maxLength: 30 - readOnly: true - type: string - schemas-zone: - properties: - name: - readOnly: true - type: object - billing_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - user_subscription_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/subscription' - type: array - type: object - subscription: - allOf: - - $ref: '#/components/schemas/subscription-v2' - subscription-v2: - properties: - app: - properties: - install_id: - $ref: '#/components/schemas/install_id' - component_values: - $ref: '#/components/schemas/component_values' - currency: - $ref: '#/components/schemas/currency' - current_period_end: - $ref: '#/components/schemas/current_period_end' - current_period_start: - $ref: '#/components/schemas/current_period_start' - frequency: - $ref: '#/components/schemas/frequency' - id: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - price: - $ref: '#/components/schemas/price' - rate_plan: - $ref: '#/components/schemas/rate_plan' - state: - $ref: '#/components/schemas/state' - zone: - $ref: '#/components/schemas/zone' - type: object - install_id: - description: app install id. - type: string - component_values: - description: The list of add-ons subscribed to. - items: - $ref: '#/components/schemas/component_value' - type: array - current_period_end: - description: The end of the current period and also when the next billing is due. - example: '2014-03-31T12:20:00Z' - format: date-time - readOnly: true - type: string - current_period_start: - description: When the current billing period started. May match initial_period_start if this is the first period. - example: '2014-05-11T12:20:00Z' - format: date-time - readOnly: true - type: string - frequency: - description: How often the subscription is renewed automatically. - enum: - - weekly - - monthly - - quarterly - - yearly - example: monthly - type: string - subscription-v2_components-schemas-identifier: - description: Subscription identifier tag. - example: 506e3185e9c882d175a2d0cb0093d9f2 - maxLength: 32 - readOnly: true - type: string - price: - description: 'The price of the subscription that will be billed, in US dollars.' - example: 20 - readOnly: true - type: number - rate_plan: - description: The rate plan applied to the subscription. - properties: - currency: - description: The currency applied to the rate plan subscription. - example: USD - type: string - externally_managed: - description: Whether this rate plan is managed externally from Cloudflare. - example: false - type: boolean - id: - description: The ID of the rate plan. - example: free - is_contract: - description: Whether a rate plan is enterprise-based (or newly adopted term contract). - example: false - type: boolean - public_name: - description: The full name of the rate plan. - example: Business Plan - type: string - scope: - description: The scope that this rate plan applies to. - example: zone - type: string - sets: - description: The list of sets this rate plan applies to. - items: - type: string - type: array - type: object - state: - description: The state that the subscription is in. - enum: - - Trial - - Provisioned - - Paid - - AwaitingPayment - - Cancelled - - Failed - - Expired - example: Paid - readOnly: true - type: string - zone: - description: A simple zone object. May have null properties if not a zone subscription. - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/properties-name' - type: object - component_value: - description: A component value for a subscription. - properties: - default: - description: The default amount assigned. - example: 5 - type: number - name: - description: The name of the component value. - example: page_rules - type: string - price: - description: The unit price for the component value. - example: 5 - type: number - value: - description: The amount of the component value assigned. - example: 20 - type: number - type: object - properties-name: - description: The domain name - example: example.com - maxLength: 253 - pattern: '^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$' - readOnly: true - type: string - user_subscription_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - collection_membership_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/membership' - type: array - type: object - membership: - properties: - account: - $ref: '#/components/schemas/schemas-account' - api_access_enabled: - $ref: '#/components/schemas/api_access_enabled' - code: - $ref: '#/components/schemas/code' - id: - $ref: '#/components/schemas/membership_components-schemas-identifier' - permissions: - allOf: - - $ref: '#/components/schemas/permissions' - description: All access permissions for the user at the account. - readOnly: true - roles: - $ref: '#/components/schemas/roles' - status: - $ref: '#/components/schemas/schemas-status' - type: object - schemas-account: - allOf: - - $ref: '#/components/schemas/account' - readOnly: true - api_access_enabled: - description: Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account. - example: true - nullable: true - type: boolean - code: - description: The unique activation code for the account membership. - example: 05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0 - maxLength: 64 - readOnly: true - type: string - membership_components-schemas-identifier: - description: Membership identifier tag. - example: 4536bcfad5faccb111b47003c79917fa - maxLength: 32 - readOnly: true - type: string - permissions: - example: - analytics: - read: true - write: false - zones: - read: true - write: true - properties: - analytics: - $ref: '#/components/schemas/grants' - billing: - $ref: '#/components/schemas/grants' - cache_purge: - $ref: '#/components/schemas/grants' - dns: - $ref: '#/components/schemas/grants' - dns_records: - $ref: '#/components/schemas/grants' - lb: - $ref: '#/components/schemas/grants' - logs: - $ref: '#/components/schemas/grants' - organization: - $ref: '#/components/schemas/grants' - ssl: - $ref: '#/components/schemas/grants' - waf: - $ref: '#/components/schemas/grants' - zone_settings: - $ref: '#/components/schemas/grants' - zones: - $ref: '#/components/schemas/grants' - type: object - roles: - description: List of role names for the user at the account. - items: - example: Account Administrator - maxLength: 120 - type: string - readOnly: true - type: array - schemas-status: - description: Status of this membership. - enum: - - accepted - - pending - - rejected - example: accepted - type: string - account: - properties: - created_on: - description: Timestamp for the creation of the account - example: '2014-03-01T12:21:02.0000Z' - format: date-time - readOnly: true - type: string - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - description: Account name - example: Demo Account - maxLength: 100 - type: string - settings: - description: Account settings - properties: - enforce_twofactor: - default: false - description: |- - Indicates whether membership in this account requires that - Two-Factor Authentication is enabled - type: boolean - use_account_custom_ns_by_default: - default: false - description: |- - Indicates whether new zones should use the account-level custom - nameservers by default - type: boolean - type: object - required: - - id - - name - type: object - grants: - example: - read: true - write: false - properties: - read: - example: true - type: boolean - write: - example: true - type: boolean - type: object - single_membership_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - schemas-collection_invite_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-invite' - type: array - type: object - schemas-invite: - allOf: - - $ref: '#/components/schemas/user_invite' - user_invite: - allOf: - - $ref: '#/components/schemas/base' - - properties: - status: - description: Current status of the invitation. - enum: - - pending - - accepted - - rejected - - expired - example: accepted - base: - properties: - expires_on: - $ref: '#/components/schemas/schemas-expires_on' - id: - $ref: '#/components/schemas/invite_components-schemas-identifier' - invited_by: - $ref: '#/components/schemas/invited_by' - invited_member_email: - $ref: '#/components/schemas/invited_member_email' - invited_member_id: - description: ID of the user to add to the organization. - example: 5a7805061c76ada191ed06f989cc3dac - maxLength: 32 - nullable: true - readOnly: true - type: string - invited_on: - $ref: '#/components/schemas/invited_on' - organization_id: - description: ID of the organization the user will be added to. - example: 5a7805061c76ada191ed06f989cc3dac - maxLength: 32 - readOnly: true - type: string - organization_name: - description: Organization name. - example: 'Cloudflare, Inc.' - maxLength: 100 - readOnly: true - type: string - roles: - description: Roles to be assigned to this user. - items: - $ref: '#/components/schemas/schemas-role' - type: array - required: - - invited_member_id - - organization_id - type: object - schemas-expires_on: - description: When the invite is no longer active. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - invite_components-schemas-identifier: - description: Invite identifier tag. - example: 4f5f0c14a2a41d5063dd301b2f829f04 - maxLength: 32 - readOnly: true - type: string - invited_by: - description: The email address of the user who created the invite. - example: user@example.com - maxLength: 90 - type: string - invited_member_email: - description: Email address of the user to add to the organization. - example: user@example.com - maxLength: 90 - type: string - invited_on: - description: When the invite was sent. - example: '2014-01-01T05:20:00Z' - format: date-time - readOnly: true - type: string - schemas-role: - properties: - description: - $ref: '#/components/schemas/description' - id: - $ref: '#/components/schemas/role_components-schemas-identifier' - name: - $ref: '#/components/schemas/components-schemas-name' - permissions: - $ref: '#/components/schemas/schemas-permissions' - required: - - id - - name - - description - - permissions - type: object - description: - description: Description of role's permissions. - example: Administrative access to the entire Organization - readOnly: true - type: string - role_components-schemas-identifier: - description: Role identifier tag. - example: 3536bcfad5faccb999b47003c79917fb - maxLength: 32 - readOnly: true - type: string - components-schemas-name: - description: Role Name. - example: Organization Admin - maxLength: 120 - readOnly: true - type: string - schemas-permissions: - description: Access permissions for this User. - items: - example: '#zones:read' - maxLength: 160 - type: string - readOnly: true - type: array - single_invite_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - collection_organization_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/organization' - type: array - type: object - organization: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/schemas-name' - permissions: - $ref: '#/components/schemas/schemas-permissions' - roles: - description: List of roles that a user has within an organization. - items: - example: All Privileges - Super Administrator - maxLength: 120 - type: string - readOnly: true - type: array - status: - $ref: '#/components/schemas/components-schemas-status' - type: object - schemas-name: - description: Organization name. - example: 'Cloudflare, Inc.' - maxLength: 100 - type: string - components-schemas-status: - description: Whether the user is a member of the organization or has an inivitation pending. - enum: - - member - - invited - example: member - type: string - single_organization_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - user_tokens_permission_groups: - id: cloudflare.users.user_tokens_permission_groups - name: user_tokens_permission_groups - title: User Tokens Permission Groups - methods: - permission_groups_list_permission_groups: - operation: - $ref: '#/paths/~1user~1tokens~1permission_groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _permission_groups_list_permission_groups: - operation: - $ref: '#/paths/~1user~1tokens~1permission_groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_tokens_permission_groups/methods/permission_groups_list_permission_groups' - insert: [] - update: [] - delete: [] - user: - id: cloudflare.users.user - name: user - title: User - methods: - user_details: - operation: - $ref: '#/paths/~1user/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _user_details: - operation: - $ref: '#/paths/~1user/get' - response: - mediaType: application/json - openAPIDocKey: '200' - edit_user: - operation: - $ref: '#/paths/~1user/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user/methods/user_details' - insert: [] - update: [] - delete: [] - user_tokens: - id: cloudflare.users.user_tokens - name: user_tokens - title: User Tokens - methods: - user_api_tokens_list_tokens: - operation: - $ref: '#/paths/~1user~1tokens/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _user_api_tokens_list_tokens: - operation: - $ref: '#/paths/~1user~1tokens/get' - response: - mediaType: application/json - openAPIDocKey: '200' - user_api_tokens_create_token: - operation: - $ref: '#/paths/~1user~1tokens/post' - response: - mediaType: application/json - openAPIDocKey: '200' - user_api_tokens_delete_token: - operation: - $ref: '#/paths/~1user~1tokens~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - user_api_tokens_token_details: - operation: - $ref: '#/paths/~1user~1tokens~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _user_api_tokens_token_details: - operation: - $ref: '#/paths/~1user~1tokens~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - user_api_tokens_update_token: - operation: - $ref: '#/paths/~1user~1tokens~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - user_api_tokens_verify_token: - operation: - $ref: '#/paths/~1user~1tokens~1verify/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _user_api_tokens_verify_token: - operation: - $ref: '#/paths/~1user~1tokens~1verify/get' - response: - mediaType: application/json - openAPIDocKey: '200' - user_api_tokens_roll_token: - operation: - $ref: '#/paths/~1user~1tokens~1{identifier}~1value/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_tokens/methods/user_api_tokens_list_tokens' - - $ref: '#/components/x-stackQL-resources/user_tokens/methods/user_api_tokens_token_details' - insert: - - $ref: '#/components/x-stackQL-resources/user_tokens/methods/user_api_tokens_create_token' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/user_tokens/methods/user_api_tokens_delete_token' - zones_firewall_ua_rules: - id: cloudflare.users.zones_firewall_ua_rules - name: zones_firewall_ua_rules - title: Zones Firewall Ua Rules - methods: - user_agent_blocking_rules_list_user_agent_blocking_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1ua_rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _user_agent_blocking_rules_list_user_agent_blocking_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1ua_rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - user_agent_blocking_rules_create_a_user_agent_blocking_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1ua_rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - user_agent_blocking_rules_delete_a_user_agent_blocking_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1ua_rules~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - user_agent_blocking_rules_get_a_user_agent_blocking_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1ua_rules~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _user_agent_blocking_rules_get_a_user_agent_blocking_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1ua_rules~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - user_agent_blocking_rules_update_a_user_agent_blocking_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1ua_rules~1{id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_firewall_ua_rules/methods/user_agent_blocking_rules_list_user_agent_blocking_rules' - - $ref: '#/components/x-stackQL-resources/zones_firewall_ua_rules/methods/user_agent_blocking_rules_get_a_user_agent_blocking_rule' - insert: - - $ref: '#/components/x-stackQL-resources/zones_firewall_ua_rules/methods/user_agent_blocking_rules_create_a_user_agent_blocking_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_firewall_ua_rules/methods/user_agent_blocking_rules_delete_a_user_agent_blocking_rule' - user_billing_history: - id: cloudflare.users.user_billing_history - name: user_billing_history - title: User Billing History - methods: - billing_history_details: - operation: - $ref: '#/paths/~1user~1billing~1history/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _billing_history_details: - operation: - $ref: '#/paths/~1user~1billing~1history/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_billing_history/methods/billing_history_details' - insert: [] - update: [] - delete: [] - user_billing_profile: - id: cloudflare.users.user_billing_profile - name: user_billing_profile - title: User Billing Profile - methods: - billing_profile_details: - operation: - $ref: '#/paths/~1user~1billing~1profile/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _billing_profile_details: - operation: - $ref: '#/paths/~1user~1billing~1profile/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_billing_profile/methods/billing_profile_details' - insert: [] - update: [] - delete: [] - user_subscriptions: - id: cloudflare.users.user_subscriptions - name: user_subscriptions - title: User Subscriptions - methods: - user_subscription_get_user_subscriptions: - operation: - $ref: '#/paths/~1user~1subscriptions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _user_subscription_get_user_subscriptions: - operation: - $ref: '#/paths/~1user~1subscriptions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - user_subscription_delete_user_subscription: - operation: - $ref: '#/paths/~1user~1subscriptions~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - user_subscription_update_user_subscription: - operation: - $ref: '#/paths/~1user~1subscriptions~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_subscriptions/methods/user_subscription_get_user_subscriptions' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/user_subscriptions/methods/user_subscription_delete_user_subscription' - memberships: - id: cloudflare.users.memberships - name: memberships - title: Memberships - methods: - account_memberships_list_memberships: - operation: - $ref: '#/paths/~1memberships/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_memberships_list_memberships: - operation: - $ref: '#/paths/~1memberships/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_memberships_delete_membership: - operation: - $ref: '#/paths/~1memberships~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - account_memberships_membership_details: - operation: - $ref: '#/paths/~1memberships~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _account_memberships_membership_details: - operation: - $ref: '#/paths/~1memberships~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - account_memberships_update_membership: - operation: - $ref: '#/paths/~1memberships~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/memberships/methods/account_memberships_list_memberships' - - $ref: '#/components/x-stackQL-resources/memberships/methods/account_memberships_membership_details' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/memberships/methods/account_memberships_delete_membership' - user_invites: - id: cloudflare.users.user_invites - name: user_invites - title: User Invites - methods: - invites_list_invitations: - operation: - $ref: '#/paths/~1user~1invites/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _invites_list_invitations: - operation: - $ref: '#/paths/~1user~1invites/get' - response: - mediaType: application/json - openAPIDocKey: '200' - invites_invitation_details: - operation: - $ref: '#/paths/~1user~1invites~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _invites_invitation_details: - operation: - $ref: '#/paths/~1user~1invites~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - invites_respond_to_invitation: - operation: - $ref: '#/paths/~1user~1invites~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_invites/methods/invites_list_invitations' - - $ref: '#/components/x-stackQL-resources/user_invites/methods/invites_invitation_details' - insert: [] - update: [] - delete: [] - user_organizations: - id: cloudflare.users.user_organizations - name: user_organizations - title: User Organizations - methods: - organizations_list_organizations: - operation: - $ref: '#/paths/~1user~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _organizations_list_organizations: - operation: - $ref: '#/paths/~1user~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_leave_organization: - operation: - $ref: '#/paths/~1user~1organizations~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_organization_details: - operation: - $ref: '#/paths/~1user~1organizations~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _organizations_organization_details: - operation: - $ref: '#/paths/~1user~1organizations~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/user_organizations/methods/organizations_list_organizations' - - $ref: '#/components/x-stackQL-resources/user_organizations/methods/organizations_organization_details' - insert: [] - update: [] - delete: [] -paths: - /user/tokens/permission_groups: - get: - description: Find all available permission groups. - operationId: permission-groups-list-permission-groups - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_collection' - description: List Permission Groups response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Permission Groups response failure - security: - - api_token: [] - summary: List Permission Groups - tags: - - Permission Groups - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.token.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /user: - get: - operationId: user-user-details - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_user_response' - description: User Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_user_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: User Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: User Details - tags: - - User - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Edit part of your user details. - operationId: user-edit-user - requestBody: - content: - application/json: - schema: - properties: - country: - $ref: '#/components/schemas/country' - first_name: - $ref: '#/components/schemas/first_name' - last_name: - $ref: '#/components/schemas/last_name' - telephone: - $ref: '#/components/schemas/telephone' - zipcode: - $ref: '#/components/schemas/zipcode' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_user_response' - description: Edit User response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_user_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit User response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit User - tags: - - User - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.user.update - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /user/tokens: - get: - description: List all access tokens you created. - operationId: user-api-tokens-list-tokens - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_collection' - description: List Tokens response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Tokens response failure - security: - - api_token: [] - summary: List Tokens - tags: - - User API Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.token.list - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Create a new access token. - operationId: user-api-tokens-create-token - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_payload' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_create' - description: Create Token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_create' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Token response failure - security: - - api_token: [] - summary: Create Token - tags: - - User API Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.token.create - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /user/tokens/verify: - get: - description: Test whether a token works. - operationId: user-api-tokens-verify-token - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single_segment' - description: Verify Token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single_segment' - - $ref: '#/components/schemas/api-response-common-failure' - description: Verify Token response failure - security: - - api_token: [] - summary: Verify Token - tags: - - User API Tokens - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/user/tokens/{identifier}': - delete: - description: Destroy a token. - operationId: user-api-tokens-delete-token - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete Token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Token response failure - security: - - api_token: [] - summary: Delete Token - tags: - - User API Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.token.delete - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Get information about a specific token. - operationId: user-api-tokens-token-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single' - description: Token Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Token Details response failure - security: - - api_token: [] - summary: Token Details - tags: - - User API Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.token.read - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Update an existing token. - operationId: user-api-tokens-update-token - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-token' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single' - description: Update Token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Token response failure - security: - - api_token: [] - summary: Update Token - tags: - - User API Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.token.update - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/user/tokens/{identifier}/value': - put: - description: Roll the token secret. - operationId: user-api-tokens-roll-token - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: - schema: - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/response_single_value' - description: Roll Token response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/response_single_value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Roll Token response failure - security: - - api_token: [] - summary: Roll Token - tags: - - User API Tokens - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.token.update - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/firewall/ua_rules': - get: - description: Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters. - operationId: user-agent-blocking-rules-list-user-agent-blocking-rules - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/firewalluablock_response_collection' - description: List User Agent Blocking rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/firewalluablock_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List User Agent Blocking rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List User Agent Blocking rules - tags: - - User Agent Blocking rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Creates a new User Agent Blocking rule in a zone. - operationId: user-agent-blocking-rules-create-a-user-agent-blocking-rule - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - mode - - configuration - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/firewalluablock_response_single' - description: Create a User Agent Blocking rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/firewalluablock_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a User Agent Blocking rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a User Agent Blocking rule - tags: - - User Agent Blocking rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/firewall/ua_rules/{id}': - delete: - description: Deletes an existing User Agent Blocking rule. - operationId: user-agent-blocking-rules-delete-a-user-agent-blocking-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/ua-rules_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/firewalluablock_response_single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/ua-rules_components-schemas-id' - type: object - description: Delete a User Agent Blocking rule response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/firewalluablock_response_single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/ua-rules_components-schemas-id' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a User Agent Blocking rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a User Agent Blocking rule - tags: - - User Agent Blocking rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the details of a User Agent Blocking rule. - operationId: user-agent-blocking-rules-get-a-user-agent-blocking-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/ua-rules_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/firewalluablock_response_single' - description: Get a User Agent Blocking rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/firewalluablock_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a User Agent Blocking rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a User Agent Blocking rule - tags: - - User Agent Blocking rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates an existing User Agent Blocking rule. - operationId: user-agent-blocking-rules-update-a-user-agent-blocking-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/ua-rules_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - - mode - - configuration - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/firewalluablock_response_single' - description: Update a User Agent Blocking rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/firewalluablock_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a User Agent Blocking rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a User Agent Blocking rule - tags: - - User Agent Blocking rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /user/billing/history: - get: - description: Accesses your billing history object. - operationId: user-billing-history-billing-history-details - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/billing_history_collection' - description: Billing History Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/billing_history_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Billing History Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Billing History Details - tags: - - User Billing History - x-cfPermissionsRequired: - enum: - - '#billing:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /user/billing/profile: - get: - description: Accesses your billing profile object. - operationId: user-billing-profile-billing-profile-details - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/billing_response_single' - description: Billing Profile Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/billing_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Billing Profile Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Billing Profile Details - tags: - - User Billing Profile - x-cfPermissionsRequired: - enum: - - '#billing:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /user/subscriptions: - get: - description: Lists all of a user's subscriptions. - operationId: user-subscription-get-user-subscriptions - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/user_subscription_response_collection' - description: Get User Subscriptions response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/user_subscription_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get User Subscriptions response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get User Subscriptions - tags: - - User Subscription - x-cfPermissionsRequired: - enum: - - '#billing:read' - '/user/subscriptions/{identifier}': - delete: - description: Deletes a user's subscription. - operationId: user-subscription-delete-user-subscription - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - properties: - subscription_id: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - type: object - description: Delete User Subscription response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - subscription_id: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete User Subscription response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete User Subscription - tags: - - User Subscription - x-cfPermissionsRequired: - enum: - - '#billing:edit' - put: - description: Updates a user's subscriptions. - operationId: user-subscription-update-user-subscription - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/subscription-v2' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/user_subscription_response_single' - description: Update User Subscription response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/user_subscription_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update User Subscription response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update User Subscription - tags: - - User Subscription - x-cfPermissionsRequired: - enum: - - '#billing:read' - - '#billing:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /memberships: - get: - description: List memberships of accounts the user can access. - operationId: user'-s-account-memberships-list-memberships - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/collection_membership_response' - description: List Memberships response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/collection_membership_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Memberships response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Memberships - tags: - - User's Account Memberships - '/memberships/{identifier}': - delete: - description: Remove the associated member from an account. - operationId: user'-s-account-memberships-delete-membership - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/membership_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/membership_components-schemas-identifier' - type: object - description: Delete Membership response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/membership_components-schemas-identifier' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Membership response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Membership - tags: - - User's Account Memberships - get: - description: Get a specific membership. - operationId: user'-s-account-memberships-membership-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/membership_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_membership_response' - description: Membership Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_membership_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Membership Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Membership Details - tags: - - User's Account Memberships - put: - description: Accept or reject this account invitation. - operationId: user'-s-account-memberships-update-membership - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/membership_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - status: - description: Whether to accept or reject this account invitation. - enum: - - accepted - - rejected - example: accepted - required: - - status - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_membership_response' - description: Update Membership response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_membership_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Membership response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Membership - tags: - - User's Account Memberships - /user/invites: - get: - description: Lists all invitations associated with my user. - operationId: user'-s-invites-list-invitations - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-collection_invite_response' - description: List Invitations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-collection_invite_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Invitations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Invitations - tags: - - User's Invites - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/user/invites/{identifier}': - get: - description: Gets the details of an invitation. - operationId: user'-s-invites-invitation-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/invite_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_invite_response' - description: Invitation Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_invite_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Invitation Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Invitation Details - tags: - - User's Invites - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: Responds to an invitation. - operationId: user'-s-invites-respond-to-invitation - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/invite_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - status: - description: Status of your response to the invitation (rejected or accepted). - enum: - - accepted - - rejected - example: accepted - required: - - status - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_invite_response' - description: Respond to Invitation response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_invite_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Respond to Invitation response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Respond to Invitation - tags: - - User's Invites - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - /user/organizations: - get: - description: Lists organizations the user is associated with. - operationId: user'-s-organizations-list-organizations - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/collection_organization_response' - description: List Organizations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/collection_organization_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Organizations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Organizations - tags: - - User's Organizations - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/user/organizations/{identifier}': - delete: - description: Removes association to an organization. - operationId: user'-s-organizations-leave-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: object - description: Leave Organization response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Leave Organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Leave Organization - tags: - - User's Organizations - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Gets a specific organization the user is associated with. - operationId: user'-s-organizations-organization-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_organization_response' - description: Organization Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_organization_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Organization Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Organization Details - tags: - - User's Organizations - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false diff --git a/providers/src/cloudflare/v00.00.00000/services/vectorize.yaml b/providers/src/cloudflare/v00.00.00000/services/vectorize.yaml new file mode 100644 index 00000000..f4ee7ab6 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/vectorize.yaml @@ -0,0 +1,3190 @@ +openapi: 3.0.3 +info: + title: vectorize API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/vectorize/indexes: + get: + deprecated: true + description: Returns a list of Vectorize Indexes + operationId: vectorize-(-deprecated)-list-vectorize-indexes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + items: + $ref: '#/components/schemas/vectorizeCreateIndexResponse' + type: array + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: List Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Vectorize Index Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Vectorize Indexes (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the GET + `/accounts/{account_id}/vectorize/v2/indexes` endpoint. + display: true + id: vectorize_list_index_deprecation + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.list + post: + deprecated: true + description: Creates and returns a new Vectorize Index. + operationId: vectorize-(-deprecated)-create-vectorize-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeCreateIndexRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeCreateIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Create Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Vectorize Index Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Vectorize Index (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the POST + `/accounts/{account_id}/vectorize/v2/indexes` endpoint. + display: true + id: vectorize_create_index_deprecation + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.create + /accounts/{account_id}/vectorize/indexes/{index_name}: + delete: + deprecated: true + description: Deletes the specified Vectorize Index. + operationId: vectorize-(-deprecated)-delete-vectorize-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Delete Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Vectorize Index Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Vectorize Index (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the DELETE + `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint. + display: true + id: vectorize_delete_index_deprecation + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.delete + get: + deprecated: true + description: Returns the specified Vectorize Index. + operationId: vectorize-(-deprecated)-get-vectorize-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeCreateIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Get Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Vectorize Index Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Vectorize Index (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the GET + `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint. + display: true + id: vectorize_get_index_deprecation + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.read + put: + deprecated: true + description: Updates and returns the specified Vectorize Index. + operationId: vectorize-(-deprecated)-update-vectorize-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeUpdateIndexRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeCreateIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Update Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Vectorize Index Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Vectorize Index (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + x-cfDeprecation: + description: This endpoint has been deprecated and will soon be removed. + display: true + id: vectorize_update_index_deprecation + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.update + /accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids: + post: + deprecated: true + description: Delete a set of vectors from an index by their vector identifiers. + operationId: vectorize-(-deprecated)-delete-vectors-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeIndexDeleteVectorsByIdRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: >- + #/components/schemas/vectorizeIndexDeleteVectorsByIdResponse + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Delete Vector Identifiers Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Vector Identifiers Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Vectors By Identifier (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the POST + `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids` + endpoint. + display: true + id: vectorize_delete_by_ids_deprecation + /accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids: + post: + deprecated: true + description: Get a set of vectors from an index by their vector identifiers. + operationId: vectorize-(-deprecated)-get-vectors-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeIndexGetVectorsByIdRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexGetVectorsByIdResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Get Vectors By Identifier Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Vectors By Identifier Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Vectors By Identifier (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the POST + `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids` + endpoint. + display: true + id: vectorize_get_by_ids_deprecation + /accounts/{account_id}/vectorize/indexes/{index_name}/insert: + post: + deprecated: true + description: >- + Inserts vectors into the specified index and returns the count of the + vectors successfully inserted. + operationId: vectorize-(-deprecated)-insert-vector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/x-ndjson: + schema: + description: ndjson file containing vectors to insert. + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexInsertResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Insert Vectors Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Insert Vectors Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Insert Vectors (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the POST + `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert` + endpoint. + display: true + id: vectorize_insert_deprecation + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.update + /accounts/{account_id}/vectorize/indexes/{index_name}/query: + post: + deprecated: true + description: Finds vectors closest to a given vector in an index. + operationId: vectorize-(-deprecated)-query-vector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeIndexQueryRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexQueryResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Query Vectors Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Query Vectors Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Query Vectors (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the POST + `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query` + endpoint. + display: true + id: vectorize_query_deprecation + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.read + /accounts/{account_id}/vectorize/indexes/{index_name}/upsert: + post: + deprecated: true + description: >- + Upserts vectors into the specified index, creating them if they do not + exist and returns the count of values and ids successfully inserted. + operationId: vectorize-(-deprecated)-upsert-vector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/x-ndjson: + schema: + description: ndjson file containing vectors to upsert. + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexUpsertResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Insert Vectors Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Insert Vectors Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upsert Vectors (Deprecated) + tags: + - Vectorize Beta (Deprecated) + x-api-token-group: + - Vectorize Write + x-cfDeprecation: + description: >- + This endpoint is deprecated in favor of the POST + `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert` + endpoint. + display: true + id: vectorize_upsert_deprecation + /accounts/{account_id}/vectorize/v2/indexes: + get: + description: Returns a list of Vectorize Indexes + operationId: vectorize-list-vectorize-indexes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + items: + $ref: '#/components/schemas/vectorizeCreateIndexResponse' + type: array + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: List Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Vectorize Index Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Vectorize Indexes + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.list + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: list + post: + description: Creates and returns a new Vectorize Index. + operationId: vectorize-create-vectorize-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeCreateIndexRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeCreateIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Create Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Vectorize Index Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Vectorize Index + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.create + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: create + /accounts/{account_id}/vectorize/v2/indexes/{index_name}: + delete: + description: Deletes the specified Vectorize Index. + operationId: vectorize-delete-vectorize-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Delete Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Vectorize Index Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Vectorize Index + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.delete + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: delete + get: + description: Returns the specified Vectorize Index. + operationId: vectorize-get-vectorize-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeCreateIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Get Vectorize Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Vectorize Index Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Vectorize Index + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.read + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: get + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids: + post: + description: Delete a set of vectors from an index by their vector identifiers. + operationId: vectorize-delete-vectors-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeIndexDeleteVectorsByIdRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: >- + #/components/schemas/vectorizeIndexDeleteVectorsByIdV2Response + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Delete Vector Identifiers Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Vector Identifiers Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Vectors By Identifier + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.delete + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: delete_by_ids + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids: + post: + description: Get a set of vectors from an index by their vector identifiers. + operationId: vectorize-get-vectors-by-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeIndexGetVectorsByIdRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexGetVectorsByIdResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Get Vectors By Identifier Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Vectors By Identifier Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Vectors By Identifier + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: get_by_ids + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/info: + get: + description: Get information about a vectorize index. + operationId: vectorize-index-info + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexInfoResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Get Vectorize Index Info Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Vectorize Index Info Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Vectorize Index Info + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.read + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: info + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert: + post: + description: >- + Inserts vectors into the specified index and returns a mutation id + corresponding to the vectors enqueued for insertion. + operationId: vectorize-insert-vector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + - in: query + name: unparsable-behavior + schema: + description: Behavior for ndjson parse failures. + enum: + - error + - discard + type: string + requestBody: + content: + application/x-ndjson: + schema: + description: ndjson file containing vectors to insert. + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexInsertV2Response' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Insert Vectors Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Insert Vectors Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Insert Vectors + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: insert + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/list: + get: + description: Returns a paginated list of vector identifiers from the specified index. + operationId: vectorize-list-vectors + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + - in: query + name: count + schema: + default: 100 + description: Maximum number of vectors to return + maximum: 1000 + minimum: 1 + type: integer + - in: query + name: cursor + schema: + description: Cursor for pagination to get the next page of results + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexListVectorsResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: List Vectors Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Vectors Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Vectors + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.read + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: list_vectors + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create: + post: + description: >- + Enable metadata filtering based on metadata property. Limited to 10 + properties. + operationId: vectorize-create-metadata-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeCreateMetadataIndexRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeCreateMetadataIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Create Metadata Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Metadata Index Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Metadata Index + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.create + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + - metadata_index + method: create + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete: + post: + description: Allow Vectorize to delete the specified metadata index. + operationId: vectorize-delete-metadata-index + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeDeleteMetadataIndexRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeDeleteMetadataIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Delete Metadata Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Metadata Index Failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Metadata Index + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.edge.vectorize.index.delete + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + - metadata_index + method: delete + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list: + get: + description: List Metadata Indexes for the specified Vectorize Index. + operationId: vectorize-list-metadata-indexes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeListMetadataIndexResponse' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: List Metadata Index Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Metadata Index Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Metadata Indexes + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + - metadata_index + method: list + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/query: + post: + description: Finds vectors closest to a given vector in an index. + operationId: vectorize-query-vector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vectorizeIndexQueryV2Request' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexQueryV2Response' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Query Vectors Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Query Vectors Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Query Vectors + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + - Vectorize Read + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: query + /accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert: + post: + description: >- + Upserts vectors into the specified index, creating them if they do not + exist and returns a mutation id corresponding to the vectors enqueued + for upsertion. + operationId: vectorize-upsert-vector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: index_name + in: path + required: true + description: The Vectorize index name. + schema: + type: string + - in: query + name: unparsable-behavior + schema: + description: Behavior for ndjson parse failures. + enum: + - error + - discard + type: string + requestBody: + content: + application/x-ndjson: + schema: + description: ndjson file containing vectors to upsert. + format: binary + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/vectorizeIndexUpsertV2Response' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Upsert Vectors Response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vectorizeMessages' + messages: + $ref: '#/components/schemas/vectorizeMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Upsert Vectors Failure Response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upsert Vectors + tags: + - Vectorize + x-api-token-group: + - Vectorize Write + x-stackql-sdk: + service: vectorize + resource_chain: + - indexes + method: upsert +components: + schemas: + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + vectorizeCreateIndexRequest: + properties: + config: + $ref: '#/components/schemas/vectorizeIndexConfiguration' + description: + $ref: '#/components/schemas/vectorizeIndexDescription' + name: + $ref: '#/components/schemas/vectorizeIndexName' + required: + - name + - config + type: object + vectorizeCreateIndexResponse: + properties: + config: + $ref: '#/components/schemas/vectorizeIndexDimensionConfiguration' + created_on: + description: >- + Specifies the timestamp the resource was created as an ISO8601 + string. + example: '2022-11-15T18:25:44.442097Z' + format: date-time + readOnly: true + type: string + x-auditable: true + description: + $ref: '#/components/schemas/vectorizeIndexDescription' + modified_on: + description: >- + Specifies the timestamp the resource was modified as an ISO8601 + string. + example: '2022-11-15T18:25:44.442097Z' + format: date-time + readOnly: true + type: string + x-auditable: true + name: + $ref: '#/components/schemas/vectorizeIndexName' + type: object + vectorizeCreateMetadataIndexRequest: + properties: + indexType: + description: Specifies the type of metadata property to index. + enum: + - string + - number + - boolean + type: string + x-auditable: true + propertyName: + description: Specifies the metadata property to index. + example: random_metadata_property + type: string + x-auditable: true + required: + - propertyName + - indexType + type: object + vectorizeCreateMetadataIndexResponse: + properties: + mutationId: + $ref: '#/components/schemas/vectorizeMutationUuid' + type: object + vectorizeDeleteMetadataIndexRequest: + properties: + propertyName: + description: Specifies the metadata property for which the index must be deleted. + example: random_metadata_property + type: string + x-auditable: true + required: + - propertyName + type: object + vectorizeDeleteMetadataIndexResponse: + properties: + mutationId: + $ref: '#/components/schemas/vectorizeMutationUuid' + type: object + vectorizeIndexConfiguration: + description: Specifies the type of configuration to use for the index. + type: object + properties: + dimensions: + $ref: '#/components/schemas/vectorizeIndexDimensions' + metric: + $ref: '#/components/schemas/vectorizeIndexMetric' + preset: + $ref: '#/components/schemas/vectorizeIndexPreset' + required: [] + vectorizeIndexDeleteVectorsByIdRequest: + properties: + ids: + description: >- + A list of vector identifiers to delete from the index indicated by + the path. + example: + - 5121db81354a40c6aedc3fe1ace51c59 + - f90eb49c2107486abdfd78c67e853430 + items: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + type: array + type: object + vectorizeIndexDeleteVectorsByIdResponse: + properties: + count: + description: The count of the vectors successfully deleted. + example: 42 + type: integer + ids: + description: >- + Array of vector identifiers of the vectors that were successfully + processed for deletion. + items: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + type: array + type: object + vectorizeIndexDeleteVectorsByIdV2Response: + properties: + mutationId: + $ref: '#/components/schemas/vectorizeMutationUuid' + type: object + vectorizeIndexDescription: + description: Specifies the description of the index. + example: This is my example index. + type: string + x-auditable: true + vectorizeIndexDimensionConfiguration: + properties: + dimensions: + $ref: '#/components/schemas/vectorizeIndexDimensions' + metric: + $ref: '#/components/schemas/vectorizeIndexMetric' + required: + - dimensions + - metric + type: object + vectorizeIndexDimensions: + description: Specifies the number of dimensions for the index + example: 768 + maximum: 1536 + minimum: 1 + type: integer + x-auditable: true + vectorizeIndexGetVectorsByIdRequest: + properties: + ids: + description: >- + A list of vector identifiers to retrieve from the index indicated by + the path. + example: + - 5121db81354a40c6aedc3fe1ace51c59 + - f90eb49c2107486abdfd78c67e853430 + items: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + type: array + type: object + vectorizeIndexGetVectorsByIdResponse: + description: Array of vectors with matching ids. + example: + - id: some-vector-id + metadata: + another-key: another-value + customer-id: 442 + values: + - 0.812 + - 0.621 + - 0.261 + - id: other-vector-id + metadata: + another-key: with-a-value + customer-id: 2151 + namespace: namespaced + values: + - 0.961 + - 0.751 + - 0.661 + items: + properties: + id: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + metadata: + type: object + namespace: + nullable: true + type: string + values: + items: + type: number + type: array + type: object + type: array + vectorizeIndexInfoResponse: + properties: + dimensions: + $ref: '#/components/schemas/vectorizeIndexDimensions' + processedUpToDatetime: + description: >- + Specifies the timestamp the last mutation batch was processed as an + ISO8601 string. + example: '2024-07-22T18:25:44.442097Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + processedUpToMutation: + $ref: '#/components/schemas/vectorizeMutationUuid' + vectorCount: + description: Specifies the number of vectors present in the index + example: 300000 + type: integer + x-auditable: true + type: object + vectorizeIndexInsertResponse: + properties: + count: + description: Specifies the count of the vectors successfully inserted. + example: 768 + type: integer + x-auditable: true + ids: + description: Array of vector identifiers of the vectors successfully inserted. + items: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + type: array + type: object + vectorizeIndexInsertV2Response: + properties: + mutationId: + $ref: '#/components/schemas/vectorizeMutationUuid' + type: object + vectorizeIndexListVectorsResponse: + properties: + count: + description: Number of vectors returned in this response + example: 100 + type: integer + cursorExpirationTimestamp: + description: When the cursor expires as an ISO8601 string + example: '2025-08-12T20:32:52.469144957+00:00' + format: date-time + nullable: true + type: string + isTruncated: + description: Whether there are more vectors available beyond this response + example: true + type: boolean + nextCursor: + description: Cursor for the next page of results + example: suUTaDY5PFUiRweVccnzyt9n75suNPbXHPshvCzue5mHjtj7Letjvzlza9eGj099 + nullable: true + type: string + totalCount: + description: Total number of vectors in the index + example: 500 + type: integer + vectors: + description: Array of vector items + items: + $ref: '#/components/schemas/vectorizeVectorListItem' + type: array + required: + - count + - totalCount + - isTruncated + - vectors + type: object + vectorizeIndexMetric: + description: Specifies the type of metric to use calculating distance. + enum: + - cosine + - euclidean + - dot-product + type: string + x-auditable: true + vectorizeIndexName: + example: example-index + type: string + x-auditable: true + vectorizeIndexPreset: + description: Specifies the preset to use for the index. + enum: + - '@cf/baai/bge-small-en-v1.5' + - '@cf/baai/bge-base-en-v1.5' + - '@cf/baai/bge-large-en-v1.5' + - openai/text-embedding-ada-002 + - cohere/embed-multilingual-v2.0 + example: '@cf/baai/bge-small-en-v1.5' + type: string + x-auditable: true + vectorizeIndexQueryRequest: + properties: + filter: + description: A metadata filter expression used to limit nearest neighbor results. + example: + has_viewed: + $ne: true + streaming_platform: netflix + type: object + returnMetadata: + default: false + description: Whether to return the metadata associated with the closest vectors. + type: boolean + returnValues: + default: false + description: Whether to return the values associated with the closest vectors. + type: boolean + topK: + default: 5 + description: The number of nearest neighbors to find. + example: 5 + type: number + vector: + description: The search vector that will be used to find the nearest neighbors. + example: + - 0.5 + - 0.5 + - 0.5 + items: + type: number + type: array + required: + - vector + type: object + vectorizeIndexQueryResponse: + properties: + count: + description: Specifies the count of vectors returned by the search + type: integer + matches: + description: Array of vectors matched by the search + items: + properties: + id: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + metadata: + nullable: true + type: object + score: + description: >- + The score of the vector according to the index's distance + metric + type: number + values: + items: + type: number + nullable: true + type: array + type: object + type: array + type: object + vectorizeIndexQueryV2Request: + properties: + filter: + description: A metadata filter expression used to limit nearest neighbor results. + example: + has_viewed: + $ne: true + streaming_platform: netflix + type: object + returnMetadata: + default: none + description: >- + Whether to return no metadata, indexed metadata or all metadata + associated with the closest vectors. + enum: + - none + - indexed + - all + type: string + returnValues: + default: false + description: Whether to return the values associated with the closest vectors. + type: boolean + topK: + default: 5 + description: The number of nearest neighbors to find. + example: 5 + type: number + vector: + description: The search vector that will be used to find the nearest neighbors. + example: + - 0.5 + - 0.5 + - 0.5 + items: + type: number + type: array + required: + - vector + type: object + vectorizeIndexQueryV2Response: + properties: + count: + description: Specifies the count of vectors returned by the search + type: integer + matches: + description: Array of vectors matched by the search + items: + properties: + id: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + metadata: + nullable: true + type: object + namespace: + nullable: true + type: string + score: + description: >- + The score of the vector according to the index's distance + metric + type: number + values: + items: + type: number + nullable: true + type: array + type: object + type: array + type: object + vectorizeIndexUpsertResponse: + properties: + count: + description: Specifies the count of the vectors successfully inserted. + example: 768 + type: integer + x-auditable: true + ids: + description: Array of vector identifiers of the vectors successfully inserted. + items: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + type: array + type: object + vectorizeIndexUpsertV2Response: + properties: + mutationId: + $ref: '#/components/schemas/vectorizeMutationUuid' + type: object + vectorizeListMetadataIndexResponse: + example: + metadataIndexes: + - indexType: number + propertyName: some-num-prop + - indexType: string + propertyName: some-str-prop + - indexType: boolean + propertyName: some-bool-prop + properties: + metadataIndexes: + description: Array of indexed metadata properties. + items: + properties: + indexType: + description: Specifies the type of indexed metadata property. + enum: + - string + - number + - boolean + type: string + x-auditable: true + propertyName: + description: Specifies the indexed metadata property. + example: random_metadata_property + type: string + x-auditable: true + type: object + type: array + type: object + vectorizeMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + vectorizeMutationUuid: + description: >- + The unique identifier for the async mutation operation containing the + changeset. + example: 0000aaaa-11bb-22cc-33dd-444444eeeeee + maxLength: 36 + x-auditable: true + type: string + vectorizeUpdateIndexRequest: + properties: + description: + $ref: '#/components/schemas/vectorizeIndexDescription' + required: + - description + type: object + vectorizeVectorIdentifier: + description: Identifier for a Vector + example: some-vector-id-023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 64 + readOnly: true + type: string + vectorizeVectorListItem: + properties: + id: + $ref: '#/components/schemas/vectorizeVectorIdentifier' + required: + - id + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + vectorize_indexes: + id: cloudflare.vectorize.vectorize_indexes + name: vectorize_indexes + title: Vectorize Indexes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1vectorize~1indexes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + vectorize_deprecated_create_vectorize_index: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1vectorize~1indexes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + vectorize_deprecated_delete_vectorize_index: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vectorize_indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/vectorize_indexes/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/vectorize_indexes/methods/vectorize_deprecated_create_vectorize_index + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/vectorize_indexes/methods/vectorize_deprecated_delete_vectorize_index + replace: [] + vectorize: + id: cloudflare.vectorize.vectorize + name: vectorize + title: Vectorize + methods: + update_indexes: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + indexes: + id: cloudflare.vectorize.indexes + name: indexes + title: Indexes + methods: + create_delete_by_ids: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}~1delete-by-ids/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_ids: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}~1get-by-ids/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_insert: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}~1insert/post + response: + mediaType: application/json + openAPIDocKey: '200' + query: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}~1query/post + response: + mediaType: application/json + openAPIDocKey: '200' + upsert: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1indexes~1{index_name}~1upsert/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_delete_by_ids_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1delete_by_ids/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_ids_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1get_by_ids/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_insert_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1insert/post + response: + mediaType: application/json + openAPIDocKey: '200' + query_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1query/post + response: + mediaType: application/json + openAPIDocKey: '200' + upsert_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1upsert/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + v2_indexes: + id: cloudflare.vectorize.v2_indexes + name: v2_indexes + title: V2 Indexes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2_indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/v2_indexes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/v2_indexes/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/v2_indexes/methods/delete' + replace: [] + indexes_info: + id: cloudflare.vectorize.indexes_info + name: indexes_info + title: Indexes Info + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1info/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indexes_info/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + indexes_list: + id: cloudflare.vectorize.indexes_list + name: indexes_list + title: Indexes List + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1list/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indexes_list/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + metadata_index: + id: cloudflare.vectorize.metadata_index + name: metadata_index + title: Metadata Index + methods: + create_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1metadata_index~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + create_delete_v2: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1metadata_index~1delete/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vectorize~1v2~1indexes~1{index_name}~1metadata_index~1list/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.metadataIndexes + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metadata_index/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/vulnerability_scanner.yaml b/providers/src/cloudflare/v00.00.00000/services/vulnerability_scanner.yaml new file mode 100644 index 00000000..27576168 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/vulnerability_scanner.yaml @@ -0,0 +1,2535 @@ +openapi: 3.0.3 +info: + title: vulnerability_scanner API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/vuln_scanner/credential_sets: + get: + description: Returns all credential sets for the account. + operationId: list-credential-sets + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/vulnScannerCredentialSet' + type: array + required: + - success + - errors + - messages + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Credential Sets + tags: + - Credential Sets + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + method: list + post: + description: Creates a new credential set. + operationId: create-credential-set + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerCreateCredentialSetRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredentialSet' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Credential Set + tags: + - Credential Sets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + method: create + /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}: + delete: + description: Deletes a credential set and all of its credentials. + operationId: delete-credential-set + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerEmptyResponse' + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Credential Set + tags: + - Credential Sets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + method: delete + get: + description: Returns a single credential set by ID. + operationId: get-credential-set + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredentialSet' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Credential Set + tags: + - Credential Sets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + method: get + patch: + description: >- + Updates a credential set with only the provided fields; omitted fields + remain unchanged. + operationId: edit-credential-set + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerPatchCredentialSetRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredentialSet' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Credential Set + tags: + - Credential Sets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + method: edit + put: + description: Replaces a credential set. All fields must be provided. + operationId: update-credential-set + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerUpdateCredentialSetRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredentialSet' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Credential Set + tags: + - Credential Sets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + method: update + /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials: + get: + description: Returns all credentials within a credential set. + operationId: list-credentials + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/vulnScannerCredential' + type: array + required: + - success + - errors + - messages + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Credentials + tags: + - Credentials + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + - credentials + method: list + post: + description: Creates a new credential within a credential set. + operationId: create-credential + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerCreateCredentialRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredential' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Credential + tags: + - Credentials + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + - credentials + method: create + /accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}: + delete: + description: Deletes a credential. + operationId: delete-credential + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerEmptyResponse' + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Credential + tags: + - Credentials + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + - description: Credential identifier. + in: path + name: credential_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + - credentials + method: delete + get: + description: Returns a single credential by ID. + operationId: get-credential + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredential' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Credential + tags: + - Credentials + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + - description: Credential identifier. + in: path + name: credential_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + - credentials + method: get + patch: + description: >- + Updates a credential with only the provided fields; omitted fields + remain unchanged. + operationId: edit-credential + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerPatchCredentialRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredential' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Credential + tags: + - Credentials + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + - description: Credential identifier. + in: path + name: credential_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + - credentials + method: edit + put: + description: Replaces a credential. All fields must be provided. + operationId: update-credential + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerUpdateCredentialRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerCredential' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Credential + tags: + - Credentials + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Credential set identifier. + in: path + name: credential_set_id + schema: + format: uuid + type: string + required: true + - description: Credential identifier. + in: path + name: credential_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - credential_sets + - credentials + method: update + /accounts/{account_id}/vuln_scanner/scans: + get: + description: Returns all scans for the account. + operationId: list-scans + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/vulnScannerScan' + type: array + required: + - success + - errors + - messages + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Scans + tags: + - Scans + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - scans + method: list + post: + description: >- + Creates and starts a new vulnerability scan. The response may include + non-fatal warnings in the `messages` array. + operationId: create-scan + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerCreateScanRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerScan' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: >- + Successful response. Check the `messages` array for non-fatal + warnings that arose during scan creation. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Scan + tags: + - Scans + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - scans + method: create + /accounts/{account_id}/vuln_scanner/scans/{scan_id}: + delete: + description: >- + Deletes a scan and all associated data. Only scans in a terminal state + (`finished`, `failed`) may be deleted. Attempting to delete a scan that + is still being created or executed (`created`, `scheduled`, `planning`, + `running`) returns `400`. + operationId: delete-scan + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerDeleteScanResponse' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Scan + tags: + - Scans + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Scan identifier. + in: path + name: scan_id + schema: + format: uuid + type: string + required: true + get: + description: Returns a single scan by ID. + operationId: get-scan + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerScan' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Scan + tags: + - Scans + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Scan identifier. + in: path + name: scan_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - scans + method: get + /accounts/{account_id}/vuln_scanner/target_environments: + get: + description: Returns all target environments for the account. + operationId: list-target-environments + parameters: + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Number of results per page. + in: query + name: per_page + schema: + default: 20 + maximum: 50 + minimum: 5 + type: integer + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/vulnScannerTargetEnvironment' + type: array + required: + - success + - errors + - messages + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Target Environments + tags: + - Target Environments + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - target_environments + method: list + post: + description: Creates a new target environment for the account. + operationId: create-target-environment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerCreateTargetEnvironmentRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerTargetEnvironment' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Target Environment + tags: + - Target Environments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - target_environments + method: create + /accounts/{account_id}/vuln_scanner/target_environments/{target_environment_id}: + delete: + description: Removes a target environment. + operationId: delete-target-environment + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerEmptyResponse' + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Target Environment + tags: + - Target Environments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Target environment identifier. + in: path + name: target_environment_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - target_environments + method: delete + get: + description: Returns a single target environment by ID. + operationId: get-target-environment + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerTargetEnvironment' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Target Environment + tags: + - Target Environments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Target environment identifier. + in: path + name: target_environment_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - target_environments + method: get + patch: + description: >- + Updates a target environment with only the provided fields; omitted + fields remain unchanged. + operationId: edit-target-environment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerPatchTargetEnvironmentRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerTargetEnvironment' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Target Environment + tags: + - Target Environments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Target environment identifier. + in: path + name: target_environment_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - target_environments + method: edit + put: + description: Replaces a target environment. All fields must be provided. + operationId: update-target-environment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerUpdateTargetEnvironmentRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/vulnScannerTargetEnvironment' + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + description: Successful response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/vulnScannerApiResponseCommonFailure' + description: Client error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Target Environment + tags: + - Target Environments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Target environment identifier. + in: path + name: target_environment_id + schema: + format: uuid + type: string + required: true + x-stackql-sdk: + service: vulnerability_scanner + resource_chain: + - target_environments + method: update +components: + schemas: + vulnScannerApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/vulnScannerMessages' + messages: + example: [] + $ref: '#/components/schemas/vulnScannerMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + vulnScannerBolaAssertionKind: + description: >- + Assert that an HTTP status code is within a range, e.g. to assert + success for the 2xx range, or expected failure for the 4xx/5xx range. + properties: + parameters: + $ref: '#/components/schemas/vulnScannerBolaHttpStatusRange' + type: + enum: + - http_status_within_range + type: string + required: + - type + - parameters + type: object + vulnScannerBolaBodyResponse: + description: HTTP response body preview. + type: object + properties: + kind: + enum: + - not_found + type: string + contents: + type: string + truncated: + type: boolean + required: + - kind + vulnScannerBolaCredentialRole: + description: >- + Identifies the role a request was made with. The credential set governs + this role. `owner` is the resource owner, `attacker` attempts to access + resources. + enum: + - owner + - attacker + type: string + vulnScannerBolaCredentialSets: + description: >- + Credential set references for a BOLA scan. The scanner uses the `owner` + credentials for legitimate requests and the `attacker` credentials to + attempt unauthorized access. + properties: + attacker: + description: Credential set ID for the attacker. + format: uuid + type: string + owner: + description: Credential set ID for the resource owner. + format: uuid + type: string + required: + - owner + - attacker + type: object + vulnScannerBolaHttpStatusRange: + description: Range of HTTP status codes. + properties: + max: + description: Maximum (inclusive) status code of the range. + maximum: 65535 + minimum: 0 + type: integer + min: + description: Minimum (inclusive) status code of the range. + maximum: 65535 + minimum: 0 + type: integer + required: + - min + - max + type: object + vulnScannerBolaMethod: + description: HTTP method. + enum: + - GET + - DELETE + - PATCH + - POST + - PUT + type: string + vulnScannerBolaOutcome: + description: >- + Outcome of an assertion. `ok` means the assertion passed, `fail` means + the assertion failed, `inconclusive` means the scanner could not + evaluate the assertion. + enum: + - ok + - fail + - inconclusive + type: string + vulnScannerBolaReport: + description: A BOLA vulnerability scan report, versioned for future evolution. + properties: + report: + $ref: '#/components/schemas/vulnScannerBolaReportV1' + report_schema_version: + description: Version of the report schema. + enum: + - v1 + type: string + required: + - report_schema_version + - report + type: object + vulnScannerBolaReportSummary: + description: Overall report summary. + properties: + verdict: + description: Overall verdict of the vulnerability scan. + $ref: '#/components/schemas/vulnScannerBolaVerdict' + required: + - verdict + type: object + vulnScannerBolaReportV1: + description: Version 1 of the BOLA vulnerability scan report. + properties: + summary: + description: Summary of all steps and findings. + $ref: '#/components/schemas/vulnScannerBolaReportSummary' + tests: + description: List of tests that were run. + items: + $ref: '#/components/schemas/vulnScannerBolaTest' + type: array + required: + - summary + - tests + type: object + vulnScannerBolaTest: + description: Result of a single test. + properties: + preflight_errors: + description: Errors that prevented step execution. + items: + $ref: '#/components/schemas/vulnScannerBolaTestError' + type: array + steps: + description: Steps that were executed. + items: + $ref: '#/components/schemas/vulnScannerBolaTestStep' + type: array + verdict: + description: Verdict of this single test. + $ref: '#/components/schemas/vulnScannerBolaVerdict' + required: + - verdict + - steps + type: object + vulnScannerBolaTestAssertion: + description: Assertion that was made against the received response. + properties: + description: + description: >- + Human-readable description of the assertion, explaining what was + checked. + type: string + kind: + description: Kind of assertion. + $ref: '#/components/schemas/vulnScannerBolaAssertionKind' + observed: + description: Observed value on which the assertion was made. + nullable: true + type: integer + outcome: + description: Outcome of the assertion. + $ref: '#/components/schemas/vulnScannerBolaOutcome' + required: + - description + - kind + - observed + - outcome + type: object + vulnScannerBolaTestCredentialSet: + description: Credential set that was used. + properties: + id: + description: ID of the credential set. + format: uuid + type: string + role: + description: Role of the credential set. + $ref: '#/components/schemas/vulnScannerBolaCredentialRole' + required: + - id + - role + type: object + vulnScannerBolaTestError: + description: Error that occurred during a test. + properties: + description: + description: Human-readable error description. + type: string + error_code: + description: Numeric error code identifying the class of error, if available. + format: uint32 + minimum: 0 + nullable: true + type: integer + required: + - description + type: object + vulnScannerBolaTestRequest: + description: HTTP request that was made. + properties: + body: + description: Request body, if any. + nullable: true + type: object + credential_set: + description: Credential set that was used. + $ref: '#/components/schemas/vulnScannerBolaTestCredentialSet' + header_names: + description: Names of headers that were sent. + items: + type: string + type: array + method: + description: HTTP method. + $ref: '#/components/schemas/vulnScannerBolaMethod' + url: + description: >- + Exact and full URL (including host, query parameters) that was + requested. + format: uri + type: string + variable_captures: + description: Variable captures requested for this step. + items: + $ref: '#/components/schemas/vulnScannerBolaVariableCapture' + type: array + required: + - method + - url + - credential_set + - header_names + - variable_captures + type: object + vulnScannerBolaTestResponse: + description: HTTP response that was received. + properties: + body: + description: HTTP response body. + $ref: '#/components/schemas/vulnScannerBolaBodyResponse' + header_names: + description: Names of headers that were received. + items: + type: string + type: array + status: + description: HTTP status code. + maximum: 65535 + minimum: 0 + type: integer + status_text: + description: HTTP status text, if available for the status code. + nullable: true + type: string + required: + - status + - header_names + - body + type: object + vulnScannerBolaTestStep: + description: A single step in a test. + properties: + assertions: + description: Assertions that were made against the received response. + items: + $ref: '#/components/schemas/vulnScannerBolaTestAssertion' + type: array + errors: + description: >- + Errors the step encountered that may explain absent or incomplete + fields. + items: + $ref: '#/components/schemas/vulnScannerBolaTestError' + type: array + request: + description: HTTP request that was made, if any. + nullable: true + type: object + $ref: '#/components/schemas/vulnScannerBolaTestRequest' + response: + description: HTTP response that was received, if any. + nullable: true + type: object + $ref: '#/components/schemas/vulnScannerBolaTestResponse' + required: + - assertions + type: object + vulnScannerBolaVariableCapture: + description: A variable to capture from the response body. + properties: + json_path: + description: JSONPath expression used for capture, e.g. `"$.id"`. + type: string + name: + description: Variable name, e.g. `"resource_id"`. + type: string + required: + - name + - json_path + type: object + vulnScannerBolaVerdict: + description: >- + A verdict. `ok` means the scan passed, `warning` means the scan detected + issues, `inconclusive` means errors prevented the scanner from reaching + an accurate verdict. + enum: + - ok + - warning + - inconclusive + type: string + vulnScannerCreateBolaScanRequest: + properties: + credential_sets: + $ref: '#/components/schemas/vulnScannerBolaCredentialSets' + open_api: + description: >- + OpenAPI schema definition for the API under test. The scanner uses + this to discover endpoints and construct requests. + type: string + scan_type: + enum: + - bola + type: string + target_environment_id: + description: The target environment to scan. + format: uuid + type: string + required: + - target_environment_id + - scan_type + - open_api + - credential_sets + type: object + vulnScannerCreateCredentialRequest: + properties: + location: + $ref: '#/components/schemas/vulnScannerCredentialLocation' + location_name: + description: Name of the header or cookie where the credential is attached. + example: Authorization + type: string + name: + description: Human-readable name. + example: Admin API key + type: string + value: + description: >- + The credential value (e.g. API key, session token). Write-only. + Never returned in responses. + example: Bearer EXAMPLE_TOKEN + type: string + writeOnly: true + x-sensitive: true + required: + - name + - location + - location_name + - value + type: object + vulnScannerCreateCredentialSetRequest: + properties: + name: + description: Human-readable name. + example: Production API credentials + type: string + required: + - name + type: object + vulnScannerCreateScanRequest: + description: >- + Create a new vulnerability scan. The `scan_type` discriminator selects + the scan variant and its required context fields. + $ref: '#/components/schemas/vulnScannerCreateBolaScanRequest' + vulnScannerCreateTargetEnvironmentRequest: + properties: + description: + description: Optional description. + example: Main production environment + nullable: true + type: string + name: + description: Human-readable name. + example: Production Zone + type: string + target: + $ref: '#/components/schemas/vulnScannerTargetType' + required: + - name + - target + type: object + vulnScannerCredential: + description: >- + A credential attached to API requests during scanning. The credential + `value` is write-only and never returned in responses. + properties: + credential_set_id: + description: Parent credential set identifier. + format: uuid + type: string + x-auditable: true + id: + description: Credential identifier. + format: uuid + type: string + x-auditable: true + location: + $ref: '#/components/schemas/vulnScannerCredentialLocation' + location_name: + description: Name of the header or cookie where the credential is attached. + example: Authorization + type: string + x-auditable: true + name: + description: Human-readable name. + example: Admin API key + type: string + x-auditable: true + required: + - id + - credential_set_id + - name + - location + - location_name + type: object + vulnScannerCredentialLocation: + description: Where the credential is attached in outgoing requests. + enum: + - header + - cookie + type: string + x-auditable: true + vulnScannerCredentialSet: + properties: + id: + description: Credential set identifier. + format: uuid + type: string + x-auditable: true + name: + description: Human-readable name. + example: Production API credentials + type: string + x-auditable: true + required: + - id + - name + type: object + vulnScannerDeleteScanResponse: + description: Successful scan deletion result. + properties: + id: + description: ID of the deleted scan. + format: uuid + type: string + x-auditable: true + required: + - id + type: object + vulnScannerEmptyResponse: + description: >- + Standard response envelope with a `null` result. Operations that produce + no result body return this response. + properties: + errors: + $ref: '#/components/schemas/vulnScannerMessages' + messages: + $ref: '#/components/schemas/vulnScannerMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + type: object + result_info: + nullable: true + type: object + required: + - success + - errors + - messages + type: object + vulnScannerMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + vulnScannerPatchCredentialRequest: + description: >- + Applies a partial update. Only the provided fields change; omitted + fields remain unchanged. + properties: + location: + $ref: '#/components/schemas/vulnScannerCredentialLocation' + location_name: + description: Name of the header or cookie where the credential is attached. + example: Authorization + type: string + name: + description: Human-readable name. + example: Admin API key + type: string + value: + description: The credential value. Write-only. Never returned in responses. + example: Bearer EXAMPLE_TOKEN + type: string + writeOnly: true + x-sensitive: true + type: object + vulnScannerPatchCredentialSetRequest: + description: >- + Applies a partial update. Only the provided fields change; omitted + fields remain unchanged. + properties: + name: + description: Human-readable name. + example: Production API credentials + type: string + type: object + vulnScannerPatchTargetEnvironmentRequest: + description: >- + Applies a partial update. Only the provided fields change; omitted + fields remain unchanged. The `description` field supports three states: + - **omitted**: leave unchanged - **`null`**: clear the description - + **`"value"`**: set to the given string + properties: + description: + description: >- + Optional description. Omit to leave unchanged, set to `null` to + clear, or provide a string to update. + example: Main production environment + nullable: true + type: string + name: + description: Human-readable name. + example: Production Zone + type: string + target: + $ref: '#/components/schemas/vulnScannerTargetType' + type: object + vulnScannerScan: + properties: + id: + description: Scan identifier. + format: uuid + type: string + x-auditable: true + report: + description: >- + Vulnerability report produced after the scan completes. The shape + depends on the scan type. Present only for finished scans. + nullable: true + type: object + $ref: '#/components/schemas/vulnScannerBolaReport' + scan_type: + description: The type of vulnerability scan. + enum: + - bola + type: string + x-auditable: true + status: + description: Current lifecycle status of the scan. + enum: + - created + - scheduled + - planning + - running + - finished + - failed + type: string + x-auditable: true + target_environment_id: + description: The target environment this scan runs against. + format: uuid + type: string + x-auditable: true + required: + - id + - target_environment_id + - scan_type + - status + type: object + vulnScannerTargetEnvironment: + properties: + description: + description: Optional description providing additional context. + example: Main production environment + nullable: true + type: string + id: + description: Target environment identifier. + format: uuid + type: string + x-auditable: true + name: + description: Human-readable name. + example: Production Zone + type: string + x-auditable: true + target: + $ref: '#/components/schemas/vulnScannerTargetType' + required: + - id + - name + - target + type: object + vulnScannerTargetType: + description: >- + Identifies the Cloudflare asset to scan. Uses a `type` discriminator. + Currently the service supports only `zone` targets. + x-auditable: true + $ref: '#/components/schemas/vulnScannerZoneTarget' + vulnScannerUpdateCredentialRequest: + description: Full replacement. Provide all fields. + properties: + location: + $ref: '#/components/schemas/vulnScannerCredentialLocation' + location_name: + description: Name of the header or cookie where the credential is attached. + example: Authorization + type: string + name: + description: Human-readable name. + example: Admin API key + type: string + value: + description: The credential value. Write-only. Never returned in responses. + example: Bearer EXAMPLE_TOKEN + type: string + writeOnly: true + x-sensitive: true + required: + - name + - location + - location_name + - value + type: object + vulnScannerUpdateCredentialSetRequest: + description: Full replacement. Provide all fields. + properties: + name: + description: Human-readable name. + example: Production API credentials + type: string + required: + - name + type: object + vulnScannerUpdateTargetEnvironmentRequest: + description: Full replacement. + properties: + description: + description: Optional description. + example: Main production environment + nullable: true + type: string + name: + description: Human-readable name. + example: Production Zone + type: string + target: + $ref: '#/components/schemas/vulnScannerTargetType' + required: + - name + - target + type: object + vulnScannerZoneTarget: + properties: + type: + enum: + - zone + type: string + zone_tag: + description: Cloudflare zone tag. The zone must belong to the account. + example: d8e8fca2dc0f896fd7cb4cb0031ba249 + maxLength: 32 + type: string + required: + - type + - zone_tag + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + credential_sets: + id: cloudflare.vulnerability_scanner.credential_sets + name: credential_sets + title: Credential Sets + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credential_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/credential_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/credential_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/credential_sets/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/credential_sets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/credential_sets/methods/update' + credentials: + id: cloudflare.vulnerability_scanner.credentials + name: credentials + title: Credentials + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}~1credentials/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}~1credentials/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}~1credentials~1{credential_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}~1credentials~1{credential_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}~1credentials~1{credential_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1credential_sets~1{credential_set_id}~1credentials~1{credential_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/credentials/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/credentials/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/credentials/methods/update' + scans: + id: cloudflare.vulnerability_scanner.scans + name: scans + title: Scans + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1vuln_scanner~1scans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1vuln_scanner~1scans/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_scan: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1scans~1{scan_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1scans~1{scan_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scans/methods/get' + - $ref: '#/components/x-stackQL-resources/scans/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scans/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/scans/methods/delete_scan' + replace: [] + target_environments: + id: cloudflare.vulnerability_scanner.target_environments + name: target_environments + title: Target Environments + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1target_environments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1target_environments/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1target_environments~1{target_environment_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1target_environments~1{target_environment_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1target_environments~1{target_environment_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1vuln_scanner~1target_environments~1{target_environment_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/target_environments/methods/get' + - $ref: '#/components/x-stackQL-resources/target_environments/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/target_environments/methods/create + update: + - $ref: '#/components/x-stackQL-resources/target_environments/methods/edit' + delete: + - $ref: >- + #/components/x-stackQL-resources/target_environments/methods/delete + replace: + - $ref: >- + #/components/x-stackQL-resources/target_environments/methods/update diff --git a/providers/src/cloudflare/v00.00.00000/services/waf.yaml b/providers/src/cloudflare/v00.00.00000/services/waf.yaml deleted file mode 100644 index 7d894a01..00000000 --- a/providers/src/cloudflare/v00.00.00000/services/waf.yaml +++ /dev/null @@ -1,1521 +0,0 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: WAF overrides - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - waf - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - override_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - allOf: - - $ref: '#/components/schemas/override' - - required: - - id - - paused - - urls - - priority - type: object - type: array - required: - - result - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - override: - properties: - description: - $ref: '#/components/schemas/overrides_components-schemas-description' - groups: - $ref: '#/components/schemas/groups' - id: - $ref: '#/components/schemas/overrides_components-schemas-id' - paused: - $ref: '#/components/schemas/schemas-paused' - priority: - $ref: '#/components/schemas/overrides_components-schemas-priority' - rewrite_action: - $ref: '#/components/schemas/rewrite_action' - rules: - $ref: '#/components/schemas/schemas-rules' - urls: - $ref: '#/components/schemas/urls' - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - overrides_components-schemas-description: - description: An informative summary of the current URI-based WAF override. - example: Enable Cloudflare Magento ruleset for shop.example.com - maxLength: 1024 - nullable: true - type: string - groups: - additionalProperties: true - description: 'An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually `default` or `disable`). When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.' - example: - ea8687e59929c1fd05ba97574ad43f77: default - type: object - overrides_components-schemas-id: - description: The unique identifier of the WAF override. - example: de677e5818985db1285d0e80225f06e5 - maxLength: 32 - readOnly: true - type: string - schemas-paused: - description: 'When true, indicates that the WAF package is currently paused.' - type: boolean - overrides_components-schemas-priority: - description: The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides. - example: 1 - maximum: 1000000000 - minimum: -1000000000 - type: number - rewrite_action: - description: 'Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.' - properties: - block: - $ref: '#/components/schemas/waf_rewrite_action' - challenge: - example: block - default: - example: block - disable: - $ref: '#/components/schemas/waf_rewrite_action' - simulate: - example: disable - type: object - schemas-rules: - additionalProperties: - allOf: - - $ref: '#/components/schemas/waf_action' - example: default - description: 'An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.' - example: - '100015': disable - type: object - urls: - description: 'The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.' - items: - example: shop.example.com/* - type: string - type: array - waf_rewrite_action: - description: The WAF rule action to apply. - enum: - - challenge - - block - - simulate - - disable - - default - waf_action: - description: The WAF rule action to apply. - enum: - - challenge - - block - - simulate - - disable - - default - override_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/override' - required: - - result - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - package_response_collection: - anyOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/package' - type: array - package: - oneOf: - - $ref: '#/components/schemas/package_definition' - - $ref: '#/components/schemas/anomaly_package' - type: object - package_definition: - properties: - description: - $ref: '#/components/schemas/package_components-schemas-description' - detection_mode: - $ref: '#/components/schemas/detection_mode' - id: - $ref: '#/components/schemas/package_components-schemas-identifier' - name: - $ref: '#/components/schemas/package_components-schemas-name' - status: - $ref: '#/components/schemas/package_components-schemas-status' - zone_id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - - name - - description - - detection_mode - - zone_id - title: Traditional WAF package - anomaly_package: - allOf: - - $ref: '#/components/schemas/package_definition' - - properties: - action_mode: - $ref: '#/components/schemas/action_mode' - description: - $ref: '#/components/schemas/anomaly_description' - detection_mode: - $ref: '#/components/schemas/anomaly_detection_mode' - name: - $ref: '#/components/schemas/anomaly_name' - sensitivity: - $ref: '#/components/schemas/sensitivity' - required: - - id - - name - - description - - zone_id - - detection_mode - - sensitivity - - action_mode - title: Anomaly detection WAF package (OWASP) - package_components-schemas-description: - description: A summary of the purpose/function of the WAF package. - example: 'null' - readOnly: true - type: string - detection_mode: - description: 'The mode that defines how rules within the package are evaluated during the course of a request. When a package uses anomaly detection mode (`anomaly` value), each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined in the WAF package, the action configured in the package will be performed. Traditional detection mode (`traditional` value) will decide the action to take when it is triggered by the request. If multiple rules are triggered, the action providing the highest protection will be applied (for example, a ''block'' action will win over a ''challenge'' action).' - enum: - - anomaly - - traditional - example: traditional - readOnly: true - type: string - package_components-schemas-identifier: - description: The unique identifier of a WAF package. - example: a25a9a7e9c00afc1fb2e0245519d725b - maxLength: 32 - readOnly: true - type: string - package_components-schemas-name: - description: The name of the WAF package. - example: USER - readOnly: true - type: string - package_components-schemas-status: - default: active - description: 'When set to `active`, indicates that the WAF package will be applied to the zone.' - enum: - - active - readOnly: true - type: string - action_mode: - default: challenge - description: The default action performed by the rules in the WAF package. - enum: - - simulate - - block - - challenge - type: string - anomaly_description: - description: A summary of the purpose/function of the WAF package. - example: Covers OWASP Top 10 vulnerabilities and more. - readOnly: true - type: string - anomaly_detection_mode: - description: 'When a WAF package uses anomaly detection, each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined on the WAF package, the action defined on the package will be taken.' - example: anomaly - readOnly: true - type: string - anomaly_name: - description: The name of the WAF package. - example: OWASP ModSecurity Core Rule Set - readOnly: true - type: string - sensitivity: - default: high - description: The sensitivity of the WAF package. - enum: - - high - - medium - - low - - 'off' - type: string - package_response_single: - oneOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - rule_group_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-group' - type: array - schemas-group: - allOf: - - $ref: '#/components/schemas/group' - - properties: - allowed_modes: - $ref: '#/components/schemas/allowed_modes' - mode: - $ref: '#/components/schemas/components-schemas-mode' - required: - - id - - name - - description - - mode - - rules_count - group: - properties: - description: - $ref: '#/components/schemas/group_components-schemas-description' - id: - $ref: '#/components/schemas/group_components-schemas-identifier' - modified_rules_count: - $ref: '#/components/schemas/modified_rules_count' - name: - $ref: '#/components/schemas/group_components-schemas-name' - package_id: - $ref: '#/components/schemas/package_components-schemas-identifier' - rules_count: - $ref: '#/components/schemas/rules_count' - type: object - allowed_modes: - description: The available states for the rule group. - example: - - 'on' - - 'off' - items: - $ref: '#/components/schemas/components-schemas-mode' - readOnly: true - type: array - components-schemas-mode: - default: 'on' - description: 'The state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable.' - enum: - - 'on' - - 'off' - type: string - group_components-schemas-description: - description: An informative summary of what the rule group does. - example: Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks - nullable: true - readOnly: true - type: string - group_components-schemas-identifier: - description: The unique identifier of the rule group. - example: de677e5818985db1285d0e80225f06e5 - maxLength: 32 - readOnly: true - type: string - modified_rules_count: - default: 0 - description: The number of rules within the group that have been modified from their default configuration. - example: 2 - readOnly: true - type: number - group_components-schemas-name: - description: The name of the rule group. - example: Project Honey Pot - readOnly: true - type: string - rules_count: - default: 0 - description: The number of rules in the current rule group. - example: 10 - readOnly: true - type: number - rule_group_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - rule_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/components-schemas-rule' - type: array - components-schemas-rule: - oneOf: - - $ref: '#/components/schemas/anomaly_rule' - - $ref: '#/components/schemas/traditional_deny_rule' - - $ref: '#/components/schemas/traditional_allow_rule' - type: object - anomaly_rule: - allOf: - - $ref: '#/components/schemas/rule_components-schemas-base-2' - - properties: - allowed_modes: - $ref: '#/components/schemas/allowed_modes_anomaly' - mode: - $ref: '#/components/schemas/mode_anomaly' - description: 'When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the ''sensitivity'' property of the WAF package.' - required: - - id - - description - - priority - - allowed_modes - - mode - - group - - package_id - title: Anomaly detection WAF rule - traditional_deny_rule: - allOf: - - $ref: '#/components/schemas/rule_components-schemas-base-2' - - properties: - allowed_modes: - $ref: '#/components/schemas/allowed_modes_deny_traditional' - default_mode: - $ref: '#/components/schemas/default_mode' - mode: - $ref: '#/components/schemas/mode_deny_traditional' - description: 'When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A ''deny'' rule will immediately respond to the request based on the configured rule action/mode (for example, ''block'') and no other rules will be processed.' - required: - - id - - description - - priority - - allowed_modes - - default_mode - - mode - - group - - package_id - title: Traditional (deny) WAF rule - traditional_allow_rule: - allOf: - - $ref: '#/components/schemas/rule_components-schemas-base-2' - - properties: - allowed_modes: - $ref: '#/components/schemas/allowed_modes_allow_traditional' - mode: - $ref: '#/components/schemas/mode_allow_traditional' - description: 'When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An ''allow'' rule will immediately allow the request and no other rules will be processed.' - required: - - id - - description - - priority - - allowed_modes - - default_mode - - mode - - group - - package_id - title: Traditional (allow) WAF rule - rule_components-schemas-base-2: - allOf: - - $ref: '#/components/schemas/rule_components-schemas-base' - allowed_modes_anomaly: - description: Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules. - example: - - 'on' - - 'off' - items: - $ref: '#/components/schemas/mode_anomaly' - readOnly: true - type: array - mode_anomaly: - description: 'When set to `on`, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.' - enum: - - 'on' - - 'off' - example: 'on' - type: string - allowed_modes_deny_traditional: - description: The list of possible actions of the WAF rule when it is triggered. - example: - - default - - disable - - simulate - - block - - challenge - items: - $ref: '#/components/schemas/mode_deny_traditional' - readOnly: true - type: array - default_mode: - description: The default action/mode of a rule. - enum: - - disable - - simulate - - block - - challenge - example: block - readOnly: true - mode_deny_traditional: - description: The action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules. - enum: - - default - - disable - - simulate - - block - - challenge - example: block - type: string - allowed_modes_allow_traditional: - description: Defines the available modes for the current WAF rule. - example: - - 'on' - - 'off' - items: - $ref: '#/components/schemas/mode_allow_traditional' - readOnly: true - type: array - mode_allow_traditional: - description: 'When set to `on`, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules.' - enum: - - 'on' - - 'off' - example: 'on' - type: string - rule_components-schemas-base: - properties: - description: - $ref: '#/components/schemas/rule_components-schemas-description' - group: - description: The rule group to which the current WAF rule belongs. - properties: - id: - $ref: '#/components/schemas/group_components-schemas-identifier' - name: - $ref: '#/components/schemas/group_components-schemas-name' - readOnly: true - type: object - id: - $ref: '#/components/schemas/rule_components-schemas-identifier-2' - package_id: - $ref: '#/components/schemas/package_components-schemas-identifier' - priority: - $ref: '#/components/schemas/rule_components-schemas-priority' - rule_components-schemas-description: - description: The public description of the WAF rule. - example: SQL injection prevention for SELECT statements - readOnly: true - type: string - rule_components-schemas-identifier-2: - description: The unique identifier of the WAF rule. - example: f939de3be84e66e757adcdcb87908023 - maxLength: 32 - readOnly: true - type: string - rule_components-schemas-priority: - description: The order in which the individual WAF rule is executed within its rule group. - readOnly: true - type: string - rule_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_firewall_overrides: - id: cloudflare.waf.zones_firewall_overrides - name: zones_firewall_overrides - title: Zones Firewall Overrides - methods: - overrides_list_waf_overrides: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1overrides/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _overrides_list_waf_overrides: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1overrides/get' - response: - mediaType: application/json - openAPIDocKey: '200' - overrides_create_a_waf_override: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1overrides/post' - response: - mediaType: application/json - openAPIDocKey: '200' - overrides_delete_a_waf_override: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1overrides~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - overrides_get_a_waf_override: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1overrides~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _overrides_get_a_waf_override: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1overrides~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - overrides_update_waf_override: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1overrides~1{id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_firewall_overrides/methods/overrides_list_waf_overrides' - - $ref: '#/components/x-stackQL-resources/zones_firewall_overrides/methods/overrides_get_a_waf_override' - insert: - - $ref: '#/components/x-stackQL-resources/zones_firewall_overrides/methods/overrides_create_a_waf_override' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_firewall_overrides/methods/overrides_delete_a_waf_override' - zones_firewall_packages: - id: cloudflare.waf.zones_firewall_packages - name: zones_firewall_packages - title: Zones Firewall Packages - methods: - packages_list_waf_packages: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _packages_list_waf_packages: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages/get' - response: - mediaType: application/json - openAPIDocKey: '200' - packages_get_a_waf_package: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _packages_get_a_waf_package: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - packages_update_a_waf_package: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_firewall_packages/methods/packages_list_waf_packages' - - $ref: '#/components/x-stackQL-resources/zones_firewall_packages/methods/packages_get_a_waf_package' - insert: [] - update: [] - delete: [] - zones_firewall_packages_groups: - id: cloudflare.waf.zones_firewall_packages_groups - name: zones_firewall_packages_groups - title: Zones Firewall Packages Groups - methods: - rule_groups_list_waf_rule_groups: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{package_identifier}~1groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _rule_groups_list_waf_rule_groups: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{package_identifier}~1groups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - rule_groups_get_a_waf_rule_group: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{package_identifier}~1groups~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _rule_groups_get_a_waf_rule_group: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{package_identifier}~1groups~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - rule_groups_update_a_waf_rule_group: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1waf~1packages~1{package_identifier}~1groups~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_firewall_packages_groups/methods/rule_groups_list_waf_rule_groups' - - $ref: '#/components/x-stackQL-resources/zones_firewall_packages_groups/methods/rule_groups_get_a_waf_rule_group' - insert: [] - update: [] - delete: [] - zones_firewall_packages_rules: - id: cloudflare.waf.zones_firewall_packages_rules - name: zones_firewall_packages_rules - title: Zones Firewall Packages Rules - methods: - rules_list_waf_rules: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _rules_list_waf_rules: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - rules_get_a_waf_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _rules_get_a_waf_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - rules_update_a_waf_rule: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1firewall~1waf~1packages~1{package_id}~1rules~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_firewall_packages_rules/methods/rules_list_waf_rules' - - $ref: '#/components/x-stackQL-resources/zones_firewall_packages_rules/methods/rules_get_a_waf_rule' - insert: [] - update: [] - delete: [] -paths: - '/zones/{zone_identifier}/firewall/waf/overrides': - get: - description: Fetches the URI-based WAF overrides in a zone. - operationId: waf-overrides-list-waf-overrides - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/override_response_collection' - description: List WAF overrides response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/override_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List WAF overrides response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List WAF overrides - tags: - - WAF overrides - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - post: - description: Creates a URI-based WAF override for a zone. - operationId: waf-overrides-create-a-waf-override - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - urls - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/override_response_single' - description: Create a WAF override response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/override_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a WAF override response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a WAF override - tags: - - WAF overrides - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/firewall/waf/overrides/{id}': - delete: - description: Deletes an existing URI-based WAF override. - operationId: waf-overrides-delete-a-waf-override - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/overrides_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - id: - $ref: '#/components/schemas/overrides_components-schemas-id' - type: object - type: object - description: Delete a WAF override response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - id: - $ref: '#/components/schemas/overrides_components-schemas-id' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a WAF override response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a WAF override - tags: - - WAF overrides - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - get: - description: Fetches the details of a URI-based WAF override. - operationId: waf-overrides-get-a-waf-override - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/overrides_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/override_response_single' - description: Get a WAF override response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/override_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a WAF override response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a WAF override - tags: - - WAF overrides - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - put: - description: Updates an existing URI-based WAF override. - operationId: waf-overrides-update-waf-override - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/overrides_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - - urls - - rules - - rewrite_action - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/override_response_single' - description: Update WAF override response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/override_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update WAF override response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update WAF override - tags: - - WAF overrides - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/firewall/waf/packages': - get: - description: Fetches WAF packages for a zone. - operationId: waf-packages-list-waf-packages - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/package_response_collection' - description: List WAF packages response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/package_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List WAF packages response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List WAF packages - tags: - - WAF packages - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/firewall/waf/packages/{identifier}': - get: - description: Fetches the details of a WAF package. - operationId: waf-packages-get-a-waf-package - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/package_response_single' - description: Get a WAF package response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/package_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a WAF package response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a WAF package - tags: - - WAF packages - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - patch: - description: Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package. - operationId: waf-packages-update-a-waf-package - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - action_mode: - $ref: '#/components/schemas/action_mode' - sensitivity: - $ref: '#/components/schemas/sensitivity' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/package_response_single' - - properties: - result: - $ref: '#/components/schemas/anomaly_package' - description: Update a WAF package response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/package_response_single' - - properties: - result: - $ref: '#/components/schemas/anomaly_package' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a WAF package response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a WAF package - tags: - - WAF packages - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups': - get: - description: Fetches the WAF rule groups in a WAF package. - operationId: waf-rule-groups-list-waf-rule-groups - parameters: - - in: path - name: package_identifier - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_group_response_collection' - description: List WAF rule groups response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_group_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List WAF rule groups response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List WAF rule groups - tags: - - WAF rule groups - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups/{identifier}': - get: - description: Fetches the details of a WAF rule group. - operationId: waf-rule-groups-get-a-waf-rule-group - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/group_components-schemas-identifier' - - in: path - name: package_identifier - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_group_response_single' - description: Get a WAF rule group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_group_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a WAF rule group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a WAF rule group - tags: - - WAF rule groups - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - patch: - description: Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group. - operationId: waf-rule-groups-update-a-waf-rule-group - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/group_components-schemas-identifier' - - in: path - name: package_identifier - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - mode: - $ref: '#/components/schemas/components-schemas-mode' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_group_response_single' - description: Update a WAF rule group response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_group_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a WAF rule group response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a WAF rule group - tags: - - WAF rule groups - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_id}/firewall/waf/packages/{package_id}/rules': - get: - description: Fetches WAF rules in a WAF package. - operationId: waf-rules-list-waf-rules - parameters: - - in: path - name: package_id - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_response_collection' - description: List WAF rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List WAF rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List WAF rules - tags: - - WAF rules - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}': - get: - description: Fetches the details of a WAF rule in a WAF package. - operationId: waf-rules-get-a-waf-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rule_components-schemas-identifier-2' - - in: path - name: package_id - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rule_response_single' - description: Get a WAF rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a WAF rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a WAF rule - tags: - - WAF rules - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - patch: - description: Updates a WAF rule. You can only update the mode/action of the rule. - operationId: waf-rules-update-a-waf-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rule_components-schemas-identifier-2' - - in: path - name: package_id - required: true - schema: - $ref: '#/components/schemas/package_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - mode: - description: The mode/action of the rule when triggered. You must use a value from the `allowed_modes` array of the current rule. - enum: - - default - - disable - - simulate - - block - - challenge - - 'on' - - 'off' - example: 'on' - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rule_response_single' - - properties: - result: - oneOf: - - $ref: '#/components/schemas/anomaly_rule' - - $ref: '#/components/schemas/traditional_deny_rule' - - $ref: '#/components/schemas/traditional_allow_rule' - description: Update a WAF rule response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/rule_response_single' - - properties: - result: - oneOf: - - $ref: '#/components/schemas/anomaly_rule' - - $ref: '#/components/schemas/traditional_deny_rule' - - $ref: '#/components/schemas/traditional_allow_rule' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a WAF rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a WAF rule - tags: - - WAF rules - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true diff --git a/providers/src/cloudflare/v00.00.00000/services/waiting_rooms.yaml b/providers/src/cloudflare/v00.00.00000/services/waiting_rooms.yaml index 74c37189..fc16fca6 100644 --- a/providers/src/cloudflare/v00.00.00000/services/waiting_rooms.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/waiting_rooms.yaml @@ -1,1392 +1,1103 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Waiting Room - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - waiting_rooms + title: waiting_rooms API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - waitingroom_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/waitingroom' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - waitingroom: - properties: - cookie_attributes: - $ref: '#/components/schemas/cookie_attributes' - created_on: - $ref: '#/components/schemas/timestamp' - custom_page_html: - $ref: '#/components/schemas/custom_page_html' - default_template_language: - $ref: '#/components/schemas/default_template_language' - description: - $ref: '#/components/schemas/waitingroom_components-schemas-description' - disable_session_renewal: - $ref: '#/components/schemas/disable_session_renewal' - host: - $ref: '#/components/schemas/components-schemas-host' - id: - $ref: '#/components/schemas/waiting_room_id' - json_response_enabled: - $ref: '#/components/schemas/json_response_enabled' - modified_on: - $ref: '#/components/schemas/timestamp' - name: - $ref: '#/components/schemas/waitingroom_components-schemas-name' - new_users_per_minute: - $ref: '#/components/schemas/new_users_per_minute' - next_event_prequeue_start_time: - $ref: '#/components/schemas/next_event_prequeue_start_time' - next_event_start_time: - $ref: '#/components/schemas/next_event_start_time' - path: - $ref: '#/components/schemas/schemas-path' - queue_all: - $ref: '#/components/schemas/queue_all' - queueing_method: - $ref: '#/components/schemas/queueing_method' - session_duration: - $ref: '#/components/schemas/schemas-session_duration' - suspended: - $ref: '#/components/schemas/schemas-suspended' - total_active_users: - $ref: '#/components/schemas/total_active_users' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/waiting_rooms: + get: + description: Lists waiting rooms for account or zone. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - cookie_attributes: - description: 'Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user''s status in the waiting room, such as queue position.' - properties: - samesite: - default: auto - description: 'Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`.' - enum: - - auto - - lax - - none - - strict - example: auto - type: string - secure: - default: auto - description: 'Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled.' - enum: - - auto - - always - - never - example: auto - type: string - type: object - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - custom_page_html: - default: '' - description: |- - Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: - 1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. - 2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: - 3. {{`waitTime`}} Number of minutes of estimated wait for a user. - 4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). - 5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). - 6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue. - - To view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls. - example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}' - type: string - default_template_language: - default: en-US - description: 'The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used.' - enum: - - en-US - - es-ES - - de-DE - - fr-FR - - it-IT - - ja-JP - - ko-KR - - pt-BR - - zh-CN - - zh-TW - - nl-NL - - pl-PL - - id-ID - - tr-TR - - ar-EG - example: es-ES - type: string - waitingroom_components-schemas-description: - default: '' - description: A note that you can use to add more details about the waiting room. - example: Production - DO NOT MODIFY - type: string - disable_session_renewal: - default: false - description: 'Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user''s session cookie will be automatically renewed on every request.' - example: false - type: boolean - components-schemas-host: - description: 'The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique.' - example: shop.example.com - type: string - waiting_room_id: - example: 699d98642c564d2e855e9661899b7252 - json_response_enabled: - default: false - description: "Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:\n1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).\n2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.\n3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.\n4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).\n5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.\n6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).\n7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.\n8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.\n10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.\n11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time —\_it will always be **zero**.\n12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.\n13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.\n14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.\n15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.\n16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.\n17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeue_start_time`, `event_start_time`, and `event_end_time` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.\n18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.\n19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.\n20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.\n21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.\n22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.\n23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.\n\nAn example cURL to a waiting room could be:\n\n\tcurl -X GET \"https://example.com/waitingroom\" \\\n\t\t-H \"Accept: application/json\"\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 0,\n\t\t\t\"waitTime50Percentile\": 0,\n\t\t\t\"waitTime75Percentile\": 0,\n\t\t\t\"waitTimeFormatted\": \"10 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"fifo\",\n\t\t\t\"isFIFOQueue\": true,\n\t\t\t\"isRandomQueue\": false,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": false,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 0,\n\t\t\t\"timeUntilEventEndFormatted\": \"unavailable\",\n\t\t\t\"shuffleAtEventStart\": false\n\t\t}\n\t}\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 5,\n\t\t\t\"waitTime50Percentile\": 10,\n\t\t\t\"waitTime75Percentile\": 15,\n\t\t\t\"waitTimeFormatted\": \"5 minutes to 15 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"random\",\n\t\t\t\"isFIFOQueue\": false,\n\t\t\t\"isRandomQueue\": true,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": true,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 15,\n\t\t\t\"timeUntilEventEndFormatted\": \"15 minutes\",\n\t\t\t\"shuffleAtEventStart\": true\n\t\t}\n\t}." - example: false - type: boolean - waitingroom_components-schemas-name: - description: 'A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.' - example: production_webinar - type: string - new_users_per_minute: - description: Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. - maximum: 2147483647 - minimum: 200 - type: integer - next_event_prequeue_start_time: - description: An ISO 8601 timestamp that marks when the next event will begin queueing. - example: '2021-09-28T15:00:00.000Z' - nullable: true - type: string - next_event_start_time: - description: An ISO 8601 timestamp that marks when the next event will start. - example: '2021-09-28T15:00:00.000Z' - nullable: true - type: string - schemas-path: - default: / - description: 'Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.' - example: /shop/checkout - type: string - queue_all: - default: false - description: 'If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.' - example: true - type: boolean - queueing_method: - default: fifo - description: |- - Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: - 1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived. - 2. `random`: Random queue where customers gain access randomly, regardless of arrival time. - 3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa. - 4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**. - enum: - - fifo - - random - - passthrough - - reject - example: fifo - type: string - schemas-session_duration: - default: 5 - description: 'Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.' - maximum: 30 - minimum: 1 - type: integer - schemas-suspended: - default: false - description: 'Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room.' - type: boolean - total_active_users: - description: Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. - maximum: 2147483647 - minimum: 200 - type: integer - query_waitingroom: - properties: - cookie_attributes: - $ref: '#/components/schemas/cookie_attributes' - custom_page_html: - $ref: '#/components/schemas/custom_page_html' - default_template_language: - $ref: '#/components/schemas/default_template_language' - description: - $ref: '#/components/schemas/waitingroom_components-schemas-description' - disable_session_renewal: - $ref: '#/components/schemas/disable_session_renewal' - host: - $ref: '#/components/schemas/components-schemas-host' - json_response_enabled: - $ref: '#/components/schemas/json_response_enabled' - name: - $ref: '#/components/schemas/waitingroom_components-schemas-name' - new_users_per_minute: - $ref: '#/components/schemas/new_users_per_minute' - path: - $ref: '#/components/schemas/schemas-path' - queue_all: - $ref: '#/components/schemas/queue_all' - queueing_method: - $ref: '#/components/schemas/queueing_method' - session_duration: - $ref: '#/components/schemas/schemas-session_duration' - suspended: - $ref: '#/components/schemas/schemas-suspended' - total_active_users: - $ref: '#/components/schemas/total_active_users' - required: - - name - - host - - new_users_per_minute - - total_active_users - type: object - waitingroom_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/waitingroom' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - query_preview: - properties: - custom_html: - $ref: '#/components/schemas/custom_page_html' - required: - - custom_html - type: object - schemas-preview_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - preview_url: - $ref: '#/components/schemas/preview_url' - type: object - preview_url: - description: URL where the custom waiting room page can temporarily be previewed. - example: 'http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb' - type: string - waiting_room_id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/waiting_room_id' - type: object - event_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/event_result' - type: array - event_result: - properties: - created_on: - $ref: '#/components/schemas/timestamp' - custom_page_html: - $ref: '#/components/schemas/event_custom_page_html' - description: - $ref: '#/components/schemas/event_description' - disable_session_renewal: - $ref: '#/components/schemas/event_disable_session_renewal' - event_end_time: - $ref: '#/components/schemas/event_end_time' - event_start_time: - $ref: '#/components/schemas/event_start_time' - id: - $ref: '#/components/schemas/event_id' - modified_on: - $ref: '#/components/schemas/timestamp' - name: - $ref: '#/components/schemas/event_name' - new_users_per_minute: - $ref: '#/components/schemas/event_new_users_per_minute' - prequeue_start_time: - $ref: '#/components/schemas/event_prequeue_start_time' - queueing_method: - $ref: '#/components/schemas/event_queueing_method' - session_duration: - $ref: '#/components/schemas/event_session_duration' - shuffle_at_event_start: - $ref: '#/components/schemas/event_shuffle_at_event_start' - suspended: - $ref: '#/components/schemas/event_suspended' - total_active_users: - $ref: '#/components/schemas/event_total_active_users' - type: object - event_custom_page_html: - description: 'If set, the event will override the waiting room''s `custom_page_html` property while it is active. If null, the event will inherit it.' - example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}' - nullable: true - type: string - event_description: - default: '' - description: A note that you can use to add more details about the event. - example: Production event - DO NOT MODIFY - type: string - event_disable_session_renewal: - description: 'If set, the event will override the waiting room''s `disable_session_renewal` property while it is active. If null, the event will inherit it.' - nullable: true - type: boolean - event_end_time: - description: An ISO 8601 timestamp that marks the end of the event. - example: '2021-09-28T17:00:00.000Z' - type: string - event_start_time: - description: 'An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event''s configuration. The start time must be at least one minute before `event_end_time`.' - example: '2021-09-28T15:30:00.000Z' - type: string - event_id: - example: 25756b2dfe6e378a06b033b670413757 - event_name: - description: 'A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.' - example: production_webinar_event - type: string - event_new_users_per_minute: - description: 'If set, the event will override the waiting room''s `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event''s `total_active_users` property is also set.' - maximum: 2147483647 - minimum: 200 - nullable: true - type: integer - event_prequeue_start_time: - description: An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. - example: '2021-09-28T15:00:00.000Z' - nullable: true - type: string - event_queueing_method: - description: 'If set, the event will override the waiting room''s `queueing_method` property while it is active. If null, the event will inherit it.' - example: random - nullable: true - type: string - event_session_duration: - description: 'If set, the event will override the waiting room''s `session_duration` property while it is active. If null, the event will inherit it.' - maximum: 30 - minimum: 1 - nullable: true - type: integer - event_shuffle_at_event_start: - default: false - description: 'If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.' - type: boolean - event_suspended: - default: false - description: 'Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.' - type: boolean - event_total_active_users: - description: 'If set, the event will override the waiting room''s `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event''s `new_users_per_minute` property is also set.' - maximum: 2147483647 - minimum: 200 - nullable: true - type: integer - query_event: - properties: - custom_page_html: - $ref: '#/components/schemas/event_custom_page_html' - description: - $ref: '#/components/schemas/event_description' - disable_session_renewal: - $ref: '#/components/schemas/event_disable_session_renewal' - event_end_time: - $ref: '#/components/schemas/event_end_time' - event_start_time: - $ref: '#/components/schemas/event_start_time' - name: - $ref: '#/components/schemas/event_name' - new_users_per_minute: - $ref: '#/components/schemas/event_new_users_per_minute' - prequeue_start_time: - $ref: '#/components/schemas/event_prequeue_start_time' - queueing_method: - $ref: '#/components/schemas/event_queueing_method' - session_duration: - $ref: '#/components/schemas/event_session_duration' - shuffle_at_event_start: - $ref: '#/components/schemas/event_shuffle_at_event_start' - suspended: - $ref: '#/components/schemas/event_suspended' - total_active_users: - $ref: '#/components/schemas/event_total_active_users' - required: - - name - - event_start_time - - event_end_time - type: object - event_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/event_result' - event_id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/event_id' - type: object - event_details_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/event_details_result' - event_details_result: - properties: - created_on: - $ref: '#/components/schemas/timestamp' - custom_page_html: - $ref: '#/components/schemas/event_details_custom_page_html' - description: - $ref: '#/components/schemas/event_description' - disable_session_renewal: - $ref: '#/components/schemas/event_details_disable_session_renewal' - event_end_time: - $ref: '#/components/schemas/event_end_time' - event_start_time: - $ref: '#/components/schemas/event_start_time' - id: - $ref: '#/components/schemas/event_id' - modified_on: - $ref: '#/components/schemas/timestamp' - name: - $ref: '#/components/schemas/event_name' - new_users_per_minute: - $ref: '#/components/schemas/event_details_new_users_per_minute' - prequeue_start_time: - $ref: '#/components/schemas/event_prequeue_start_time' - queueing_method: - $ref: '#/components/schemas/event_details_queueing_method' - session_duration: - $ref: '#/components/schemas/event_details_session_duration' - shuffle_at_event_start: - $ref: '#/components/schemas/event_shuffle_at_event_start' - suspended: - $ref: '#/components/schemas/event_suspended' - total_active_users: - $ref: '#/components/schemas/event_details_total_active_users' - type: object - event_details_custom_page_html: - example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}' - type: string - event_details_disable_session_renewal: - example: false - type: boolean - event_details_new_users_per_minute: - type: integer - event_details_queueing_method: - example: random - type: string - event_details_session_duration: - type: integer - event_details_total_active_users: - type: integer - schemas-rules_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/rule_result' - type: array - rule_result: - properties: - action: - $ref: '#/components/schemas/rule_action' - description: - $ref: '#/components/schemas/rule_description' - enabled: - $ref: '#/components/schemas/rule_enabled' - expression: - $ref: '#/components/schemas/rule_expression' - id: - $ref: '#/components/schemas/rule_id' - last_updated: - $ref: '#/components/schemas/timestamp' - version: - $ref: '#/components/schemas/rule_version' - type: object - rule_action: - description: The action to take when the expression matches. - enum: - - bypass_waiting_room - example: bypass_waiting_room - type: string - rule_description: - default: '' - description: The description of the rule. - example: allow all traffic from 10.20.30.40 - type: string - rule_enabled: - default: true - description: 'When set to true, the rule is enabled.' - example: true - type: boolean - rule_expression: - description: Criteria defining when there is a match for the current rule. - example: 'ip.src in {10.20.30.40}' - type: string - rule_id: - description: The ID of the rule. - example: 25756b2dfe6e378a06b033b670413757 - type: string - rule_version: - description: The version of the rule. - example: '1' - type: string - create_rule: - properties: - action: - $ref: '#/components/schemas/rule_action' - description: - $ref: '#/components/schemas/rule_description' - enabled: - $ref: '#/components/schemas/rule_enabled' - expression: - $ref: '#/components/schemas/rule_expression' - required: - - action - - expression - update_rules: - items: - $ref: '#/components/schemas/create_rule' - type: array - patch_rule: - properties: - action: - $ref: '#/components/schemas/rule_action' - description: - $ref: '#/components/schemas/rule_description' - enabled: - $ref: '#/components/schemas/rule_enabled' - expression: - $ref: '#/components/schemas/rule_expression' - position: - $ref: '#/components/schemas/rule_position' - required: - - action - - expression - rule_position: - description: Reorder the position of a rule - oneOf: - - properties: - index: - description: ' Places the rule in the exact position specified by the integer number . Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten).' - type: integer - type: object - - properties: - before: - description: ' Places the rule before rule . Use this argument with an empty rule ID value ("") to set the rule as the first rule in the ruleset.' - example: - type: string - type: object - - properties: - after: - description: Places the rule after rule . Use this argument with an empty rule ID value ("") to set the rule as the last rule in the ruleset. - example: - type: string - type: object - type: object - status_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - estimated_queued_users: - $ref: '#/components/schemas/estimated_queued_users' - estimated_total_active_users: - $ref: '#/components/schemas/estimated_total_active_users' - event_id: - $ref: '#/components/schemas/status_event_id' - max_estimated_time_minutes: - $ref: '#/components/schemas/max_estimated_time_minutes' - status: - $ref: '#/components/schemas/waitingroom_components-schemas-status' - type: object - estimated_queued_users: - type: integer - estimated_total_active_users: - type: integer - status_event_id: - example: 25756b2dfe6e378a06b033b670413757 - type: string - max_estimated_time_minutes: - type: integer - waitingroom_components-schemas-status: - enum: - - event_prequeueing - - not_queueing - - queueing - example: queueing - type: string - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones: - id: cloudflare.waiting_rooms.zones - name: zones - title: Zones - methods: - waiting_room_list_waiting_rooms: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _waiting_room_list_waiting_rooms: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms/get' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_create_waiting_room: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms/post' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_delete_waiting_room: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_waiting_room_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _waiting_room_waiting_room_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_patch_waiting_room: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_update_waiting_room: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones/methods/waiting_room_list_waiting_rooms' - - $ref: '#/components/x-stackQL-resources/zones/methods/waiting_room_waiting_room_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones/methods/waiting_room_create_waiting_room' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones/methods/waiting_room_delete_waiting_room' - zones_preview: - id: cloudflare.waiting_rooms.zones_preview - name: zones_preview - title: Zones Preview - methods: - waiting_room_create_a_custom_waiting_room_page_preview: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1preview/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/zones_preview/methods/waiting_room_create_a_custom_waiting_room_page_preview' - update: [] - delete: [] - zones_events: - id: cloudflare.waiting_rooms.zones_events - name: zones_events - title: Zones Events - methods: - waiting_room_list_events: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _waiting_room_list_events: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events/get' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_create_event: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events/post' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_delete_event: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_event_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _waiting_room_event_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_patch_event: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_update_event: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_events/methods/waiting_room_list_events' - - $ref: '#/components/x-stackQL-resources/zones_events/methods/waiting_room_event_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_events/methods/waiting_room_create_event' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_events/methods/waiting_room_delete_event' - zones_events_details: - id: cloudflare.waiting_rooms.zones_events_details - name: zones_events_details - title: Zones Events Details - methods: - waiting_room_preview_active_event_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}~1details/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _waiting_room_preview_active_event_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}~1details/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_events_details/methods/waiting_room_preview_active_event_details' - insert: [] - update: [] - delete: [] - zones_rules: - id: cloudflare.waiting_rooms.zones_rules - name: zones_rules - title: Zones Rules - methods: - waiting_room_list_waiting_room_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _waiting_room_list_waiting_room_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_create_waiting_room_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_replace_waiting_room_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1rules/put' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_delete_waiting_room_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1rules~1{rule_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - waiting_room_patch_waiting_room_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1rules~1{rule_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_rules/methods/waiting_room_list_waiting_room_rules' - insert: - - $ref: '#/components/x-stackQL-resources/zones_rules/methods/waiting_room_create_waiting_room_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_rules/methods/waiting_room_delete_waiting_room_rule' - zones_status: - id: cloudflare.waiting_rooms.zones_status - name: zones_status - title: Zones Status - methods: - waiting_room_get_waiting_room_status: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1status/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _waiting_room_get_waiting_room_status: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1waiting_rooms~1{waiting_room_id}~1status/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_status/methods/waiting_room_get_waiting_room_status' - insert: [] - update: [] - delete: [] -paths: - '/zones/{zone_identifier}/waiting_rooms': - get: - description: Lists waiting rooms. - operationId: waiting-room-list-waiting-rooms + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Maximum number of results per page. Must be a multiple of 5. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 5 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/waitingroomResponseCollection' + description: List waiting rooms for account or zone response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/waitingroomWaitingroom' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List waiting rooms for account or zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List waiting rooms for account or zone + tags: [] + x-api-token-group: + - Account Waiting Rooms Read + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: [] + method: list + operationId: get_zones_zone_id_waiting_rooms + /zones/{zone_id}/waiting_rooms/preview: + post: + description: >- + Creates a waiting room page preview. Upload a custom waiting room page + for preview. You will receive a preview URL in the form + `http://waitingrooms.dev/preview/`. You can use the following + query parameters to change the state of the preview: 1. `force_queue`: + Boolean indicating if all users will be queued in the waiting room and + no one will be let into the origin website (also known as queueAll). 2. + `queue_is_full`: Boolean indicating if the waiting room's queue is + currently full and not accepting new users at the moment. 3. + `queueing_method`: The queueing method currently used by the waiting + room. - **fifo** indicates a FIFO queue. - **random** indicates a Random + queue. - **passthrough** indicates a Passthrough queue. Keep in mind + that the waiting room page will only be displayed if `force_queue=true` + or `event=prequeueing` — for other cases the request will pass through + to the origin. For our preview, this will be a fake origin website + returning \"Welcome\". - **reject** indicates a Reject queue. 4. + `event`: Used to preview a waiting room event. - **none** indicates no + event is occurring. - **prequeueing** indicates that an event is + prequeueing (between `prequeue_start_time` and `event_start_time`). - + **started** indicates that an event has started (between + `event_start_time` and `event_end_time`). 5. `shuffle_at_event_start`: + Boolean indicating if the event will shuffle users in the prequeue when + it starts. This can only be set to **true** if an event is active + (`event` is not **none**). For example, you can make a request to + `http://waitingrooms.dev/preview/?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true` + 6. `waitTime`: Non-zero, positive integer indicating the estimated wait + time in minutes. The default value is 10 minutes. For example, you can + make a request to `http://waitingrooms.dev/preview/?waitTime=50` + to configure the estimated wait time as 50 minutes. + operationId: waiting-room-create-a-custom-waiting-room-page-preview parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/waitingroomQueryPreview' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/waitingroom_components-schemas-response_collection' - description: List waiting rooms response - 4xx: + $ref: '#/components/schemas/waitingroomPreviewResponse' + description: Create a custom waiting room page preview response + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/waitingroom_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List waiting rooms response failure + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + preview_url: + $ref: '#/components/schemas/waitingroomPreviewUrl' + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + description: Create a custom waiting room page preview response failure security: + - api_token: [] - api_email: [] api_key: [] + summary: Create a custom waiting room page preview + tags: + - Waiting Room + x-api-token-group: + - Waiting Rooms Write + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - page + method: preview + /zones/{zone_id}/waiting_rooms/settings: + get: + description: >- + Gets the zone-level Waiting Room settings that apply as defaults to all + waiting rooms on the zone. + operationId: waiting-room-get-zone-settings + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/waitingroomZoneSettingsResponse' + description: The current zone-level Waiting Room settings + 4XX: + content: + application/json: + schema: + type: object + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + properties: + result: + $ref: '#/components/schemas/waitingRoomSetting' + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + description: The current zone-level Waiting Room settings response failure + security: - api_token: [] - summary: List waiting rooms + - api_email: [] + api_key: [] + summary: Get zone-level Waiting Room settings tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Read + - Waiting Rooms Write x-cfPlanAvailability: business: true enterprise: true free: false pro: false - post: - description: Creates a new waiting room. - operationId: waiting-room-create-waiting-room + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - settings + method: get + patch: + description: >- + Partially updates zone-level Waiting Room settings using PATCH + semantics. + operationId: waiting-room-patch-zone-settings parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/query_waitingroom' - required: true + $ref: '#/components/schemas/waitingroomZoneSettings' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' - description: Create waiting room response - 4xx: + $ref: '#/components/schemas/waitingroomZoneSettingsResponse' + description: The updated zone-level Waiting Room settings + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create waiting room response failure + type: object + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + properties: + result: + $ref: '#/components/schemas/waitingRoomSetting' + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + description: The zone-level Waiting Room settings response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create waiting room + summary: Patch zone-level Waiting Room settings tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: true enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/preview': - post: - description: "Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n3. `queueing_method`: The queueing method currently used by the waiting room.\n\t- **fifo** indicates a FIFO queue.\n\t- **random** indicates a Random queue.\n\t- **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \"Welcome\". \n\t- **reject** indicates a Reject queue.\n4. `event`: Used to preview a waiting room event.\n\t- **none** indicates no event is occurring.\n\t- **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`).\n\t- **started** indicates that an event has started (between `event_start_time` and `event_end_time`).\n5. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**).\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true`\n6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/?waitTime=50` to configure the estimated wait time as 50 minutes." - operationId: waiting-room-create-a-custom-waiting-room-page-preview + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - settings + method: edit + put: + description: >- + Fully updates zone-level Waiting Room settings, replacing the existing + configuration. + operationId: waiting-room-update-zone-settings parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/query_preview' - required: true + $ref: '#/components/schemas/waitingroomZoneSettings' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-preview_response' - description: Create a custom waiting room page preview response - 4xx: + $ref: '#/components/schemas/waitingroomZoneSettingsResponse' + description: The updated zone-level Waiting Room settings + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-preview_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a custom waiting room page preview response failure + type: object + required: + - success + - errors + - messages + - result + - result + - success + - errors + - messages + - result + properties: + result: + $ref: '#/components/schemas/waitingRoomSetting' + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + description: The zone-level Waiting Room settings response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Create a custom waiting room page preview + summary: Update zone-level Waiting Room settings tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: - business: false + business: true enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}': + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - settings + method: update + /zones/{zone_id}/waiting_rooms/{waiting_room_id}: delete: description: Deletes a waiting room. operationId: waiting-room-delete-waiting-room parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/waiting_room_id_response' + $ref: '#/components/schemas/waitingroomWaitingRoomIdResponse' description: Delete waiting room response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/waiting_room_id_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + id: + $ref: '#/components/schemas/waitingroomWaitingRoomId' + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Delete waiting room response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete waiting room tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: true enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: [] + method: delete get: description: Fetches a single configured waiting room. operationId: waiting-room-waiting-room-details parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' + $ref: '#/components/schemas/waitingroomSingleResponse' description: Waiting room details response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + additional_routes: + $ref: '#/components/schemas/waitingroomAdditionalRoutes' + cookie_attributes: + $ref: '#/components/schemas/waitingroomCookieAttributes' + cookie_suffix: + $ref: '#/components/schemas/waitingroomCookieSuffix' + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: '#/components/schemas/waitingroomCustomPageHtml' + default_template_language: + $ref: >- + #/components/schemas/waitingroomDefaultTemplateLanguage + description: + $ref: '#/components/schemas/waitingroomDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomDisableSessionRenewal' + enabled_origin_commands: + $ref: '#/components/schemas/waitingroomEnabledOriginCommands' + host: + $ref: '#/components/schemas/waitingroomHost' + id: + $ref: '#/components/schemas/waitingroomWaitingRoomId' + json_response_enabled: + $ref: '#/components/schemas/waitingroomJsonResponseEnabled' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomNewUsersPerMinute' + next_event_prequeue_start_time: + $ref: >- + #/components/schemas/waitingroomNextEventPrequeueStartTime + next_event_start_time: + $ref: '#/components/schemas/waitingroomNextEventStartTime' + path: + $ref: '#/components/schemas/waitingroomPath' + queue_all: + $ref: '#/components/schemas/waitingroomQueueAll' + queueing_method: + $ref: '#/components/schemas/waitingroomQueueingMethod' + queueing_status_code: + $ref: '#/components/schemas/waitingroomQueueingStatusCode' + session_duration: + $ref: '#/components/schemas/waitingroomSessionDuration' + suspended: + $ref: '#/components/schemas/waitingroomSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomTurnstileMode' + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Waiting room details response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Waiting room details tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Read + - Waiting Rooms Write x-cfPlanAvailability: business: true enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: [] + method: get patch: description: Patches a configured waiting room. operationId: waiting-room-patch-waiting-room parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/query_waitingroom' - required: true + $ref: '#/components/schemas/waitingroomQueryWaitingroom' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' + $ref: '#/components/schemas/waitingroomSingleResponse' description: Patch waiting room response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + additional_routes: + $ref: '#/components/schemas/waitingroomAdditionalRoutes' + cookie_attributes: + $ref: '#/components/schemas/waitingroomCookieAttributes' + cookie_suffix: + $ref: '#/components/schemas/waitingroomCookieSuffix' + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: '#/components/schemas/waitingroomCustomPageHtml' + default_template_language: + $ref: >- + #/components/schemas/waitingroomDefaultTemplateLanguage + description: + $ref: '#/components/schemas/waitingroomDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomDisableSessionRenewal' + enabled_origin_commands: + $ref: '#/components/schemas/waitingroomEnabledOriginCommands' + host: + $ref: '#/components/schemas/waitingroomHost' + id: + $ref: '#/components/schemas/waitingroomWaitingRoomId' + json_response_enabled: + $ref: '#/components/schemas/waitingroomJsonResponseEnabled' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomNewUsersPerMinute' + next_event_prequeue_start_time: + $ref: >- + #/components/schemas/waitingroomNextEventPrequeueStartTime + next_event_start_time: + $ref: '#/components/schemas/waitingroomNextEventStartTime' + path: + $ref: '#/components/schemas/waitingroomPath' + queue_all: + $ref: '#/components/schemas/waitingroomQueueAll' + queueing_method: + $ref: '#/components/schemas/waitingroomQueueingMethod' + queueing_status_code: + $ref: '#/components/schemas/waitingroomQueueingStatusCode' + session_duration: + $ref: '#/components/schemas/waitingroomSessionDuration' + suspended: + $ref: '#/components/schemas/waitingroomSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomTurnstileMode' + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Patch waiting room response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch waiting room tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: true enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: [] + method: edit put: description: Updates a configured waiting room. operationId: waiting-room-update-waiting-room parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/query_waitingroom' - required: true + $ref: '#/components/schemas/waitingroomQueryWaitingroom' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' + $ref: '#/components/schemas/waitingroomSingleResponse' description: Update waiting room response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/waitingroom_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + additional_routes: + $ref: '#/components/schemas/waitingroomAdditionalRoutes' + cookie_attributes: + $ref: '#/components/schemas/waitingroomCookieAttributes' + cookie_suffix: + $ref: '#/components/schemas/waitingroomCookieSuffix' + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: '#/components/schemas/waitingroomCustomPageHtml' + default_template_language: + $ref: >- + #/components/schemas/waitingroomDefaultTemplateLanguage + description: + $ref: '#/components/schemas/waitingroomDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomDisableSessionRenewal' + enabled_origin_commands: + $ref: '#/components/schemas/waitingroomEnabledOriginCommands' + host: + $ref: '#/components/schemas/waitingroomHost' + id: + $ref: '#/components/schemas/waitingroomWaitingRoomId' + json_response_enabled: + $ref: '#/components/schemas/waitingroomJsonResponseEnabled' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomNewUsersPerMinute' + next_event_prequeue_start_time: + $ref: >- + #/components/schemas/waitingroomNextEventPrequeueStartTime + next_event_start_time: + $ref: '#/components/schemas/waitingroomNextEventStartTime' + path: + $ref: '#/components/schemas/waitingroomPath' + queue_all: + $ref: '#/components/schemas/waitingroomQueueAll' + queueing_method: + $ref: '#/components/schemas/waitingroomQueueingMethod' + queueing_status_code: + $ref: '#/components/schemas/waitingroomQueueingStatusCode' + session_duration: + $ref: '#/components/schemas/waitingroomSessionDuration' + suspended: + $ref: '#/components/schemas/waitingroomSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomTurnstileMode' + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Update waiting room response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update waiting room tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: true enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events': + x-stackql-sdk: + service: waiting_rooms + resource_chain: [] + method: update + /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events: get: description: Lists events for a waiting room. operationId: waiting-room-list-events parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Maximum number of results per page. Must be a multiple of 5. + in: query + name: per_page schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + default: 25 + maximum: 1000 + minimum: 5 + type: number responses: '200': content: application/json: schema: - $ref: '#/components/schemas/event_response_collection' + $ref: '#/components/schemas/waitingroomEventResponseCollection' description: List events response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/event_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/waitingroomEventResult' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: List events response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: List events tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Read + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - events + method: list post: - description: 'Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event''s configuration may either override or inherit from the waiting room''s configuration. Note that events cannot overlap with each other, so only one event can be active at a time.' + description: >- + Only available for the Waiting Room Advanced subscription. Creates an + event for a waiting room. An event takes place during a specified period + of time, temporarily changing the behavior of a waiting room. While the + event is active, some of the properties in the event's configuration may + either override or inherit from the waiting room's configuration. Note + that events cannot overlap with each other, so only one event can be + active at a time. operationId: waiting-room-create-event parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/query_event' - required: true + $ref: '#/components/schemas/waitingroomQueryEvent' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/event_response' + $ref: '#/components/schemas/waitingroomEventResponse' description: Create event response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/event_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRef229c159575bc68a9c21f5a1615629cf6 + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Create event response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create event tags: - Waiting Room @@ -1395,335 +1106,630 @@ paths: enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}': + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - events + method: create + /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}: delete: description: Deletes an event for a waiting room. operationId: waiting-room-delete-event parameters: - - in: path - name: event_id + - name: event_id + in: path required: true + description: The event ID. schema: - $ref: '#/components/schemas/event_id' - - in: path - name: waiting_room_id + type: string + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/event_id_response' + $ref: '#/components/schemas/waitingroomEventIdResponse' description: Delete event response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/event_id_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + id: + $ref: '#/components/schemas/waitingroomEventId' + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Delete event response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete event tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - events + method: delete get: description: Fetches a single configured event for a waiting room. operationId: waiting-room-event-details parameters: - - in: path - name: event_id + - name: event_id + in: path required: true + description: The event ID. schema: - $ref: '#/components/schemas/event_id' - - in: path - name: waiting_room_id + type: string + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/event_response' + $ref: '#/components/schemas/waitingroomEventResponse' description: Event details response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/event_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRef229c159575bc68a9c21f5a1615629cf6 + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Event details response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Event details tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Read + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - events + method: get patch: description: Patches a configured event for a waiting room. operationId: waiting-room-patch-event parameters: - - in: path - name: event_id + - name: event_id + in: path required: true + description: The event ID. schema: - $ref: '#/components/schemas/event_id' - - in: path - name: waiting_room_id + type: string + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/query_event' - required: true + $ref: '#/components/schemas/waitingroomQueryEvent' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/event_response' + $ref: '#/components/schemas/waitingroomEventResponse' description: Patch event response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/event_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRef229c159575bc68a9c21f5a1615629cf6 + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Patch event response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch event tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - events + method: edit put: description: Updates a configured event for a waiting room. operationId: waiting-room-update-event parameters: - - in: path - name: event_id + - name: event_id + in: path required: true + description: The event ID. schema: - $ref: '#/components/schemas/event_id' - - in: path - name: waiting_room_id + type: string + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/query_event' - required: true + $ref: '#/components/schemas/waitingroomQueryEvent' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/event_response' + $ref: '#/components/schemas/waitingroomEventResponse' description: Update event response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/event_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + $ref: >- + #/components/schemas/unnamedSchemaRef229c159575bc68a9c21f5a1615629cf6 + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Update event response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update event tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details': + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - events + method: update + /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}/details: get: - description: Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values. + description: >- + Previews an event's configuration as if it was active. Inherited fields + from the waiting room will be displayed with their current values. operationId: waiting-room-preview-active-event-details parameters: - - in: path - name: event_id + - name: event_id + in: path required: true + description: The event ID. schema: - $ref: '#/components/schemas/event_id' - - in: path - name: waiting_room_id + type: string + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/event_details_response' + $ref: '#/components/schemas/waitingroomEventDetailsResponse' description: Preview active event details response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/event_details_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: >- + #/components/schemas/waitingroomEventDetailsCustomPageHtml + description: + $ref: '#/components/schemas/waitingroomEventDescription' + disable_session_renewal: + $ref: >- + #/components/schemas/waitingroomEventDetailsDisableSessionRenewal + event_end_time: + $ref: '#/components/schemas/waitingroomEventEndTime' + event_start_time: + $ref: '#/components/schemas/waitingroomEventStartTime' + id: + $ref: '#/components/schemas/waitingroomEventId' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomEventName' + new_users_per_minute: + $ref: >- + #/components/schemas/waitingroomEventDetailsNewUsersPerMinute + prequeue_start_time: + $ref: '#/components/schemas/waitingroomEventPrequeueStartTime' + queueing_method: + $ref: >- + #/components/schemas/waitingroomEventDetailsQueueingMethod + session_duration: + $ref: >- + #/components/schemas/waitingroomEventDetailsSessionDuration + shuffle_at_event_start: + $ref: >- + #/components/schemas/waitingroomEventShuffleAtEventStart + suspended: + $ref: '#/components/schemas/waitingroomEventSuspended' + total_active_users: + $ref: >- + #/components/schemas/waitingroomEventDetailsTotalActiveUsers + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Preview active event details response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Preview active event details tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Read + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules': + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - events + - details + method: get + /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules: get: description: Lists rules for a waiting room. operationId: waiting-room-list-waiting-room-rules parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-rules_response_collection' + $ref: '#/components/schemas/waitingroomRulesResponseCollection' description: List Waiting Room Rules response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-rules_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: >- + #/components/schemas/unnamedSchemaRefF1c0ba8f44601f2db2e07b9397b6c430 + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: List Waiting Room Rules response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: List Waiting Room Rules tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Read + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - rules + method: create post: - description: Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room. + description: >- + Only available for the Waiting Room Advanced subscription. Creates a + rule for a waiting room. operationId: waiting-room-create-waiting-room-rule parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/create_rule' - required: true + $ref: '#/components/schemas/waitingroomCreateRule' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-rules_response_collection' + $ref: '#/components/schemas/waitingroomRulesResponseCollection' description: Create Waiting Room Rule response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-rules_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: >- + #/components/schemas/unnamedSchemaRefF1c0ba8f44601f2db2e07b9397b6c430 + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: Create Waiting Room Rule response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Waiting Room Rule tags: - Waiting Room @@ -1733,98 +1739,180 @@ paths: free: false pro: false put: - description: Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room. + description: >- + Only available for the Waiting Room Advanced subscription. Replaces all + rules for a waiting room. operationId: waiting-room-replace-waiting-room-rules parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/update_rules' - required: true + $ref: '#/components/schemas/waitingroomUpdateRules' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-rules_response_collection' + $ref: '#/components/schemas/waitingroomRulesResponseCollection' description: Replace Waiting Room Rules response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-rules_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: >- + #/components/schemas/unnamedSchemaRefF1c0ba8f44601f2db2e07b9397b6c430 + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: Replace Waiting Room Rules response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Replace Waiting Room Rules tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}': + /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}: delete: description: Deletes a rule for a waiting room. operationId: waiting-room-delete-waiting-room-rule parameters: - - in: path - name: rule_id + - name: rule_id + in: path required: true + description: The rule ID. schema: - $ref: '#/components/schemas/rule_id' - - in: path - name: waiting_room_id + type: string + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-rules_response_collection' + $ref: '#/components/schemas/waitingroomRulesResponseCollection' description: Delete Waiting Room Rule response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-rules_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: >- + #/components/schemas/unnamedSchemaRefF1c0ba8f44601f2db2e07b9397b6c430 + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: Delete Waiting Room Rule response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Waiting Room Rule tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true @@ -1834,93 +1922,1943 @@ paths: description: Patches a rule for a waiting room. operationId: waiting-room-patch-waiting-room-rule parameters: - - in: path - name: rule_id + - name: rule_id + in: path required: true + description: The rule ID. schema: - $ref: '#/components/schemas/rule_id' - - in: path - name: waiting_room_id + type: string + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/patch_rule' - required: true + $ref: '#/components/schemas/waitingroomPatchRule' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/schemas-rules_response_collection' + $ref: '#/components/schemas/waitingroomRulesResponseCollection' description: Patch Waiting Room Rule response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/schemas-rules_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: >- + #/components/schemas/unnamedSchemaRefF1c0ba8f44601f2db2e07b9397b6c430 + required: + - success + - errors + - messages + - success + - errors + - messages + - result description: Patch Waiting Room Rule response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Patch Waiting Room Rule tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false - '/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status': + /zones/{zone_id}/waiting_rooms/{waiting_room_id}/status: get: - description: "Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it starts.\n2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string.\n3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue.\n4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin.\n5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users." + description: >- + Fetches the status of a configured waiting room. Response fields + include: 1. `status`: String indicating the status of the waiting room. + The possible status are: - **not_queueing** indicates that the + configured thresholds have not been met and all users are going through + to the origin. - **queueing** indicates that the thresholds have been + met and some users are held in the waiting room. - **event_prequeueing** + indicates that an event is active and is currently prequeueing users + before it starts. - **suspended** indicates that the room is suspended. + 2. `event_id`: String of the current event's `id` if an event is active, + otherwise an empty string. 3. `estimated_queued_users`: Integer of the + estimated number of users currently waiting in the queue. 4. + `estimated_total_active_users`: Integer of the estimated number of users + currently active on the origin. 5. `max_estimated_time_minutes`: Integer + of the maximum estimated time currently presented to the users. operationId: waiting-room-get-waiting-room-status parameters: - - in: path - name: waiting_room_id + - name: waiting_room_id + in: path required: true + description: The Waiting Room ID. schema: - $ref: '#/components/schemas/waiting_room_id' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/status_response' + $ref: '#/components/schemas/waitingroomStatusResponse' description: Get waiting room status response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/status_response' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + estimated_queued_users: + $ref: '#/components/schemas/waitingroomEstimatedQueuedUsers' + estimated_total_active_users: + $ref: >- + #/components/schemas/waitingroomEstimatedTotalActiveUsers + event_id: + $ref: '#/components/schemas/waitingroomStatusEventId' + max_estimated_time_minutes: + $ref: >- + #/components/schemas/waitingroomMaxEstimatedTimeMinutes + status: + $ref: '#/components/schemas/waitingroomStatus' + enum: + - null + errors: + minLength: 1 + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - false + type: boolean description: Get waiting room status response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Get waiting room status tags: - Waiting Room + x-api-token-group: + - Waiting Rooms Read + - Waiting Rooms Write + x-cfPlanAvailability: + business: true + enterprise: true + free: false + pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: + - statuses + method: get + /accounts/{account_id}/waiting_rooms: + get: + description: Lists waiting rooms for account or zone. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Maximum number of results per page. Must be a multiple of 5. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 5 + type: number + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/waitingroomResponseCollection' + description: List waiting rooms for account or zone response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/waitingroomWaitingroom' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List waiting rooms for account or zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List waiting rooms for account or zone + tags: [] + x-api-token-group: + - Account Waiting Rooms Read x-cfPlanAvailability: business: true enterprise: true free: false pro: false + x-stackql-sdk: + service: waiting_rooms + resource_chain: [] + method: list + operationId: get_accounts_account_id_waiting_rooms +components: + schemas: + unnamedSchemaRef229c159575bc68a9c21f5a1615629cf6: + type: object + properties: + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: '#/components/schemas/waitingroomEventCustomPageHtml' + description: + $ref: '#/components/schemas/waitingroomEventDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomEventDisableSessionRenewal' + event_end_time: + $ref: '#/components/schemas/waitingroomEventEndTime' + event_start_time: + $ref: '#/components/schemas/waitingroomEventStartTime' + id: + $ref: '#/components/schemas/waitingroomEventId' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomEventName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomEventNewUsersPerMinute' + prequeue_start_time: + $ref: '#/components/schemas/waitingroomEventPrequeueStartTime' + queueing_method: + $ref: '#/components/schemas/waitingroomEventQueueingMethod' + session_duration: + $ref: '#/components/schemas/waitingroomEventSessionDuration' + shuffle_at_event_start: + $ref: '#/components/schemas/waitingroomEventShuffleAtEventStart' + suspended: + $ref: '#/components/schemas/waitingroomEventSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomEventTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomEventTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomEventTurnstileMode' + enum: + - null + unnamedSchemaRefF1c0ba8f44601f2db2e07b9397b6c430: + items: + $ref: '#/components/schemas/waitingroomRuleResult' + type: array + enum: + - null + waitingRoomSetting: + type: object + properties: + search_engine_crawler_bypass: + $ref: '#/components/schemas/waitingroomSearchEngineCrawlerBypass' + required: + - search_engine_crawler_bypass + enum: + - null + waitingroomAdditionalRoutes: + description: >- + Only available for the Waiting Room Advanced subscription. Additional + hostname and path combinations to which this waiting room will be + applied. There is an implied wildcard at the end of the path. The + hostname and path combination must be unique to this and all other + waiting rooms. + items: + properties: + host: + description: >- + The hostname to which this waiting room will be applied (no + wildcards). The hostname must be the primary domain, subdomain, or + custom hostname (if using SSL for SaaS) of this zone. Please do + not include the scheme (http:// or https://). + example: shop2.example.com + type: string + x-auditable: true + path: + default: / + description: >- + Sets the path within the host to enable the waiting room on. The + waiting room will be enabled for all subpaths as well. If there + are two waiting rooms on the same subpath, the waiting room for + the most specific path will be chosen. Wildcards and query + parameters are not supported. + example: /shop2/checkout + type: string + x-auditable: true + type: object + type: array + waitingroomCookieAttributes: + description: >- + Configures cookie attributes for the waiting room cookie. This encrypted + cookie stores a user's status in the waiting room, such as queue + position. + properties: + samesite: + default: auto + description: >- + Configures the SameSite attribute on the waiting room cookie. Value + `auto` will be translated to `lax` or `none` depending if **Always + Use HTTPS** is enabled. Note that when using value `none`, the + secure attribute cannot be set to `never`. + enum: + - auto + - lax + - none + - strict + example: auto + type: string + x-auditable: true + secure: + default: auto + description: >- + Configures the Secure attribute on the waiting room cookie. Value + `always` indicates that the Secure attribute will be set in the + Set-Cookie header, `never` indicates that the Secure attribute will + not be set, and `auto` will set the Secure attribute depending if + **Always Use HTTPS** is enabled. + enum: + - auto + - always + - never + example: auto + type: string + x-auditable: true + type: object + waitingroomCookieSuffix: + default: '' + description: >- + Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's + cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie + name will be `__cf_waitingroom_abcd`. This field is required if using + `additional_routes`. + example: abcd + type: string + x-auditable: true + waitingroomCreateRule: + properties: + action: + $ref: '#/components/schemas/waitingroomRuleAction' + description: + $ref: '#/components/schemas/waitingroomRuleDescription' + enabled: + $ref: '#/components/schemas/waitingroomRuleEnabled' + expression: + $ref: '#/components/schemas/waitingroomRuleExpression' + required: + - action + - expression + type: object + waitingroomCustomPageHtml: + default: '' + description: >- + Only available for the Waiting Room Advanced subscription. This is a + template html file that will be rendered at the edge. If no + custom_page_html is provided, the default waiting room will be used. The + template is based on mustache ( https://mustache.github.io/ ). There are + several variables that are evaluated by the Cloudflare edge: 1. + {{`waitTimeKnown`}} Acts like a boolean value that indicates the + behavior to take when wait time is not available, for instance when + queue_all is **true**. 2. {{`waitTimeFormatted`}} Estimated wait time + for the user. For example, five minutes. Alternatively, you can use: 3. + {{`waitTime`}} Number of minutes of estimated wait for a user. 4. + {{`waitTimeHours`}} Number of hours of estimated wait for a user + (`Math.floor(waitTime/60)`). 5. {{`waitTimeHourMinutes`}} Number of + minutes above the `waitTimeHours` value (`waitTime%60`). 6. + {{`queueIsFull`}} Changes to **true** when no more people can be added + to the queue. To view the full list of variables, look at the + `cfWaitingRoom` object described under the `json_response_enabled` + property in other Waiting Room API calls. + example: >- + {{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} + {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}} + type: string + x-auditable: true + waitingroomDefaultTemplateLanguage: + default: en-US + description: >- + The language of the default page template. If no + default_template_language is provided, then `en-US` (English) will be + used. + enum: + - en-US + - es-ES + - de-DE + - fr-FR + - it-IT + - ja-JP + - ko-KR + - pt-BR + - zh-CN + - zh-TW + - nl-NL + - pl-PL + - id-ID + - tr-TR + - ar-EG + - ru-RU + - fa-IR + - bg-BG + - hr-HR + - cs-CZ + - da-DK + - fi-FI + - lt-LT + - ms-MY + - nb-NO + - ro-RO + - el-GR + - he-IL + - hi-IN + - hu-HU + - sr-BA + - sk-SK + - sl-SI + - sv-SE + - tl-PH + - th-TH + - uk-UA + - vi-VN + example: es-ES + type: string + x-auditable: true + waitingroomDescription: + default: '' + description: A note that you can use to add more details about the waiting room. + example: Production - DO NOT MODIFY + type: string + x-auditable: true + waitingroomDisableSessionRenewal: + default: false + description: >- + Only available for the Waiting Room Advanced subscription. Disables + automatic renewal of session cookies. If `true`, an accepted user will + have session_duration minutes to browse the site. After that, they will + have to go through the waiting room again. If `false`, a user's session + cookie will be automatically renewed on every request. + example: false + type: boolean + x-auditable: true + waitingroomEnabledOriginCommands: + default: [] + description: A list of enabled origin commands. + items: + enum: + - revoke + type: string + uniqueItems: true + x-auditable: true + type: array + waitingroomEstimatedQueuedUsers: + type: integer + x-auditable: true + waitingroomEstimatedTotalActiveUsers: + type: integer + x-auditable: true + waitingroomEventCustomPageHtml: + description: >- + If set, the event will override the waiting room's `custom_page_html` + property while it is active. If null, the event will inherit it. + example: >- + {{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} + {{^waitTimeKnown}} Event is prequeueing / Queue all enabled + {{/waitTimeKnown}} + nullable: true + type: string + x-auditable: true + waitingroomEventDescription: + default: '' + description: A note that you can use to add more details about the event. + example: Production event - DO NOT MODIFY + type: string + x-auditable: true + waitingroomEventDetailsCustomPageHtml: + example: >- + {{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} + {{^waitTimeKnown}} Event is prequeueing / Queue all enabled + {{/waitTimeKnown}} + type: string + x-auditable: true + waitingroomEventDetailsDisableSessionRenewal: + example: false + type: boolean + x-auditable: true + waitingroomEventDetailsNewUsersPerMinute: + type: integer + x-auditable: true + waitingroomEventDetailsQueueingMethod: + example: random + type: string + x-auditable: true + waitingroomEventDetailsResponse: + type: object + required: + - success + - errors + - messages + - result + properties: + result: + type: object + $ref: '#/components/schemas/waitingroomEventDetailsResult' + waitingroomEventDetailsResult: + properties: + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: '#/components/schemas/waitingroomEventDetailsCustomPageHtml' + description: + $ref: '#/components/schemas/waitingroomEventDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomEventDetailsDisableSessionRenewal' + event_end_time: + $ref: '#/components/schemas/waitingroomEventEndTime' + event_start_time: + $ref: '#/components/schemas/waitingroomEventStartTime' + id: + $ref: '#/components/schemas/waitingroomEventId' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomEventName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomEventDetailsNewUsersPerMinute' + prequeue_start_time: + $ref: '#/components/schemas/waitingroomEventPrequeueStartTime' + queueing_method: + $ref: '#/components/schemas/waitingroomEventDetailsQueueingMethod' + session_duration: + $ref: '#/components/schemas/waitingroomEventDetailsSessionDuration' + shuffle_at_event_start: + $ref: '#/components/schemas/waitingroomEventShuffleAtEventStart' + suspended: + $ref: '#/components/schemas/waitingroomEventSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomEventDetailsTotalActiveUsers' + type: object + waitingroomEventDetailsSessionDuration: + type: integer + x-auditable: true + waitingroomEventDetailsTotalActiveUsers: + type: integer + x-auditable: true + waitingroomEventDisableSessionRenewal: + description: >- + If set, the event will override the waiting room's + `disable_session_renewal` property while it is active. If null, the + event will inherit it. + nullable: true + type: boolean + x-auditable: true + waitingroomEventEndTime: + description: An ISO 8601 timestamp that marks the end of the event. + example: '2021-09-28T17:00:00.000Z' + type: string + x-auditable: true + waitingroomEventId: + example: 25756b2dfe6e378a06b033b670413757 + type: string + x-auditable: true + waitingroomEventIdResponse: + type: object + required: + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + id: + $ref: '#/components/schemas/waitingroomEventId' + waitingroomEventName: + description: >- + A unique name to identify the event. Only alphanumeric characters, + hyphens and underscores are allowed. + example: production_webinar_event + type: string + x-auditable: true + waitingroomEventNewUsersPerMinute: + description: >- + If set, the event will override the waiting room's + `new_users_per_minute` property while it is active. If null, the event + will inherit it. This can only be set if the event's + `total_active_users` property is also set. + maximum: 2147483647 + minimum: 200 + nullable: true + type: integer + x-auditable: true + waitingroomEventPrequeueStartTime: + description: >- + An ISO 8601 timestamp that marks when to begin queueing all users before + the event starts. The prequeue must start at least five minutes before + `event_start_time`. + example: '2021-09-28T15:00:00.000Z' + nullable: true + type: string + x-auditable: true + waitingroomEventQueueingMethod: + description: >- + If set, the event will override the waiting room's `queueing_method` + property while it is active. If null, the event will inherit it. + example: random + nullable: true + type: string + x-auditable: true + waitingroomEventResponse: + type: object + required: + - success + - errors + - messages + - result + properties: + result: + type: object + $ref: '#/components/schemas/waitingroomEventResult' + waitingroomEventResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/waitingroomEventResult' + type: array + required: + - success + - errors + - messages + waitingroomEventResult: + properties: + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: '#/components/schemas/waitingroomEventCustomPageHtml' + description: + $ref: '#/components/schemas/waitingroomEventDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomEventDisableSessionRenewal' + event_end_time: + $ref: '#/components/schemas/waitingroomEventEndTime' + event_start_time: + $ref: '#/components/schemas/waitingroomEventStartTime' + id: + $ref: '#/components/schemas/waitingroomEventId' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomEventName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomEventNewUsersPerMinute' + prequeue_start_time: + $ref: '#/components/schemas/waitingroomEventPrequeueStartTime' + queueing_method: + $ref: '#/components/schemas/waitingroomEventQueueingMethod' + session_duration: + $ref: '#/components/schemas/waitingroomEventSessionDuration' + shuffle_at_event_start: + $ref: '#/components/schemas/waitingroomEventShuffleAtEventStart' + suspended: + $ref: '#/components/schemas/waitingroomEventSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomEventTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomEventTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomEventTurnstileMode' + type: object + waitingroomEventSessionDuration: + description: >- + If set, the event will override the waiting room's `session_duration` + property while it is active. If null, the event will inherit it. + maximum: 30 + minimum: 1 + nullable: true + type: integer + x-auditable: true + waitingroomEventShuffleAtEventStart: + default: false + description: >- + If enabled, users in the prequeue will be shuffled randomly at the + `event_start_time`. Requires that `prequeue_start_time` is not null. + This is useful for situations when many users will join the event + prequeue at the same time and you want to shuffle them to ensure + fairness. Naturally, it makes the most sense to enable this feature when + the `queueing_method` during the event respects ordering such as + **fifo**, or else the shuffling may be unnecessary. + type: boolean + x-auditable: true + waitingroomEventStartTime: + description: >- + An ISO 8601 timestamp that marks the start of the event. At this time, + queued users will be processed with the event's configuration. The start + time must be at least one minute before `event_end_time`. + example: '2021-09-28T15:30:00.000Z' + type: string + x-auditable: true + waitingroomEventSuspended: + default: false + description: >- + Suspends or allows an event. If set to `true`, the event is ignored and + traffic will be handled based on the waiting room configuration. + type: boolean + x-auditable: true + waitingroomEventTotalActiveUsers: + description: >- + If set, the event will override the waiting room's `total_active_users` + property while it is active. If null, the event will inherit it. This + can only be set if the event's `new_users_per_minute` property is also + set. + maximum: 2147483647 + minimum: 200 + nullable: true + type: integer + x-auditable: true + waitingroomEventTurnstileAction: + description: >- + If set, the event will override the waiting room's `turnstile_action` + property while it is active. If null, the event will inherit it. + enum: + - log + - infinite_queue + nullable: true + type: string + x-auditable: true + waitingroomEventTurnstileMode: + description: >- + If set, the event will override the waiting room's `turnstile_mode` + property while it is active. If null, the event will inherit it. + enum: + - 'off' + - invisible + - visible_non_interactive + - visible_managed + nullable: true + type: string + x-auditable: true + waitingroomHost: + description: >- + The host name to which the waiting room will be applied (no wildcards). + Please do not include the scheme (http:// or https://). The host and + path combination must be unique. + example: shop.example.com + type: string + x-auditable: true + waitingroomJsonResponseEnabled: + default: false + description: >- + Only available for the Waiting Room Advanced subscription. If `true`, + requests to the waiting room with the header `Accept: application/json` + will receive a JSON response object with information on the user's + status in the waiting room as opposed to the configured static HTML + page. This JSON response object has one property `cfWaitingRoom` which + is an object containing the following fields: 1. `inWaitingRoom`: + Boolean indicating if the user is in the waiting room (always **true**). + 2. `waitTimeKnown`: Boolean indicating if the current estimated wait + times are accurate. If **false**, they are not available. 3. `waitTime`: + Valid only when `waitTimeKnown` is **true**. Integer indicating the + current estimated time in minutes the user will wait in the waiting + room. When `queueingMethod` is **random**, this is set to + `waitTime50Percentile`. 4. `waitTime25Percentile`: Valid only when + `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer + indicating the current estimated maximum wait time for the 25% of users + that gain entry the fastest (25th percentile). 5. + `waitTime50Percentile`: Valid only when `queueingMethod` is **random** + and `waitTimeKnown` is **true**. Integer indicating the current + estimated maximum wait time for the 50% of users that gain entry the + fastest (50th percentile). In other words, half of the queued users are + expected to let into the origin website before `waitTime50Percentile` + and half are expected to be let in after it. 6. `waitTime75Percentile`: + Valid only when `queueingMethod` is **random** and `waitTimeKnown` is + **true**. Integer indicating the current estimated maximum wait time for + the 75% of users that gain entry the fastest (75th percentile). 7. + `waitTimeFormatted`: String displaying the `waitTime` formatted in + English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` + will display **unavailable**. 8. `queueIsFull`: Boolean indicating if + the waiting room's queue is currently full and not accepting new users + at the moment. 9. `queueAll`: Boolean indicating if all users will be + queued in the waiting room and no one will be let into the origin + website. 10. `lastUpdated`: String displaying the timestamp as an ISO + 8601 string of the user's last attempt to leave the waiting room and be + let into the origin website. The user is able to make another attempt + after `refreshIntervalSeconds` past this time. If the user makes a + request too soon, it will be ignored and `lastUpdated` will not change. + 11. `refreshIntervalSeconds`: Integer indicating the number of seconds + after `lastUpdated` until the user is able to make another attempt to + leave the waiting room and be let into the origin website. When the + `queueingMethod` is `reject`, there is no specified refresh time —\_it + will always be **zero**. 12. `queueingMethod`: The queueing method + currently used by the waiting room. It is either **fifo**, **random**, + **passthrough**, or **reject**. 13. `isFIFOQueue`: Boolean indicating if + the waiting room uses a FIFO (First-In-First-Out) queue. 14. + `isRandomQueue`: Boolean indicating if the waiting room uses a Random + queue where users gain access randomly. 15. `isPassthroughQueue`: + Boolean indicating if the waiting room uses a passthrough queue. Keep in + mind that when passthrough is enabled, this JSON response will only + exist when `queueAll` is **true** or `isEventPrequeueing` is **true** + because in all other cases requests will go directly to the origin. 16. + `isRejectQueue`: Boolean indicating if the waiting room uses a reject + queue. 17. `isEventActive`: Boolean indicating if an event is currently + occurring. Events are able to change a waiting room's behavior during a + specified period of time. For additional information, look at the event + properties `prequeue_start_time`, `event_start_time`, and + `event_end_time` in the documentation for creating waiting room events. + Events are considered active between these start and end times, as well + as during the prequeueing period if it exists. 18. `isEventPrequeueing`: + Valid only when `isEventActive` is **true**. Boolean indicating if an + event is currently prequeueing users before it starts. 19. + `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. + Integer indicating the number of minutes until the event starts. 20. + `timeUntilEventStartFormatted`: String displaying the + `timeUntilEventStart` formatted in English for users. If + `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will + display **unavailable**. 21. `timeUntilEventEnd`: Valid only when + `isEventActive` is **true**. Integer indicating the number of minutes + until the event ends. 22. `timeUntilEventEndFormatted`: String + displaying the `timeUntilEventEnd` formatted in English for users. If + `isEventActive` is **false**, `timeUntilEventEndFormatted` will display + **unavailable**. 23. `shuffleAtEventStart`: Valid only when + `isEventActive` is **true**. Boolean indicating if the users in the + prequeue are shuffled randomly when the event starts. 24. `turnstile`: + Empty when turnstile isn't enabled. String displaying an html tag to + display the Turnstile widget. Please add the `{{{turnstile}}}` tag to + the `custom_html` template to ensure the Turnstile widget appears. 25. + `infiniteQueue`: Boolean indicating whether the response is for a user + in the infinite queue. An example cURL to a waiting room could be: curl + -X GET "https://example.com/waitingroom" \ -H "Accept: application/json" + If `json_response_enabled` is **true** and the request hits the waiting + room, an example JSON response when `queueingMethod` is **fifo** and no + event is active could be: { "cfWaitingRoom": { "inWaitingRoom": true, + "waitTimeKnown": true, "waitTime": 10, "waitTime25Percentile": 0, + "waitTime50Percentile": 0, "waitTime75Percentile": 0, + "waitTimeFormatted": "10 minutes", "queueIsFull": false, "queueAll": + false, "lastUpdated": "2020-08-03T23:46:00.000Z", + "refreshIntervalSeconds": 20, "queueingMethod": "fifo", "isFIFOQueue": + true, "isRandomQueue": false, "isPassthroughQueue": false, + "isRejectQueue": false, "isEventActive": false, "isEventPrequeueing": + false, "timeUntilEventStart": 0, "timeUntilEventStartFormatted": + "unavailable", "timeUntilEventEnd": 0, "timeUntilEventEndFormatted": + "unavailable", "shuffleAtEventStart": false } } If + `json_response_enabled` is **true** and the request hits the waiting + room, an example JSON response when `queueingMethod` is **random** and + an event is active could be: { "cfWaitingRoom": { "inWaitingRoom": true, + "waitTimeKnown": true, "waitTime": 10, "waitTime25Percentile": 5, + "waitTime50Percentile": 10, "waitTime75Percentile": 15, + "waitTimeFormatted": "5 minutes to 15 minutes", "queueIsFull": false, + "queueAll": false, "lastUpdated": "2020-08-03T23:46:00.000Z", + "refreshIntervalSeconds": 20, "queueingMethod": "random", "isFIFOQueue": + false, "isRandomQueue": true, "isPassthroughQueue": false, + "isRejectQueue": false, "isEventActive": true, "isEventPrequeueing": + false, "timeUntilEventStart": 0, "timeUntilEventStartFormatted": + "unavailable", "timeUntilEventEnd": 15, "timeUntilEventEndFormatted": + "15 minutes", "shuffleAtEventStart": true } } + example: false + type: boolean + x-auditable: true + waitingroomMaxEstimatedTimeMinutes: + type: integer + x-auditable: true + waitingroomMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + waitingroomName: + description: >- + A unique name to identify the waiting room. Only alphanumeric + characters, hyphens and underscores are allowed. + example: production_webinar + type: string + x-auditable: true + waitingroomNewUsersPerMinute: + description: >- + Sets the number of new users that will be let into the route every + minute. This value is used as baseline for the number of users that are + let in per minute. So it is possible that there is a little more or + little less traffic coming to the route based on the traffic patterns at + that time around the world. + maximum: 2147483647 + minimum: 200 + type: integer + x-auditable: true + waitingroomNextEventPrequeueStartTime: + description: >- + An ISO 8601 timestamp that marks when the next event will begin + queueing. + example: '2021-09-28T15:00:00.000Z' + nullable: true + type: string + x-auditable: true + waitingroomNextEventStartTime: + description: An ISO 8601 timestamp that marks when the next event will start. + example: '2021-09-28T15:00:00.000Z' + nullable: true + type: string + x-auditable: true + waitingroomPatchRule: + properties: + action: + $ref: '#/components/schemas/waitingroomRuleAction' + description: + $ref: '#/components/schemas/waitingroomRuleDescription' + enabled: + $ref: '#/components/schemas/waitingroomRuleEnabled' + expression: + $ref: '#/components/schemas/waitingroomRuleExpression' + position: + $ref: '#/components/schemas/waitingroomRulePosition' + required: + - action + - expression + type: object + waitingroomPath: + default: / + description: >- + Sets the path within the host to enable the waiting room on. The waiting + room will be enabled for all subpaths as well. If there are two waiting + rooms on the same subpath, the waiting room for the most specific path + will be chosen. Wildcards and query parameters are not supported. + example: /shop/checkout + type: string + x-auditable: true + waitingroomPreviewResponse: + type: object + required: + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + preview_url: + $ref: '#/components/schemas/waitingroomPreviewUrl' + waitingroomPreviewUrl: + description: URL where the custom waiting room page can temporarily be previewed. + example: http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb + type: string + x-auditable: true + waitingroomQueryEvent: + properties: + custom_page_html: + $ref: '#/components/schemas/waitingroomEventCustomPageHtml' + description: + $ref: '#/components/schemas/waitingroomEventDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomEventDisableSessionRenewal' + event_end_time: + $ref: '#/components/schemas/waitingroomEventEndTime' + event_start_time: + $ref: '#/components/schemas/waitingroomEventStartTime' + name: + $ref: '#/components/schemas/waitingroomEventName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomEventNewUsersPerMinute' + prequeue_start_time: + $ref: '#/components/schemas/waitingroomEventPrequeueStartTime' + queueing_method: + $ref: '#/components/schemas/waitingroomEventQueueingMethod' + session_duration: + $ref: '#/components/schemas/waitingroomEventSessionDuration' + shuffle_at_event_start: + $ref: '#/components/schemas/waitingroomEventShuffleAtEventStart' + suspended: + $ref: '#/components/schemas/waitingroomEventSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomEventTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomEventTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomEventTurnstileMode' + required: + - name + - event_start_time + - event_end_time + type: object + waitingroomQueryPreview: + properties: + custom_html: + $ref: '#/components/schemas/waitingroomCustomPageHtml' + required: + - custom_html + type: object + waitingroomQueryWaitingroom: + properties: + additional_routes: + $ref: '#/components/schemas/waitingroomAdditionalRoutes' + cookie_attributes: + $ref: '#/components/schemas/waitingroomCookieAttributes' + cookie_suffix: + $ref: '#/components/schemas/waitingroomCookieSuffix' + custom_page_html: + $ref: '#/components/schemas/waitingroomCustomPageHtml' + default_template_language: + $ref: '#/components/schemas/waitingroomDefaultTemplateLanguage' + description: + $ref: '#/components/schemas/waitingroomDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomDisableSessionRenewal' + enabled_origin_commands: + $ref: '#/components/schemas/waitingroomEnabledOriginCommands' + host: + $ref: '#/components/schemas/waitingroomHost' + json_response_enabled: + $ref: '#/components/schemas/waitingroomJsonResponseEnabled' + name: + $ref: '#/components/schemas/waitingroomName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomNewUsersPerMinute' + path: + $ref: '#/components/schemas/waitingroomPath' + queue_all: + $ref: '#/components/schemas/waitingroomQueueAll' + queueing_method: + $ref: '#/components/schemas/waitingroomQueueingMethod' + queueing_status_code: + $ref: '#/components/schemas/waitingroomQueueingStatusCode' + session_duration: + $ref: '#/components/schemas/waitingroomSessionDuration' + suspended: + $ref: '#/components/schemas/waitingroomSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomTurnstileMode' + required: + - name + - host + - new_users_per_minute + - total_active_users + type: object + waitingroomQueueAll: + default: false + description: >- + If queue_all is `true`, all the traffic that is coming to a route will + be sent to the waiting room. No new traffic can get to the route once + this field is set and estimated time will become unavailable. + example: true + type: boolean + x-auditable: true + waitingroomQueueingMethod: + default: fifo + description: >- + Sets the queueing method used by the waiting room. Changing this + parameter from the **default** queueing method is only available for the + Waiting Room Advanced subscription. Regardless of the queueing method, + if `queue_all` is enabled or an event is prequeueing, users in the + waiting room will not be accepted to the origin. These users will always + see a waiting room page that refreshes automatically. The valid queueing + methods are: 1. `fifo` **(default)**: First-In-First-Out queue where + customers gain access in the order they arrived. 2. `random`: Random + queue where customers gain access randomly, regardless of arrival time. + 3. `passthrough`: Users will pass directly through the waiting room and + into the origin website. As a result, any configured limits will not be + respected while this is enabled. This method can be used as an + alternative to disabling a waiting room (with `suspended`) so that + analytics are still reported. This can be used if you wish to allow all + traffic normally, but want to restrict traffic during a waiting room + event, or vice versa. 4. `reject`: Users will be immediately rejected + from the waiting room. As a result, no users will reach the origin + website while this is enabled. This can be used if you wish to reject + all traffic while performing maintenance, block traffic during a + specified period of time (an event), or block traffic while events are + not occurring. Consider a waiting room used for vaccine distribution + that only allows traffic during sign-up events, and otherwise blocks all + traffic. For this case, the waiting room uses `reject`, and its events + override this with `fifo`, `random`, or `passthrough`. When this + queueing method is enabled and neither `queueAll` is enabled nor an + event is prequeueing, the waiting room page **will not refresh + automatically**. + enum: + - fifo + - random + - passthrough + - reject + example: fifo + type: string + x-auditable: true + waitingroomQueueingStatusCode: + default: 200 + description: HTTP status code returned to a user while in the queue. + enum: + - 200 + - 202 + - 429 + example: 202 + type: integer + x-auditable: true + waitingroomResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/waitingroomWaitingroom' + type: array + required: + - success + - errors + - messages + waitingroomRuleAction: + description: The action to take when the expression matches. + enum: + - bypass_waiting_room + example: bypass_waiting_room + type: string + x-auditable: true + waitingroomRuleDescription: + default: '' + description: The description of the rule. + example: allow all traffic from 10.20.30.40 + type: string + x-auditable: true + waitingroomRuleEnabled: + default: true + description: When set to true, the rule is enabled. + example: true + type: boolean + x-auditable: true + waitingroomRuleExpression: + description: Criteria defining when there is a match for the current rule. + example: ip.src in {10.20.30.40} + type: string + x-auditable: true + waitingroomRuleId: + description: The ID of the rule. + example: 25756b2dfe6e378a06b033b670413757 + type: string + x-auditable: true + waitingroomRulePosition: + description: Reorder the position of a rule + type: object + properties: + index: + description: >- + Places the rule in the exact position specified by the integer + number . Position numbers start with 1. Existing + rules in the ruleset from the specified position number onward are + shifted one position (no rule is overwritten). + type: integer + x-auditable: true + before: + description: >- + Places the rule before rule . Use this argument with an + empty rule ID value ("") to set the rule as the first rule in the + ruleset. + example: + type: string + x-auditable: true + after: + description: >- + Places the rule after rule . Use this argument with an + empty rule ID value ("") to set the rule as the last rule in the + ruleset. + example: + type: string + x-auditable: true + waitingroomRuleResult: + properties: + action: + $ref: '#/components/schemas/waitingroomRuleAction' + description: + $ref: '#/components/schemas/waitingroomRuleDescription' + enabled: + $ref: '#/components/schemas/waitingroomRuleEnabled' + expression: + $ref: '#/components/schemas/waitingroomRuleExpression' + id: + $ref: '#/components/schemas/waitingroomRuleId' + last_updated: + $ref: '#/components/schemas/waitingroomTimestamp' + version: + $ref: '#/components/schemas/waitingroomRuleVersion' + type: object + waitingroomRuleVersion: + description: The version of the rule. + example: '1' + type: string + x-auditable: true + waitingroomRulesResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/waitingroomMessages' + messages: + $ref: '#/components/schemas/waitingroomMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/waitingroomRuleResult' + type: array + required: + - success + - errors + - messages + waitingroomSearchEngineCrawlerBypass: + default: false + description: >- + Whether to allow verified search engine crawlers to bypass all waiting + rooms on this zone. Verified search engine crawlers will not be tracked + or counted by the waiting room system, and will not appear in waiting + room analytics. + example: true + type: boolean + x-auditable: true + waitingroomSessionDuration: + default: 5 + description: >- + Lifetime of a cookie (in minutes) set by Cloudflare for users who get + access to the route. If a user is not seen by Cloudflare again in that + time period, they will be treated as a new user that visits the route. + maximum: 30 + minimum: 1 + type: integer + x-auditable: true + waitingroomSingleResponse: + type: object + required: + - success + - errors + - messages + - result + properties: + result: + type: object + $ref: '#/components/schemas/waitingroomWaitingroom' + waitingroomStatus: + enum: + - event_prequeueing + - not_queueing + - queueing + - suspended + example: queueing + type: string + x-auditable: true + waitingroomStatusEventId: + example: 25756b2dfe6e378a06b033b670413757 + type: string + x-auditable: true + waitingroomStatusResponse: + type: object + required: + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + estimated_queued_users: + $ref: '#/components/schemas/waitingroomEstimatedQueuedUsers' + estimated_total_active_users: + $ref: '#/components/schemas/waitingroomEstimatedTotalActiveUsers' + event_id: + $ref: '#/components/schemas/waitingroomStatusEventId' + max_estimated_time_minutes: + $ref: '#/components/schemas/waitingroomMaxEstimatedTimeMinutes' + status: + $ref: '#/components/schemas/waitingroomStatus' + waitingroomSuspended: + default: false + description: >- + Suspends or allows traffic going to the waiting room. If set to `true`, + the traffic will not go to the waiting room. + type: boolean + x-auditable: true + waitingroomTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + waitingroomTotalActiveUsers: + description: >- + Sets the total number of active user sessions on the route at a point in + time. A route is a combination of host and path on which a waiting room + is available. This value is used as a baseline for the total number of + active user sessions on the route. It is possible to have a situation + where there are more or less active users sessions on the route based on + the traffic patterns at that time around the world. + maximum: 2147483647 + minimum: 200 + type: integer + x-auditable: true + waitingroomTurnstileAction: + default: log + description: >- + Which action to take when a bot is detected using Turnstile. `log` will + have no impact on queueing behavior, simply keeping track of how many + bots are detected in Waiting Room Analytics. `infinite_queue` will send + bots to a false queueing state, where they will never reach your origin. + `infinite_queue` requires Advanced Waiting Room. + enum: + - log + - infinite_queue + type: string + x-auditable: true + waitingroomTurnstileMode: + default: invisible + description: >- + Which Turnstile widget type to use for detecting bot traffic. See [the + Turnstile + documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) + for the definitions of these widget types. Set to `off` to disable the + Turnstile integration entirely. Setting this to anything other than + `off` or `invisible` requires Advanced Waiting Room. + enum: + - 'off' + - invisible + - visible_non_interactive + - visible_managed + type: string + x-auditable: true + waitingroomUpdateRules: + items: + $ref: '#/components/schemas/waitingroomCreateRule' + type: array + waitingroomWaitingRoomId: + example: 699d98642c564d2e855e9661899b7252 + type: string + x-auditable: true + waitingroomWaitingRoomIdResponse: + type: object + required: + - success + - errors + - messages + - result + properties: + result: + type: object + properties: + id: + $ref: '#/components/schemas/waitingroomWaitingRoomId' + waitingroomWaitingroom: + properties: + additional_routes: + $ref: '#/components/schemas/waitingroomAdditionalRoutes' + cookie_attributes: + $ref: '#/components/schemas/waitingroomCookieAttributes' + cookie_suffix: + $ref: '#/components/schemas/waitingroomCookieSuffix' + created_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + custom_page_html: + $ref: '#/components/schemas/waitingroomCustomPageHtml' + default_template_language: + $ref: '#/components/schemas/waitingroomDefaultTemplateLanguage' + description: + $ref: '#/components/schemas/waitingroomDescription' + disable_session_renewal: + $ref: '#/components/schemas/waitingroomDisableSessionRenewal' + enabled_origin_commands: + $ref: '#/components/schemas/waitingroomEnabledOriginCommands' + host: + $ref: '#/components/schemas/waitingroomHost' + id: + $ref: '#/components/schemas/waitingroomWaitingRoomId' + json_response_enabled: + $ref: '#/components/schemas/waitingroomJsonResponseEnabled' + modified_on: + $ref: '#/components/schemas/waitingroomTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/waitingroomName' + new_users_per_minute: + $ref: '#/components/schemas/waitingroomNewUsersPerMinute' + next_event_prequeue_start_time: + $ref: '#/components/schemas/waitingroomNextEventPrequeueStartTime' + next_event_start_time: + $ref: '#/components/schemas/waitingroomNextEventStartTime' + path: + $ref: '#/components/schemas/waitingroomPath' + queue_all: + $ref: '#/components/schemas/waitingroomQueueAll' + queueing_method: + $ref: '#/components/schemas/waitingroomQueueingMethod' + queueing_status_code: + $ref: '#/components/schemas/waitingroomQueueingStatusCode' + session_duration: + $ref: '#/components/schemas/waitingroomSessionDuration' + suspended: + $ref: '#/components/schemas/waitingroomSuspended' + total_active_users: + $ref: '#/components/schemas/waitingroomTotalActiveUsers' + turnstile_action: + $ref: '#/components/schemas/waitingroomTurnstileAction' + turnstile_mode: + $ref: '#/components/schemas/waitingroomTurnstileMode' + type: object + waitingroomZoneSettings: + properties: + search_engine_crawler_bypass: + $ref: '#/components/schemas/waitingroomSearchEngineCrawlerBypass' + type: object + waitingroomZoneSettingsResponse: + type: object + required: + - success + - errors + - messages + - result + - result + properties: + result: + type: object + properties: + search_engine_crawler_bypass: + $ref: '#/components/schemas/waitingroomSearchEngineCrawlerBypass' + required: + - search_engine_crawler_bypass + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + waiting_rooms: + id: cloudflare.waiting_rooms.waiting_rooms + name: waiting_rooms + title: Waiting Rooms + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + preview: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms~1preview/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1waiting_rooms/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/waiting_rooms/methods/get' + - $ref: >- + #/components/x-stackQL-resources/waiting_rooms/methods/list_by_zone + - $ref: >- + #/components/x-stackQL-resources/waiting_rooms/methods/list_by_account + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/waiting_rooms/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/waiting_rooms/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/waiting_rooms/methods/update' + settings: + id: cloudflare.waiting_rooms.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1waiting_rooms~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/edit' + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/update' + events: + id: cloudflare.waiting_rooms.events + name: events + title: Events + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1events/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1events/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events/methods/get' + - $ref: '#/components/x-stackQL-resources/events/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/events/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/events/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/events/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/events/methods/update' + details: + id: cloudflare.waiting_rooms.details + name: details + title: Details + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1events~1{event_id}~1details/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/details/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + rules: + id: cloudflare.waiting_rooms.rules + name: rules + title: Rules + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1rules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + waiting_room_create_waiting_room_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1rules/post + response: + mediaType: application/json + openAPIDocKey: '200' + waiting_room_replace_waiting_room_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1rules/put + response: + mediaType: application/json + openAPIDocKey: '200' + waiting_room_delete_waiting_room_rule: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1rules~1{rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + waiting_room_patch_waiting_room_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1rules~1{rule_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/waiting_room_create_waiting_room_rule + update: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/waiting_room_patch_waiting_room_rule + delete: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/waiting_room_delete_waiting_room_rule + replace: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/waiting_room_replace_waiting_room_rules + statuses: + id: cloudflare.waiting_rooms.statuses + name: statuses + title: Statuses + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1waiting_rooms~1{waiting_room_id}~1status/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/statuses/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/web3.yaml b/providers/src/cloudflare/v00.00.00000/services/web3.yaml index 883d5fe1..4a035ace 100644 --- a/providers/src/cloudflare/v00.00.00000/services/web3.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/web3.yaml @@ -1,865 +1,1055 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Web3 Hostname - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - web3 + title: web3 API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - components-schemas-collection_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/web3-hostname' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - web3-hostname: - properties: - created_on: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/web3-hostname_components-schemas-description' - dnslink: - $ref: '#/components/schemas/dnslink' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - modified_on: - $ref: '#/components/schemas/timestamp' - name: - $ref: '#/components/schemas/web3-hostname_components-schemas-name' - status: - $ref: '#/components/schemas/web3-hostname_components-schemas-status' - target: - $ref: '#/components/schemas/components-schemas-target' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/web3/hostnames: + get: + operationId: web3-hostname-list-web3-hostnames + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - web3-hostname_components-schemas-description: - description: An optional description of the hostname. - example: This is my IPFS gateway. - maxLength: 500 - type: string - dnslink: - description: DNSLink value used if the target is ipfs. - example: /ipns/onboarding.ipfs.cloudflare.com - type: string - web3-hostname_components-schemas-name: - description: The hostname that will point to the target gateway via CNAME. - example: gateway.example.com - maxLength: 255 - readOnly: true - type: string - web3-hostname_components-schemas-status: - description: Status of the hostname's activation. - enum: - - active - - pending - - deleting - - error - example: active - readOnly: true - type: string - components-schemas-target: - description: Target gateway of the hostname. - enum: - - ethereum - - ipfs - - ipfs_universal_path - - polygon - example: ipfs - type: string - create_request: - properties: - description: - $ref: '#/components/schemas/web3-hostname_components-schemas-description' - dnslink: - $ref: '#/components/schemas/dnslink' - name: - $ref: '#/components/schemas/web3-hostname_components-schemas-name' - target: - $ref: '#/components/schemas/components-schemas-target' - required: - - name - - target - type: object - web3-hostname_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/web3-hostname' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - api-response-single-id: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - type: object - modify_request: - properties: - description: - $ref: '#/components/schemas/web3-hostname_components-schemas-description' - dnslink: - $ref: '#/components/schemas/dnslink' - type: object - content_list_details_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/content_list_details' - content_list_details: - properties: - action: - $ref: '#/components/schemas/content_list_action' - type: object - content_list_action: - description: Behavior of the content list. - enum: - - block - example: block - type: string - content_list_update_request: - properties: - action: - $ref: '#/components/schemas/content_list_action' - entries: - $ref: '#/components/schemas/content_list_entries' - required: - - action - - entries - type: object - content_list_entries: - description: Content list entries. - items: - $ref: '#/components/schemas/content_list_entry' - type: array - content_list_entry: - description: Content list entry to be blocked. - properties: - content: - $ref: '#/components/schemas/content_list_entry_content' - created_on: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/content_list_entry_description' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - modified_on: - $ref: '#/components/schemas/timestamp' - type: - $ref: '#/components/schemas/content_list_entry_type' - type: object - content_list_entry_content: - description: CID or content path of content to block. - example: QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB - maxLength: 500 - type: string - content_list_entry_description: - description: An optional description of the content list entry. - example: this is my content list entry - maxLength: 500 - type: string - content_list_entry_type: - description: Type of content list entry to block. - enum: - - cid - - content_path - example: cid - type: string - content_list_entry_collection_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - properties: - entries: - $ref: '#/components/schemas/content_list_entries' - type: object - content_list_entry_create_request: - properties: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/web3CollectionResponse' + description: List Web3 Hostnames response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: + $ref: '#/components/schemas/web3Web3Hostname' + nullable: true + type: array + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Web3 Hostnames error response (4XX). + 5XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: + $ref: '#/components/schemas/web3Web3Hostname' + nullable: true + type: array + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Web3 Hostnames response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Web3 Hostnames + tags: + - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write + - Web3 Hostnames Read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + method: list + post: + operationId: web3-hostname-create-web3-hostname + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: content: - $ref: '#/components/schemas/content_list_entry_content' - description: - $ref: '#/components/schemas/content_list_entry_description' - type: - $ref: '#/components/schemas/content_list_entry_type' - required: - - type - - content - type: object - content_list_entry_single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/content_list_entry' - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - zones_hostnames: - id: cloudflare.web3.zones_hostnames - name: zones_hostnames - title: Zones Hostnames - methods: - hostname_list_web3_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _hostname_list_web3_hostnames: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames/get' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_create_web3_hostname: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames/post' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_delete_web3_hostname: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_web3_hostname_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _hostname_web3_hostname_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_edit_web3_hostname: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_hostnames/methods/hostname_list_web3_hostnames' - - $ref: '#/components/x-stackQL-resources/zones_hostnames/methods/hostname_web3_hostname_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_hostnames/methods/hostname_create_web3_hostname' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_hostnames/methods/hostname_delete_web3_hostname' - zones_hostnames_ipfs_universal_path_content_list: - id: cloudflare.web3.zones_hostnames_ipfs_universal_path_content_list - name: zones_hostnames_ipfs_universal_path_content_list - title: Zones Hostnames Ipfs Universal Path Content List - methods: - hostname_ipfs_universal_path_gateway_content_list_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _hostname_ipfs_universal_path_gateway_content_list_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list/get' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_update_ipfs_universal_path_gateway_content_list: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_hostnames_ipfs_universal_path_content_list/methods/hostname_ipfs_universal_path_gateway_content_list_details' - insert: [] - update: [] - delete: [] - zones_hostnames_ipfs_universal_path_content_list_entries: - id: cloudflare.web3.zones_hostnames_ipfs_universal_path_content_list_entries - name: zones_hostnames_ipfs_universal_path_content_list_entries - title: Zones Hostnames Ipfs Universal Path Content List Entries - methods: - hostname_list_ipfs_universal_path_gateway_content_list_entries: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.entries - _hostname_list_ipfs_universal_path_gateway_content_list_entries: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries/get' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_create_ipfs_universal_path_gateway_content_list_entry: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries/post' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_delete_ipfs_universal_path_gateway_content_list_entry: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries~1{content_list_entry_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_ipfs_universal_path_gateway_content_list_entry_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries~1{content_list_entry_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _hostname_ipfs_universal_path_gateway_content_list_entry_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries~1{content_list_entry_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - hostname_edit_ipfs_universal_path_gateway_content_list_entry: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries~1{content_list_entry_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_hostnames_ipfs_universal_path_content_list_entries/methods/hostname_list_ipfs_universal_path_gateway_content_list_entries' - - $ref: '#/components/x-stackQL-resources/zones_hostnames_ipfs_universal_path_content_list_entries/methods/hostname_ipfs_universal_path_gateway_content_list_entry_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones_hostnames_ipfs_universal_path_content_list_entries/methods/hostname_create_ipfs_universal_path_gateway_content_list_entry' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_hostnames_ipfs_universal_path_content_list_entries/methods/hostname_delete_ipfs_universal_path_gateway_content_list_entry' -paths: - '/zones/{zone_identifier}/web3/hostnames': - get: - operationId: web3-hostname-list-web3-hostnames - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + application/json: + schema: + $ref: '#/components/schemas/web3CreateRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/components-schemas-collection_response' - description: List Web3 Hostnames response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Web3 Hostnames response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Web3 Hostnames - tags: - - Web3 Hostname - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - operationId: web3-hostname-create-web3-hostname - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_request' - required: true - responses: - '200': + $ref: '#/components/schemas/web3SingleResponse' + description: Create Web3 Hostname response. + 4XX: content: application/json: schema: - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response' - description: Create Web3 Hostname response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: + $ref: '#/components/schemas/web3Web3Hostname' + nullable: true + type: array + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Web3 Hostname error response (4XX). + 5XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Web3 Hostname response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef2e420942fb77cd2cd2ba3ca7b5f32e1e + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Web3 Hostname response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Web3 Hostname tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/web3/hostnames/{identifier}': + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + method: create + /zones/{zone_id}/web3/hostnames/{identifier}: delete: operationId: web3-hostname-delete-web3-hostname parameters: - - in: path - name: identifier + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete Web3 Hostname response - 4xx: + $ref: '#/components/schemas/web3ApiResponseSingleId' + description: Delete Web3 Hostname response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: + $ref: '#/components/schemas/web3Web3Hostname' + nullable: true + type: array + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Web3 Hostname error response (4XX). + 5XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Web3 Hostname response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/web3Identifier' + required: + - id + type: object + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Web3 Hostname response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete Web3 Hostname tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + method: delete get: operationId: web3-hostname-web3-hostname-details parameters: - - in: path - name: identifier + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response' - description: Web3 Hostname Details response - 4xx: + $ref: '#/components/schemas/web3SingleResponse' + description: Web3 Hostname Details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: + $ref: '#/components/schemas/web3Web3Hostname' + nullable: true + type: array + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Web3 Hostname Details error response (4XX). + 5XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Web3 Hostname Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef2e420942fb77cd2cd2ba3ca7b5f32e1e + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Web3 Hostname Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Web3 Hostname Details tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write + - Web3 Hostnames Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + method: get patch: operationId: web3-hostname-edit-web3-hostname parameters: - - in: path - name: identifier + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/modify_request' - required: true + $ref: '#/components/schemas/web3ModifyRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response' - description: Edit Web3 Hostname response - 4xx: + $ref: '#/components/schemas/web3SingleResponse' + description: Edit Web3 Hostname response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: + $ref: '#/components/schemas/web3Web3Hostname' + nullable: true + type: array + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Edit Web3 Hostname error response (4XX). + 5XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Web3 Hostname response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef2e420942fb77cd2cd2ba3ca7b5f32e1e + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Edit Web3 Hostname response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Edit Web3 Hostname tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list': + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + method: edit + /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list: get: operationId: web3-hostname-ipfs-universal-path-gateway-content-list-details parameters: - - in: path - name: identifier + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/content_list_details_response' - description: IPFS Universal Path Gateway Content List Details response - 4xx: + $ref: '#/components/schemas/web3ContentListDetailsResponse' + description: IPFS Universal Path Gateway Content List Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/content_list_details_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: IPFS Universal Path Gateway Content List Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + properties: + action: + $ref: '#/components/schemas/web3ContentListAction' + type: object + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + IPFS Universal Path Gateway Content List Details error response + (4XX). + 5XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + properties: + action: + $ref: '#/components/schemas/web3ContentListAction' + type: object + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: IPFS Universal Path Gateway Content List Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: IPFS Universal Path Gateway Content List Details tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write + - Web3 Hostnames Read x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + - ipfs_universal_paths + - content_lists + method: get put: operationId: web3-hostname-update-ipfs-universal-path-gateway-content-list parameters: - - in: path - name: identifier + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/content_list_update_request' - required: true + $ref: '#/components/schemas/web3ContentListUpdateRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/content_list_details_response' - description: Update IPFS Universal Path Gateway Content List response - 4xx: + $ref: '#/components/schemas/web3ContentListDetailsResponse' + description: Update IPFS Universal Path Gateway Content List response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/content_list_details_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update IPFS Universal Path Gateway Content List response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + properties: + action: + $ref: '#/components/schemas/web3ContentListAction' + type: object + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + Update IPFS Universal Path Gateway Content List error response + (4XX). + 5XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + properties: + action: + $ref: '#/components/schemas/web3ContentListAction' + type: object + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update IPFS Universal Path Gateway Content List response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update IPFS Universal Path Gateway Content List tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false - '/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries': + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + - ipfs_universal_paths + - content_lists + method: update + /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries: get: operationId: web3-hostname-list-ipfs-universal-path-gateway-content-list-entries parameters: - - in: path - name: identifier + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/content_list_entry_collection_response' - description: List IPFS Universal Path Gateway Content List Entries response - 4xx: + $ref: '#/components/schemas/web3ContentListEntryCollectionResponse' + description: List IPFS Universal Path Gateway Content List Entries response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: {} + nullable: true + type: object + properties: + entries: + $ref: '#/components/schemas/web3ContentListEntries' + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + List IPFS Universal Path Gateway Content List Entries error response + (4XX). + 5XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/content_list_entry_collection_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: List IPFS Universal Path Gateway Content List Entries response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: {} + nullable: true + type: object + properties: + entries: + $ref: '#/components/schemas/web3ContentListEntries' + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + List IPFS Universal Path Gateway Content List Entries response + failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: List IPFS Universal Path Gateway Content List Entries tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write + - Web3 Hostnames Read x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + - ipfs_universal_paths + - content_lists + - entries + method: list post: operationId: web3-hostname-create-ipfs-universal-path-gateway-content-list-entry parameters: - - in: path - name: identifier + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/content_list_entry_create_request' - required: true + $ref: '#/components/schemas/web3ContentListEntryCreateRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/content_list_entry_single_response' - description: Create IPFS Universal Path Gateway Content List Entry response - 4xx: + $ref: '#/components/schemas/web3ContentListEntrySingleResponse' + description: Create IPFS Universal Path Gateway Content List Entry response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef5e618833803e286db9ee7c73727f8b86 + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + Create IPFS Universal Path Gateway Content List Entry error response + (4XX). + 5XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/content_list_entry_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create IPFS Universal Path Gateway Content List Entry response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef5e618833803e286db9ee7c73727f8b86 + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + Create IPFS Universal Path Gateway Content List Entry response + failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create IPFS Universal Path Gateway Content List Entry tags: - Web3 Hostname @@ -868,149 +1058,945 @@ paths: enterprise: true free: false pro: false - '/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}': + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + - ipfs_universal_paths + - content_lists + - entries + method: create + /zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}: delete: operationId: web3-hostname-delete-ipfs-universal-path-gateway-content-list-entry parameters: - in: path name: content_list_entry_identifier - required: true schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: identifier + $ref: '#/components/schemas/web3Identifier' required: true + - name: identifier + in: path + required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete IPFS Universal Path Gateway Content List Entry response - 4xx: + $ref: '#/components/schemas/web3ApiResponseSingleId' + description: Delete IPFS Universal Path Gateway Content List Entry response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete IPFS Universal Path Gateway Content List Entry response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/web3Identifier' + required: + - id + type: object + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + Delete IPFS Universal Path Gateway Content List Entry error response + (4XX). + 5XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/web3Identifier' + required: + - id + type: object + enum: + - null + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + Delete IPFS Universal Path Gateway Content List Entry response + failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Delete IPFS Universal Path Gateway Content List Entry tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + - ipfs_universal_paths + - content_lists + - entries + method: delete get: operationId: web3-hostname-ipfs-universal-path-gateway-content-list-entry-details parameters: - in: path name: content_list_entry_identifier - required: true schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: identifier + $ref: '#/components/schemas/web3Identifier' required: true + - name: identifier + in: path + required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/content_list_entry_single_response' - description: IPFS Universal Path Gateway Content List Entry Details response - 4xx: + $ref: '#/components/schemas/web3ContentListEntrySingleResponse' + description: IPFS Universal Path Gateway Content List Entry Details response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/content_list_entry_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: IPFS Universal Path Gateway Content List Entry Details response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef5e618833803e286db9ee7c73727f8b86 + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + IPFS Universal Path Gateway Content List Entry Details error + response (4XX). + 5XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef5e618833803e286db9ee7c73727f8b86 + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + IPFS Universal Path Gateway Content List Entry Details response + failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: IPFS Universal Path Gateway Content List Entry Details tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write + - Web3 Hostnames Read x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + - ipfs_universal_paths + - content_lists + - entries + method: get put: operationId: web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry parameters: - in: path name: content_list_entry_identifier - required: true schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: identifier + $ref: '#/components/schemas/web3Identifier' + required: true + - name: identifier + in: path required: true + description: Resource identifier. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier + type: string + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/content_list_entry_create_request' - required: true + $ref: '#/components/schemas/web3ContentListEntryCreateRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/content_list_entry_single_response' - description: Edit IPFS Universal Path Gateway Content List Entry response - 4xx: + $ref: '#/components/schemas/web3ContentListEntrySingleResponse' + description: Edit IPFS Universal Path Gateway Content List Entry response. + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/content_list_entry_single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit IPFS Universal Path Gateway Content List Entry response failure + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef5e618833803e286db9ee7c73727f8b86 + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + Edit IPFS Universal Path Gateway Content List Entry error response + (4XX). + 5XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: >- + #/components/schemas/unnamedSchemaRef5e618833803e286db9ee7c73727f8b86 + success: + description: Specifies whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: >- + Edit IPFS Universal Path Gateway Content List Entry response + failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Edit IPFS Universal Path Gateway Content List Entry tags: - Web3 Hostname + x-api-token-group: + - Web3 Hostnames Write x-cfPlanAvailability: business: false enterprise: true free: false pro: false + x-stackql-sdk: + service: web3 + resource_chain: + - hostnames + - ipfs_universal_paths + - content_lists + - entries + method: update +components: + schemas: + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + unnamedSchemaRef2e420942fb77cd2cd2ba3ca7b5f32e1e: + properties: + created_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + description: + $ref: '#/components/schemas/web3Description' + dnslink: + $ref: '#/components/schemas/web3Dnslink' + id: + $ref: '#/components/schemas/web3Identifier' + modified_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + name: + $ref: '#/components/schemas/web3Name' + status: + $ref: '#/components/schemas/web3Status' + target: + $ref: '#/components/schemas/web3Target' + type: object + enum: + - null + unnamedSchemaRef5e618833803e286db9ee7c73727f8b86: + description: Specify a content list entry to block. + properties: + content: + $ref: '#/components/schemas/web3ContentListEntryContent' + created_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + description: + $ref: '#/components/schemas/web3ContentListEntryDescription' + id: + $ref: '#/components/schemas/web3Identifier' + modified_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + type: + $ref: '#/components/schemas/web3ContentListEntryType' + type: object + enum: + - null + web3ApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/web3Identifier' + required: + - id + type: object + success: + description: Specifies whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + web3CollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: + $ref: '#/components/schemas/web3Web3Hostname' + nullable: true + type: array + success: + description: Specifies whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + web3ContentListAction: + description: Behavior of the content list. + enum: + - block + example: block + type: string + web3ContentListDetails: + properties: + action: + $ref: '#/components/schemas/web3ContentListAction' + type: object + web3ContentListDetailsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: '#/components/schemas/web3ContentListDetails' + success: + description: Specifies whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + web3ContentListEntries: + description: Provides content list entries. + items: + $ref: '#/components/schemas/web3ContentListEntry' + type: array + web3ContentListEntry: + description: Specify a content list entry to block. + properties: + content: + $ref: '#/components/schemas/web3ContentListEntryContent' + created_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + description: + $ref: '#/components/schemas/web3ContentListEntryDescription' + id: + $ref: '#/components/schemas/web3Identifier' + modified_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + type: + $ref: '#/components/schemas/web3ContentListEntryType' + type: object + web3ContentListEntryCollectionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + items: {} + nullable: true + type: object + properties: + entries: + $ref: '#/components/schemas/web3ContentListEntries' + success: + description: Specifies whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/web3ResultInfo' + required: + - success + - errors + - messages + - result + web3ContentListEntryContent: + description: Specify the CID or content path of content to block. + example: QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB + maxLength: 500 + type: string + web3ContentListEntryCreateRequest: + properties: + content: + $ref: '#/components/schemas/web3ContentListEntryContent' + description: + $ref: '#/components/schemas/web3ContentListEntryDescription' + type: + $ref: '#/components/schemas/web3ContentListEntryType' + required: + - type + - content + type: object + web3ContentListEntryDescription: + description: Specify an optional description of the content list entry. + example: this is my content list entry + maxLength: 500 + type: string + web3ContentListEntrySingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: '#/components/schemas/web3ContentListEntry' + success: + description: Specifies whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + web3ContentListEntryType: + description: Specify the type of content list entry to block. + enum: + - cid + - content_path + example: cid + type: string + web3ContentListUpdateRequest: + properties: + action: + $ref: '#/components/schemas/web3ContentListAction' + entries: + $ref: '#/components/schemas/web3ContentListEntries' + required: + - action + - entries + type: object + web3CreateRequest: + properties: + description: + $ref: '#/components/schemas/web3Description' + dnslink: + $ref: '#/components/schemas/web3Dnslink' + name: + $ref: '#/components/schemas/web3Name' + target: + $ref: '#/components/schemas/web3Target' + required: + - name + - target + type: object + web3Description: + description: Specify an optional description of the hostname. + example: This is my IPFS gateway. + maxLength: 500 + type: string + web3Dnslink: + description: Specify the DNSLink value used if the target is ipfs. + example: /ipns/onboarding.ipfs.cloudflare.com + type: string + web3Identifier: + description: Specify the identifier of the hostname. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + web3Messages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + web3ModifyRequest: + properties: + description: + $ref: '#/components/schemas/web3Description' + dnslink: + $ref: '#/components/schemas/web3Dnslink' + type: object + web3Name: + description: Specify the hostname that points to the target gateway via CNAME. + example: gateway.example.com + maxLength: 255 + type: string + web3ResultInfo: + properties: + count: + description: Specifies the total number of results for the requested service. + example: 1 + type: number + page: + description: Specifies the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Specifies the number of results per page of results. + example: 20 + type: number + total_count: + description: Specifies the total results available without any search parameters. + example: 2000 + type: number + type: object + web3SingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/web3Messages' + messages: + $ref: '#/components/schemas/web3Messages' + result: + $ref: '#/components/schemas/web3Web3Hostname' + success: + description: Specifies whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + description: Provides the API response. + type: object + required: + - success + - errors + - messages + - result + web3Status: + description: Specifies the status of the hostname's activation. + enum: + - active + - pending + - deleting + - error + example: active + readOnly: true + type: string + web3Target: + description: Specify the target gateway of the hostname. + enum: + - ethereum + - ipfs + - ipfs_universal_path + example: ipfs + type: string + web3Timestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + web3Web3Hostname: + properties: + created_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + description: + $ref: '#/components/schemas/web3Description' + dnslink: + $ref: '#/components/schemas/web3Dnslink' + id: + $ref: '#/components/schemas/web3Identifier' + modified_on: + $ref: '#/components/schemas/web3Timestamp' + readOnly: true + name: + $ref: '#/components/schemas/web3Name' + status: + $ref: '#/components/schemas/web3Status' + target: + $ref: '#/components/schemas/web3Target' + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + hostnames: + id: cloudflare.web3.hostnames + name: hostnames + title: Hostnames + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1web3~1hostnames/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1web3~1hostnames/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/get' + - $ref: '#/components/x-stackQL-resources/hostnames/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/delete' + replace: [] + content_lists: + id: cloudflare.web3.content_lists + name: content_lists + title: Content Lists + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/content_lists/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/content_lists/methods/update' + entries: + id: cloudflare.web3.entries + name: entries + title: Entries + methods: + list: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.entries + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries~1{content_list_entry_identifier}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries~1{content_list_entry_identifier}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1web3~1hostnames~1{identifier}~1ipfs_universal_path~1content_list~1entries~1{content_list_entry_identifier}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/entries/methods/get' + - $ref: '#/components/x-stackQL-resources/entries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/entries/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/entries/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/entries/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/workers.yaml b/providers/src/cloudflare/v00.00.00000/services/workers.yaml index df727ad7..b6f15d21 100644 --- a/providers/src/cloudflare/v00.00.00000/services/workers.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/workers.yaml @@ -1,4203 +1,17685 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Durable Objects Namespace - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - workers - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - schemas-namespace: - properties: - class: - readOnly: true - id: - readOnly: true - name: - readOnly: true - script: - readOnly: true - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - namespaces_components-schemas-id: - description: ID of the namespace. - example: 5fd1cafff895419c8bcc647fc64ab8f0 - type: string - object: - properties: - hasStoredData: - description: Whether the Durable Object has stored data. - example: true - readOnly: true - type: boolean - id: - description: ID of the Durable Object. - example: fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8 - readOnly: true - type: string - type: object - schemas-cursor: - description: Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure. - example: AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc - type: string - queue: - properties: - consumers: - readOnly: true - consumers_total_count: - readOnly: true - created_on: - readOnly: true - modified_on: - readOnly: true - producers: - readOnly: true - producers_total_count: - readOnly: true - queue_id: - readOnly: true - queue_name: - $ref: '#/components/schemas/queues_components-schemas-name' - type: object - queues_components-schemas-name: - example: example-queue - type: string - queue_created: - properties: - created_on: - readOnly: true - modified_on: - readOnly: true - queue_id: - readOnly: true - queue_name: - $ref: '#/components/schemas/queues_components-schemas-name' - type: object - queue_updated: - properties: - created_on: - readOnly: true - modified_on: - readOnly: true - queue_id: - readOnly: true - queue_name: - $ref: '#/components/schemas/renamed_name' - type: object - renamed_name: - example: renamed-example-queue - type: string - consumer: - properties: - created_on: - readOnly: true - environment: - readOnly: true - queue_name: - readOnly: true - service: - readOnly: true - settings: - properties: - batch_size: - $ref: '#/components/schemas/batch_size' - max_retries: - $ref: '#/components/schemas/max_retries' - max_wait_time_ms: - $ref: '#/components/schemas/max_wait_time_ms' - type: object - type: object - batch_size: - example: 10 - type: number - max_retries: - example: 3 - type: number - max_wait_time_ms: - example: 5000 - type: number - consumer_created: - properties: - created_on: - readOnly: true - dead_letter_queue: - $ref: '#/components/schemas/dlq_name' - environment: - readOnly: true - queue_name: - readOnly: true - script_name: - readOnly: true - settings: - properties: - batch_size: - $ref: '#/components/schemas/batch_size' - max_retries: - $ref: '#/components/schemas/max_retries' - max_wait_time_ms: - $ref: '#/components/schemas/max_wait_time_ms' - type: object - type: object - dlq_name: - example: example-dlq - type: string - consumer_name: - example: example-consumer - type: string - consumer_updated: - properties: - created_on: - readOnly: true - dead_letter_queue: - example: updated-example-dlq - environment: - readOnly: true - queue_name: - readOnly: true - script_name: - readOnly: true - settings: - properties: - batch_size: - example: 100 - type: number - max_retries: - $ref: '#/components/schemas/max_retries' - max_wait_time_ms: - $ref: '#/components/schemas/max_wait_time_ms' - type: object - type: object - account-settings-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - properties: - default_usage_model: - readOnly: true - green_compute: - readOnly: true - type: object - binding: - oneOf: - - $ref: '#/components/schemas/kv_namespace_binding' - - $ref: '#/components/schemas/wasm_module_binding' - kv_namespace_binding: - properties: - name: - $ref: '#/components/schemas/binding_name' - namespace_id: - $ref: '#/components/schemas/namespace_identifier' - type: - description: The class of resource that the binding provides. - enum: - - kv_namespace - example: kv_namespace - type: string - required: - - name - - type - - namespace_id - type: object - wasm_module_binding: - properties: - name: - $ref: '#/components/schemas/binding_name' - type: - description: The class of resource that the binding provides. - enum: - - wasm_module - example: wasm_module - type: string - required: - - name - - type - type: object - binding_name: - description: A JavaScript variable name for the binding. - example: myBinding - readOnly: true - type: string - namespace_identifier: - description: Namespace identifier tag. - example: 0f2ac74b498b48028cb68387c421e279 - maxLength: 32 - readOnly: true - type: string - script_name: - description: 'Name of the script, used in URLs and route configuration.' - example: this-is_my_script-01 - pattern: '^[a-z0-9_][a-z0-9-_]*$' - type: string - cron-trigger-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - properties: - schedules: - items: - properties: - created_on: - readOnly: true - cron: - readOnly: true - modified_on: - readOnly: true - type: array - type: object - domains_components-schemas-account_identifier: - example: 9a7806061c88ada191ed06f989cc3dac - schemas-domain-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/domain' - type: array - type: object - domain: - properties: - environment: - $ref: '#/components/schemas/environment' - hostname: - $ref: '#/components/schemas/components-schemas-hostname' - id: - $ref: '#/components/schemas/domain_identifier' - service: - $ref: '#/components/schemas/service' - zone_id: - $ref: '#/components/schemas/zone_identifier' - zone_name: - $ref: '#/components/schemas/zone_name' - type: object - environment: - description: Worker environment associated with the zone and hostname. - example: production - type: string - components-schemas-hostname: - description: Hostname of the Worker Domain. - example: foo.example.com - type: string - domain_identifier: - description: Identifer of the Worker Domain. - example: dbe10b4bc17c295377eabd600e1787fd - service: - description: Worker service associated with the zone and hostname. - example: foo - type: string - zone_identifier: - description: Identifier of the zone. - example: 593c9c94de529bbbfaac7c53ced0447d - zone_name: - description: Name of the zone. - example: example.com - type: string - schemas-domain-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - $ref: '#/components/schemas/domain' - type: object - filter-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/filters' - type: array - filters: - properties: - enabled: - $ref: '#/components/schemas/filters_components-schemas-enabled' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - pattern: - $ref: '#/components/schemas/schemas-pattern' - required: - - id - - pattern - - enabled - type: object - filters_components-schemas-enabled: - example: true - title: Whether or not this filter will run a script - type: boolean - schemas-pattern: - example: example.net/* - title: Filter pattern - type: string - filter-no-id: - properties: - enabled: - $ref: '#/components/schemas/filters_components-schemas-enabled' - pattern: - $ref: '#/components/schemas/schemas-pattern' - required: - - pattern - - enabled - api-response-single-id: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - type: object - filter-response-single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/filters' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - route-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/routes' - type: array - routes: - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - pattern: - $ref: '#/components/schemas/pattern' - script: - $ref: '#/components/schemas/schemas-script_name' - required: - - id - - pattern - - script - type: object - pattern: - example: example.net/* - title: Route pattern - type: string - schemas-script_name: - description: Name of the script to apply when the route is matched. The route is skipped when this is blank/missing. - example: this-is_my_script-01 - pattern: '^[a-z0-9_][a-z0-9-_]*$' - type: string - route-no-id: - properties: - pattern: - $ref: '#/components/schemas/pattern' - script: - $ref: '#/components/schemas/schemas-script_name' - required: - - pattern - route-response-single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/routes' - script-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - properties: - created_on: - readOnly: true - etag: - readOnly: true - id: - readOnly: true - modified_on: - readOnly: true - usage_model: - readOnly: true - type: array - usage-model-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - properties: - usage_model: - readOnly: true - type: object - script-response-single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - subdomain-response: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - properties: - name: - readOnly: true - type: object - namespace: - properties: - id: - $ref: '#/components/schemas/namespace_identifier' - supports_url_encoding: - description: 'True if keys written on the URL will be URL-decoded before storing. For example, if set to "true", a key written on the URL as "%3F" will be stored as "?".' - example: true - readOnly: true - type: boolean - title: - $ref: '#/components/schemas/namespace_title' - required: - - id - - title - type: object - namespace_title: - description: A human-readable string name for a Namespace. - example: My Own Namespace - type: string - create_rename_namespace_body: - properties: - title: - $ref: '#/components/schemas/namespace_title' - required: - - title - type: object - bulk_delete: - items: - $ref: '#/components/schemas/key_name_bulk' - type: array - key_name_bulk: - description: 'A key''s name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.' - example: My-Key - maxLength: 512 - type: string - bulk_write: - items: - properties: - base64: - default: false - description: 'Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn''t otherwise be valid JSON strings, such as images.' - type: boolean - expiration: - $ref: '#/components/schemas/expiration' - expiration_ttl: - $ref: '#/components/schemas/expiration_ttl' - key: - $ref: '#/components/schemas/key_name_bulk' - metadata: - $ref: '#/components/schemas/list_metadata' - value: - description: 'A UTF-8 encoded string to be stored, up to 10 MB in length.' - example: Some string - maxLength: 10485760 - type: string - type: object - required: - - key - - value - type: array - expiration: - description: 'The time, measured in number of seconds since the UNIX epoch, at which the key should expire.' - example: 1578435000 - type: number - expiration_ttl: - description: The number of seconds for which the key should be visible before it expires. At least 60. - example: 300 - type: number - list_metadata: - description: Arbitrary JSON that is associated with a key. - example: - someMetadataKey: someMetadataValue - type: object - key: - description: A name for a value. A value stored under a given key may be retrieved via the same key. - properties: - expiration: - description: 'The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire.' - example: 1577836800 - type: number - metadata: - $ref: '#/components/schemas/list_metadata' - name: - $ref: '#/components/schemas/key_name' - required: - - name - type: object - cursor: - description: Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure. - example: 6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw - type: string - key_name: - description: 'A key''s name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL.' - example: My-Key - maxLength: 512 - type: string - kv_components-schemas-value: - description: 'A byte sequence to be stored, up to 10 MB in length.' - example: Some Value - type: string - components-schemas-metadata: - description: Arbitrary JSON to be associated with a key/value pair. - example: '{"someMetadataKey": "someMetadataValue"}' - type: string - components-schemas-result: - allOf: - - $ref: '#/components/schemas/schemas-result' - - properties: - data: - example: - - metrics: - - - 2 - - 4 - - - 16 - - 32 - max: - example: - readKiB: 32 - requests: 4 - min: - example: - readKiB: 16 - requests: 2 - query: - $ref: '#/components/schemas/schemas-query' - totals: - example: - readKiB: 48 - requests: 6 - schemas-result: - description: Metrics on Workers KV requests. - properties: - data: - items: - properties: - metrics: - description: List of metrics returned by the query. - items: {} - type: array - required: - - metrics - type: object - nullable: true - type: array - data_lag: - description: 'Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.' - example: 0 - minimum: 0 - type: number - max: - description: Maximum results for each metric. - min: - description: Minimum results for each metric. - query: - $ref: '#/components/schemas/query' - rows: - description: Total number of rows in the result. - example: 2 - minimum: 0 - type: number - totals: - description: Total results for metrics across all data. - required: - - rows - - data - - data_lag - - min - - max - - totals - - query - type: object - schemas-query: - allOf: - - $ref: '#/components/schemas/query' - - properties: - dimensions: - example: - - accountId - - responseCode - items: - enum: - - accountId - - responseCode - - requestType - filters: - example: requestType==read AND responseCode!=200 - metrics: - default: '["requests"]' - example: - - requests - - readKiB - items: - enum: - - requests - - writeKiB - - readKiB - sort: - example: - - +requests - - '-responseCode' - query: - description: For specifying result metrics. - properties: - dimensions: - default: '[]' - description: Can be used to break down the data by given attributes. - items: - description: For drilling down on metrics. - type: string - type: array - filters: - default: '""' - description: |- - Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: - - Operator | Name | URL Encoded - --------------------------|---------------------------------|-------------------------- - == | Equals | %3D%3D - != | Does not equals | !%3D - > | Greater Than | %3E - < | Less Than | %3C - >= | Greater than or equal to | %3E%3D - <= | Less than or equal to | %3C%3D . - type: string - limit: - default: 10000 - description: Limit number of returned metrics. - type: integer - metrics: - description: One or more metrics to compute. - items: - description: A quantitative measurement of KV usage. - type: string - type: array - since: - default: <6 hours ago> - description: 'Start of time interval to query, defaults to 6 hours before request received.' - example: '2019-01-02T02:20:00Z' - format: date-time - type: string - sort: - default: '[]' - description: 'Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).' - items: {} - type: array - until: - default: - description: 'End of time interval to query, defaults to current time.' - example: '2019-01-02T03:20:00Z' - format: date-time - type: string - type: object - stored_components-schemas-result: - allOf: - - $ref: '#/components/schemas/schemas-result' - - properties: - data: - example: - - metrics: - - - 2 - - 4 - - - 16 - - 32 - max: - example: - storedBytes: 32 - storedKeys: 4 - min: - example: - storedBytes: 16 - storedKeys: 2 - query: - $ref: '#/components/schemas/components-schemas-query' - totals: - example: - storedBytes: 48 - storedKeys: 6 - components-schemas-query: - allOf: - - $ref: '#/components/schemas/query' - - properties: - dimensions: - example: - - namespaceId - items: - enum: - - namespaceId - filters: - example: namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64 - metrics: - default: '["storedBytes"]' - example: - - storedBytes - - storedKeys - items: - enum: - - storedBytes - - storedKeys - sort: - example: - - +storedBytes - - '-namespaceId' - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_durable_objects_namespaces: - id: cloudflare.workers.accounts_durable_objects_namespaces - name: accounts_durable_objects_namespaces - title: Accounts Durable Objects Namespaces - methods: - durable_objects_namespace_list_namespaces: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1durable_objects~1namespaces/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _durable_objects_namespace_list_namespaces: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1durable_objects~1namespaces/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_durable_objects_namespaces/methods/durable_objects_namespace_list_namespaces' - insert: [] - update: [] - delete: [] - accounts_durable_objects_namespaces_objects: - id: cloudflare.workers.accounts_durable_objects_namespaces_objects - name: accounts_durable_objects_namespaces_objects - title: Accounts Durable Objects Namespaces Objects - methods: - durable_objects_namespace_list_objects: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1durable_objects~1namespaces~1{id}~1objects/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _durable_objects_namespace_list_objects: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1durable_objects~1namespaces~1{id}~1objects/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_durable_objects_namespaces_objects/methods/durable_objects_namespace_list_objects' - insert: [] - update: [] - delete: [] - accounts_queues: - id: cloudflare.workers.accounts_queues - name: accounts_queues - title: Accounts Queues - methods: - queue_list_queues: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _queue_list_queues: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues/get' - response: - mediaType: application/json - openAPIDocKey: '200' - queue_create_queue: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues/post' - response: - mediaType: application/json - openAPIDocKey: '200' - queue_delete_queue: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - queue_queue_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _queue_queue_details: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - queue_update_queue: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_queues/methods/queue_list_queues' - - $ref: '#/components/x-stackQL-resources/accounts_queues/methods/queue_queue_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_queues/methods/queue_create_queue' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_queues/methods/queue_delete_queue' - accounts_queues_consumers: - id: cloudflare.workers.accounts_queues_consumers - name: accounts_queues_consumers - title: Accounts Queues Consumers - methods: - queue_list_queue_consumers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}~1consumers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _queue_list_queue_consumers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}~1consumers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - queue_create_queue_consumer: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}~1consumers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - queue_delete_queue_consumer: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}~1consumers~1{consumer_name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - queue_update_queue_consumer: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1queues~1{name}~1consumers~1{consumer_name}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_queues_consumers/methods/queue_list_queue_consumers' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_queues_consumers/methods/queue_create_queue_consumer' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_queues_consumers/methods/queue_delete_queue_consumer' - accounts_account_settings: - id: cloudflare.workers.accounts_account_settings - name: accounts_account_settings - title: Accounts Account Settings - methods: - worker_account_settings_fetch_worker_account_settings: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1account-settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _worker_account_settings_fetch_worker_account_settings: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1account-settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_account_settings_create_worker_account_settings: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1account-settings/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - zones_script_bindings: - id: cloudflare.workers.zones_script_bindings - name: zones_script_bindings - title: Zones Script Bindings - methods: - worker_binding___deprecated__list_bindings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1workers~1script~1bindings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_binding___deprecated__list_bindings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1workers~1script~1bindings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_script_bindings/methods/worker_binding___deprecated__list_bindings' - insert: [] - update: [] - delete: [] - accounts_scripts_schedules: - id: cloudflare.workers.accounts_scripts_schedules - name: accounts_scripts_schedules - title: Accounts Scripts Schedules - methods: - worker_cron_trigger_get_cron_triggers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1schedules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_cron_trigger_get_cron_triggers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1schedules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_cron_trigger_update_cron_triggers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1schedules/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_scripts_schedules/methods/worker_cron_trigger_get_cron_triggers' - insert: [] - update: [] - delete: [] - accounts_domains: - id: cloudflare.workers.accounts_domains - name: accounts_domains - title: Accounts Domains - methods: - worker_domain_list_domains: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_domain_list_domains: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1domains/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_domain_attach_to_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1domains/put' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_domain_detach_from_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1domains~1{domain_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_domain_get_a_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1domains~1{domain_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_domain_get_a_domain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1domains~1{domain_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_domains/methods/worker_domain_list_domains' - - $ref: '#/components/x-stackQL-resources/accounts_domains/methods/worker_domain_get_a_domain' - insert: [] - update: [] - delete: [] - zones_filters: - id: cloudflare.workers.zones_filters - name: zones_filters - title: Zones Filters - methods: - worker_filters___deprecated__list_filters: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1filters/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_filters___deprecated__list_filters: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1filters/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_filters___deprecated__create_filter: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1filters/post' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_filters___deprecated__delete_filter: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1filters~1{filter_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_filters___deprecated__update_filter: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1filters~1{filter_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_filters/methods/worker_filters___deprecated__list_filters' - insert: - - $ref: '#/components/x-stackQL-resources/zones_filters/methods/worker_filters___deprecated__create_filter' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_filters/methods/worker_filters___deprecated__delete_filter' - zones_routes: - id: cloudflare.workers.zones_routes - name: zones_routes - title: Zones Routes - methods: - worker_routes_list_routes: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_routes_list_routes: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_routes_create_route: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes/post' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_routes_delete_route: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes~1{route_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_routes_get_route: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes~1{route_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_routes_get_route: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes~1{route_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_routes_update_route: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes~1{route_id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_routes/methods/worker_routes_list_routes' - - $ref: '#/components/x-stackQL-resources/zones_routes/methods/worker_routes_get_route' - insert: - - $ref: '#/components/x-stackQL-resources/zones_routes/methods/worker_routes_create_route' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_routes/methods/worker_routes_delete_route' - accounts_scripts: - id: cloudflare.workers.accounts_scripts - name: accounts_scripts - title: Accounts Scripts - methods: - worker_script_list_workers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_script_list_workers: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_script_delete_worker: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_script_download_worker: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _worker_script_download_worker: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_script_upload_worker_module: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_script_fetch_usage_model: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1usage-model/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _worker_script_fetch_usage_model: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1usage-model/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_script_update_usage_model: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1scripts~1{script_name}~1usage-model/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_scripts/methods/worker_script_list_workers' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_scripts/methods/worker_script_delete_worker' - zones_script: - id: cloudflare.workers.zones_script - name: zones_script - title: Zones Script - methods: - worker_script___deprecated__delete_worker: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1workers~1script/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_script___deprecated__download_worker: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1workers~1script/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _worker_script___deprecated__download_worker: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1workers~1script/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_script___deprecated__upload_worker: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1workers~1script/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones_script/methods/worker_script___deprecated__delete_worker' - accounts_subdomain: - id: cloudflare.workers.accounts_subdomain - name: accounts_subdomain - title: Accounts Subdomain - methods: - worker_subdomain_get_subdomain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1subdomain/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _worker_subdomain_get_subdomain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1subdomain/get' - response: - mediaType: application/json - openAPIDocKey: '200' - worker_subdomain_create_subdomain: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1workers~1subdomain/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_subdomain/methods/worker_subdomain_get_subdomain' - insert: [] - update: [] - delete: [] - accounts_storage_kv_namespaces: - id: cloudflare.workers.accounts_storage_kv_namespaces - name: accounts_storage_kv_namespaces - title: Accounts Storage Kv Namespaces - methods: - kv_namespace_list_namespaces: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _kv_namespace_list_namespaces: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces/get' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_namespace_create_a_namespace: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces/post' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_namespace_remove_a_namespace: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_namespace_rename_a_namespace: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_namespace_read_the_metadata_for_a_key: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1metadata~1{key_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _kv_namespace_read_the_metadata_for_a_key: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1metadata~1{key_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_storage_kv_namespaces/methods/kv_namespace_list_namespaces' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_storage_kv_namespaces/methods/kv_namespace_create_a_namespace' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_storage_kv_namespaces/methods/kv_namespace_remove_a_namespace' - accounts_storage_kv_namespaces_bulk: - id: cloudflare.workers.accounts_storage_kv_namespaces_bulk - name: accounts_storage_kv_namespaces_bulk - title: Accounts Storage Kv Namespaces Bulk - methods: - kv_namespace_delete_multiple_key_value_pairs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1bulk/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_namespace_write_multiple_key_value_pairs: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1bulk/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_storage_kv_namespaces_bulk/methods/kv_namespace_delete_multiple_key_value_pairs' - accounts_storage_kv_namespaces_keys: - id: cloudflare.workers.accounts_storage_kv_namespaces_keys - name: accounts_storage_kv_namespaces_keys - title: Accounts Storage Kv Namespaces Keys - methods: - kv_namespace_list_a_namespaces_keys: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1keys/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _kv_namespace_list_a_namespaces_keys: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1keys/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_storage_kv_namespaces_keys/methods/kv_namespace_list_a_namespaces_keys' - insert: [] - update: [] - delete: [] - accounts_storage_kv_namespaces_values: - id: cloudflare.workers.accounts_storage_kv_namespaces_values - name: accounts_storage_kv_namespaces_values - title: Accounts Storage Kv Namespaces Values - methods: - kv_namespace_delete_key_value_pair: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1values~1{key_name}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_namespace_read_key_value_pair: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1values~1{key_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _kv_namespace_read_key_value_pair: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1values~1{key_name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_namespace_write_key_value_pair_with_metadata: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1kv~1namespaces~1{namespace_identifier}~1values~1{key_name}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_storage_kv_namespaces_values/methods/kv_namespace_delete_key_value_pair' - accounts_storage_analytics: - id: cloudflare.workers.accounts_storage_analytics - name: accounts_storage_analytics - title: Accounts Storage Analytics - methods: - kv_request_analytics_query_request_analytics: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1analytics/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _kv_request_analytics_query_request_analytics: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1analytics/get' - response: - mediaType: application/json - openAPIDocKey: '200' - kv_stored_data_analytics_query_stored_data_analytics: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1analytics~1stored/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _kv_stored_data_analytics_query_stored_data_analytics: - operation: - $ref: '#/paths/~1accounts~1{account_identifier}~1storage~1analytics~1stored/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] -paths: - '/accounts/{account_identifier}/workers/durable_objects/namespaces': - get: - description: Returns the namespaces owned by an account. - operationId: durable-objects-namespace-list-namespaces - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-namespace' - type: array - type: object - description: List Namespaces response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-namespace' - type: array - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Namespaces response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Namespaces - tags: - - Durable Objects Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.durable-object.class.list - '/accounts/{account_identifier}/workers/durable_objects/namespaces/{id}/objects': - get: - description: Returns the Durable Objects in a given namespace. - operationId: durable-objects-namespace-list-objects - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/namespaces_components-schemas-id' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/object' - type: array - result_info: - properties: - count: - description: Total results returned based on your list parameters. - example: 1 - type: number - cursor: - $ref: '#/components/schemas/schemas-cursor' - type: object - description: List Objects response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/object' - type: array - result_info: - properties: - count: - description: Total results returned based on your list parameters. - example: 1 - type: number - cursor: - $ref: '#/components/schemas/schemas-cursor' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Objects response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Objects - tags: - - Durable Objects Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.durable-object.class.read - '/accounts/{account_identifier}/workers/queues': - get: - description: Returns the queues owned by an account. - operationId: queue-list-queues - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - errors: - nullable: true - - properties: - messages: - nullable: true - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - total_pages: - example: 1 - type: object - - properties: - result: - items: - $ref: '#/components/schemas/queue' - type: array - required: - - queue_id - - queue_name - - created_on - - modified_on - - producers_total_count - - producers - - consumers_total_count - - consumers - type: object - description: List Queues response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - errors: - nullable: true - - properties: - messages: - nullable: true - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - total_pages: - example: 1 - type: object - - properties: - result: - items: - $ref: '#/components/schemas/queue' - type: array - required: - - queue_id - - queue_name - - created_on - - modified_on - - producers_total_count - - producers - - consumers_total_count - - consumers - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Queues response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Queues - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.list - post: - description: Creates a new queue. - operationId: queue-create-queue - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: - queue_name: example-queue - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/queue_created' - type: object - required: - - queue_id - - queue_name - - created_on - - modified_on - type: object - description: Create Queue response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/queue_created' - type: object - required: - - queue_id - - queue_name - - created_on - - modified_on - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Queue response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Queue - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.create - '/accounts/{account_identifier}/workers/queues/{name}': - delete: - description: Deletes a queue. - operationId: queue-delete-queue - parameters: - - in: path - name: name - required: true - schema: - $ref: '#/components/schemas/queues_components-schemas-name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - nullable: true - properties: - result: - nullable: true - description: Delete Queue response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - nullable: true - properties: - result: - nullable: true - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Queue response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Queue - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.delete - get: - description: Get information about a specific queue. - operationId: queue-queue-details - parameters: - - in: path - name: name - required: true - schema: - $ref: '#/components/schemas/queues_components-schemas-name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/queue' - type: object - required: - - queue_id - - queue_name - - created_on - - modified_on - type: object - description: Queue Details response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/queue' - type: object - required: - - queue_id - - queue_name - - created_on - - modified_on - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Queue Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Queue Details - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.read - put: - description: Updates a queue. - operationId: queue-update-queue - parameters: - - in: path - name: name - required: true - schema: - $ref: '#/components/schemas/queues_components-schemas-name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: - queue_name: renamed-example-queue - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/queue_updated' - type: object - required: - - queue_id - - queue_name - - created_on - - modified_on - type: object - description: Update Queue response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/queue_updated' - type: object - required: - - queue_id - - queue_name - - created_on - - modified_on - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Queue response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Queue - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.update - '/accounts/{account_identifier}/workers/queues/{name}/consumers': - get: - description: Returns the consumers for a queue. - operationId: queue-list-queue-consumers - parameters: - - in: path - name: name - required: true - schema: - $ref: '#/components/schemas/queues_components-schemas-name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - errors: - nullable: true - - properties: - messages: - nullable: true - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - total_pages: - example: 1 - type: object - - properties: - result: - items: - $ref: '#/components/schemas/consumer' - type: array - required: - - queue_name - - created_on - - settings - type: object - description: List Queue Consumers response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - errors: - nullable: true - - properties: - messages: - nullable: true - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - total_pages: - example: 1 - type: object - - properties: - result: - items: - $ref: '#/components/schemas/consumer' - type: array - required: - - queue_name - - created_on - - settings - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Queue Consumers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Queue Consumers - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.list - post: - description: Creates a new consumer for a queue. - operationId: queue-create-queue-consumer - parameters: - - in: path - name: name - required: true - schema: - $ref: '#/components/schemas/queues_components-schemas-name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: - dead_letter_queue: example-dlq - environment: production - script_name: example-consumer - settings: - batch_size: 10 - max_retries: 3 - max_wait_time_ms: 5000 - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/consumer_created' - type: object - required: - - queue_name - - script_name - - settings - - dead_letter_queue - - created_on - type: object - description: Create Queue Consumer response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/consumer_created' - type: object - required: - - queue_name - - script_name - - settings - - dead_letter_queue - - created_on - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Queue Consumer response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Queue Consumer - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.create - '/accounts/{account_identifier}/workers/queues/{name}/consumers/{consumer_name}': - delete: - description: Deletes the consumer for a queue. - operationId: queue-delete-queue-consumer - parameters: - - in: path - name: consumer_name - required: true - schema: - $ref: '#/components/schemas/consumer_name' - - in: path - name: name - required: true - schema: - $ref: '#/components/schemas/queues_components-schemas-name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - nullable: true - properties: - result: - nullable: true - description: Delete Queue Consumer response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - nullable: true - properties: - result: - nullable: true - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Queue Consumer response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Queue Consumer - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.delete - put: - description: 'Updates the consumer for a queue, or creates one if it does not exist.' - operationId: queue-update-queue-consumer - parameters: - - in: path - name: consumer_name - required: true - schema: - $ref: '#/components/schemas/consumer_name' - - in: path - name: name - required: true - schema: - $ref: '#/components/schemas/queues_components-schemas-name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: - dead_letter_queue: updated-example-dlq - environment: production - script_name: example-consumer - settings: - batch_size: 100 - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/consumer_updated' - type: object - required: - - queue_name - - script_name - - settings - - dead_letter_queue - - created_on - type: object - description: Update Queue Consumer response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - allOf: - - $ref: '#/components/schemas/consumer_updated' - type: object - required: - - queue_name - - script_name - - settings - - dead_letter_queue - - created_on - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Queue Consumer response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Queue Consumer - tags: - - Queue - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.queue.update - '/accounts/{account_identifier}/workers/account-settings': - get: - description: Fetches Worker Account Settings for an account. - operationId: worker-account-settings-fetch-worker-account-settings - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/account-settings-response' - description: Fetch Worker Account Settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/account-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Fetch Worker Account Settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Fetch Worker Account Settings - tags: - - Worker Account Settings - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.read - put: - description: Creates Worker Account Settings for an account. - operationId: worker-account-settings-create-worker-account-settings - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: '{''default_usage_model'': ''unbound''}' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/account-settings-response' - description: Create Worker Account Settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/account-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Worker Account Settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Worker Account Settings - tags: - - Worker Account Settings - x-cfPermissionsRequired: - enum: - - com.cloudflare.api.account.update - '/zones/{zone_identifier}/workers/script/bindings': - get: - deprecated: true - description: List the bindings for a Workers script. - operationId: worker-binding-(-deprecated)-list-bindings - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/binding' - type: array - type: object - description: List Bindings response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/binding' - type: array - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Bindings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Bindings - tags: - - Worker Binding (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/bindings/x-cfDeprecations/worker_binding_deprecation' - '/accounts/{account_identifier}/workers/scripts/{script_name}/schedules': - get: - description: Fetches Cron Triggers for a Worker. - operationId: worker-cron-trigger-get-cron-triggers - parameters: - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/cron-trigger-response-collection' - description: Get Cron Triggers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/cron-trigger-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Cron Triggers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Cron Triggers - tags: - - Worker Cron Trigger - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.cron.trigger.read - put: - description: Updates Cron Triggers for a Worker. - operationId: worker-cron-trigger-update-cron-triggers - parameters: - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: '[{''cron'': ''*/30 * * * *''}]' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/cron-trigger-response-collection' - description: Update Cron Triggers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/cron-trigger-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Cron Triggers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Cron Triggers - tags: - - Worker Cron Trigger - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.cron.trigger.update - '/accounts/{account_identifier}/workers/domains': - get: - description: Lists all Worker Domains. - operationId: worker-domain-list-domains - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/domains_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-domain-response-collection' - description: List Domains response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-domain-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Domains response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Domains - tags: - - Worker Domain - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.domain.list - put: - description: Attaches a worker to a zone and hostname. - operationId: worker-domain-attach-to-domain - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/domains_components-schemas-account_identifier' - requestBody: - content: - application/json: - schema: - properties: - environment: - $ref: '#/components/schemas/environment' - hostname: - $ref: '#/components/schemas/components-schemas-hostname' - service: - $ref: '#/components/schemas/service' - zone_id: - $ref: '#/components/schemas/zone_identifier' - required: - - zone_id - - hostname - - service - - environment - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-domain-response-single' - description: Attach to Domain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-domain-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Attach to Domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Attach to Domain - tags: - - Worker Domain - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.domain.update - '/accounts/{account_identifier}/workers/domains/{domain_identifier}': - delete: - description: Detaches a worker from a zone and hostname. - operationId: worker-domain-detach-from-domain - parameters: - - in: path - name: domain_identifier - required: true - schema: - $ref: '#/components/schemas/domain_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/domains_components-schemas-account_identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: {} - description: Detach from Domain response - 4xx: - content: - application/json: {} - description: Detach from Domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Detach from Domain - tags: - - Worker Domain - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.domain.delete - get: - description: Gets a Worker Domain. - operationId: worker-domain-get-a-domain - parameters: - - in: path - name: domain_identifier - required: true - schema: - $ref: '#/components/schemas/domain_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/domains_components-schemas-account_identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-domain-response-single' - description: Get a Domain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-domain-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Domain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Domain - tags: - - Worker Domain - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.domain.read - '/zones/{zone_id}/workers/filters': - get: - deprecated: true - operationId: worker-filters-(-deprecated)-list-filters - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-response-collection' - description: List Filters response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Filters response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Filters - tags: - - Worker Filters (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation' - post: - deprecated: true - operationId: worker-filters-(-deprecated)-create-filter - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/filter-no-id' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Create Filter response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Filter response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Filter - tags: - - Worker Filters (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation' - '/zones/{zone_id}/workers/filters/{filter_id}': - delete: - deprecated: true - operationId: worker-filters-(-deprecated)-delete-filter - parameters: - - in: path - name: filter_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete Filter response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Filter response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Filter - tags: - - Worker Filters (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation' - put: - deprecated: true - operationId: worker-filters-(-deprecated)-update-filter - parameters: - - in: path - name: filter_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/filter-no-id' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-response-single' - description: Update Filter response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Filter response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Filter - tags: - - Worker Filters (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation' - '/zones/{zone_id}/workers/routes': - get: - operationId: worker-routes-list-routes - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route-response-collection' - description: List Routes response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Routes response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Routes - tags: - - Worker Routes - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.route.list - post: - operationId: worker-routes-create-route - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/route-no-id' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Create Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Route - tags: - - Worker Routes - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.route.create - '/zones/{zone_id}/workers/routes/{route_id}': - delete: - operationId: worker-routes-delete-route - parameters: - - in: path - name: route_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Route - tags: - - Worker Routes - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.route.delete - get: - operationId: worker-routes-get-route - parameters: - - in: path - name: route_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route-response-single' - description: Get Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Route - tags: - - Worker Routes - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.route.read - put: - operationId: worker-routes-update-route - parameters: - - in: path - name: route_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/route-no-id' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/route-response-single' - description: Update Route response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/route-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Route response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Route - tags: - - Worker Routes - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.route.update - '/accounts/{account_identifier}/workers/scripts': - get: - description: Fetch a list of uploaded workers. - operationId: worker-script-list-workers - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/script-response-collection' - description: List Workers response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/script-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Workers response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Workers - tags: - - Worker Script - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.list - '/accounts/{account_identifier}/workers/scripts/{script_name}': - delete: - description: |- - Delete your worker. This call has no response body on a successful delete. - - **Query paramaters**: - - 1. `force`: boolean; If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script. - operationId: worker-script-delete-worker - parameters: - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: {} - description: Delete Worker response - 4xx: - content: - application/json: {} - description: Delete Worker response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Worker - tags: - - Worker Script - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.delete - get: - description: 'Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.' - operationId: worker-script-download-worker - parameters: - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - undefined: - schema: - example: 'addEventListener(''fetch'', event => { event.respondWith(fetch(event.request)) })' - description: Download Worker response - 4xx: - content: - undefined: - schema: - example: 'addEventListener(''fetch'', event => { event.respondWith(fetch(event.request)) })' - description: Download Worker response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Download Worker - tags: - - Worker Script - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.read - put: - description: Upload a worker module. - operationId: worker-script-upload-worker-module - parameters: - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - multipart/form-data: - schema: - properties: - '"second-file.js"': - description: Worker script. - example: '@second-file.js;type=application/javascript+module' - type: string - '"worker.js"': - description: Worker script. - example: '@worker.js;type=application/javascript+module' - type: string - metadata: - description: Metadata for script such as bindings. Main module needs to be specified with `main_module`. - example: '{"main_module": "worker.js", "some_binding": "stuff"}' - type: string - required: true - responses: - '200': - content: - application/json: - schema: - example: - errors: [] - messages: [] - result: - created_on: '2022-05-05T05:15:11.602148Z' - etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1 - handlers: - - fetch - id: this-is_my_script-01 - modified_on: '2022-05-20T19:02:56.446492Z' - usage_model: bundled - success: true - description: Upload Worker Module response - 4xx: - content: - application/json: - schema: - allOf: - - example: - errors: [] - messages: [] - result: - created_on: '2022-05-05T05:15:11.602148Z' - etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1 - handlers: - - fetch - id: this-is_my_script-01 - modified_on: '2022-05-20T19:02:56.446492Z' - usage_model: bundled - success: true - - $ref: '#/components/schemas/api-response-common-failure' - description: Upload Worker Module response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Upload Worker Module - tags: - - Worker Script - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.create - '/accounts/{account_identifier}/workers/scripts/{script_name}/usage-model': - get: - description: Fetches the Usage Model for a given Worker. - operationId: worker-script-fetch-usage-model - parameters: - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/usage-model-response' - description: Fetch Usage Model response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/usage-model-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Fetch Usage Model response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Fetch Usage Model - tags: - - Worker Script - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.read - put: - description: Updates the Usage Model for a given Worker. Requires a Workers Paid subscription. - operationId: worker-script-update-usage-model - parameters: - - in: path - name: script_name - required: true - schema: - $ref: '#/components/schemas/script_name' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: '{''usage_model'': ''unbound''}' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/usage-model-response' - description: Update Usage Model response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/usage-model-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Usage Model response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Usage Model - tags: - - Worker Script - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.script.create - '/zones/{zone_identifier}/workers/script': - delete: - deprecated: true - description: Delete your worker. This call has no response body on a successful delete. - operationId: worker-script-(-deprecated)-delete-worker - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: {} - description: Delete Worker response - 4xx: - content: - application/json: {} - description: Delete Worker response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Worker - tags: - - Worker Script (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation' - get: - deprecated: true - description: 'Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.' - operationId: worker-script-(-deprecated)-download-worker - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - undefined: - schema: - example: 'addEventListener(''fetch'', event => { event.respondWith(fetch(event.request)) })' - description: Download Worker response - 4xx: - content: - undefined: - schema: - example: 'addEventListener(''fetch'', event => { event.respondWith(fetch(event.request)) })' - description: Download Worker response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Download Worker - tags: - - Worker Script (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation' - put: - deprecated: true - description: 'Upload a worker, or a new version of a worker.' - operationId: worker-script-(-deprecated)-upload-worker - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/javascript: - schema: - example: 'addEventListener(''fetch'', event => { event.respondWith(fetch(event.request)) })' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/script-response-single' - description: Upload Worker response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/script-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Upload Worker response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Upload Worker - tags: - - Worker Script (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation' - '/accounts/{account_identifier}/workers/subdomain': - get: - description: Returns a Workers subdomain for an account. - operationId: worker-subdomain-get-subdomain - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/subdomain-response' - description: Get Subdomain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/subdomain-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Subdomain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Subdomain - tags: - - Worker Subdomain - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.cron.subdomain.read - put: - description: Creates a Workers subdomain for an account. - operationId: worker-subdomain-create-subdomain - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - example: '{''subdomain'': ''example-subdomain''}' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/subdomain-response' - description: Create Subdomain response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/subdomain-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Subdomain response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Subdomain - tags: - - Worker Subdomain - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.worker.cron.subdomain.create - '/accounts/{account_identifier}/storage/kv/namespaces': - get: - description: Returns the namespaces owned by an account. - operationId: workers-kv-namespace-list-namespaces - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/namespace' - type: array - type: object - description: List Namespaces response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/namespace' - type: array - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Namespaces response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Namespaces - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.namespace.list - post: - description: Creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced. - operationId: workers-kv-namespace-create-a-namespace - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_rename_namespace_body' - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/namespace' - type: object - description: Create a Namespace response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/namespace' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a Namespace response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a Namespace - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.namespace.create - '/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}': - delete: - description: Deletes the namespace corresponding to the given ID. - operationId: workers-kv-namespace-remove-a-namespace - parameters: - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Remove a Namespace response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Remove a Namespace response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Remove a Namespace - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.namespace.delete - put: - description: Modifies a namespace's title. - operationId: workers-kv-namespace-rename-a-namespace - parameters: - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/create_rename_namespace_body' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Rename a Namespace response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Rename a Namespace response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Rename a Namespace - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.namespace.delete - '/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/bulk': - delete: - description: 'Remove multiple KV pairs from the Namespace. Body should be an array of up to 10,000 keys to be removed.' - operationId: workers-kv-namespace-delete-multiple-key-value-pairs - parameters: - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/bulk_delete' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Delete multiple key-value pairs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete multiple key-value pairs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete multiple key-value pairs - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.key.delete - put: - description: 'Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less.' - operationId: workers-kv-namespace-write-multiple-key-value-pairs - parameters: - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/bulk_write' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Write multiple key-value pairs response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Write multiple key-value pairs response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Write multiple key-value pairs - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.key.update - '/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/keys': - get: - description: Lists a namespace's keys. - operationId: workers-kv-namespace-list-a-namespace'-s-keys - parameters: - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/key' - type: array - result_info: - properties: - count: - description: Total results returned based on your list parameters. - example: 1 - type: number - cursor: - $ref: '#/components/schemas/cursor' - description: List a Namespace's Keys response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: - $ref: '#/components/schemas/key' - type: array - result_info: - properties: - count: - description: Total results returned based on your list parameters. - example: 1 - type: number - cursor: - $ref: '#/components/schemas/cursor' - - $ref: '#/components/schemas/api-response-common-failure' - description: List a Namespace's Keys response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List a Namespace's Keys - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.key.list - '/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/metadata/{key_name}': - get: - description: 'Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.' - operationId: workers-kv-namespace-read-the-metadata-for-a-key - parameters: - - in: path - name: key_name - required: true - schema: - $ref: '#/components/schemas/key_name' - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/list_metadata' - description: Read the metadata for a key response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/list_metadata' - - $ref: '#/components/schemas/api-response-common-failure' - description: Read the metadata for a key response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Read the metadata for a key - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.key.read - '/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/values/{key_name}': - delete: - description: 'Remove a KV pair from the Namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.' - operationId: workers-kv-namespace-delete-key-value-pair - parameters: - - in: path - name: key_name - required: true - schema: - $ref: '#/components/schemas/key_name' - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Delete key-value pair response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete key-value pair response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete key-value pair - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.key.delete - get: - description: 'Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the "Expiration" response header.' - operationId: workers-kv-namespace-read-key-value-pair - parameters: - - in: path - name: key_name - required: true - schema: - $ref: '#/components/schemas/key_name' - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/kv_components-schemas-value' - description: Read key-value pair response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/kv_components-schemas-value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Read key-value pair response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Read key-value pair - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.key.read - put: - description: 'Write a value identified by a key. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. Body should be the value to be stored along with json metadata to be associated with the key/value pair. Existing values, expirations and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.' - operationId: workers-kv-namespace-write-key-value-pair-with-metadata - parameters: - - in: path - name: key_name - required: true - schema: - $ref: '#/components/schemas/key_name' - - in: path - name: namespace_identifier - required: true - schema: - $ref: '#/components/schemas/namespace_identifier' - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - multipart/form-data: - schema: - properties: - metadata: - $ref: '#/components/schemas/components-schemas-metadata' - value: - $ref: '#/components/schemas/kv_components-schemas-value' - required: - - value - - metadata - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Write key-value pair with metadata response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Write key-value pair with metadata response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Write key-value pair with metadata - tags: - - Workers KV Namespace - x-cfPermissionsRequired: - enum: - - com.cloudflare.edge.storage.kv.key.update - '/accounts/{account_identifier}/storage/analytics': - get: - description: Retrieves Workers KV request metrics for the given account. - operationId: workers-kv-request-analytics-query-request-analytics - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/components-schemas-result' - type: object - description: Query Request Analytics response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/components-schemas-result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Query Request Analytics response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Query Request Analytics - tags: - - Workers KV Request Analytics - '/accounts/{account_identifier}/storage/analytics/stored': - get: - description: Retrieves Workers KV stored data metrics for the given account. - operationId: workers-kv-stored-data-analytics-query-stored-data-analytics - parameters: - - in: path - name: account_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/stored_components-schemas-result' - type: object - description: Query Stored Data Analytics response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/stored_components-schemas-result' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Query Stored Data Analytics response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Query Stored Data Analytics - tags: - - Workers KV Stored Data Analytics +openapi: 3.0.3 +info: + title: workers API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/builds/account/limits: + get: + description: Retrieve account limits and usage information + operationId: getAccountLimits + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsGetAccountLimitResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Account limits retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get account limits + tags: + - Account + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/builds: + get: + description: Retrieve builds for specific version IDs + operationId: getBuildsByVersionIds + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: version_ids + schema: + $ref: '#/components/schemas/buildsVersionIds' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsBuildsByVersionResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Builds retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get builds by version IDs + tags: + - Builds + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/builds/latest: + get: + description: Retrieve the most recent builds for multiple worker scripts + operationId: getLatestBuildsByScripts + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: external_script_ids + schema: + $ref: '#/components/schemas/buildsExternalScriptIds' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsLatestBuildsResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Latest builds retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get latest builds by script IDs + tags: + - Builds + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/builds/{build_uuid}: + get: + description: Retrieve detailed information about a specific build + operationId: getBuildByUuid + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: build_uuid + schema: + $ref: '#/components/schemas/buildsBuildUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsBuildResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Build retrieved successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get build by UUID + tags: + - Builds + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/builds/{build_uuid}/cancel: + put: + description: Cancel a running or queued build + operationId: cancelBuildByUuid + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: build_uuid + schema: + $ref: '#/components/schemas/buildsBuildUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsCanceledBuildResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Build canceled successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Cancel build + tags: + - Builds + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/builds/{build_uuid}/logs: + get: + description: Retrieve logs for a specific build with cursor-based pagination + operationId: getBuildLogs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: build_uuid + schema: + $ref: '#/components/schemas/buildsBuildUuid' + required: true + - in: query + name: cursor + schema: + $ref: '#/components/schemas/buildsCursor' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsBuildLogsResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Build logs retrieved successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get build logs + tags: + - Builds + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/repos/connections: + put: + description: Upsert a repository connection for CI/CD integration + operationId: upsertRepoConnection + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsUpsertRepoConnectionRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsUpsertRepoConnectionResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Repository connection upserted successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create or update repository connection + tags: + - Repository Connections + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/repos/connections/{repo_connection_uuid}: + delete: + description: Remove a repository connection + operationId: deleteRepoConnection + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: repo_connection_uuid + schema: + $ref: '#/components/schemas/buildsRepoConnectionUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsAPIResponse' + description: Operation successful + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete repository connection + tags: + - Repository Connections + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/repos/{provider_type}/{provider_account_id}/{repo_id}/config_autofill: + get: + description: Analyze repository for automatic configuration detection + operationId: getWorkerConfigAutofill + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: SCM provider type + in: path + name: provider_type + schema: + $ref: '#/components/schemas/buildsSCMProviderType' + required: true + - in: path + name: provider_account_id + schema: + $ref: '#/components/schemas/buildsProviderAccountId' + required: true + - in: path + name: repo_id + schema: + $ref: '#/components/schemas/buildsRepoId' + required: true + - in: query + name: branch + schema: + $ref: '#/components/schemas/buildsBranch' + - in: query + name: root_directory + schema: + $ref: '#/components/schemas/buildsRootDirectory' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsConfigAutofillResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Configuration autofill data retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get repository configuration autofill + tags: + - GitHub Integration + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/tokens: + get: + description: Get all build tokens with pagination + operationId: listBuildTokens + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number for pagination + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Number of items per page + in: query + name: per_page + schema: + default: 50 + maximum: 200 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: array + items: + $ref: '#/components/schemas/buildsListTokensResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Build tokens retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List build tokens + tags: + - Build Tokens + x-api-token-group: + - Workers CI Write + - Workers CI Read + post: + description: Create a new build authentication token + operationId: createBuildToken + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsCreateBuildTokenRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsCreateBuildTokenResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Build token created successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create build token + tags: + - Build Tokens + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/tokens/{build_token_uuid}: + delete: + description: Remove a build authentication token + operationId: deleteBuildToken + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: build_token_uuid + schema: + $ref: '#/components/schemas/buildsBuildTokenUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsAPIResponse' + description: Operation successful + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete build token + tags: + - Build Tokens + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/triggers: + post: + description: Create a new CI/CD trigger + operationId: createTrigger + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsCreateTriggerRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsTriggerResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Trigger created successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create trigger + tags: + - Triggers + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/triggers/{trigger_uuid}: + delete: + description: Remove a CI/CD trigger + operationId: deleteTrigger + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trigger_uuid + schema: + $ref: '#/components/schemas/buildsTriggerUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsAPIResponse' + description: Operation successful + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete trigger + tags: + - Triggers + x-api-token-group: + - Workers CI Write + patch: + description: Update an existing CI/CD trigger + operationId: updateTrigger + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trigger_uuid + schema: + $ref: '#/components/schemas/buildsTriggerUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsUpdateTriggerRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsTriggerResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Trigger updated successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update trigger + tags: + - Triggers + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/triggers/{trigger_uuid}/builds: + post: + description: Trigger a manual build for a specific trigger + operationId: createManualBuild + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trigger_uuid + schema: + $ref: '#/components/schemas/buildsTriggerUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsCreateBuildRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsInsertBuildResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Build created successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create manual build + tags: + - Triggers + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables: + get: + description: Get all environment variables for a trigger + operationId: listEnvironmentVariables + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trigger_uuid + schema: + $ref: '#/components/schemas/buildsTriggerUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsEnvironmentVariablesResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Environment variables retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List environment variables + tags: + - Environment Variables + x-api-token-group: + - Workers CI Write + - Workers CI Read + patch: + description: Create or update environment variables for a trigger + operationId: upsertEnvironmentVariables + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trigger_uuid + schema: + $ref: '#/components/schemas/buildsTriggerUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsEnvironmentVariablesRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsEnvironmentVariablesResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Environment variables updated successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upsert environment variables + tags: + - Environment Variables + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables/{environment_variable_key}: + delete: + description: Remove a specific environment variable from a trigger + operationId: deleteEnvironmentVariable + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trigger_uuid + schema: + $ref: '#/components/schemas/buildsTriggerUuid' + required: true + - in: path + name: environment_variable_key + schema: + $ref: '#/components/schemas/buildsEnvironmentVariableKey' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsAPIResponse' + description: Operation successful + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete environment variable + tags: + - Environment Variables + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/triggers/{trigger_uuid}/purge_build_cache: + post: + description: Clear the build cache for a specific trigger + operationId: purgeBuildCache + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: trigger_uuid + schema: + $ref: '#/components/schemas/buildsTriggerUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsAPIResponse' + description: Operation successful + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Purge build cache + tags: + - Triggers + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/workers/{external_script_id}/builds: + get: + description: Get all builds for a specific worker script with pagination + operationId: listBuildsByScript + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: external_script_id + schema: + $ref: '#/components/schemas/buildsExternalScriptId' + required: true + - description: Page number for pagination + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Number of items per page + in: query + name: per_page + schema: + default: 50 + maximum: 200 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: array + items: + $ref: '#/components/schemas/buildsBuildResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Builds retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List builds by script + tags: + - Workers + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/workers/{external_script_id}/triggers: + get: + description: Get all triggers for a specific worker script + operationId: listTriggersByScript + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: external_script_id + schema: + $ref: '#/components/schemas/buildsExternalScriptId' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: array + items: + $ref: '#/components/schemas/buildsTriggerResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Triggers retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List triggers by script + tags: + - Workers + x-api-token-group: + - Workers CI Write + - Workers CI Read + /accounts/{account_id}/builds/workers/{script_name}/deploy_hooks: + get: + description: Get all deploy hooks for a specific worker script. + operationId: listDeployHooks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: array + items: + $ref: '#/components/schemas/buildsDetailedDeployHookResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Deploy hooks retrieved successfully + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List deploy hooks + tags: + - Deploy Hooks + x-api-token-group: + - Workers CI Write + - Workers CI Read + post: + description: Create a new deploy hook for a worker script. + operationId: createDeployHook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsCreateDeployHookRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsDeployHookResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Deploy hook created successfully + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Invalid request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Conflict - duplicate resource + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create deploy hook + tags: + - Deploy Hooks + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}: + delete: + description: Delete a deploy hook. + operationId: deleteDeployHook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: Deploy hook UUID + in: path + name: deploy_hook_uuid + schema: + $ref: '#/components/schemas/buildsDeployHookUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsDeployHookResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Deploy hook deleted successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete deploy hook + tags: + - Deploy Hooks + x-api-token-group: + - Workers CI Write + get: + description: Get details of a specific deploy hook. + operationId: getDeployHook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: Deploy hook UUID + in: path + name: deploy_hook_uuid + schema: + $ref: '#/components/schemas/buildsDeployHookUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsDeployHookResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Deploy hook retrieved successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get deploy hook + tags: + - Deploy Hooks + x-api-token-group: + - Workers CI Write + - Workers CI Read + put: + description: Update an existing deploy hook. + operationId: updateDeployHook + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: Deploy hook UUID + in: path + name: deploy_hook_uuid + schema: + $ref: '#/components/schemas/buildsDeployHookUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/buildsCreateDeployHookRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsDeployHookResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Deploy hook updated successfully + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Invalid request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Conflict - duplicate resource + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update deploy hook + tags: + - Deploy Hooks + x-api-token-group: + - Workers CI Write + /accounts/{account_id}/containers: + get: + description: Lists all the container applications that are associated with your account. + operationId: publicListApplications + parameters: + - description: Filter containers by name + in: query + name: name + schema: + type: string + - description: Filter containers by image + in: query + name: image + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/ccMessages' + messages: + $ref: '#/components/schemas/ccMessages' + success: + description: Whether the API call was successful. + type: boolean + result: + items: + $ref: '#/components/schemas/ccPublicApplication' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Returns all public applications associated with your account. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ccV4BaseErrorResponse' + description: Unauthorized for Public API. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ccV4BaseErrorResponse' + description: InternalError500. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List containers. + tags: + - Containers + /accounts/{account_id}/containers/registries/{domain}/credentials: + post: + description: Generates temporary credentials for accessing Cloudflare's container image registry. Used for pulling and pushing container images. + operationId: generateImageRegistryCredentials + parameters: + - in: path + name: domain + schema: + description: The domain to get credentials for. + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ccImageRegistryCredentialsConfiguration' + responses: + '201': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/ccMessages' + messages: + $ref: '#/components/schemas/ccMessages' + success: + description: Whether the API call was successful. + type: boolean + result: + $ref: '#/components/schemas/ccAccountRegistryToken' + required: + - success + - errors + - messages + - result + type: object + description: Credentials with 'pull' or 'push' permissions to access the registry + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ccV4BaseErrorResponse' + description: Bad Request for Public API. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ccRegistryTokenPermissionsNotAllowedError' + description: The requested token permissions are not allowed for this account + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/ccV4BaseErrorResponse' + description: The image registry does not exist + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/ccV4BaseErrorResponse' + description: The registry was configured as public, so credentials can not be generated + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ccV4BaseErrorResponse' + description: InternalError500. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Generate a JWT to interact with the specified image registry. + tags: + - Image Registries + /accounts/{account_id}/workers/account-settings: + get: + description: Fetches Worker account settings for an account. + operationId: worker-account-settings-fetch-worker-account-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersAccountSettings' + required: + - success + - errors + - messages + - result + type: object + description: Fetch Worker Account Settings response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch Worker Account Settings response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch Worker Account Settings + tags: + - Worker Account Settings + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - DNS View Write + - DNS View Read + - SCIM Provisioning + - Load Balancers Account Write + - Load Balancers Account Read + - 'Zero Trust: PII Read' + - DDoS Botnet Feed Write + - DDoS Botnet Feed Read + - Workers R2 Storage Write + - Workers R2 Storage Read + - DDoS Protection Write + - DDoS Protection Read + - Workers Tail Read + - Workers KV Storage Write + - Workers KV Storage Read + - Workers Scripts Write + - Workers Scripts Read + - 'Load Balancing: Monitors and Pools Write' + - 'Load Balancing: Monitors and Pools Read' + - Account Firewall Access Rules Write + - Account Firewall Access Rules Read + - DNS Firewall Write + - DNS Firewall Read + - Billing Write + - Billing Read + - Account Settings Write + - Account Settings Read + x-stackql-sdk: + service: workers + resource_chain: + - account_settings + method: get + put: + description: Creates Worker account settings for an account. + operationId: worker-account-settings-create-worker-account-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersAccountSettings' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersAccountSettings' + required: + - success + - errors + - messages + - result + type: object + description: Create Worker Account Settings response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Create Worker Account Settings response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Worker Account Settings + tags: + - Worker Account Settings + x-api-token-group: + - Account Settings Write + x-stackql-sdk: + service: workers + resource_chain: + - account_settings + method: update + /accounts/{account_id}/workers/assets/upload: + post: + description: Upload assets ahead of creating a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/. + operationId: worker-assets-upload + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: base64 + schema: + description: Whether the file contents are base64-encoded. Must be `true`. + enum: + - true + type: boolean + requestBody: + content: + multipart/form-data: + encoding: + '*': + contentType: '*/*' + schema: + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/workersCompletedUploadAssetsResponse' + description: Upload Assets response. + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/workersUploadAssetsResponse' + description: Upload Assets response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Upload Assets response failure. + security: + - assets_jwt: [] + summary: Upload Assets + tags: + - Worker Script + x-stackql-sdk: + service: workers + resource_chain: + - assets + - upload + method: create + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts: + delete: + description: Delete multiple scripts from a Workers for Platforms namespace based on optional tag filters. + operationId: namespace-worker-delete-scripts + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - description: 'Filter scripts by tags before deletion. Format: comma-separated list of tag:allowed pairs where allowed is ''yes'' or ''no''.' + in: query + name: tags + schema: + type: string + - description: Limit the number of scripts to delete. + in: query + name: limit + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersNamespaceScriptDeleteBulkResponse' + description: Delete scripts in namespace response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete scripts in namespace response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Scripts in Namespace + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + get: + description: Fetch a list of scripts uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-list-scripts + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - description: 'Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is ''yes'' or ''no''.' + in: query + name: tags + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/workersNamespaceScriptResponse' + type: array + required: + - success + - errors + - messages + - result + type: object + description: List scripts in namespace response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List scripts in namespace response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Scripts in Namespace + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + /accounts/{account_id}/workers/domains: + get: + description: Lists all domains for an account. + operationId: workers.domains.list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: zone_id + schema: + description: ID of the zone containing the domain hostname. + type: string + - in: query + name: zone_name + schema: + description: Name of the zone containing the domain hostname. + type: string + - in: query + name: service + schema: + description: Name of the Worker associated with the domain. + type: string + - in: query + name: hostname + schema: + description: Hostname of the domain. + type: string + - deprecated: true + in: query + name: environment + schema: + description: Worker environment associated with the domain. + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/workersDomain' + type: array + required: + - success + - errors + - messages + - result + description: List domains response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List domains failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Domains + tags: + - Domains + x-api-token-group: + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - domains + method: list + put: + description: Attaches a domain that routes traffic to a Worker. + operationId: workers.domains.update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersDomain' + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersDomain' + required: + - success + - errors + - messages + - result + type: object + description: Attach domain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Attach domain failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Attach Domain + tags: + - Domains + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - domains + method: update + /accounts/{account_id}/workers/domains/{domain_id}: + delete: + description: Detaches a domain from a Worker. Both the Worker and all of its previews are no longer routable using this domain. + operationId: workers.domains.delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain_id + schema: + description: ID of the domain. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommon' + description: Detach domain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Detach domain failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Detach Domain + tags: + - Domains + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - domains + method: delete + get: + description: Gets information about a domain. + operationId: workers.domains.get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: domain_id + schema: + description: ID of the domain. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersDomain' + required: + - success + - errors + - messages + - result + type: object + description: Get domain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get domain failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Domain + tags: + - Domains + x-api-token-group: + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - domains + method: get + /accounts/{account_id}/workers/observability/destinations: + get: + description: List your Workers Observability Telemetry Destinations. + operationId: destination.list + parameters: + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - in: query + name: perPage + schema: + default: 20 + maximum: 50 + minimum: 5 + type: number + - in: query + name: order + schema: + default: desc + enum: + - asc + - desc + type: string + - in: query + name: orderBy + schema: + default: updated + enum: + - created + - updated + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + items: + properties: + configuration: + properties: + destination_conf: + type: string + headers: + type: object + jobStatus: + properties: + error_message: + type: string + last_complete: + type: string + last_error: + type: string + required: + - last_complete + - last_error + - error_message + type: object + logpushDataset: + type: string + enum: + - opentelemetry-traces + type: + enum: + - logpush + type: string + url: + type: string + required: + - type + - logpushDataset + - destination_conf + - url + - headers + - jobStatus + type: object + enabled: + type: boolean + name: + type: string + scripts: + items: + type: string + type: array + slug: + type: string + required: + - slug + - name + - enabled + - configuration + - scripts + type: object + type: array + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Not found + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Get Destinations + tags: + - Destinations + x-api-token-group: + - Workers Observability Write + - Workers Observability Read + x-stackql-sdk: + service: workers + resource_chain: + - observability + - destinations + method: list + post: + description: Create a new Workers Observability Telemetry Destination. + operationId: destination.create + requestBody: + content: + application/json: + schema: + properties: + configuration: + properties: + headers: + type: object + logpushDataset: + type: string + enum: + - opentelemetry-traces + type: + enum: + - logpush + type: string + url: + type: string + required: + - type + - logpushDataset + - url + - headers + type: object + enabled: + type: boolean + name: + type: string + skipPreflightCheck: + type: boolean + required: + - name + - enabled + - configuration + type: object + responses: + '201': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Resource created + type: string + required: + - message + type: object + type: array + result: + properties: + configuration: + properties: + destination_conf: + type: string + logpushDataset: + type: string + enum: + - opentelemetry-traces + logpushJob: + type: number + type: + enum: + - logpush + type: string + url: + type: string + required: + - type + - logpushDataset + - logpushJob + - destination_conf + - url + type: object + enabled: + type: boolean + name: + type: string + scripts: + items: + type: string + type: array + slug: + type: string + required: + - slug + - name + - enabled + - configuration + - scripts + type: object + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Resource created + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Bad Request + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Bad Request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Create Destination + tags: + - Destinations + x-api-token-group: + - Workers Observability Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: workers + resource_chain: + - observability + - destinations + method: create + /accounts/{account_id}/workers/observability/destinations/{slug}: + delete: + description: Delete a Workers Observability Telemetry Destination. + operationId: destinations.delete + parameters: + - in: path + name: slug + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + properties: + configuration: + properties: + destination_conf: + type: string + logpushDataset: + type: string + enum: + - opentelemetry-traces + logpushJob: + type: number + type: + enum: + - logpush + type: string + url: + type: string + required: + - type + - logpushDataset + - logpushJob + - destination_conf + - url + type: object + enabled: + type: boolean + name: + type: string + scripts: + items: + type: string + type: array + slug: + type: string + required: + - slug + - name + - enabled + - configuration + - scripts + type: object + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + type: object + description: Successful request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Not found + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Delete Destination + tags: + - Destinations + x-api-token-group: + - Workers Observability Write + x-stackql-sdk: + service: workers + resource_chain: + - observability + - destinations + method: delete + patch: + description: Update an existing Workers Observability Telemetry Destination. + operationId: destination.update + parameters: + - in: path + name: slug + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + configuration: + properties: + headers: + type: object + type: + enum: + - logpush + type: string + url: + type: string + required: + - type + - url + - headers + type: object + enabled: + type: boolean + required: + - enabled + - configuration + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + properties: + configuration: + properties: + destination_conf: + type: string + logpushDataset: + type: string + enum: + - opentelemetry-traces + logpushJob: + type: number + type: + enum: + - logpush + type: string + url: + type: string + required: + - type + - logpushDataset + - logpushJob + - destination_conf + - url + type: object + enabled: + type: boolean + name: + type: string + scripts: + items: + type: string + type: array + slug: + type: string + required: + - slug + - name + - enabled + - configuration + - scripts + type: object + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Bad Request + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Bad Request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Not found + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Update Destination + tags: + - Destinations + x-api-token-group: + - Workers Observability Write + x-stackql-sdk: + service: workers + resource_chain: + - observability + - destinations + method: update + /accounts/{account_id}/workers/observability/queries: + get: + description: List saved queries. + operationId: queries.list + parameters: + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - in: query + name: perPage + schema: + default: 20 + maximum: 50 + minimum: 5 + type: number + - in: query + name: order + schema: + default: desc + enum: + - asc + - desc + type: string + - in: query + name: orderBy + schema: + default: updated + enum: + - created + - updated + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + items: + $ref: '#/components/schemas/workersObservabilityQuery' + type: array + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Not found + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: List queries + tags: + - Saved Queries + x-api-token-group: + - Workers Observability Write + - Workers Observability Read + post: + description: Persist query for later use. + operationId: queries.post + requestBody: + content: + application/json: + schema: + properties: + description: + maxLength: 1000 + nullable: true + type: string + name: + description: Query name + maxLength: 250 + minLength: 1 + type: string + parameters: + properties: + calculations: + description: Create Calculations to compute as part of the query. + items: + properties: + alias: + type: string + key: + type: string + keyType: + enum: + - string + - number + - boolean + type: string + operator: + enum: + - uniq + - count + - max + - min + - sum + - avg + - median + - p001 + - p01 + - p05 + - p10 + - p25 + - p75 + - p90 + - p95 + - p99 + - p999 + - stddev + - variance + - COUNT_DISTINCT + - COUNT + - MAX + - MIN + - SUM + - AVG + - MEDIAN + - P001 + - P01 + - P05 + - P10 + - P25 + - P75 + - P90 + - P95 + - P99 + - P999 + - STDDEV + - VARIANCE + type: string + required: + - operator + type: object + type: array + datasets: + description: Set the Datasets to query. Leave it empty to query all the datasets. + items: + type: string + type: array + filterCombination: + description: Set a Flag to describe how to combine the filters on the query. + enum: + - and + - or + - AND + - OR + type: string + filters: + description: 'Configure the Filters to apply to the query. Supports nested groups via kind: ''group''.' + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + type: array + groupBys: + description: Define how to group the results of the query. + items: + properties: + type: + enum: + - string + - number + - boolean + type: string + value: + type: string + required: + - type + - value + type: object + type: array + havings: + description: Configure the Having clauses that filter on calculations in the query result. + items: + properties: + key: + type: string + operation: + enum: + - eq + - neq + - gt + - gte + - lt + - lte + type: string + value: + type: number + required: + - key + - operation + - value + type: object + type: array + limit: + description: Set a limit on the number of results / records returned by the query + maximum: 100 + minimum: 0 + type: integer + needle: + description: Define an expression to search using full-text search. + properties: + isRegex: + type: boolean + matchCase: + type: boolean + value: + maxLength: 1000 + type: string + required: + - value + type: object + orderBy: + description: Configure the order of the results returned by the query. + properties: + order: + description: Set the order of the results + enum: + - asc + - desc + type: string + value: + description: Configure which Calculation to order the results by. + type: string + required: + - value + type: object + type: object + required: + - description + - name + - parameters + type: object + description: Specify the new contents of the query. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + $ref: '#/components/schemas/workersObservabilityQuery' + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Conflict + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Conflict + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Save query + tags: + - Saved Queries + x-api-token-group: + - Workers Observability Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/workers/observability/queries/{query_id}: + delete: + description: Delete a saved query. + operationId: queries.delete + parameters: + - in: path + name: query_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + $ref: '#/components/schemas/workersObservabilityQuery' + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Not found + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Delete query + tags: + - Saved Queries + x-api-token-group: + - Workers Observability Write + get: + description: Retrieve a saved query. + operationId: queries.get + parameters: + - in: path + name: query_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + $ref: '#/components/schemas/workersObservabilityQuery' + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Not found + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Get query + tags: + - Saved Queries + x-api-token-group: + - Workers Observability Write + - Workers Observability Read + patch: + description: Update saved query. + operationId: queries.patch + parameters: + - in: path + name: query_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + maxLength: 1000 + nullable: true + type: string + name: + description: Query name + maxLength: 250 + minLength: 1 + type: string + parameters: + properties: + calculations: + description: Create Calculations to compute as part of the query. + items: + properties: + alias: + type: string + key: + type: string + keyType: + enum: + - string + - number + - boolean + type: string + operator: + enum: + - uniq + - count + - max + - min + - sum + - avg + - median + - p001 + - p01 + - p05 + - p10 + - p25 + - p75 + - p90 + - p95 + - p99 + - p999 + - stddev + - variance + - COUNT_DISTINCT + - COUNT + - MAX + - MIN + - SUM + - AVG + - MEDIAN + - P001 + - P01 + - P05 + - P10 + - P25 + - P75 + - P90 + - P95 + - P99 + - P999 + - STDDEV + - VARIANCE + type: string + required: + - operator + type: object + type: array + datasets: + description: Set the Datasets to query. Leave it empty to query all the datasets. + items: + type: string + type: array + filterCombination: + description: Set a Flag to describe how to combine the filters on the query. + enum: + - and + - or + - AND + - OR + type: string + filters: + description: 'Configure the Filters to apply to the query. Supports nested groups via kind: ''group''.' + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + type: array + groupBys: + description: Define how to group the results of the query. + items: + properties: + type: + enum: + - string + - number + - boolean + type: string + value: + type: string + required: + - type + - value + type: object + type: array + havings: + description: Configure the Having clauses that filter on calculations in the query result. + items: + properties: + key: + type: string + operation: + enum: + - eq + - neq + - gt + - gte + - lt + - lte + type: string + value: + type: number + required: + - key + - operation + - value + type: object + type: array + limit: + description: Set a limit on the number of results / records returned by the query + maximum: 100 + minimum: 0 + type: integer + needle: + description: Define an expression to search using full-text search. + properties: + isRegex: + type: boolean + matchCase: + type: boolean + value: + maxLength: 1000 + type: string + required: + - value + type: object + orderBy: + description: Configure the order of the results returned by the query. + properties: + order: + description: Set the order of the results + enum: + - asc + - desc + type: string + value: + description: Configure which Calculation to order the results by. + type: string + required: + - value + type: object + type: object + required: + - description + - name + - parameters + type: object + description: Specify the new contents of the query. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + $ref: '#/components/schemas/workersObservabilityQuery' + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Not found + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Not found + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Update query + tags: + - Saved Queries + x-api-token-group: + - Workers Observability Write + /accounts/{account_id}/workers/observability/telemetry/keys: + post: + description: List all the keys in your telemetry events. + operationId: telemetry.keys.list + requestBody: + content: + application/json: + schema: + properties: + datasets: + default: [] + description: Leave this empty to use the default datasets + items: + type: string + type: array + filters: + default: [] + description: 'Apply filters to narrow key discovery. Supports nested groups via kind: ''group''. Maximum nesting depth is 4.' + items: + description: 'Supports nested groups via kind: ''group''.' + type: object + properties: + filterCombination: + enum: + - and + - or + - AND + - OR + type: string + filters: + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + minItems: 1 + type: array + kind: + enum: + - group + type: string + key: + description: Filter field name. Use verified keys from previous query results or the keys endpoint. Common keys include $metadata.service, $metadata.origin, $metadata.trigger, $metadata.message, and $metadata.error. + type: string + operation: + description: 'Comparison operator. String operators: includes, not_includes, starts_with, regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.' + enum: + - includes + - not_includes + - starts_with + - regex + - exists + - is_null + - in + - not_in + - eq + - neq + - gt + - gte + - lt + - lte + - '=' + - '!=' + - '>' + - '>=' + - < + - <= + - INCLUDES + - DOES_NOT_INCLUDE + - MATCH_REGEX + - EXISTS + - DOES_NOT_EXIST + - IN + - NOT_IN + - STARTS_WITH + type: string + type: + description: Data type of the filter field. Must match the actual type of the key being filtered. + enum: + - string + - number + - boolean + type: string + value: + description: "Comparison value. Must match actual values in your data \u2014 verify with the values endpoint. Ensure the value type (string/number/boolean) matches the field type. String comparisons are case-sensitive. Regex uses RE2 syntax (no lookaheads/lookbehinds)." + type: string + required: [] + type: array + from: + type: number + keyNeedle: + description: If the user suggests a key, use this to narrow down the list of keys returned. Make sure matchCase is false to avoid case sensitivity issues. + properties: + isRegex: + description: When true, treats the value as a regular expression (RE2 syntax). + type: boolean + matchCase: + description: When true, performs a case-sensitive search. Defaults to case-insensitive. + type: boolean + value: + description: The text or pattern to search for. + maxLength: 1000 + type: string + required: + - value + type: object + limit: + description: 'Advanced usage: set limit=1000+ to retrieve comprehensive key options without needing additional filtering.' + type: number + needle: + description: Search for a specific substring in any of the events + properties: + isRegex: + description: When true, treats the value as a regular expression (RE2 syntax). + type: boolean + matchCase: + description: When true, performs a case-sensitive search. Defaults to case-insensitive. + type: boolean + value: + description: The text or pattern to search for. + maxLength: 1000 + type: string + required: + - value + type: object + to: + type: number + type: object + description: Find keys in your telemetry events matching a specific filter or needle. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + items: + properties: + key: + type: string + lastSeenAt: + type: number + type: + enum: + - string + - boolean + - number + type: string + required: + - key + - type + - lastSeenAt + type: object + type: array + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Bad Request + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Bad Request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: List keys + tags: + - Keys + x-api-token-group: + - Workers Observability Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/workers/observability/telemetry/query: + post: + description: Run a temporary or saved query. + operationId: telemetry.query + requestBody: + content: + application/json: + schema: + properties: + chart: + description: When true, includes time-series data in the response. + type: boolean + compare: + description: When true, includes a comparison dataset from the previous time period of equal length. + type: boolean + dry: + default: false + description: When true, executes the query without persisting the results. Useful for validation or previewing. + type: boolean + granularity: + description: Number of time-series buckets. Only used when view is 'calculations'. Omit to let the system auto-detect an appropriate granularity. + type: number + ignoreSeries: + default: false + description: When true, omits time-series data from the response and returns only aggregated values. Reduces response size when series are not needed. + type: boolean + limit: + default: 50 + description: Maximum number of events to return when view is 'events'. Also controls the number of group-by rows when view is 'calculations'. + maximum: 2000 + type: number + offset: + description: Cursor for pagination in event, trace, and invocation views. Pass the $metadata.id of the last returned item to fetch the next page. + type: string + offsetBy: + description: Numeric offset for paginating grouped/pattern results (top-N lists). Use together with limit. Not used by cursor-based pagination. + type: number + offsetDirection: + description: 'Pagination direction: ''next'' for forward, ''prev'' for backward.' + type: string + parameters: + description: "Query parameters defining what data to retrieve \u2014 filters, calculations, group-bys, and ordering. In practice this should always be provided for ad-hoc queries. Only omit when executing a previously saved query by queryId. Use the keys and values endpoints to discover available fields before building filters." + properties: + calculations: + description: Aggregation calculations to compute (e.g. count, avg, p99). Each calculation produces aggregate values and optional time-series data. + items: + properties: + alias: + description: Custom label for this calculation in the results. Useful for distinguishing multiple calculations. + type: string + key: + description: "Field name to calculate over. Must exist in the data \u2014 verify with the keys endpoint. Omit for operators that don't require a key (e.g. count)." + type: string + keyType: + description: Data type of the key. Required when key is provided to ensure correct aggregation. + enum: + - string + - number + - boolean + type: string + operator: + description: 'Aggregation operator to apply. Examples: count, avg, sum, min, max, p50, p90, p95, p99, uniq, stddev, variance.' + enum: + - uniq + - count + - max + - min + - sum + - avg + - median + - p001 + - p01 + - p05 + - p10 + - p25 + - p75 + - p90 + - p95 + - p99 + - p999 + - stddev + - variance + - COUNT_DISTINCT + - COUNT + - MAX + - MIN + - SUM + - AVG + - MEDIAN + - P001 + - P01 + - P05 + - P10 + - P25 + - P75 + - P90 + - P95 + - P99 + - P999 + - STDDEV + - VARIANCE + type: string + required: + - operator + type: object + type: array + datasets: + description: Datasets to query. Leave empty to query all available datasets. + items: + type: string + type: array + filterCombination: + description: 'Logical operator for combining top-level filters: ''and'' (all must match) or ''or'' (any must match). Defaults to ''and''.' + enum: + - and + - or + - AND + - OR + type: string + filters: + description: 'Filters to narrow query results. Use the keys and values endpoints to discover available fields before building filters. Supports nested groups via kind: ''group''. Maximum nesting depth is 4.' + items: + description: 'Supports nested groups via kind: ''group''.' + type: object + properties: + filterCombination: + enum: + - and + - or + - AND + - OR + type: string + filters: + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + minItems: 1 + type: array + kind: + enum: + - group + type: string + key: + description: Filter field name. Use verified keys from previous query results or the keys endpoint. Common keys include $metadata.service, $metadata.origin, $metadata.trigger, $metadata.message, and $metadata.error. + type: string + operation: + description: 'Comparison operator. String operators: includes, not_includes, starts_with, regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.' + enum: + - includes + - not_includes + - starts_with + - regex + - exists + - is_null + - in + - not_in + - eq + - neq + - gt + - gte + - lt + - lte + - '=' + - '!=' + - '>' + - '>=' + - < + - <= + - INCLUDES + - DOES_NOT_INCLUDE + - MATCH_REGEX + - EXISTS + - DOES_NOT_EXIST + - IN + - NOT_IN + - STARTS_WITH + type: string + type: + description: Data type of the filter field. Must match the actual type of the key being filtered. + enum: + - string + - number + - boolean + type: string + value: + description: "Comparison value. Must match actual values in your data \u2014 verify with the values endpoint. Ensure the value type (string/number/boolean) matches the field type. String comparisons are case-sensitive. Regex uses RE2 syntax (no lookaheads/lookbehinds)." + type: string + required: [] + type: array + groupBys: + description: Fields to group calculation results by. Only applicable when the query view is 'calculations'. Produces per-group aggregate values. + items: + properties: + type: + description: Data type of the group-by field. + enum: + - string + - number + - boolean + type: string + value: + description: Field name to group results by (e.g. $metadata.service, $metadata.statusCode). + type: string + required: + - type + - value + type: object + type: array + havings: + description: Post-aggregation filters applied to calculation results. Use to filter groups after aggregation (e.g. only groups where count > 100). + items: + properties: + key: + description: Calculation alias or operator to filter on after aggregation. + type: string + operation: + description: 'Numeric comparison operator: eq, neq, gt, gte, lt, lte.' + enum: + - eq + - neq + - gt + - gte + - lt + - lte + type: string + value: + description: Threshold value to compare the calculation result against. + type: number + required: + - key + - operation + - value + type: object + type: array + limit: + description: Maximum number of group-by rows to return in calculation results. A value of 10 is a sensible default for most use cases. + maximum: 2000 + minimum: 0 + type: integer + needle: + description: Full-text search expression applied across all event fields. Matches events containing the specified text. + properties: + isRegex: + description: When true, treats the value as a regular expression (RE2 syntax). + type: boolean + matchCase: + description: When true, performs a case-sensitive search. Defaults to case-insensitive. + type: boolean + value: + description: The text or pattern to search for. + maxLength: 1000 + type: string + required: + - value + type: object + orderBy: + description: Ordering for grouped calculation results. Only effective when a group-by is present. + properties: + order: + description: 'Sort direction: ''asc'' for ascending, ''desc'' for descending.' + enum: + - asc + - desc + type: string + value: + description: Alias of the calculation to order results by. Must match the alias (or operator) of a calculation in the query. + type: string + required: + - value + type: object + type: object + queryId: + description: Identifier for the query. When parameters are omitted, this ID is used to load a previously saved query's parameters. When providing parameters inline, pass any identifier (e.g. an ad-hoc ID). + type: string + timeframe: + description: Timeframe for the query using Unix timestamps in milliseconds. Narrower timeframes produce faster responses and more specific results. + properties: + from: + description: Start timestamp for the query timeframe (Unix timestamp in milliseconds) + type: number + to: + description: End timestamp for the query timeframe (Unix timestamp in milliseconds) + type: number + required: + - to + - from + type: object + view: + default: calculations + description: 'Controls the shape of the response. ''events'': individual log lines matching the query. ''calculations'': aggregated metrics (count, avg, p99, etc.) with optional group-by breakdowns and time-series. ''invocations'': events grouped by request ID. ''traces'': distributed trace summaries. ''agents'': Durable Object agent summaries.' + enum: + - traces + - events + - calculations + - invocations + - requests + - agents + type: string + required: + - queryId + - timeframe + type: object + description: Query your observability events, requests, and traces to build visualizations and identify insights. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + $ref: '#/components/schemas/workersObservabilityQueryResults' + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Bad Request + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Bad Request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: Run a query + tags: + - Query run + x-api-token-group: + - Workers Observability Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + x-stackql-sdk: + service: workers + resource_chain: + - observability + - telemetry + method: query + /accounts/{account_id}/workers/observability/telemetry/values: + post: + description: List unique values found in your events. + operationId: telemetry.values.list + requestBody: + content: + application/json: + schema: + properties: + datasets: + description: Leave this empty to use the default datasets + items: + type: string + type: array + filters: + default: [] + description: 'Apply filters before listing values. Supports nested groups via kind: ''group''. Maximum nesting depth is 4.' + items: + description: 'Supports nested groups via kind: ''group''.' + type: object + properties: + filterCombination: + enum: + - and + - or + - AND + - OR + type: string + filters: + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + minItems: 1 + type: array + kind: + enum: + - group + type: string + key: + description: Filter field name. Use verified keys from previous query results or the keys endpoint. Common keys include $metadata.service, $metadata.origin, $metadata.trigger, $metadata.message, and $metadata.error. + type: string + operation: + description: 'Comparison operator. String operators: includes, not_includes, starts_with, regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.' + enum: + - includes + - not_includes + - starts_with + - regex + - exists + - is_null + - in + - not_in + - eq + - neq + - gt + - gte + - lt + - lte + - '=' + - '!=' + - '>' + - '>=' + - < + - <= + - INCLUDES + - DOES_NOT_INCLUDE + - MATCH_REGEX + - EXISTS + - DOES_NOT_EXIST + - IN + - NOT_IN + - STARTS_WITH + type: string + type: + description: Data type of the filter field. Must match the actual type of the key being filtered. + enum: + - string + - number + - boolean + type: string + value: + description: "Comparison value. Must match actual values in your data \u2014 verify with the values endpoint. Ensure the value type (string/number/boolean) matches the field type. String comparisons are case-sensitive. Regex uses RE2 syntax (no lookaheads/lookbehinds)." + type: string + required: [] + type: array + key: + type: string + limit: + default: 50 + type: number + needle: + description: Full-text search expression to match events containing the specified text or pattern. + properties: + isRegex: + description: When true, treats the value as a regular expression (RE2 syntax). + type: boolean + matchCase: + description: When true, performs a case-sensitive search. Defaults to case-insensitive. + type: boolean + value: + description: The text or pattern to search for. + maxLength: 1000 + type: string + required: + - value + type: object + timeframe: + properties: + from: + type: number + to: + type: number + required: + - to + - from + type: object + type: + enum: + - string + - boolean + - number + type: string + required: + - timeframe + - key + - type + - datasets + type: object + description: Retrieve values from your telemetry events. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + enum: + - Successful request + type: string + required: + - message + type: object + type: array + result: + items: + properties: + dataset: + type: string + key: + type: string + type: + enum: + - string + - boolean + - number + type: string + value: + type: string + required: + - key + - type + - value + - dataset + type: object + type: array + success: + enum: + - true + type: boolean + required: + - messages + - success + - errors + - result + type: object + description: Successful request + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Bad Request + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Bad Request + '401': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Unauthorized + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Unauthorized + '500': + content: + application/json: + schema: + properties: + errors: + items: + properties: + detail: + type: string + message: + enum: + - Internal error + type: string + required: + - message + type: object + type: array + messages: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - errors + - success + - messages + type: object + description: Internal error + summary: List values + tags: + - Values + x-api-token-group: + - Workers Observability Write + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + /accounts/{account_id}/workers/placement/regions: + get: + description: Returns a list of available placement regions organized by cloud provider. These regions can be used to configure Smart Placement for Workers. + operationId: worker-placement-list-regions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersPlacementRegionsResponse' + required: + - success + - errors + - messages + - result + type: object + description: List Placement Regions response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List Placement Regions response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Placement Regions + tags: + - Worker Placement + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + /accounts/{account_id}/workers/scripts: + get: + description: Fetch a list of uploaded workers. + operationId: worker-script-list-workers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: 'Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is ''yes'' or ''no''.' + in: query + name: tags + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptResponseCollection' + description: List Workers response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List Workers response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Workers + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + method: list + /accounts/{account_id}/workers/scripts-search: + get: + description: Search for Workers in an account. + operationId: worker-script-search-workers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: Worker name to search for. Both exact and partial matches are returned. + type: string + - in: query + name: id + schema: + description: Worker ID (also called tag) to search for. Only exact matches are returned. + type: string + - in: query + name: order_by + schema: + default: name + description: Property to sort results by. Results are sorted in ascending order. + enum: + - created_on + - modified_on + - name + type: string + - description: Current page. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Items per page. + in: query + name: per_page + schema: + default: 10 + maximum: 100 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + properties: + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + environment_is_default: + description: Whether the environment is the default environment. + type: boolean + environment_name: + description: Name of the environment. + type: string + id: + $ref: '#/components/schemas/workersIdentifier' + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + script_name: + $ref: '#/components/schemas/workersScriptName' + service_name: + description: Name of the service. + type: string + required: + - id + - script_name + - created_on + - modified_on + type: object + type: array + required: + - success + - errors + - messages + - result + description: Search Workers success. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Search Workers failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Search Workers + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + method: search + /accounts/{account_id}/workers/scripts/{script_name}: + delete: + description: Delete your worker. This call has no response body on a successful delete. + operationId: worker-script-delete-worker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script. + in: query + name: force + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseNullResult' + description: Delete Worker response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete Worker response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Worker + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + method: delete + get: + description: Fetch raw script content for your worker. Note this is the original script content, not JSON encoded. + operationId: worker-script-download-worker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + type: object + properties: + contents: + type: string + description: Worker successfully downloaded. Returns script content as a multipart form, with no metadata part and no JSON encoding applied. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Download Worker response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Download Worker + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + method: get + put: + description: 'Upload a worker module. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.' + operationId: worker-script-upload-worker-module + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: When set to "strict", the upload will fail if any `inherit` type bindings cannot be resolved against the previous version of the Worker. Without this, unresolvable inherit bindings are silently dropped. + in: query + name: bindings_inherit + schema: + enum: + - strict + type: string + requestBody: + content: + application/javascript: + schema: + description: Raw javascript content comprising a Worker. Must be in service worker syntax. + type: string + multipart/form-data: + encoding: + files: + contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map + metadata: + contentType: application/json + schema: + properties: + files: + description: 'An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.
Possible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.' + items: + format: binary + type: string + type: array + x-stainless-collection-type: set + metadata: + description: JSON-encoded metadata about the uploaded parts and Worker configuration. + properties: + assets: + $ref: '#/components/schemas/workersAssets' + bindings: + $ref: '#/components/schemas/workersBindings' + body_part: + description: Name of the uploaded file that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker. + type: string + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + keep_assets: + description: Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token. + type: boolean + keep_bindings: + description: List of binding types to keep from previous_upload. + items: + type: string + type: array + x-stainless-collection-type: set + limits: + $ref: '#/components/schemas/workersLimits' + logpush: + $ref: '#/components/schemas/workersLogpush' + main_module: + description: Name of the uploaded file that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker. + type: string + migrations: + description: Migrations to apply for Durable Objects associated with this Worker. + writeOnly: true + type: object + properties: + new_tag: + description: Tag to set as the latest migration tag. + type: string + writeOnly: true + x-auditable: true + old_tag: + description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected. + type: string + writeOnly: true + x-auditable: true + deleted_classes: + description: A list of classes to delete Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_classes: + description: A list of classes to create Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_sqlite_classes: + description: A list of classes to create Durable Object namespaces with SQLite from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + renamed_classes: + description: A list of classes with Durable Object namespaces that were renamed. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + transferred_classes: + description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + from_script: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + steps: + description: Migrations to apply in order. + items: + $ref: '#/components/schemas/workersMigrationStep' + type: array + writeOnly: true + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfo' + tags: + description: List of strings to use as tags for this Worker. + items: + type: string + type: array + x-stainless-collection-type: set + tail_consumers: + $ref: '#/components/schemas/workersTailConsumers' + usage_model: + $ref: '#/components/schemas/workersUsageModel' + annotations: + description: Annotations for the version created by this upload. + properties: + workers/message: + description: Human-readable message about the version. Truncated to 1000 bytes if longer. + maxLength: 1000 + type: string + workers/tag: + description: User-provided identifier for the version. Maximum 100 bytes. + maxLength: 100 + type: string + type: object + type: object + required: + - metadata + type: object + text/javascript: + schema: + description: Raw javascript content comprising a Worker. Must be in service worker syntax. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptResponseUploadSingle' + type: object + description: Upload Worker Module response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Upload Worker Module response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload Worker Module + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + method: update + /accounts/{account_id}/workers/scripts/{script_name}/assets-upload-session: + post: + description: Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/. + operationId: worker-script-update-create-assets-upload-session + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersCreateAssetsUploadSessionObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersCreateAssetsUploadSessionResponse' + description: Create Assets Upload Session response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + buckets: + description: The requests to make to upload assets. + items: + description: The set of assets to include in each request while uploading. + items: + description: The file hash to include in this bucket. + type: string + type: array + x-stainless-collection-type: set + type: array + x-stainless-collection-type: set + jwt: + description: A JWT to use as authentication for uploading assets. + type: string + x-sensitive: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Create Assets Upload Session response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Assets Upload Session + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - assets + - upload + method: create + /accounts/{account_id}/workers/scripts/{script_name}/content: + put: + description: Put script content without touching config or metadata. + operationId: worker-script-put-content + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part. + in: header + name: CF-WORKER-BODY-PART + schema: + type: string + - description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part. + in: header + name: CF-WORKER-MAIN-MODULE-PART + schema: + type: string + requestBody: + content: + multipart/form-data: + encoding: + files: + contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map + metadata: + contentType: application/json + schema: + properties: + files: + description: 'An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.
Possible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.' + items: + format: binary + type: string + type: array + x-stainless-collection-type: set + metadata: + description: JSON-encoded metadata about the uploaded parts and Worker configuration. + properties: + body_part: + description: Name of the uploaded file that contains the Worker script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker. + type: string + main_module: + description: Name of the uploaded file that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker. + type: string + type: object + required: + - metadata + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptResponseSingle' + description: Put script content. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Put script content failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Put script content + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - content + method: update + /accounts/{account_id}/workers/scripts/{script_name}/content/v2: + get: + description: Fetch script content only. + operationId: worker-script-get-content + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + string: + schema: + type: object + properties: + contents: + type: string + description: Fetch script content. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script content failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get script content + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - content + method: get + /accounts/{account_id}/workers/scripts/{script_name}/deployments: + get: + description: List of Worker Deployments. The first deployment in the list is the latest deployment actively serving traffic. + operationId: worker-deployments-list-deployments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + deployments: + items: + $ref: '#/components/schemas/workersDeployment' + type: array + required: + - deployments + type: object + required: + - success + - errors + - messages + - result + type: object + description: List Deployments response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List Deployments response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Deployments + tags: + - Worker Deployments + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - deployments + method: list + post: + description: Deployments configure how [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions) are deployed to traffic. A deployment can consist of one or two versions of a Worker. + operationId: worker-deployments-create-deployment + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: If set to true, the deployment will be created even if normally blocked by something such rolling back to an older version when a secret has changed. + in: query + name: force + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersDeployment' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersDeployment' + required: + - success + - errors + - messages + - result + type: object + description: Create Deployment response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Create Deployment response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Deployment + tags: + - Worker Deployments + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - deployments + method: create + /accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id}: + delete: + description: Delete a Worker Deployment. The latest deployment, which is actively serving traffic, cannot be deleted. All other deployments can be deleted. + operationId: worker-deployments-delete-deployment + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: deployment_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommon' + description: Delete Deployment response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete Deployment response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Deployment + tags: + - Worker Deployments + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - deployments + method: delete + get: + description: Get information about a Worker Deployment. + operationId: worker-deployments-get-deployment + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: deployment_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersDeployment' + required: + - success + - errors + - messages + - result + type: object + description: Get Deployment response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get Deployment response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Deployment + tags: + - Worker Deployments + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - deployments + method: get + /accounts/{account_id}/workers/scripts/{script_name}/schedules: + get: + description: Fetches Cron Triggers for a Worker. + operationId: worker-cron-trigger-get-cron-triggers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + schedules: + items: + $ref: '#/components/schemas/workersSchedule' + type: array + required: + - schedules + type: object + required: + - success + - errors + - messages + - result + type: object + description: Get Cron Triggers response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get Cron Triggers response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Cron Triggers + tags: + - Worker Cron Trigger + x-api-token-group: + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - schedules + method: get + put: + description: Updates Cron Triggers for a Worker. + operationId: worker-cron-trigger-update-cron-triggers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/workersSchedule' + type: array + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + schedules: + items: + $ref: '#/components/schemas/workersSchedule' + type: array + required: + - schedules + type: object + required: + - success + - errors + - messages + - result + type: object + description: Update Cron Triggers response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Update Cron Triggers response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Cron Triggers + tags: + - Worker Cron Trigger + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - schedules + method: update + /accounts/{account_id}/workers/scripts/{script_name}/script-settings: + get: + description: Get script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Includes Logpush and Tail Consumers. + operationId: worker-script-settings-get-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptSettingsResponse' + description: Fetch script settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Script Settings + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - settings + method: get + patch: + description: Patch script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Including but not limited to Logpush and Tail Consumers. + operationId: worker-script-settings-patch-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptSettingsItem' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptSettingsResponse' + description: Patch script settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Patch script settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Script Settings + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - settings + method: edit + /accounts/{account_id}/workers/scripts/{script_name}/secrets: + get: + description: List secrets bound to a script. + operationId: worker-list-script-secrets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/workersSecret' + type: array + required: + - success + - errors + - messages + type: object + description: List script secrets. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List script secrets failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List script secrets + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - secrets + method: list + put: + description: Add a secret to a script. + operationId: worker-put-script-secret + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersSecret' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSecret' + required: + - success + - errors + - messages + type: object + description: Put script secret binding success. + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Too many requests are currently modifying the script. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Put script secret binding failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add script secret + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - secrets + method: update + /accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name}: + delete: + description: Remove a secret from a script. + operationId: worker-delete-script-secret + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: secret_name + schema: + $ref: '#/components/schemas/workersSecretName' + required: true + - in: query + name: url_encoded + schema: + $ref: '#/components/schemas/workersSecretNameUrlEncoded' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseNullResult' + description: Delete script secret binding. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete script secret failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete script secret + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - secrets + method: delete + get: + description: Get a given secret binding (value omitted) on a script. + operationId: worker-get-script-secret + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: secret_name + schema: + $ref: '#/components/schemas/workersSecretName' + required: true + - in: query + name: url_encoded + schema: + $ref: '#/components/schemas/workersSecretNameUrlEncoded' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSecret' + required: + - success + - errors + - messages + type: object + description: Get script secret binding. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get script secret failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get secret binding + tags: + - Worker Script + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - secrets + method: get + /accounts/{account_id}/workers/scripts/{script_name}/settings: + get: + description: Get metadata and config, such as bindings or usage model. + operationId: worker-script-get-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptAndVersionSettingsResponse' + description: Fetch settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Settings + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - script_and_version_settings + method: get + patch: + description: Patch metadata or config, such as bindings or usage model. + operationId: worker-script-patch-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + multipart/form-data: + encoding: + settings: + contentType: application/json + schema: + properties: + settings: + $ref: '#/components/schemas/workersScriptAndVersionSettingsItem' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptAndVersionSettingsResponse' + description: Patch settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Patch settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Settings + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - script_and_version_settings + method: edit + /accounts/{account_id}/workers/scripts/{script_name}/subdomain: + delete: + description: Disable all workers.dev subdomains for a Worker. + operationId: worker-script-delete-subdomain + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSubdomain' + required: + - success + - errors + - messages + - result + description: Delete subdomain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete subdomain response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Worker subdomain + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - subdomain + method: delete + get: + description: Get if the Worker is available on the workers.dev subdomain. + operationId: worker-script-get-subdomain + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSubdomain' + required: + - success + - errors + - messages + - result + description: Get subdomain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get subdomain response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Worker subdomain + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - subdomain + method: get + post: + description: Enable or disable the Worker on the workers.dev subdomain. + operationId: worker-script-post-subdomain + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + enabled: + description: Whether the Worker should be available on the workers.dev subdomain. + type: boolean + x-auditable: true + previews_enabled: + description: Whether the Worker's Preview URLs should be available on the workers.dev subdomain. + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + required: + - enabled + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSubdomain' + required: + - success + - errors + - messages + - result + description: Post subdomain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Post subdomain response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Post Worker subdomain + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - subdomain + method: create + /accounts/{account_id}/workers/scripts/{script_name}/tails: + get: + description: Get list of tails currently deployed on a Worker. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersTail' + required: + - success + - errors + - messages + - result + type: object + description: List Tails response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List Tails response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Tails + tags: + - Worker Tail Logs + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - tail + method: get + operationId: get_accounts_account_id_workers_scripts_script_name_tails + post: + description: Starts a tail that receives logs and exception from a Worker. + operationId: worker-tail-logs-start-tail + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersTail' + required: + - success + - errors + - messages + - result + type: object + description: Start Tail response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Start Tail response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Start Tail + tags: + - Worker Tail Logs + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - tail + method: create + /accounts/{account_id}/workers/scripts/{script_name}/tails/{id}: + delete: + description: Deletes a tail from a Worker. + operationId: worker-tail-logs-delete-tail + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommon' + description: Delete Tail response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete Tail response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Tail + tags: + - Worker Tail Logs + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - tail + method: delete + /accounts/{account_id}/workers/scripts/{script_name}/usage-model: + get: + description: Fetches the Usage Model for a given Worker. + operationId: worker-script-fetch-usage-model + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersUsageModelResponse' + description: Fetch Usage Model response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch Usage Model response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch Usage Model + tags: + - Worker Script + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + put: + description: Updates the Usage Model for a given Worker. Requires a Workers Paid subscription. + operationId: worker-script-update-usage-model + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + usage_model: + $ref: '#/components/schemas/workersUsageModel' + user_limits: + $ref: '#/components/schemas/workersUserLimits' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersUsageModelResponse' + description: Update Usage Model response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Update Usage Model response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Usage Model + tags: + - Worker Script + x-api-token-group: + - Workers Scripts Write + /accounts/{account_id}/workers/scripts/{script_name}/versions: + get: + description: List of Worker Versions. The first version in the list is the latest version. + operationId: worker-versions-list-versions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: Only return versions that can be used in a deployment. Ignores pagination. + in: query + name: deployable + schema: + default: false + type: boolean + - description: Current page. + in: query + name: page + schema: + default: 1 + type: integer + - description: Items per-page. + in: query + name: per_page + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersVersionsListResponse' + description: List Versions response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + items: + items: + $ref: '#/components/schemas/workersVersionItemShort' + type: array + type: object + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: List Versions response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Versions + tags: + - Worker Versions + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - versions + method: list + post: + description: 'Upload a Worker Version without deploying to Cloudflare''s network. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.' + operationId: worker-versions-upload-version + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: When set to "strict", the upload will fail if any `inherit` type bindings cannot be resolved against the previous version of the Worker. Without this, unresolvable inherit bindings are silently dropped. + in: query + name: bindings_inherit + schema: + enum: + - strict + type: string + requestBody: + content: + multipart/form-data: + encoding: + files: + contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, `text/x-python`, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map + metadata: + contentType: application/json + schema: + properties: + files: + description: 'An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.
Possible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.' + items: + format: binary + type: string + type: array + x-stainless-collection-type: set + metadata: + description: JSON-encoded metadata about the uploaded parts and Worker configuration. + properties: + annotations: + properties: + workers/alias: + description: Associated alias for a version. + maxLength: 63 + type: string + workers/message: + description: Human-readable message about the version. Truncated to 1000 bytes if longer. + maxLength: 1000 + type: string + workers/tag: + description: User-provided identifier for the version. Maximum 100 bytes. + maxLength: 100 + type: string + type: object + bindings: + $ref: '#/components/schemas/workersBindings' + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + keep_bindings: + description: List of binding types to keep from previous_upload. + items: + type: string + type: array + x-stainless-collection-type: set + main_module: + description: Name of the uploaded file that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker, which is required for Version Upload. + type: string + usage_model: + $ref: '#/components/schemas/workersUsageModel' + required: + - main_module + type: object + required: + - metadata + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersVersionsUploadResponse' + description: Upload Version response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + description: Unique identifier for the version. + readOnly: true + type: string + x-auditable: true + metadata: + properties: + author_email: + description: Email of the user who created the version. + readOnly: true + type: string + x-auditable: true + author_id: + description: Identifier of the user who created the version. + readOnly: true + type: string + x-auditable: true + created_on: + description: When the version was created. + readOnly: true + type: string + x-auditable: true + hasPreview: + description: Whether the version can be previewed. + readOnly: true + type: boolean + modified_on: + description: When the version was last modified. + readOnly: true + type: string + x-auditable: true + source: + description: The source of the version upload. + enum: + - unknown + - api + - wrangler + - terraform + - dash + - dash_template + - integration + - quick_editor + - playground + - workersci + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + number: + description: Sequential version number. + readOnly: true + type: number + x-auditable: true + resources: + properties: + bindings: + type: array + description: 'List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.' + items: + $ref: '#/components/schemas/workersBindingItem' + script: + properties: + etag: + description: Hashed script content + readOnly: true + type: string + x-auditable: true + handlers: + description: The names of handlers exported as part of the default export. + items: + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + last_deployed_from: + description: The client most recently used to deploy this Worker. + readOnly: true + type: string + x-auditable: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + items: + properties: + handlers: + description: The names of handlers exported as part of the named export. + items: + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + name: + description: The name of the exported class or entrypoint. + readOnly: true + type: string + readOnly: true + type: object + readOnly: true + type: array + x-stainless-collection-type: set + readOnly: true + type: object + script_runtime: + description: Runtime configuration for the Worker. + properties: + compatibility_date: + description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker. + readOnly: true + type: string + x-auditable: true + compatibility_flags: + description: Flags that enable or disable certain features in the Workers runtime. + items: + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + limits: + description: Resource limits for the Worker. + properties: + cpu_ms: + description: The amount of CPU time this Worker can use in milliseconds. + readOnly: true + type: integer + readOnly: true + type: object + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + readOnly: true + type: string + x-auditable: true + usage_model: + description: Usage model for the Worker invocations. + enum: + - bundled + - unbound + - standard + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + readOnly: true + type: object + startup_time_ms: + description: Time in milliseconds spent on [Worker startup](https://developers.cloudflare.com/workers/platform/limits/#worker-startup-time). + type: integer + type: object + required: + - resources + - resources + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Upload Version response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload Version + tags: + - Worker Versions + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - versions + method: create + /accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}: + get: + description: Retrieves detailed information about a specific version of a Workers script. + operationId: worker-versions-get-version-detail + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: version_id + schema: + $ref: '#/components/schemas/workersVersionIdentifier' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersVersionsSingleResponse' + description: Get Version Detail response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + id: + description: Unique identifier for the version. + readOnly: true + type: string + x-auditable: true + metadata: + properties: + author_email: + description: Email of the user who created the version. + readOnly: true + type: string + x-auditable: true + author_id: + description: Identifier of the user who created the version. + readOnly: true + type: string + x-auditable: true + created_on: + description: When the version was created. + readOnly: true + type: string + x-auditable: true + hasPreview: + description: Whether the version can be previewed. + readOnly: true + type: boolean + modified_on: + description: When the version was last modified. + readOnly: true + type: string + x-auditable: true + source: + description: The source of the version upload. + enum: + - unknown + - api + - wrangler + - terraform + - dash + - dash_template + - integration + - quick_editor + - playground + - workersci + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + number: + description: Sequential version number. + readOnly: true + type: number + x-auditable: true + resources: + properties: + bindings: + $ref: '#/components/schemas/workersBindings' + readOnly: true + script: + properties: + etag: + description: Hashed script content + readOnly: true + type: string + x-auditable: true + handlers: + description: The names of handlers exported as part of the default export. + items: + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + last_deployed_from: + description: The client most recently used to deploy this Worker. + readOnly: true + type: string + x-auditable: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + items: + properties: + handlers: + description: The names of handlers exported as part of the named export. + items: + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + name: + description: The name of the exported class or entrypoint. + readOnly: true + type: string + readOnly: true + type: object + readOnly: true + type: array + x-stainless-collection-type: set + readOnly: true + type: object + script_runtime: + description: Runtime configuration for the Worker. + properties: + compatibility_date: + description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker. + readOnly: true + type: string + x-auditable: true + compatibility_flags: + description: Flags that enable or disable certain features in the Workers runtime. + items: + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + limits: + description: Resource limits for the Worker. + properties: + cpu_ms: + description: The amount of CPU time this Worker can use in milliseconds. + readOnly: true + type: integer + readOnly: true + type: object + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + readOnly: true + type: string + x-auditable: true + usage_model: + description: Usage model for the Worker invocations. + enum: + - bundled + - unbound + - standard + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + readOnly: true + type: object + type: object + required: + - resources + enum: + - null + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get Version Detail response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Version Detail + tags: + - Worker Versions + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - scripts + - versions + method: get + /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content: + get: + description: Get script content from a worker with an environment. + operationId: worker-environment-get-script-content + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: service_name + in: path + required: true + description: The Worker service name. + schema: + type: string + - name: environment_name + in: path + required: true + description: The Worker service environment name. + schema: + type: string + responses: + '200': + content: + string: + schema: + type: object + properties: + contents: + type: string + description: Get script content. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get script content failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get script content + tags: + - Worker Environment + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + put: + description: Put script content from a worker with an environment. + operationId: worker-environment-put-script-content + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: service_name + in: path + required: true + description: The Worker service name. + schema: + type: string + - name: environment_name + in: path + required: true + description: The Worker service environment name. + schema: + type: string + - description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part. + in: header + name: CF-WORKER-BODY-PART + schema: + type: string + - description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part. + in: header + name: CF-WORKER-MAIN-MODULE-PART + schema: + type: string + requestBody: + content: + multipart/form-data: + encoding: + files: + contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map + metadata: + contentType: application/json + schema: + properties: + files: + description: 'An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.
Possible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.' + items: + format: binary + type: string + type: array + x-stainless-collection-type: set + metadata: + $ref: '#/components/schemas/unnamedSchemaRefEe1e79edcb234d14c4dd266880f2fd24' + required: + - metadata + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptResponseSingle' + description: Put script content. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Put script content failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Put script content + tags: + - Worker Environment + x-api-token-group: + - Workers Scripts Write + /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings: + get: + description: Get script settings from a worker with an environment. + operationId: worker-script-environment-get-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: service_name + in: path + required: true + description: The Worker service name. + schema: + type: string + - name: environment_name + in: path + required: true + description: The Worker service environment name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptSettingsResponse' + description: Fetch script settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Script Settings + tags: + - Worker Environment + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + patch: + description: Patch script metadata, such as bindings. + operationId: worker-script-environment-patch-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: service_name + in: path + required: true + description: The Worker service name. + schema: + type: string + - name: environment_name + in: path + required: true + description: The Worker service environment name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptSettingsResponse' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptSettingsResponse' + description: Patch script settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Patch script settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Script Settings + tags: + - Worker Environment + /accounts/{account_id}/workers/subdomain: + delete: + description: Deletes a Workers subdomain for an account. + operationId: worker-subdomain-delete-subdomain + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '204': + description: Subdomain deleted successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete Subdomain response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Subdomain + tags: + - Worker Subdomain + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - subdomains + method: delete + get: + description: Returns a Workers subdomain for an account. + operationId: worker-subdomain-get-subdomain + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSchemasSubdomain' + required: + - success + - errors + - messages + - result + type: object + description: Get Subdomain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get Subdomain response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Subdomain + tags: + - Worker Subdomain + x-api-token-group: + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - subdomains + method: get + put: + description: Creates a Workers subdomain for an account. + operationId: worker-subdomain-create-subdomain + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersSchemasSubdomain' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSchemasSubdomain' + required: + - success + - errors + - messages + - result + type: object + description: Create Subdomain response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Create Subdomain response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Subdomain + tags: + - Worker Subdomain + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - subdomains + method: update + /accounts/{account_id}/workers/workers: + get: + description: List all Workers for an account. + operationId: listWorkers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Current page. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Items per-page. + in: query + name: per_page + schema: + default: 10 + maximum: 100 + minimum: 1 + type: integer + - description: Property to sort results by. + in: query + name: order_by + schema: + default: deployed_on + enum: + - deployed_on + - updated_on + - created_on + - name + type: string + - description: Sort direction. + in: query + name: order + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/workersWorker' + type: array + required: + - success + - errors + - messages + - result + description: List Workers success. + '401': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the user is not authorized to perform this action. + enum: + - 10023 + documentation_url: + type: string + message: + type: string + description: Message explaining that the user lacks access to this feature. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Authentication required or insufficient permissions. + '500': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that an unknown internal server error has occurred. + enum: + - 10002 + documentation_url: + type: string + message: + type: string + description: Message explaining that an unknown error occurred and providing guidance for reporting the issue. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Internal Server Error - An unexpected server error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Workers + tags: + - Workers + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + method: list + post: + description: Create a new Worker. + operationId: createWorker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersWorker' + type: object + description: Worker creation parameters. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersWorker' + required: + - success + - errors + - messages + - result + type: object + description: Create Worker success. + '400': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Bad Request - Invalid input data. + '401': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the user is not authorized to perform this action. + enum: + - 10023 + documentation_url: + type: string + message: + type: string + description: Message explaining that the user lacks access to this feature. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Authentication required or insufficient permissions. + '403': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Forbidden - Access denied or limit exceeded. + '409': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that a Worker with this name already exists. + enum: + - 10040 + documentation_url: + type: string + message: + type: string + description: Message explaining that the Worker name is already in use and suggesting to choose a different name. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Conflict - Resource already exists. + '500': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that an unknown internal server error has occurred. + enum: + - 10002 + documentation_url: + type: string + message: + type: string + description: Message explaining that an unknown error occurred and providing guidance for reporting the issue. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Internal Server Error - An unexpected server error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Worker + tags: + - Workers + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + method: create + /accounts/{account_id}/workers/workers/{worker_id}: + delete: + description: Delete a Worker and all its associated resources (versions, deployments, etc.). + operationId: deleteWorker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommon' + description: Delete Worker success. + '400': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that a required URL parameter is missing. + enum: + - 10003 + documentation_url: + type: string + message: + type: string + description: Message explaining which required parameter is missing and suggesting to check the URL. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Bad Request - Missing or invalid parameters. + '401': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the user is not authorized to perform this action. + enum: + - 10023 + documentation_url: + type: string + message: + type: string + description: Message explaining that the user lacks access to this feature. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Authentication required or insufficient permissions. + '404': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the Worker does not exist. + enum: + - 10007 + documentation_url: + type: string + message: + type: string + description: Message explaining that the Worker was not found. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Not Found - Worker does not exist. + '500': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that an unknown internal server error has occurred. + enum: + - 10002 + documentation_url: + type: string + message: + type: string + description: Message explaining that an unknown error occurred and providing guidance for reporting the issue. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Internal Server Error - An unexpected server error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Worker + tags: + - Workers + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + method: delete + get: + description: Get details about a specific Worker. + operationId: getWorker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersWorker' + required: + - success + - errors + - messages + - result + type: object + description: Get Worker success. + '400': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that a required URL parameter is missing. + enum: + - 10003 + documentation_url: + type: string + message: + type: string + description: Message explaining which required parameter is missing and suggesting to check the URL. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Bad Request - Missing or invalid parameters. + '404': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the Worker does not exist. + enum: + - 10007 + documentation_url: + type: string + message: + type: string + description: Message explaining that the Worker was not found. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Not Found - Worker does not exist. + '500': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that an unknown internal server error has occurred. + enum: + - 10002 + documentation_url: + type: string + message: + type: string + description: Message explaining that an unknown error occurred and providing guidance for reporting the issue. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Internal Server Error - An unexpected server error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Worker + tags: + - Workers + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + method: get + patch: + description: Perform a partial update on a Worker, where omitted properties are left unchanged from their current values. + operationId: editWorker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersWorker' + type: object + application/merge-patch+json: + schema: + $ref: '#/components/schemas/workersWorker' + type: object + description: Worker partial update parameters. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersWorker' + required: + - success + - errors + - messages + - result + type: object + description: Partially Update Worker success. + '400': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Bad Request - Invalid input data. + '401': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the user is not authorized to perform this action. + enum: + - 10023 + documentation_url: + type: string + message: + type: string + description: Message explaining that the user lacks access to this feature. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Authentication required or insufficient permissions. + '403': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Forbidden - Insufficient permissions or quota exceeded. + '404': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the Worker does not exist. + enum: + - 10007 + documentation_url: + type: string + message: + type: string + description: Message explaining that the Worker was not found. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Not Found - Worker does not exist. + '409': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that a Worker with this name already exists. + enum: + - 10040 + documentation_url: + type: string + message: + type: string + description: Message explaining that the Worker name is already in use and suggesting to choose a different name. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Conflict - Worker name already exists. + '500': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that an unknown internal server error has occurred. + enum: + - 10002 + documentation_url: + type: string + message: + type: string + description: Message explaining that an unknown error occurred and providing guidance for reporting the issue. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Internal Server Error - An unexpected server error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Worker + tags: + - Workers + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + method: edit + put: + description: Perform a complete replacement of a Worker, where omitted properties are set to their default values. This is the exact same as the Create Worker endpoint, but operates on an existing Worker. To perform a partial update instead, use the Edit Worker endpoint. + operationId: updateWorker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersWorker' + type: object + description: Worker update parameters. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersWorker' + required: + - success + - errors + - messages + - result + type: object + description: Update Worker success. + '400': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Bad Request - Invalid input data. + '401': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the user is not authorized to perform this action. + enum: + - 10023 + documentation_url: + type: string + message: + type: string + description: Message explaining that the user lacks access to this feature. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Authentication required or insufficient permissions. + '403': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Forbidden - Insufficient permissions or quota exceeded. + '404': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that the Worker does not exist. + enum: + - 10007 + documentation_url: + type: string + message: + type: string + description: Message explaining that the Worker was not found. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Not Found - Worker does not exist. + '409': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that a Worker with this name already exists. + enum: + - 10040 + documentation_url: + type: string + message: + type: string + description: Message explaining that the Worker name is already in use and suggesting to choose a different name. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Conflict - Worker name already exists. + '500': + content: + application/json: + schema: + properties: + errors: + minLength: 1 + items: + properties: + code: + minimum: 1000 + type: integer + description: Code indicating that an unknown internal server error has occurred. + enum: + - 10002 + documentation_url: + type: string + message: + type: string + description: Message explaining that an unknown error occurred and providing guidance for reporting the issue. + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + - code + - message + type: object + uniqueItems: true + type: array + messages: + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + type: boolean + required: + - success + - errors + - messages + - result + - errors + type: object + description: Internal Server Error - An unexpected server error occurred. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Worker + tags: + - Workers + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + method: update + /accounts/{account_id}/workers/workers/{worker_id}/versions: + get: + description: List all versions for a Worker. + operationId: listWorkerVersions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + - description: Current page. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: Items per-page. + in: query + name: per_page + schema: + default: 10 + maximum: 100 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + items: + $ref: '#/components/schemas/workersVersion' + type: array + required: + - success + - errors + - messages + - result + description: List versions success. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List versions failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Versions + tags: + - Versions + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + - versions + method: list + post: + description: Create a new version. + operationId: createWorkerVersion + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + - in: query + name: deploy + schema: + description: If true, a deployment will be created that sends 100% of traffic to the new version. + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersVersion' + description: Version creation parameters. + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersVersion' + required: + - success + - errors + - messages + - result + type: object + description: Create version success. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Create version failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Version + tags: + - Versions + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + - versions + method: create + /accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id}: + delete: + description: Delete a version. + operationId: deleteWorkerVersion + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + - in: path + name: version_id + schema: + description: Identifier for the version, which can be a UUID, a UUID prefix (minimum length 8), or the literal "latest" to operate on the most recently created version. + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommon' + description: Delete version success. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete version failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Version + tags: + - Versions + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + - versions + method: delete + get: + description: Get details about a specific version. + operationId: getWorkerVersion + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: worker_id + schema: + description: Identifier for the Worker, which can be ID or name. + type: string + required: true + - in: path + name: version_id + schema: + description: Identifier for the version, which can be a UUID, a UUID prefix (minimum length 8), or the literal "latest" to operate on the most recently created version. + type: string + required: true + - in: query + name: include + schema: + description: Whether to include the `modules` property of the version in the response, which contains code and sourcemap content and may add several megabytes to the response size. + enum: + - modules + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersVersion' + required: + - success + - errors + - messages + - result + type: object + description: Get version success. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get version failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Version + tags: + - Versions + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers + resource_chain: + - beta + - workers + - versions + method: get + /workers/builds/deploy_hooks/{deploy_hook_uuid}: + post: + description: Trigger a build using a deploy hook. This endpoint does not require authentication - the deploy_hook_uuid acts as a secret token. + operationId: triggerDeployHook + parameters: + - description: Deploy hook UUID + in: path + name: deploy_hook_uuid + schema: + $ref: '#/components/schemas/buildsDeployHookUuid' + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: integer + message: + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + $ref: '#/components/schemas/buildsTriggerDeployHookResponse' + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + type: boolean + required: + - success + - errors + - messages + - result + type: object + description: Build triggered successfully + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Resource not found + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/buildsErrorResponse' + description: Rate limit exceeded + security: [] + summary: Trigger deploy hook + tags: + - Deploy Hooks + /zones/{zone_id}/workers/routes: + get: + description: Returns routes for a zone. + operationId: worker-routes-list-routes + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/workersRoute' + type: array + required: + - success + - errors + - messages + - result + description: List Routes response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List Routes response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Routes + tags: + - Worker Routes + x-api-token-group: + - Workers Routes Write + - Workers Routes Read + x-stackql-sdk: + service: workers + resource_chain: + - routes + method: list + post: + description: Creates a route that maps a URL pattern to a Worker. + operationId: worker-routes-create-route + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersRoute' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersRoute' + required: + - success + - errors + - messages + - result + description: Create Route response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Create Route response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Route + tags: + - Worker Routes + x-api-token-group: + - Workers Routes Write + x-stackql-sdk: + service: workers + resource_chain: + - routes + method: create + /zones/{zone_id}/workers/routes/{route_id}: + delete: + description: Deletes a route. + operationId: worker-routes-delete-route + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/workersIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/workersIdentifier' + type: object + required: + - success + - errors + - messages + - result + description: Delete Route response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete Route response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Route + tags: + - Worker Routes + x-api-token-group: + - Workers Routes Write + x-stackql-sdk: + service: workers + resource_chain: + - routes + method: delete + get: + description: Returns information about a route, including URL pattern and Worker. + operationId: worker-routes-get-route + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/workersIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersRoute' + required: + - success + - errors + - messages + - result + description: Get Route response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get Route response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Route + tags: + - Worker Routes + x-api-token-group: + - Workers Routes Write + - Workers Routes Read + x-stackql-sdk: + service: workers + resource_chain: + - routes + method: get + put: + description: Updates the URL pattern or Worker associated with a route. + operationId: worker-routes-update-route + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/workersIdentifier' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersRoute' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersRoute' + required: + - success + - errors + - messages + - result + description: Update Route response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Update Route response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Route + tags: + - Worker Routes + x-api-token-group: + - Workers Routes Write + x-stackql-sdk: + service: workers + resource_chain: + - routes + method: update +components: + schemas: + buildsAPIResponse: + properties: + errors: + items: + properties: + code: + example: 12000 + type: integer + message: + example: Not found + type: string + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + result_info: + $ref: '#/components/schemas/buildsPaginationInfo' + success: + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + buildsBranch: + description: Git branch name. + example: main + type: string + buildsBranchExcludes: + example: [] + items: + type: string + type: array + buildsBranchIncludes: + example: + - main + items: + type: string + type: array + buildsBuildCachingEnabled: + default: false + example: false + type: boolean + buildsBuildCommand: + example: npm run build + type: string + buildsBuildLogsResponse: + properties: + cursor: + $ref: '#/components/schemas/buildsCursor' + lines: + items: + items: + type: number + description: Unix epoch timestamp + example: 1636472400 + maxItems: 2 + minItems: 2 + type: array + type: array + truncated: + example: false + type: boolean + type: object + buildsBuildOutcome: + enum: + - success + - fail + - skipped + - cancelled + - terminated + example: success + type: string + buildsBuildResponse: + properties: + build_outcome: + $ref: '#/components/schemas/buildsBuildOutcome' + build_trigger_metadata: + $ref: '#/components/schemas/buildsBuildTriggerMetadataResponse' + build_uuid: + $ref: '#/components/schemas/buildsBuildUuid' + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + initializing_on: + format: date-time + nullable: true + type: string + modified_on: + $ref: '#/components/schemas/buildsModifiedOn' + readOnly: true + pull_request: + nullable: true + properties: + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + pull_request_url: + example: https://github.com/cloudflare/workers-sdk/pull/123 + format: uri + type: string + type: object + running_on: + format: date-time + nullable: true + type: string + status: + $ref: '#/components/schemas/buildsBuildStatus' + stopped_on: + $ref: '#/components/schemas/buildsStoppedOn' + trigger: + description: Trigger information without build_token_uuid + properties: + branch_excludes: + $ref: '#/components/schemas/buildsBranchExcludes' + branch_includes: + $ref: '#/components/schemas/buildsBranchIncludes' + build_caching_enabled: + $ref: '#/components/schemas/buildsBuildCachingEnabled' + build_command: + $ref: '#/components/schemas/buildsBuildCommand' + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + deleted_on: + $ref: '#/components/schemas/buildsDeletedOn' + deploy_command: + $ref: '#/components/schemas/buildsDeployCommand' + external_script_id: + $ref: '#/components/schemas/buildsExternalScriptId' + modified_on: + $ref: '#/components/schemas/buildsModifiedOn' + readOnly: true + path_excludes: + $ref: '#/components/schemas/buildsPathExcludes' + path_includes: + $ref: '#/components/schemas/buildsPathIncludes' + repo_connection: + $ref: '#/components/schemas/buildsUpsertRepoConnectionResponse' + root_directory: + $ref: '#/components/schemas/buildsRootDirectory' + trigger_name: + $ref: '#/components/schemas/buildsTriggerName' + trigger_uuid: + $ref: '#/components/schemas/buildsTriggerUuid' + type: object + type: object + buildsBuildSeedRepoInput: + properties: + branch: + $ref: '#/components/schemas/buildsBranch' + files: + items: + $ref: '#/components/schemas/buildsBuildSeedRepoInputFile' + maxItems: 2 + type: array + owner: + example: cloudflare + type: string + path: + example: / + type: string + provider: + $ref: '#/components/schemas/buildsSCMProviderType' + repository: + example: workers-sdk + type: string + required: + - provider + - owner + - repository + - branch + - path + type: object + buildsBuildSeedRepoInputFile: + properties: + content: + example: 'name = "my-worker" + + main = "src/index.js" + + ' + type: string + filename: + example: wrangler.toml + type: string + isBase64: + default: false + type: boolean + replace: + description: Text to replace in the file + type: string + required: + - filename + - content + type: object + buildsBuildStatus: + enum: + - queued + - initializing + - running + - stopped + example: running + type: string + buildsBuildTokenName: + example: My Build Token + type: string + buildsBuildTokenUuid: + description: Build token UUID. + format: uuid + type: string + buildsBuildTriggerMetadataResponse: + properties: + author: + example: developer@cloudflare.com + type: string + branch: + $ref: '#/components/schemas/buildsBranch' + build_command: + $ref: '#/components/schemas/buildsBuildCommand' + build_token_name: + $ref: '#/components/schemas/buildsBuildTokenName' + build_token_uuid: + $ref: '#/components/schemas/buildsBuildTokenUuid' + build_trigger_source: + $ref: '#/components/schemas/buildsBuildTriggerSource' + commit_hash: + $ref: '#/components/schemas/buildsCommitHash' + commit_message: + example: Add new feature + type: string + deploy_command: + $ref: '#/components/schemas/buildsDeployCommand' + environment_variables: + type: object + provider_account_name: + $ref: '#/components/schemas/buildsProviderAccountName' + provider_type: + $ref: '#/components/schemas/buildsSCMProviderType' + repo_name: + $ref: '#/components/schemas/buildsRepoName' + root_directory: + $ref: '#/components/schemas/buildsRootDirectory' + type: object + buildsBuildTriggerSource: + enum: + - push + - pull_request + - manual + - api + example: push + type: string + buildsBuildUuid: + description: Build UUID. + format: uuid + type: string + buildsBuildsByVersionResponse: + properties: + builds: + type: object + type: object + buildsCanceledBuildResponse: + properties: + build_outcome: + $ref: '#/components/schemas/buildsBuildOutcome' + build_uuid: + $ref: '#/components/schemas/buildsBuildUuid' + stopped_on: + $ref: '#/components/schemas/buildsStoppedOn' + type: object + buildsCloudflareTokenId: + example: cf-token-123 + type: string + buildsCommitHash: + description: Git commit hash + example: abc123def456 + type: string + buildsConfigAutofillResponse: + properties: + config_file: + example: wrangler.toml + nullable: true + type: string + default_worker_name: + example: my-worker + nullable: true + type: string + env_worker_names: + example: + production: my-worker-prod + staging: my-worker-staging + nullable: true + type: object + package_manager: + nullable: true + type: string + $ref: '#/components/schemas/buildsPackageManager' + scripts: + example: + build: npm run build + test: npm test + nullable: true + type: object + type: object + buildsCreateBuildRequest: + properties: + branch: + description: Git branch name (required if commit_hash not provided) + $ref: '#/components/schemas/buildsBranch' + commit_hash: + description: Git commit hash (required if branch not provided) + $ref: '#/components/schemas/buildsCommitHash' + seed_repo: + $ref: '#/components/schemas/buildsBuildSeedRepoInput' + type: object + required: [] + buildsCreateBuildTokenRequest: + properties: + build_token_name: + $ref: '#/components/schemas/buildsBuildTokenName' + build_token_secret: + example: super-secret-token + type: string + cloudflare_token_id: + $ref: '#/components/schemas/buildsCloudflareTokenId' + required: + - build_token_name + - build_token_secret + - cloudflare_token_id + type: object + buildsCreateBuildTokenResponse: + properties: + build_token_name: + $ref: '#/components/schemas/buildsBuildTokenName' + build_token_uuid: + $ref: '#/components/schemas/buildsBuildTokenUuid' + cloudflare_token_id: + $ref: '#/components/schemas/buildsCloudflareTokenId' + owner_type: + $ref: '#/components/schemas/buildsOwnerType' + type: object + buildsCreateDeployHookRequest: + properties: + branch: + $ref: '#/components/schemas/buildsBranch' + deploy_hook_name: + $ref: '#/components/schemas/buildsDeployHookName' + required: + - deploy_hook_name + - branch + type: object + buildsCreateTriggerRequest: + properties: + branch_excludes: + $ref: '#/components/schemas/buildsBranchExcludes' + branch_includes: + $ref: '#/components/schemas/buildsBranchIncludes' + build_caching_enabled: + $ref: '#/components/schemas/buildsBuildCachingEnabled' + build_command: + $ref: '#/components/schemas/buildsBuildCommand' + build_token_uuid: + $ref: '#/components/schemas/buildsBuildTokenUuid' + deploy_command: + $ref: '#/components/schemas/buildsDeployCommand' + external_script_id: + $ref: '#/components/schemas/buildsExternalScriptId' + path_excludes: + $ref: '#/components/schemas/buildsPathExcludes' + path_includes: + $ref: '#/components/schemas/buildsPathIncludes' + repo_connection_uuid: + $ref: '#/components/schemas/buildsRepoConnectionUuid' + root_directory: + $ref: '#/components/schemas/buildsRootDirectory' + trigger_name: + $ref: '#/components/schemas/buildsTriggerName' + required: + - external_script_id + - build_token_uuid + - trigger_name + - build_command + - deploy_command + - root_directory + - branch_includes + - branch_excludes + - path_includes + - path_excludes + - repo_connection_uuid + type: object + buildsCreatedOn: + format: date-time + type: string + buildsCursor: + description: Pagination cursor for log retrieval. + example: eyJsaW5lIjoxMDAsInRpbWVzdGFtcCI6MTYzNjQ3MjQwMH0 + type: string + buildsDeletedOn: + format: date-time + nullable: true + type: string + buildsDeployCommand: + example: npx wrangler deploy + type: string + buildsDeployHookName: + description: Deploy hook name (1-58 characters). + example: Production Deploy Hook + maxLength: 58 + minLength: 1 + type: string + buildsDeployHookResponse: + properties: + branch: + $ref: '#/components/schemas/buildsBranch' + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + deploy_hook_name: + $ref: '#/components/schemas/buildsDeployHookName' + deploy_hook_uuid: + $ref: '#/components/schemas/buildsDeployHookUuid' + external_script_id: + $ref: '#/components/schemas/buildsExternalScriptId' + modified_on: + $ref: '#/components/schemas/buildsModifiedOn' + readOnly: true + type: object + buildsDeployHookUuid: + description: Deploy hook UUID. + format: uuid + type: string + buildsDetailedDeployHookResponse: + properties: + branch: + $ref: '#/components/schemas/buildsBranch' + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + deploy_hook_name: + $ref: '#/components/schemas/buildsDeployHookName' + deploy_hook_uuid: + $ref: '#/components/schemas/buildsDeployHookUuid' + external_script_id: + $ref: '#/components/schemas/buildsExternalScriptId' + latest_build: + nullable: true + properties: + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + type: object + modified_on: + $ref: '#/components/schemas/buildsModifiedOn' + readOnly: true + type: object + buildsEnvironmentVariableKey: + description: Environment variable key. + example: NODE_ENV + type: string + buildsEnvironmentVariablesRequest: + example: + API_KEY: + is_secret: true + value: secret-key + NODE_ENV: + is_secret: false + value: production + type: object + buildsEnvironmentVariablesResponse: + example: + API_KEY: + created_on: '2023-01-01T00:00:00Z' + is_secret: true + value: null + NODE_ENV: + created_on: '2023-01-01T00:00:00Z' + is_secret: false + value: production + type: object + buildsErrorResponse: + properties: + errors: + items: + properties: + code: + example: 12000 + type: integer + message: + example: Not found + type: string + required: + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + nullable: true + type: object + success: + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + buildsExternalScriptId: + description: System-generated worker script tag. + example: dd7160bb9cef458093557736f4b9e75b + type: string + buildsExternalScriptIds: + description: Comma-separated list of system-generated worker script tags (max 20). + example: dd7160bb9cef458093557736f4b9e75b,42fb14fe81df47139d3be684e4c637a6,ff7cf9a7582f4c0d90a4b95cb17d659e + type: string + buildsGetAccountLimitResponse: + properties: + build_minutes_refresh_on: + description: When build minutes will refresh (only for non-paid plans) + format: date-time + nullable: true + type: string + has_reached_build_minutes_limit: + description: Whether build minutes limit has been reached (only for non-paid plans) + nullable: true + type: boolean + type: object + buildsInsertBuildResponse: + properties: + build_uuid: + $ref: '#/components/schemas/buildsBuildUuid' + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + type: object + buildsLatestBuildsResponse: + properties: + builds: + type: object + type: object + buildsListTokensResponse: + properties: + build_token_name: + $ref: '#/components/schemas/buildsBuildTokenName' + build_token_uuid: + $ref: '#/components/schemas/buildsBuildTokenUuid' + cloudflare_token_id: + $ref: '#/components/schemas/buildsCloudflareTokenId' + owner_type: + $ref: '#/components/schemas/buildsOwnerType' + type: object + buildsModifiedOn: + format: date-time + type: string + buildsOwnerType: + example: user + type: string + buildsPackageManager: + enum: + - npm + - yarn + - pnpm + - bun + - uv + example: npm + type: string + buildsPaginationInfo: + properties: + count: + example: 25 + type: integer + page: + example: 1 + type: integer + per_page: + example: 50 + type: integer + total_count: + example: 150 + type: integer + total_pages: + example: 3 + type: integer + type: object + buildsPathExcludes: + example: + - '*.md' + items: + type: string + type: array + buildsPathIncludes: + example: + - '*' + items: + type: string + type: array + buildsProviderAccountId: + description: Provider account identifier. + example: cloudflare + type: string + buildsProviderAccountName: + example: Cloudflare + type: string + buildsRepoConnectionUuid: + description: Repository connection UUID. + format: uuid + type: string + buildsRepoId: + description: Repository identifier. + example: workers-sdk + type: string + buildsRepoName: + example: workers-sdk + type: string + buildsRootDirectory: + description: Root directory path. + example: / + type: string + buildsSCMProviderType: + enum: + - github + example: github + type: string + buildsStoppedOn: + format: date-time + nullable: true + type: string + buildsTriggerDeployHookResponse: + properties: + already_exists: + description: True if a pending build already exists for this branch + example: false + type: boolean + build_uuid: + $ref: '#/components/schemas/buildsBuildUuid' + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + status: + $ref: '#/components/schemas/buildsBuildStatus' + type: object + buildsTriggerName: + example: Production Deploy + type: string + buildsTriggerResponse: + properties: + branch_excludes: + $ref: '#/components/schemas/buildsBranchExcludes' + branch_includes: + $ref: '#/components/schemas/buildsBranchIncludes' + build_caching_enabled: + $ref: '#/components/schemas/buildsBuildCachingEnabled' + build_command: + $ref: '#/components/schemas/buildsBuildCommand' + build_token_name: + $ref: '#/components/schemas/buildsBuildTokenName' + build_token_uuid: + $ref: '#/components/schemas/buildsBuildTokenUuid' + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + deleted_on: + $ref: '#/components/schemas/buildsDeletedOn' + deploy_command: + $ref: '#/components/schemas/buildsDeployCommand' + external_script_id: + $ref: '#/components/schemas/buildsExternalScriptId' + modified_on: + $ref: '#/components/schemas/buildsModifiedOn' + readOnly: true + path_excludes: + $ref: '#/components/schemas/buildsPathExcludes' + path_includes: + $ref: '#/components/schemas/buildsPathIncludes' + repo_connection: + $ref: '#/components/schemas/buildsUpsertRepoConnectionResponse' + root_directory: + $ref: '#/components/schemas/buildsRootDirectory' + trigger_name: + $ref: '#/components/schemas/buildsTriggerName' + trigger_uuid: + $ref: '#/components/schemas/buildsTriggerUuid' + type: object + buildsTriggerUuid: + description: Trigger UUID. + format: uuid + type: string + buildsUpdateTriggerRequest: + properties: + branch_excludes: + $ref: '#/components/schemas/buildsBranchExcludes' + branch_includes: + $ref: '#/components/schemas/buildsBranchIncludes' + build_caching_enabled: + $ref: '#/components/schemas/buildsBuildCachingEnabled' + build_command: + $ref: '#/components/schemas/buildsBuildCommand' + build_token_uuid: + $ref: '#/components/schemas/buildsBuildTokenUuid' + deploy_command: + $ref: '#/components/schemas/buildsDeployCommand' + path_excludes: + $ref: '#/components/schemas/buildsPathExcludes' + path_includes: + $ref: '#/components/schemas/buildsPathIncludes' + root_directory: + $ref: '#/components/schemas/buildsRootDirectory' + trigger_name: + $ref: '#/components/schemas/buildsTriggerName' + type: object + buildsUpsertRepoConnectionRequest: + properties: + provider_account_id: + $ref: '#/components/schemas/buildsProviderAccountId' + provider_account_name: + $ref: '#/components/schemas/buildsProviderAccountName' + provider_type: + $ref: '#/components/schemas/buildsSCMProviderType' + repo_id: + $ref: '#/components/schemas/buildsRepoId' + repo_name: + $ref: '#/components/schemas/buildsRepoName' + required: + - repo_id + - repo_name + - provider_type + - provider_account_id + - provider_account_name + type: object + buildsUpsertRepoConnectionResponse: + properties: + created_on: + $ref: '#/components/schemas/buildsCreatedOn' + readOnly: true + deleted_on: + $ref: '#/components/schemas/buildsDeletedOn' + modified_on: + $ref: '#/components/schemas/buildsModifiedOn' + readOnly: true + provider_account_id: + $ref: '#/components/schemas/buildsProviderAccountId' + provider_account_name: + $ref: '#/components/schemas/buildsProviderAccountName' + provider_type: + $ref: '#/components/schemas/buildsSCMProviderType' + repo_connection_uuid: + $ref: '#/components/schemas/buildsRepoConnectionUuid' + repo_id: + $ref: '#/components/schemas/buildsRepoId' + repo_name: + $ref: '#/components/schemas/buildsRepoName' + type: object + buildsVersionIds: + description: Comma-separated list of version UUIDs (max 20). + example: 123e4567-e89b-12d3-a456-426614174000,223e4567-e89b-12d3-a456-426614174001 + type: string + ccAccountID: + description: A unique identifier for the user's account + type: string + ccAccountRegistryToken: + description: Credentials that can be used to interact with the requested image registry. + properties: + account_id: + $ref: '#/components/schemas/ccAccountID' + password: + description: The password to use when authenticating to the image registry. + type: string + registry_host: + description: The domain of the image registry the credentials are for. + type: string + username: + description: The username to use when authenticating to the image registry. + type: string + required: + - account_id + - registry_host + - username + type: object + ccApplicationHealthInstances: + description: Shows a count of application instance states. + properties: + active: + description: Number of instances with a running container. + type: integer + assigned: + description: Number of instances assigned to a container, but the container is not yet running. + type: integer + required: + - active + - assigned + - healthy + - stopped + - failed + - starting + - scheduling + type: object + ccApplicationID: + description: An Application ID represents an identifier of an application + type: string + ccApplicationNetwork: + description: Network settings for an application + properties: + bandwidth_limit_mbps: + description: The network bandwidth limit per container in Megabits per second (Mbps). + minimum: 1 + type: integer + required: + - bandwidth_limit_mbps + type: object + ccApplicationObservability: + description: Settings for application observability such as logging. + properties: + logs: + $ref: '#/components/schemas/ccObservabilityLogs' + target_instance_count: + description: Fixed number of instances that should receive the application-level observability overlay. Mutually exclusive with `target_instance_percentage`. + minimum: 1 + type: integer + target_instance_percentage: + description: Percentage of instances that should receive the application-level observability overlay. This rounds up so at least this percentage of instances is targeted. Mutually exclusive with `target_instance_count`. + maximum: 99 + minimum: 1 + type: integer + type: object + ccApplicationRolloutActiveGracePeriod: + default: 0 + description: Grace period for active instances to stay alive before becoming eligible for shutdown signal due to a rollout, in seconds. Defaults to 0. + maximum: 604800 + minimum: 0 + type: integer + ccDurableObjectsConfigurationNamespaceId: + description: Durable object configuration using a namespace ID + properties: + namespace_id: + description: The namespace ID of the durable object namespace to use for this application. + type: string + required: + - namespace_id + type: object + ccISO8601Timestamp: + description: UTC timestamp string in ISO 8601 format + example: '2021-04-01T12:32:41.488Z' + type: string + ccImage: + description: Image url + type: string + ccImageRegistryCredentialsConfiguration: + description: Specifies the configuration for the image registry credential to create. + properties: + expiration_minutes: + description: The number of minutes the credentials will be valid for. + type: integer + permissions: + items: + $ref: '#/components/schemas/ccImageRegistryPermissions' + type: array + required: + - permissions + - expiration_minutes + type: object + ccImageRegistryPermissions: + description: Specifies what permissions the credentials will have. + enum: + - pull + - push + - library_push + type: string + ccMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + ccObservabilityLogs: + description: Observability logging settings. + properties: + enabled: + default: false + type: boolean + type: object + ccPublicApplication: + description: Provides the current state and configuration of a Containers application. + properties: + created_at: + $ref: '#/components/schemas/ccISO8601Timestamp' + readOnly: true + durable_object: + $ref: '#/components/schemas/ccDurableObjectsConfigurationNamespaceId' + health: + $ref: '#/components/schemas/ccApplicationHealthInstances' + id: + $ref: '#/components/schemas/ccApplicationID' + image: + $ref: '#/components/schemas/ccImage' + instance_type: + $ref: '#/components/schemas/ccPublicInstanceType' + max_instances: + description: Maximum number of instances that the application will allow. + type: integer + name: + description: The name of the application. + type: string + network: + $ref: '#/components/schemas/ccApplicationNetwork' + observability: + $ref: '#/components/schemas/ccApplicationObservability' + rollout_active_grace_period: + $ref: '#/components/schemas/ccApplicationRolloutActiveGracePeriod' + updated_at: + $ref: '#/components/schemas/ccISO8601Timestamp' + readOnly: true + version: + description: The current version number of this application. This increments with application rollouts. + example: 1 + type: integer + required: + - id + - created_at + - updated_at + - version + - health + - name + - instance_type + - max_instances + - image + type: object + ccPublicInstanceType: + description: Specifies either a pre-set instance type or a custom resource allocation. + type: object + properties: + disk_mb: + description: The disk size in MB. + type: integer + memory_mib: + description: Specify the memory to be used for the deployment, in MiB. The default will be the one configured for the account. + type: integer + vcpu: + description: Specify the vcpu to be used for the deployment. Vcpu must be at least 1. The input value will be rounded to the nearest 0.0001. The default will be the one configured for the account. + format: float + type: number + required: + - vcpu + - memory_mib + - disk_mb + example: lite + default: lite + enum: + - lite + - basic + - standard-1 + - standard-2 + - standard-3 + - standard-4 + ccRegistryTokenPermissionsNotAllowedError: + description: The requested token permissions are not allowed for this account + properties: + error: + enum: + - TOKEN_PERMISSIONS_NOT_ALLOWED + type: string + required: + - error + type: object + ccV4BaseErrorResponse: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/ccMessages' + messages: + example: [] + $ref: '#/components/schemas/ccMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + type: boolean + required: + - success + - errors + - messages + - result + type: object + unnamedSchemaRefEe1e79edcb234d14c4dd266880f2fd24: + description: JSON-encoded metadata about the uploaded parts and Worker configuration. + properties: + body_part: + description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker. + example: worker.js + type: string + main_module: + description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker. + example: worker.js + type: string + type: object + workersAccountSettings: + properties: + default_usage_model: + type: string + x-auditable: true + green_compute: + type: boolean + x-auditable: true + type: object + workersApiResponseCommon: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + type: object + workersApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/workersMessages' + messages: + example: [] + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + workersApiResponseNullResult: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + type: object + workersAssets: + description: Configuration for assets within a Worker. + properties: + config: + description: Configuration for assets within a Worker. + properties: + _headers: + description: The contents of a _headers file (used to attach custom headers on asset responses). + example: '/dashboard/* + + X-Frame-Options: DENY + + + /static/* + + Access-Control-Allow-Origin: *' + type: string + _redirects: + description: The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving). + example: '/foo /bar 301 + + /news/* /blog/:splat' + type: string + html_handling: + description: Determines the redirects and rewrites of requests for HTML content. + enum: + - auto-trailing-slash + - force-trailing-slash + - drop-trailing-slash + - none + example: auto-trailing-slash + type: string + not_found_handling: + description: Determines the response when a request does not match a static asset, and there is no Worker script. + enum: + - none + - 404-page + - single-page-application + example: 404-page + type: string + run_worker_first: + type: array + description: Contains a list path rules to control routing to either the Worker or assets. Glob (*) and negative (!) rules are supported. Rules must start with either '/' or '!/'. At least one non-negative rule must be provided, and negative rules have higher precedence than non-negative rules. + items: + type: string + example: true + serve_directly: + deprecated: true + description: When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script. + example: true + type: boolean + type: object + jwt: + description: Token provided upon successful upload of all files from a registered manifest. + type: string + x-sensitive: true + type: object + workersBindingItem: + description: A binding to allow the Worker to communicate with resources. + type: object + properties: + name: + $ref: '#/components/schemas/workersBindingName' + type: + description: The kind of resource that the binding provides. + enum: + - ai + type: string + x-auditable: true + instance_name: + description: The user-chosen instance name. Must exist at deploy time. The worker can search, chat, update, and manage items/jobs on this instance. + example: cloudflare-blog + type: string + x-auditable: true + namespace: + description: The namespace the instance belongs to. Defaults to "default" if omitted. Customers who don't use namespaces can simply omit this field. + example: production + type: string + x-auditable: true + dataset: + description: The name of the dataset to bind to. + example: some_dataset + type: string + x-auditable: true + database_id: + description: Identifier of the D1 database to bind to. + example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + type: string + x-auditable: true + id: + deprecated: true + description: Identifier of the D1 database to bind to. + example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + type: string + x-auditable: true + x-stainless-deprecation-message: This property has been renamed to `database_id`. + part: + description: The name of the file containing the data content. Only accepted for `service worker syntax` Workers. + example: my-module.bin + type: string + x-auditable: true + outbound: + description: Outbound worker. + properties: + params: + description: Pass information from the Dispatch Worker to the Outbound Worker through the parameters. + items: + properties: + name: + description: Name of the parameter. + example: customer_name + type: string + x-auditable: true + required: + - name + type: object + type: array + worker: + description: Outbound worker. + properties: + entrypoint: + description: Entrypoint to invoke on the outbound worker. + type: string + x-auditable: true + environment: + description: Environment of the outbound worker. + type: string + x-auditable: true + service: + description: Name of the outbound worker. + type: string + x-auditable: true + type: object + type: object + class_name: + description: The exported class name of the Durable Object. + example: MyDurableObject + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + dispatch_namespace: + description: The dispatch namespace the Durable Object script belongs to. + example: my-dispatch-namespace + type: string + x-auditable: true + environment: + description: The environment of the script_name to bind to. + example: production + type: string + x-auditable: true + namespace_id: + $ref: '#/components/schemas/workersNamespaceIdentifier' + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + script_name: + description: The script where the Durable Object is defined, if it is external to this Worker. + example: my-other-worker + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + old_name: + description: The old name of the inherited binding. If set, the binding will be renamed from `old_name` to `name` in the new version. If not set, the binding will keep the same name between versions. + example: MY_OLD_BINDING + type: string + x-auditable: true + version_id: + default: latest + description: Identifier for the version to inherit the binding from, which can be the version ID or the literal "latest" to inherit from the latest version. Defaults to inheriting the binding from the latest version. + example: 8969331f-7192-434c-9938-6aea24ed58bf + type: string + x-auditable: true + json: + description: JSON data to use. + type: object + x-stainless-any: true + certificate_id: + description: Identifier of the certificate to bind to. + example: efwu2n6s-q69d-2kr9-184j-4913e8h391k6 + type: string + x-auditable: true + text: + description: The text value to use. + example: Hello, world! + type: string + x-auditable: true + pipeline: + description: Name of the Pipeline to bind to. + example: my-pipeline + type: string + x-auditable: true + queue_name: + description: Name of the Queue to bind to. + example: my-queue + type: string + simple: + description: The rate limit configuration. + properties: + limit: + description: The limit (requests per period). + example: 100 + type: number + x-auditable: true + mitigation_timeout: + description: Duration in seconds to apply the mitigation action after the rate limit is exceeded. Valid values are 0 (disabled), 10, or multiples of 60 up to 86400. Must be greater than or equal to the period when non-zero. + example: 60 + type: integer + x-auditable: true + period: + description: The period in seconds. + example: 60 + type: integer + x-auditable: true + required: + - limit + - period + type: object + bucket_name: + description: R2 bucket to bind to. + example: my-r2-bucket + type: string + x-auditable: true + jurisdiction: + description: The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket. + enum: + - eu + - fedramp + - fedramp-high + example: eu + type: string + x-auditable: true + allowed_destination_addresses: + description: List of allowed destination addresses. + example: + - user1@example.com + - user2@example.com + items: + format: email + type: string + type: array + x-auditable: true + allowed_sender_addresses: + description: List of allowed sender addresses. + example: + - user1@example.com + - user2@example.com + items: + format: email + type: string + type: array + x-auditable: true + destination_address: + description: Destination address for the email. + example: user@example.com + format: email + type: string + x-auditable: true + entrypoint: + description: Entrypoint to invoke on the target Worker. + example: MyHandler + type: string + x-auditable: true + service: + description: Name of Worker to bind to. + example: my-worker + type: string + x-auditable: true + index_name: + description: Name of the Vectorize index to bind to. + example: my-index-name + type: string + x-auditable: true + secret_name: + description: Name of the secret in the store. + example: my_secret + type: string + x-auditable: true + store_id: + description: ID of the store containing the secret. + example: 8c8b1387108e49be85669169793e7bd2 + type: string + x-auditable: true + app_id: + description: ID of the Flagship app to bind to for feature flag evaluation. + example: app-12345678-1234-1234-1234-123456789012 + maxLength: 128 + type: string + x-auditable: true + algorithm: + description: Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm). + type: object + x-auditable: true + format: + description: Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format). + enum: + - raw + - pkcs8 + - spki + - jwk + example: raw + type: string + x-auditable: true + key_base64: + description: Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki". + type: string + writeOnly: true + x-sensitive: true + key_jwk: + description: Key data in [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key) format. Required if `format` is "jwk". + type: object + writeOnly: true + x-sensitive: true + usages: + description: Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages). + example: + - encrypt + - decrypt + items: + enum: + - encrypt + - decrypt + - sign + - verify + - deriveKey + - deriveBits + - wrapKey + - unwrapKey + type: string + type: array + x-auditable: true + x-stainless-collection-type: set + workflow_name: + description: Name of the Workflow to bind to. + example: my-workflow + type: string + service_id: + description: Identifier of the VPC service to bind to. + example: 8c8b1387108e49be85669169793e7bd2 + type: string + x-auditable: true + network_id: + description: Identifier of the network to bind to. Only "cf1:network" is currently supported. Mutually exclusive with tunnel_id. + example: cf1:network + type: string + x-auditable: true + tunnel_id: + description: UUID of the Cloudflare Tunnel to bind to. Mutually exclusive with network_id. + example: abcd1234-5678-90ef-ghij-klmnopqrstuv + type: string + x-auditable: true + required: + - name + - type + workersBindingName: + description: A JavaScript variable name for the binding. + example: myBinding + type: string + x-auditable: true + workersBindings: + description: 'List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.' + example: + - name: MY_ENV_VAR + text: my_data + type: plain_text + items: + $ref: '#/components/schemas/workersBindingItem' + type: array + workersCompatibilityDate: + description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker. + example: '2021-01-01' + type: string + x-auditable: true + workersCompatibilityFlag: + description: Flag that enables or disables a specific feature in the Workers runtime. + example: nodejs_compat + type: string + x-auditable: true + workersCompatibilityFlags: + default: [] + description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`. + example: + - nodejs_compat + items: + $ref: '#/components/schemas/workersCompatibilityFlag' + type: array + x-stainless-collection-type: set + workersCompletedUploadAssetsResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + jwt: + description: A "completion" JWT which can be redeemed when creating a Worker version. + type: string + x-sensitive: true + type: object + required: + - success + - errors + - messages + type: object + workersContainerItem: + description: Container configuration for a Worker. + properties: + class_name: + description: Select which Durable Object class should get this container attached. + type: string + x-auditable: true + required: + - class_name + type: object + workersContainers: + description: List of containers attached to a Worker. Containers can only be attached to Durable Object classes of this Worker script. + example: + - class_name: MyDurableObject + items: + $ref: '#/components/schemas/workersContainerItem' + type: array + x-stainless-collection-type: set + workersCreateAssetsUploadSessionObject: + properties: + manifest: + description: 'A manifest ([path]: {hash, size}) map of files to upload. As an example, `/blog/hello-world.html` would be a valid path key.' + type: object + required: + - manifest + type: object + workersCreateAssetsUploadSessionResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + buckets: + description: The requests to make to upload assets. + items: + description: The set of assets to include in each request while uploading. + items: + description: The file hash to include in this bucket. + type: string + type: array + x-stainless-collection-type: set + type: array + x-stainless-collection-type: set + jwt: + description: A JWT to use as authentication for uploading assets. + type: string + x-sensitive: true + type: object + required: + - success + - errors + - messages + type: object + workersCreatedOn: + description: When the script was created. + example: '2017-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + workersDeployment: + properties: + annotations: + properties: + workers/message: + description: Human-readable message about the deployment. Truncated to 1000 bytes if longer. + example: Deploy bug fix. + maxLength: 1000 + type: string + x-auditable: true + workers/triggered_by: + description: Operation that triggered the creation of the deployment. + example: deployment + readOnly: true + type: string + type: object + author_email: + format: email + readOnly: true + type: string + x-auditable: true + created_on: + format: date-time + readOnly: true + type: string + x-auditable: true + id: + format: uuid + readOnly: true + type: string + x-auditable: true + source: + example: api + readOnly: true + type: string + x-auditable: true + strategy: + enum: + - percentage + type: string + x-auditable: true + versions: + items: + properties: + percentage: + example: 100 + maximum: 100 + minimum: 0.01 + type: number + x-auditable: true + version_id: + format: uuid + type: string + x-auditable: true + required: + - version_id + - percentage + type: object + type: array + x-auditable: true + required: + - id + - source + - strategy + - versions + - created_on + type: object + workersDispatchNamespaceName: + description: Name of the Workers for Platforms dispatch namespace. + example: my-dispatch-namespace + type: string + x-auditable: true + workersDomain: + properties: + cert_id: + description: ID of the TLS certificate issued for the domain. + example: 9fdf92c8-64c2-4a3d-b1af-e15304961145 + format: uuid + readOnly: true + type: string + x-auditable: true + environment: + deprecated: true + description: Worker environment associated with the domain. + example: production + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + hostname: + description: Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker. + example: app.example.com + type: string + x-auditable: true + id: + description: Immutable ID of the domain. + example: dbe10b4bc17c295377eabd600e1787fd + readOnly: true + type: string + x-auditable: true + service: + description: Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker. + example: my-worker + type: string + x-auditable: true + zone_id: + description: ID of the zone containing the domain hostname. + example: 593c9c94de529bbbfaac7c53ced0447d + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zone_name: + description: Name of the zone containing the domain hostname. + example: example.com + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + required: + - id + - cert_id + - zone_id + - zone_name + - hostname + - service + - environment + type: object + workersEtag: + description: Hashed script content, can be used in a If-None-Match header when updating. + example: ea95132c15732412d22c1476fa83f27a + readOnly: true + type: string + workersHasAssets: + description: Whether a Worker contains assets. + example: false + type: boolean + x-auditable: true + workersHasModules: + description: Whether a Worker contains modules. + example: false + type: boolean + x-auditable: true + workersIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + workersLimits: + description: Limits to apply for this Worker. + properties: + cpu_ms: + description: The amount of CPU time this Worker can use in milliseconds. + example: 50 + type: integer + x-auditable: true + subrequests: + description: The number of subrequests this Worker can make per request. + example: 1000 + type: integer + x-auditable: true + type: object + workersLogpush: + default: false + description: Whether Logpush is turned on for the Worker. + example: false + type: boolean + x-auditable: true + workersMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + workersMigrationStep: + properties: + deleted_classes: + description: A list of classes to delete Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_classes: + description: A list of classes to create Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_sqlite_classes: + description: A list of classes to create Durable Object namespaces with SQLite from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + renamed_classes: + description: A list of classes with Durable Object namespaces that were renamed. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + transferred_classes: + description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + from_script: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + type: object + workersModifiedOn: + description: When the script was last modified. + example: '2017-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + workersNamespaceIdentifier: + description: Namespace identifier tag. + example: 0f2ac74b498b48028cb68387c421e279 + maxLength: 32 + type: string + x-auditable: true + workersNamespaceScriptDeleteBulkResponse: + description: Detail about bulk deletion of scripts in a namespace. + properties: + deleted: + items: + properties: + id: + $ref: '#/components/schemas/workersUuid' + type: object + type: array + deleted_count: + example: 100 + type: integer + has_more: + example: false + type: boolean + type: object + workersNamespaceScriptResponse: + description: Details about a worker uploaded to a Workers for Platforms namespace. + properties: + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + dispatch_namespace: + $ref: '#/components/schemas/workersDispatchNamespaceName' + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + script: + $ref: '#/components/schemas/workersScriptResponse' + type: object + workersObservability: + description: Observability settings for the Worker. + properties: + enabled: + description: Whether observability is enabled for the Worker. + example: true + type: boolean + x-auditable: true + head_sampling_rate: + description: The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. + example: 0.1 + nullable: true + type: number + x-auditable: true + logs: + description: Log settings for the Worker. + nullable: true + properties: + destinations: + description: A list of destinations where logs will be exported to. + example: + - cloudflare + items: + type: string + type: array + x-auditable: true + enabled: + description: Whether logs are enabled for the Worker. + example: true + type: boolean + x-auditable: true + head_sampling_rate: + description: The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. + example: 0.1 + nullable: true + type: number + x-auditable: true + invocation_logs: + description: Whether [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs) are enabled for the Worker. + example: true + type: boolean + x-auditable: true + persist: + default: true + description: Whether log persistence is enabled for the Worker. + example: true + type: boolean + x-auditable: true + required: + - enabled + - invocation_logs + type: object + traces: + description: Trace settings for the Worker. + nullable: true + properties: + destinations: + description: A list of destinations where traces will be exported to. + example: + - cloudflare + items: + type: string + type: array + x-auditable: true + enabled: + description: Whether traces are enabled for the Worker. + example: true + type: boolean + x-auditable: true + head_sampling_rate: + description: The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. + example: 0.1 + nullable: true + type: number + x-auditable: true + persist: + default: true + description: Whether trace persistence is enabled for the Worker. + example: true + type: boolean + x-auditable: true + type: object + required: + - enabled + type: object + workersObservabilityFilterNode: + description: 'Supports nested groups via kind: ''group''.' + type: object + properties: + filterCombination: + enum: + - and + - or + - AND + - OR + type: string + filters: + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + minItems: 1 + type: array + kind: + enum: + - group + type: string + key: + description: Filter field name. Use verified keys from previous query results or the keys endpoint. Common keys include $metadata.service, $metadata.origin, $metadata.trigger, $metadata.message, and $metadata.error. + type: string + operation: + description: 'Comparison operator. String operators: includes, not_includes, starts_with, regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.' + enum: + - includes + - not_includes + - starts_with + - regex + - exists + - is_null + - in + - not_in + - eq + - neq + - gt + - gte + - lt + - lte + - '=' + - '!=' + - '>' + - '>=' + - < + - <= + - INCLUDES + - DOES_NOT_INCLUDE + - MATCH_REGEX + - EXISTS + - DOES_NOT_EXIST + - IN + - NOT_IN + - STARTS_WITH + type: string + type: + description: Data type of the filter field. Must match the actual type of the key being filtered. + enum: + - string + - number + - boolean + type: string + value: + description: "Comparison value. Must match actual values in your data \u2014 verify with the values endpoint. Ensure the value type (string/number/boolean) matches the field type. String comparisons are case-sensitive. Regex uses RE2 syntax (no lookaheads/lookbehinds)." + type: string + required: [] + workersObservabilityPerformanceInformation: + description: Query performance statistics from the database. Includes execution time, rows scanned, and bytes read. Does not include network latency. + properties: + abr_level: + description: The level of Adaptive Bit Rate (ABR) sampling used for the query. If empty the ABR level is 1 + type: number + bytes_read: + description: Number of uncompressed bytes read from the table. + type: number + elapsed: + description: Time in seconds for the query to run. + type: number + rows_read: + description: Number of rows scanned from the table. + type: number + required: + - elapsed + - rows_read + - bytes_read + type: object + workersObservabilityQuery: + properties: + adhoc: + description: If the query wasn't explcitly saved + type: boolean + created: + type: string + createdBy: + type: string + description: + example: Query description + maxLength: 1000 + nullable: true + type: string + id: + type: string + name: + description: Query name + maxLength: 250 + minLength: 1 + type: string + parameters: + properties: + calculations: + description: Create Calculations to compute as part of the query. + items: + properties: + alias: + type: string + key: + type: string + keyType: + enum: + - string + - number + - boolean + type: string + operator: + enum: + - uniq + - count + - max + - min + - sum + - avg + - median + - p001 + - p01 + - p05 + - p10 + - p25 + - p75 + - p90 + - p95 + - p99 + - p999 + - stddev + - variance + - COUNT_DISTINCT + - COUNT + - MAX + - MIN + - SUM + - AVG + - MEDIAN + - P001 + - P01 + - P05 + - P10 + - P25 + - P75 + - P90 + - P95 + - P99 + - P999 + - STDDEV + - VARIANCE + type: string + required: + - operator + type: object + type: array + datasets: + description: Set the Datasets to query. Leave it empty to query all the datasets. + example: [] + items: + type: string + type: array + filterCombination: + description: Set a Flag to describe how to combine the filters on the query. + enum: + - and + - or + - AND + - OR + type: string + filters: + description: 'Configure the Filters to apply to the query. Supports nested groups via kind: ''group''.' + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + type: array + groupBys: + description: Define how to group the results of the query. + items: + properties: + type: + enum: + - string + - number + - boolean + type: string + value: + type: string + required: + - type + - value + type: object + type: array + havings: + description: Configure the Having clauses that filter on calculations in the query result. + items: + properties: + key: + type: string + operation: + enum: + - eq + - neq + - gt + - gte + - lt + - lte + type: string + value: + type: number + required: + - key + - operation + - value + type: object + type: array + limit: + description: Set a limit on the number of results / records returned by the query + maximum: 100 + minimum: 0 + type: integer + needle: + description: Define an expression to search using full-text search. + properties: + isRegex: + type: boolean + matchCase: + type: boolean + value: + maxLength: 1000 + type: string + required: + - value + type: object + orderBy: + description: Configure the order of the results returned by the query. + properties: + order: + description: Set the order of the results + enum: + - asc + - desc + type: string + value: + description: Configure which Calculation to order the results by. + type: string + required: + - value + type: object + type: object + updated: + type: string + updatedBy: + type: string + required: + - id + - name + - description + - adhoc + - parameters + - created + - createdBy + - updated + - updatedBy + type: object + workersObservabilityQueryResults: + description: Complete results of a query run. The populated fields depend on the requested view type (events, calculations, invocations, traces, or agents). + properties: + agents: + description: Durable Object agent summaries. Present when the query view is 'agents'. Each entry represents an agent with its event counts and status. + items: + properties: + agentClass: + description: Class name of the Durable Object agent. + type: string + eventTypeCounts: + description: Breakdown of event counts by event type. + type: object + firstEventMs: + description: Timestamp of the earliest event from this agent in the queried window (Unix epoch ms). + type: number + hasErrors: + description: Whether the agent emitted any error events in the queried window. + type: boolean + lastEventMs: + description: Timestamp of the most recent event from this agent (Unix epoch ms). + type: number + namespace: + description: Durable Object namespace the agent belongs to. + type: string + service: + description: Worker service name that hosts this agent. + type: string + totalEvents: + description: Total number of events emitted by this agent in the queried window. + type: number + required: + - namespace + - agentClass + - service + - lastEventMs + - firstEventMs + - totalEvents + - eventTypeCounts + - hasErrors + type: object + type: array + calculations: + description: Aggregated calculation results. Present when the query view is 'calculations'. Contains computed metrics (count, avg, p99, etc.) with optional group-by breakdowns and time-series data. + items: + properties: + aggregates: + items: + properties: + count: + type: number + groups: + items: + properties: + key: + type: string + value: + type: string + required: + - key + - value + type: object + type: array + interval: + type: number + sampleInterval: + type: number + value: + type: number + required: + - value + - count + - interval + - sampleInterval + type: object + type: array + alias: + type: string + calculation: + type: string + series: + items: + properties: + data: + items: + properties: + count: + type: number + firstSeen: + type: string + groups: + items: + properties: + key: + type: string + value: + type: string + required: + - key + - value + type: object + type: array + interval: + type: number + lastSeen: + type: string + sampleInterval: + type: number + value: + type: number + required: + - value + - count + - interval + - sampleInterval + type: object + type: array + time: + type: string + required: + - time + - data + type: object + type: array + required: + - calculation + - aggregates + - series + type: object + type: array + compare: + description: Comparison calculation results from the previous time period. Present when the compare option is enabled. Same structure as calculations. + items: + properties: + aggregates: + items: + properties: + count: + type: number + groups: + items: + properties: + key: + type: string + value: + type: string + required: + - key + - value + type: object + type: array + interval: + type: number + sampleInterval: + type: number + value: + type: number + required: + - value + - count + - interval + - sampleInterval + type: object + type: array + alias: + type: string + calculation: + type: string + series: + items: + properties: + data: + items: + properties: + count: + type: number + firstSeen: + type: string + groups: + items: + properties: + key: + type: string + value: + type: string + required: + - key + - value + type: object + type: array + interval: + type: number + lastSeen: + type: string + sampleInterval: + type: number + value: + type: number + required: + - value + - count + - interval + - sampleInterval + type: object + type: array + time: + type: string + required: + - time + - data + type: object + type: array + required: + - calculation + - aggregates + - series + type: object + type: array + events: + description: Individual event results. Present when the query view is 'events'. Contains the matching log lines and their metadata. + properties: + count: + description: Total number of events matching the query (may exceed the number returned due to limits). + type: number + events: + description: List of individual telemetry events matching the query. + items: + $ref: '#/components/schemas/workersObservabilityTelemetryEvent' + type: array + fields: + description: List of fields discovered in the matched events. Useful for building dynamic UIs. + items: + properties: + key: + description: Field name present in the matched events. + type: string + type: + description: Data type of the field (string, number, or boolean). + type: string + required: + - key + - type + type: object + type: array + series: + description: Time-series data for the matched events, bucketed by the query granularity. + items: + properties: + data: + items: + properties: + aggregates: + properties: + _count: + deprecated: true + exclusiveMinimum: true + minimum: 0 + type: integer + _firstSeen: + deprecated: true + type: string + _interval: + deprecated: true + exclusiveMinimum: true + minimum: 0 + type: number + _lastSeen: + deprecated: true + type: string + bin: + deprecated: true + type: object + required: + - _count + - _interval + type: object + count: + type: number + errors: + type: number + groups: + description: Groups in the query results. + type: object + interval: + type: number + sampleInterval: + type: number + required: + - aggregates + - count + - interval + - sampleInterval + type: object + type: array + time: + type: string + required: + - time + - data + type: object + type: array + type: object + invocations: + description: Events grouped by invocation (request ID). Present when the query view is 'invocations'. Each key is a request ID mapping to all events from that invocation. + type: object + run: + $ref: '#/components/schemas/workersObservabilityQueryRun' + statistics: + $ref: '#/components/schemas/workersObservabilityPerformanceInformation' + traces: + description: Trace summaries matching the query. Present when the query view is 'traces'. Each entry represents a distributed trace with its spans, duration, and services involved. + items: + properties: + errors: + description: Error messages encountered during the trace, if any. + items: + type: string + type: array + rootSpanName: + description: Name of the root span that initiated the trace. + type: string + rootTransactionName: + description: Logical transaction name for the root span. + type: string + service: + description: List of Worker services involved in the trace. + items: + type: string + type: array + spans: + description: Total number of spans in the trace. + type: number + traceDurationMs: + description: Total duration of the trace in milliseconds. + type: number + traceEndMs: + description: Trace end time as a Unix epoch in milliseconds. + type: number + traceId: + description: Unique identifier for the distributed trace. + type: string + traceStartMs: + description: Trace start time as a Unix epoch in milliseconds. + type: number + required: + - traceId + - spans + - service + - traceStartMs + - traceEndMs + - traceDurationMs + - rootSpanName + - rootTransactionName + type: object + type: array + required: + - run + - statistics + type: object + workersObservabilityQueryRun: + description: The query run metadata including the query definition, execution status, and timeframe. + properties: + accountId: + description: Cloudflare account ID that owns this query run. + type: string + created: + description: ISO-8601 timestamp when the query run was created. + type: string + dry: + description: Whether this was a dry run (results not persisted). + type: boolean + granularity: + description: Number of time-series buckets used for the query. Higher values produce more detailed series data. + type: number + id: + description: Unique identifier for this query run. + type: string + query: + description: A saved query definition with its parameters, metadata, and ownership information. + properties: + adhoc: + description: If the query wasn't explcitly saved + type: boolean + created: + type: string + createdBy: + type: string + description: + example: Query description + maxLength: 1000 + nullable: true + type: string + id: + type: string + name: + description: Query name + maxLength: 250 + minLength: 1 + type: string + parameters: + properties: + calculations: + description: Create Calculations to compute as part of the query. + items: + properties: + alias: + type: string + key: + type: string + keyType: + enum: + - string + - number + - boolean + type: string + operator: + enum: + - uniq + - count + - max + - min + - sum + - avg + - median + - p001 + - p01 + - p05 + - p10 + - p25 + - p75 + - p90 + - p95 + - p99 + - p999 + - stddev + - variance + - COUNT_DISTINCT + - COUNT + - MAX + - MIN + - SUM + - AVG + - MEDIAN + - P001 + - P01 + - P05 + - P10 + - P25 + - P75 + - P90 + - P95 + - P99 + - P999 + - STDDEV + - VARIANCE + type: string + required: + - operator + type: object + type: array + datasets: + description: Set the Datasets to query. Leave it empty to query all the datasets. + example: [] + items: + type: string + type: array + filterCombination: + description: Set a Flag to describe how to combine the filters on the query. + enum: + - and + - or + - AND + - OR + type: string + filters: + description: 'Configure the Filters to apply to the query. Supports nested groups via kind: ''group''.' + items: + $ref: '#/components/schemas/workersObservabilityFilterNode' + type: array + groupBys: + description: Define how to group the results of the query. + items: + properties: + type: + enum: + - string + - number + - boolean + type: string + value: + type: string + required: + - type + - value + type: object + type: array + havings: + description: Configure the Having clauses that filter on calculations in the query result. + items: + properties: + key: + type: string + operation: + enum: + - eq + - neq + - gt + - gte + - lt + - lte + type: string + value: + type: number + required: + - key + - operation + - value + type: object + type: array + limit: + description: Set a limit on the number of results / records returned by the query + maximum: 100 + minimum: 0 + type: integer + needle: + description: Define an expression to search using full-text search. + properties: + isRegex: + type: boolean + matchCase: + type: boolean + value: + type: string + required: + - value + type: object + orderBy: + description: Configure the order of the results returned by the query. + properties: + order: + description: Set the order of the results + enum: + - asc + - desc + type: string + value: + description: Configure which Calculation to order the results by. + type: string + required: + - value + type: object + type: object + updated: + type: string + updatedBy: + type: string + required: + - id + - name + - description + - adhoc + - parameters + - created + - createdBy + - updated + - updatedBy + type: object + statistics: + description: Query performance statistics from the database (does not include network latency). + properties: + abr_level: + description: The level of Adaptive Bit Rate (ABR) sampling used for the query. If empty the ABR level is 1 + type: number + bytes_read: + description: Number of uncompressed bytes read from the table. + type: number + elapsed: + description: Time in seconds for the query to run. + type: number + rows_read: + description: Number of rows scanned from the table. + type: number + required: + - elapsed + - rows_read + - bytes_read + type: object + status: + description: Current execution status of the query run. + enum: + - STARTED + - COMPLETED + type: string + timeframe: + description: Time range for the query execution + properties: + from: + description: Start timestamp for the query timeframe (Unix timestamp in milliseconds) + type: number + to: + description: End timestamp for the query timeframe (Unix timestamp in milliseconds) + type: number + required: + - to + - from + type: object + updated: + description: ISO-8601 timestamp when the query run was last updated. + type: string + userId: + description: ID of the user who initiated the query run. + type: string + required: + - id + - query + - accountId + - timeframe + - userId + - status + - granularity + - dry + type: object + workersObservabilityTelemetryEvent: + description: A single telemetry event representing a log line, span, or metric data point emitted by a Worker. + properties: + $containers: + description: Cloudflare Containers event information that enriches your logs for identifying and debugging issues. + type: object + $metadata: + description: Structured metadata extracted from the event. These fields are indexed and available for filtering and aggregation. + properties: + account: + description: Cloudflare account identifier. + type: string + cloudService: + description: Cloudflare product that generated this event (e.g. workers, pages). + type: string + coldStart: + description: Whether this was a cold start (1) or warm invocation (0). + exclusiveMinimum: true + minimum: 0 + type: integer + cost: + description: Estimated cost units for this invocation. + exclusiveMinimum: true + minimum: 0 + type: integer + duration: + description: Span duration in milliseconds. + exclusiveMinimum: true + minimum: 0 + type: integer + endTime: + description: Span end time as a Unix epoch in milliseconds. + minimum: 0 + type: integer + error: + description: Error message, present when the log represents an error. + type: string + errorTemplate: + description: Templatized version of the error message used for grouping similar errors. + type: string + fingerprint: + description: Content-based fingerprint used to group similar events. + type: string + id: + description: Unique event ID. Use as the cursor value for offset-based pagination. + type: string + level: + description: Log level (e.g. log, debug, info, warn, error). + type: string + message: + description: Log message text. + type: string + messageTemplate: + description: Templatized version of the log message used for grouping similar messages. + type: string + metricName: + description: Metric name when the event represents a metric data point. + type: string + origin: + description: Origin of the event (e.g. fetch, scheduled, queue). + type: string + parentSpanId: + description: Span ID of the parent span in the trace hierarchy. + type: string + provider: + description: Infrastructure provider identifier. + type: string + region: + description: Cloudflare data center / region that handled the request. + type: string + requestId: + description: Cloudflare request ID that ties all logs from a single invocation together. + type: string + service: + description: Worker script name that produced this event. + type: string + spanId: + description: Span ID for this individual unit of work within a trace. + type: string + spanName: + description: Human-readable name for this span. + type: string + stackId: + description: Stack / deployment identifier. + type: string + startTime: + description: Span start time as a Unix epoch in milliseconds. + minimum: 0 + type: integer + statusCode: + description: HTTP response status code returned by the Worker. + exclusiveMinimum: true + minimum: 0 + type: integer + traceDuration: + description: Total duration of the entire trace in milliseconds. + exclusiveMinimum: true + minimum: 0 + type: integer + traceId: + description: Distributed trace ID linking spans across services. + type: string + transactionName: + description: Logical transaction name for this request. + type: string + trigger: + description: What triggered the invocation (e.g. GET /users, POST /orders, queue message). + type: string + type: + description: Event type classifier (e.g. cf-worker-event, cf-worker-log). + type: string + url: + description: Request URL that triggered the Worker invocation. + type: string + required: + - id + type: object + $workers: + description: Cloudflare Workers event information that enriches your logs for identifying and debugging issues. + type: object + properties: + durableObjectId: + type: string + entrypoint: + type: string + event: + type: object + eventType: + enum: + - fetch + - scheduled + - alarm + - cron + - queue + - email + - tail + - rpc + - websocket + - workflow + - unknown + type: string + executionModel: + enum: + - durableObject + - stateless + type: string + outcome: + type: string + requestId: + type: string + scriptName: + type: string + scriptVersion: + properties: + id: + type: string + message: + type: string + tag: + type: string + type: object + spanId: + type: string + traceId: + type: string + truncated: + type: boolean + cpuTimeMs: + type: number + diagnosticsChannelEvents: + items: + properties: + channel: + type: string + message: + type: string + timestamp: + type: number + required: + - timestamp + - channel + - message + type: object + type: array + dispatchNamespace: + type: string + wallTimeMs: + type: number + required: + - eventType + - requestId + - scriptName + dataset: + description: The dataset this event belongs to (e.g. cloudflare-workers). + type: string + source: + description: Raw log payload. May be a string or a structured object depending on how the log was emitted. + type: string + timestamp: + description: Event timestamp as a Unix epoch in milliseconds. + minimum: 0 + type: integer + required: + - dataset + - timestamp + - source + - $metadata + type: object + workersPlacementInfo: + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + type: object + properties: + last_analyzed_at: + description: The last time the script was analyzed for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + example: '2025-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + status: + $ref: '#/components/schemas/workersPlacementStatus' + mode: + description: Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - smart + type: string + x-auditable: true + region: + description: Cloud region for targeted placement in format 'provider:region'. + example: aws:us-east-1 + type: string + x-auditable: true + hostname: + description: HTTP hostname for targeted placement. + example: api.example.com + type: string + x-auditable: true + host: + description: TCP host and port for targeted placement. + example: db.example.com:5432 + type: string + x-auditable: true + target: + description: Array of placement targets (currently limited to single target). + items: + $ref: '#/components/schemas/workersPlacementTarget' + maxItems: 1 + minItems: 1 + type: array + x-auditable: true + required: [] + workersPlacementInfoNoStatus: + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + type: object + properties: + mode: + description: Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - smart + type: string + x-auditable: true + region: + description: Cloud region for targeted placement in format 'provider:region'. + example: aws:us-east-1 + type: string + x-auditable: true + hostname: + description: HTTP hostname for targeted placement. + example: api.example.com + type: string + x-auditable: true + host: + description: TCP host and port for targeted placement. + example: db.example.com:5432 + type: string + x-auditable: true + target: + description: Array of placement targets (currently limited to single target). + items: + $ref: '#/components/schemas/workersPlacementTarget' + maxItems: 1 + minItems: 1 + type: array + x-auditable: true + required: [] + workersPlacementMode: + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + enum: + - smart + - targeted + type: string + x-auditable: true + workersPlacementProvider: + properties: + id: + description: The cloud provider identifier. + example: aws + type: string + regions: + description: List of regions available for this provider. + items: + $ref: '#/components/schemas/workersPlacementRegion' + type: array + required: + - id + - regions + type: object + workersPlacementRegion: + properties: + id: + description: The region identifier. + example: us-east-1 + type: string + required: + - id + type: object + workersPlacementRegionsResponse: + properties: + providers: + description: List of cloud providers with their available regions. + items: + $ref: '#/components/schemas/workersPlacementProvider' + type: array + required: + - providers + type: object + workersPlacementStatus: + description: Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - SUCCESS + - UNSUPPORTED_APPLICATION + - INSUFFICIENT_INVOCATIONS + readOnly: true + type: string + x-auditable: true + workersPlacementTarget: + description: A target to run your Worker near. + type: object + properties: + region: + description: Cloud region in format 'provider:region'. + example: aws:us-east-1 + type: string + hostname: + description: HTTP hostname for targeted placement. + example: api.example.com + type: string + host: + description: TCP host:port for targeted placement. + example: db.example.com:5432 + type: string + required: [] + workersRoute: + properties: + id: + readOnly: true + $ref: '#/components/schemas/workersIdentifier' + pattern: + description: Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior). + example: example.com/* + type: string + x-auditable: true + script: + description: Name of the script to run if the route matches. + example: my-workers-script + type: string + x-auditable: true + required: + - id + - pattern + type: object + workersSchedule: + properties: + created_on: + readOnly: true + type: string + x-auditable: true + cron: + example: '*/30 * * * *' + type: string + x-auditable: true + modified_on: + readOnly: true + type: string + x-auditable: true + required: + - cron + type: object + workersSchemasSubdomain: + properties: + subdomain: + example: my-subdomain + type: string + x-auditable: true + required: + - subdomain + type: object + workersScriptAndVersionSettingsItem: + properties: + annotations: + description: Annotations for the Worker version. Annotations are not inherited across settings updates; omitting this field means the new version will have no annotations. + properties: + workers/message: + description: Human-readable message about the version. Truncated to 1000 bytes if longer. + example: Fixed bug. + maxLength: 1000 + type: string + workers/tag: + description: User-provided identifier for the version. Maximum 100 bytes. + example: v1.0.1 + maxLength: 100 + type: string + workers/triggered_by: + description: Operation that triggered the creation of the version. This is read-only and set by the server. + example: upload + readOnly: true + type: string + type: object + bindings: + description: 'List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.' + example: + - name: MY_ENV_VAR + text: my_data + type: plain_text + items: + $ref: '#/components/schemas/workersBindingItem' + type: array + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + default: '' + type: string + x-auditable: true + compatibility_flags: + default: [] + description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`. + example: + - nodejs_compat + items: + $ref: '#/components/schemas/workersCompatibilityFlag' + type: string + x-auditable: true + type: array + x-stainless-collection-type: set + limits: + $ref: '#/components/schemas/workersLimits' + logpush: + $ref: '#/components/schemas/workersLogpush' + migrations: + description: Migrations to apply for Durable Objects associated with this Worker. + writeOnly: true + type: object + properties: + new_tag: + description: Tag to set as the latest migration tag. + example: v2 + type: string + writeOnly: true + x-auditable: true + old_tag: + description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected. + example: v1 + type: string + writeOnly: true + x-auditable: true + deleted_classes: + description: A list of classes to delete Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_classes: + description: A list of classes to create Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_sqlite_classes: + description: A list of classes to create Durable Object namespaces with SQLite from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + renamed_classes: + description: A list of classes with Durable Object namespaces that were renamed. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + transferred_classes: + description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + from_script: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + steps: + description: Migrations to apply in order. + items: + $ref: '#/components/schemas/workersMigrationStep' + type: array + writeOnly: true + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfoNoStatus' + type: object + tags: + description: Tags associated with the Worker. + example: + - my-team + - my-public-api + items: + $ref: '#/components/schemas/workersTag' + type: string + x-auditable: true + maxItems: 10 + nullable: true + type: array + x-auditable: true + x-stainless-collection-type: set + tail_consumers: + description: List of Workers that will consume logs from the attached Worker. + items: + $ref: '#/components/schemas/workersTailConsumersScript' + nullable: true + type: array + x-stainless-collection-type: set + usage_model: + $ref: '#/components/schemas/workersUsageModel' + type: object + workersScriptAndVersionSettingsResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersScriptAndVersionSettingsItem' + required: + - success + - errors + - messages + - result + type: object + workersScriptName: + description: Name of the script, used in URLs and route configuration. + example: this-is_my_script-01 + type: string + x-auditable: true + workersScriptResponse: + properties: + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + etag: + $ref: '#/components/schemas/workersEtag' + handlers: + description: The names of handlers exported as part of the default export. + example: + - fetch + - scheduled + items: + type: string + type: array + has_assets: + $ref: '#/components/schemas/workersHasAssets' + has_modules: + $ref: '#/components/schemas/workersHasModules' + id: + description: The name used to identify the script. + example: my-workers-script + readOnly: true + type: string + x-auditable: true + last_deployed_from: + description: The client most recently used to deploy this Worker. + example: wrangler + type: string + logpush: + $ref: '#/components/schemas/workersLogpush' + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + example: v1 + type: string + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + items: + properties: + handlers: + description: The names of handlers exported as part of the named export. + example: + - class + items: + type: string + type: array + name: + description: The name of the export. + example: MyDurableObject + type: string + type: object + type: array + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfo' + placement_mode: + $ref: '#/components/schemas/workersPlacementMode' + deprecated: true + type: string + placement_status: + $ref: '#/components/schemas/workersPlacementStatus' + deprecated: true + type: string + tag: + description: The immutable ID of the script. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + readOnly: true + type: string + tags: + $ref: '#/components/schemas/workersTags' + tail_consumers: + $ref: '#/components/schemas/workersTailConsumers' + usage_model: + $ref: '#/components/schemas/workersUsageModel' + type: object + workersScriptResponseCollection: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/workersScriptResponseCollection_result_item' + type: array + required: + - success + - errors + - messages + - result + type: object + workersScriptResponseCollection_result_item: + properties: + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + etag: + $ref: '#/components/schemas/workersEtag' + handlers: + description: The names of handlers exported as part of the default export. + example: + - fetch + - scheduled + items: + type: string + type: array + has_assets: + $ref: '#/components/schemas/workersHasAssets' + has_modules: + $ref: '#/components/schemas/workersHasModules' + id: + description: The name used to identify the script. + example: my-workers-script + readOnly: true + type: string + x-auditable: true + last_deployed_from: + description: The client most recently used to deploy this Worker. + example: wrangler + type: string + logpush: + $ref: '#/components/schemas/workersLogpush' + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + example: v1 + type: string + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + items: + properties: + handlers: + description: The names of handlers exported as part of the named export. + example: + - class + items: + type: string + type: array + name: + description: The name of the export. + example: MyDurableObject + type: string + type: object + type: array + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfo' + placement_mode: + type: string + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + enum: + - smart + - targeted + placement_status: + type: string + description: Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - SUCCESS + - UNSUPPORTED_APPLICATION + - INSUFFICIENT_INVOCATIONS + tag: + description: The immutable ID of the script. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + readOnly: true + type: string + tags: + $ref: '#/components/schemas/workersTags' + tail_consumers: + $ref: '#/components/schemas/workersTailConsumers' + usage_model: + $ref: '#/components/schemas/workersUsageModel' + routes: + description: Routes associated with the Worker. + items: + $ref: '#/components/schemas/workersRoute' + nullable: true + type: array + type: object + workersScriptResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersScriptResponse' + required: + - success + - errors + - messages + - result + workersScriptResponseUpload: + properties: + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + etag: + $ref: '#/components/schemas/workersEtag' + handlers: + description: The names of handlers exported as part of the default export. + example: + - fetch + - scheduled + items: + type: string + type: array + has_assets: + $ref: '#/components/schemas/workersHasAssets' + has_modules: + $ref: '#/components/schemas/workersHasModules' + id: + description: The name used to identify the script. + example: my-workers-script + readOnly: true + type: string + x-auditable: true + last_deployed_from: + description: The client most recently used to deploy this Worker. + example: wrangler + type: string + logpush: + $ref: '#/components/schemas/workersLogpush' + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + example: v1 + type: string + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + items: + properties: + handlers: + description: The names of handlers exported as part of the named export. + example: + - class + items: + type: string + type: array + name: + description: The name of the export. + example: MyDurableObject + type: string + type: object + type: array + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfo' + placement_mode: + type: string + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + enum: + - smart + - targeted + placement_status: + type: string + description: Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - SUCCESS + - UNSUPPORTED_APPLICATION + - INSUFFICIENT_INVOCATIONS + tag: + description: The immutable ID of the script. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + readOnly: true + type: string + tags: + $ref: '#/components/schemas/workersTags' + tail_consumers: + $ref: '#/components/schemas/workersTailConsumers' + usage_model: + $ref: '#/components/schemas/workersUsageModel' + entry_point: + description: The entry point for the script. + example: index.js + readOnly: true + type: string + startup_time_ms: + example: 10 + readOnly: true + type: integer + x-auditable: true + type: object + required: + - startup_time_ms + workersScriptResponseUploadSingle: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersScriptResponseUpload' + required: + - success + - errors + - messages + - result + type: object + workersScriptSettingsItem: + properties: + logpush: + $ref: '#/components/schemas/workersLogpush' + observability: + $ref: '#/components/schemas/workersObservability' + nullable: true + type: object + x-auditable: true + tags: + description: Tags associated with the Worker. + example: + - my-team + - my-public-api + items: + $ref: '#/components/schemas/workersTag' + maxItems: 10 + nullable: true + type: array + x-auditable: true + x-stainless-collection-type: set + tail_consumers: + description: List of Workers that will consume logs from the attached Worker. + items: + $ref: '#/components/schemas/workersTailConsumersScript' + nullable: true + type: array + x-stainless-collection-type: set + type: object + workersScriptSettingsResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersScriptSettingsItem' + required: + - success + - errors + - messages + - result + type: object + workersSecret: + description: A secret value accessible through a binding. + type: object + properties: + name: + $ref: '#/components/schemas/workersBindingName' + text: + description: The secret value to use. + example: My secret. + type: string + writeOnly: true + x-sensitive: true + type: + description: The kind of resource that the binding provides. + enum: + - secret_text + type: string + x-auditable: true + algorithm: + description: Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm). + type: object + x-auditable: true + format: + description: Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format). + enum: + - raw + - pkcs8 + - spki + - jwk + example: raw + type: string + x-auditable: true + key_base64: + description: Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki". + type: string + writeOnly: true + x-sensitive: true + key_jwk: + description: Key data in [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key) format. Required if `format` is "jwk". + type: object + writeOnly: true + x-sensitive: true + usages: + description: Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages). + example: + - encrypt + - decrypt + items: + enum: + - encrypt + - decrypt + - sign + - verify + - deriveKey + - deriveBits + - wrapKey + - unwrapKey + type: string + type: array + x-auditable: true + x-stainless-collection-type: set + required: + - name + - type + workersSecretName: + description: A JavaScript variable name for the secret binding. + example: mySecret + readOnly: true + type: string + x-auditable: true + workersSecretNameUrlEncoded: + description: Flag that indicates whether the secret name is URL encoded. + example: true + readOnly: true + type: boolean + x-auditable: true + workersSubdomain: + properties: + enabled: + default: false + description: Whether the Worker is available on the workers.dev subdomain. + example: false + type: boolean + x-auditable: true + previews_enabled: + description: Whether the Worker's Preview URLs are available on the workers.dev subdomain. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + required: + - enabled + - previews_enabled + type: object + workersTag: + example: my-tag + maxLength: 1024 + type: string + workersTags: + description: Tags associated with the Worker. + example: + - my-team + - my-public-api + items: + $ref: '#/components/schemas/workersTag' + maxItems: 10 + nullable: true + type: array + x-auditable: true + x-stainless-collection-type: set + workersTail: + properties: + expires_at: + readOnly: true + type: string + x-auditable: true + id: + readOnly: true + $ref: '#/components/schemas/workersIdentifier' + url: + readOnly: true + type: string + x-auditable: true + required: + - id + - url + - expires_at + type: object + workersTailConsumers: + description: List of Workers that will consume logs from the attached Worker. + items: + $ref: '#/components/schemas/workersTailConsumersScript' + nullable: true + type: array + x-stainless-collection-type: set + workersTailConsumersScript: + description: A reference to a script that will consume logs from the attached Worker. + properties: + environment: + description: Optional environment if the Worker utilizes one. + example: production + type: string + x-auditable: true + namespace: + description: Optional dispatch namespace the script belongs to. + example: my-namespace + type: string + x-auditable: true + service: + description: Name of Worker that is to be the consumer. + example: my-log-consumer + type: string + x-auditable: true + required: + - service + type: object + workersUploadAssetsResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + maxProperties: 0 + type: object + required: + - success + - errors + - messages + type: object + workersUsageModel: + default: standard + description: Usage model for the Worker invocations. + enum: + - standard + - bundled + - unbound + example: standard + type: string + x-auditable: true + workersUsageModelResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + usage_model: + $ref: '#/components/schemas/workersUsageModel' + user_limits: + $ref: '#/components/schemas/workersUserLimits' + type: object + required: + - success + - errors + - messages + - result + type: object + workersUserLimits: + description: User-defined resource limits for Workers with standard usage model. + nullable: true + properties: + cpu_ms: + description: The amount of CPU time this Worker can use in milliseconds. + example: 50 + nullable: true + type: integer + type: object + workersUuid: + description: API Resource UUID tag. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + workersVersion: + properties: + annotations: + description: Metadata about the version. + properties: + workers/message: + description: Human-readable message about the version. Truncated to 1000 bytes if longer. + example: Fixed bug. + maxLength: 1000 + type: string + x-auditable: true + workers/tag: + description: User-provided identifier for the version. Maximum 100 bytes. + example: v1.0.1 + maxLength: 100 + type: string + x-auditable: true + workers/triggered_by: + description: Operation that triggered the creation of the version. + example: upload + readOnly: true + type: string + x-auditable: true + type: object + assets: + description: Configuration for assets within a Worker. [`_headers`](https://developers.cloudflare.com/workers/static-assets/headers/#custom-headers) and [`_redirects`](https://developers.cloudflare.com/workers/static-assets/redirects/) files should be included as modules named `_headers` and `_redirects` with content type `text/plain`. + properties: + config: + description: Configuration for assets within a Worker. + properties: + html_handling: + default: auto-trailing-slash + description: Determines the redirects and rewrites of requests for HTML content. + enum: + - auto-trailing-slash + - force-trailing-slash + - drop-trailing-slash + - none + example: auto-trailing-slash + type: string + x-auditable: true + not_found_handling: + default: none + description: Determines the response when a request does not match a static asset, and there is no Worker script. + enum: + - none + - 404-page + - single-page-application + example: 404-page + type: string + x-auditable: true + run_worker_first: + default: false + type: array + description: Contains a list path rules to control routing to either the Worker or assets. Glob (*) and negative (!) rules are supported. Rules must start with either '/' or '!/'. At least one non-negative rule must be provided, and negative rules have higher precedence than non-negative rules. + items: + type: string + example: true + type: object + jwt: + description: Token provided upon successful upload of all files from a registered manifest. + type: string + x-sensitive: true + type: object + bindings: + $ref: '#/components/schemas/workersBindings' + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + containers: + $ref: '#/components/schemas/workersContainers' + created_on: + description: When the version was created. + format: date-time + readOnly: true + type: string + x-auditable: true + id: + description: Version identifier. + format: uuid + readOnly: true + type: string + x-auditable: true + limits: + description: Resource limits enforced at runtime. + properties: + cpu_ms: + description: CPU time limit in milliseconds. + example: 50 + type: integer + subrequests: + description: Subrequest limit per request. + example: 1000 + type: integer + type: object + x-stainless-terraform-configurability: computed_optional + main_module: + description: The name of the main module in the `modules` array (e.g. the name of the module that exports a `fetch` handler). + example: index.js + type: string + x-auditable: true + migration_tag: + description: Durable Object migration tag. Set when the version is deployed. Omitted if the version has not been deployed or the Worker does not use Durable Objects. + example: v1 + readOnly: true + type: string + migrations: + description: Migrations for Durable Objects associated with the version. Migrations are applied when the version is deployed. + type: object + properties: + new_tag: + description: Tag to set as the latest migration tag. + example: v2 + type: string + writeOnly: true + x-auditable: true + old_tag: + description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected. + example: v1 + type: string + writeOnly: true + x-auditable: true + deleted_classes: + description: A list of classes to delete Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_classes: + description: A list of classes to create Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_sqlite_classes: + description: A list of classes to create Durable Object namespaces with SQLite from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + renamed_classes: + description: A list of classes with Durable Object namespaces that were renamed. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + transferred_classes: + description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + from_script: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + steps: + description: Migrations to apply in order. + items: + $ref: '#/components/schemas/workersMigrationStep' + type: array + writeOnly: true + modules: + description: Code, sourcemaps, and other content used at runtime. This includes [`_headers`](https://developers.cloudflare.com/workers/static-assets/headers/#custom-headers) and [`_redirects`](https://developers.cloudflare.com/workers/static-assets/redirects/) files used to configure [Static Assets](https://developers.cloudflare.com/workers/static-assets/). `_headers` and `_redirects` files should be included as modules named `_headers` and `_redirects` with content type `text/plain`. + items: + properties: + content_base64: + description: The base64-encoded module content. + example: ZXhwb3J0IGRlZmF1bHQgewogIGFzeW5jIGZldGNoKHJlcXVlc3QsIGVudiwgY3R4KSB7CiAgICByZXR1cm4gbmV3IFJlc3BvbnNlKCdIZWxsbyBXb3JsZCEnKQogIH0KfQ== + format: byte + type: string + content_type: + description: The content type of the module. + example: application/javascript+module + type: string + name: + description: The name of the module. + example: index.js + type: string + required: + - name + - content_type + - content_base64 + type: object + type: array + x-stainless-collection-type: set + number: + description: The integer version number, starting from one. + readOnly: true + type: integer + x-auditable: true + placement: + $ref: '#/components/schemas/workersPlacementInfoNoStatus' + source: + description: The client used to create the version. + example: wrangler + readOnly: true + type: string + x-auditable: true + startup_time_ms: + description: Time in milliseconds spent on [Worker startup](https://developers.cloudflare.com/workers/platform/limits/#worker-startup-time). + example: 10 + readOnly: true + type: integer + x-auditable: true + urls: + description: All routable URLs that always point to this version. Does not include alias URLs, since aliases can be updated to point to a different version. + example: + - https://9387e76d-my-worker.my-subdomain.workers.dev + items: + format: uri + type: string + readOnly: true + type: array + usage_model: + default: standard + deprecated: true + description: Usage model for the version. + enum: + - standard + - bundled + - unbound + example: standard + type: string + x-auditable: true + required: + - id + - number + - urls + - created_on + type: object + workersVersionIdentifier: + example: bcf48806-b317-4351-9ee7-36e7d557d4de + maxLength: 36 + readOnly: true + type: string + workersVersionItemFull: + properties: + id: + description: Unique identifier for the version. + example: 18f97339-c287-4872-9bdd-e2135c07ec12 + readOnly: true + type: string + x-auditable: true + metadata: + example: + author_email: user@example.com + author_id: 408cbcdfd4dda4617efef40b04d168a1 + created_on: '2022-11-08T17:19:29.176266Z' + modified_on: '2022-11-08T17:19:29.176266Z' + source: api + properties: + author_email: + description: Email of the user who created the version. + example: user@example.com + readOnly: true + type: string + x-auditable: true + author_id: + description: Identifier of the user who created the version. + example: 408cbcdfd4dda4617efef40b04d168a1 + readOnly: true + type: string + x-auditable: true + created_on: + description: When the version was created. + example: '2022-11-08T17:19:29.176266Z' + readOnly: true + type: string + x-auditable: true + hasPreview: + description: Whether the version can be previewed. + readOnly: true + type: boolean + modified_on: + description: When the version was last modified. + example: '2022-11-08T17:19:29.176266Z' + readOnly: true + type: string + x-auditable: true + source: + description: The source of the version upload. + enum: + - unknown + - api + - wrangler + - terraform + - dash + - dash_template + - integration + - quick_editor + - playground + - workersci + example: api + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + number: + description: Sequential version number. + example: 1 + readOnly: true + type: number + x-auditable: true + resources: + properties: + bindings: + $ref: '#/components/schemas/workersBindings' + readOnly: true + script: + example: + etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794 + handlers: + - fetch + last_deployed_from: api + named_handlers: + - handlers: + - fetch + name: MyClass + properties: + etag: + description: Hashed script content + example: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794 + readOnly: true + type: string + x-auditable: true + handlers: + description: The names of handlers exported as part of the default export. + example: + - fetch + items: + example: fetch + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + last_deployed_from: + description: The client most recently used to deploy this Worker. + example: api + readOnly: true + type: string + x-auditable: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + example: + - handlers: + - fetch + name: MyClass + items: + example: + handlers: + - fetch + name: MyClass + properties: + handlers: + description: The names of handlers exported as part of the named export. + example: + - fetch + items: + example: fetch + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + name: + description: The name of the exported class or entrypoint. + example: MyClass + readOnly: true + type: string + readOnly: true + type: object + readOnly: true + type: array + x-stainless-collection-type: set + readOnly: true + type: object + script_runtime: + description: Runtime configuration for the Worker. + properties: + compatibility_date: + description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker. + example: '2022-11-08' + readOnly: true + type: string + x-auditable: true + compatibility_flags: + description: Flags that enable or disable certain features in the Workers runtime. + items: + example: x + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + limits: + description: Resource limits for the Worker. + example: + cpu_ms: 50 + properties: + cpu_ms: + description: The amount of CPU time this Worker can use in milliseconds. + example: 50 + readOnly: true + type: integer + readOnly: true + type: object + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + example: v1 + readOnly: true + type: string + x-auditable: true + usage_model: + description: Usage model for the Worker invocations. + enum: + - bundled + - unbound + - standard + example: standard + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + readOnly: true + type: object + type: object + required: + - resources + workersVersionItemShort: + properties: + id: + description: Unique identifier for the version. + example: 18f97339-c287-4872-9bdd-e2135c07ec12 + readOnly: true + type: string + x-auditable: true + metadata: + example: + author_email: user@example.com + author_id: 408cbcdfd4dda4617efef40b04d168a1 + created_on: '2022-11-08T17:19:29.176266Z' + modified_on: '2022-11-08T17:19:29.176266Z' + source: api + properties: + author_email: + description: Email of the user who created the version. + example: user@example.com + readOnly: true + type: string + x-auditable: true + author_id: + description: Identifier of the user who created the version. + example: 408cbcdfd4dda4617efef40b04d168a1 + readOnly: true + type: string + x-auditable: true + created_on: + description: When the version was created. + example: '2022-11-08T17:19:29.176266Z' + readOnly: true + type: string + x-auditable: true + hasPreview: + description: Whether the version can be previewed. + readOnly: true + type: boolean + modified_on: + description: When the version was last modified. + example: '2022-11-08T17:19:29.176266Z' + readOnly: true + type: string + x-auditable: true + source: + description: The source of the version upload. + enum: + - unknown + - api + - wrangler + - terraform + - dash + - dash_template + - integration + - quick_editor + - playground + - workersci + example: api + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + number: + description: Sequential version number. + example: 1 + readOnly: true + type: number + x-auditable: true + type: object + workersVersionItemUploaded: + properties: + id: + description: Unique identifier for the version. + example: 18f97339-c287-4872-9bdd-e2135c07ec12 + readOnly: true + type: string + x-auditable: true + metadata: + example: + author_email: user@example.com + author_id: 408cbcdfd4dda4617efef40b04d168a1 + created_on: '2022-11-08T17:19:29.176266Z' + modified_on: '2022-11-08T17:19:29.176266Z' + source: api + properties: + author_email: + description: Email of the user who created the version. + example: user@example.com + readOnly: true + type: string + x-auditable: true + author_id: + description: Identifier of the user who created the version. + example: 408cbcdfd4dda4617efef40b04d168a1 + readOnly: true + type: string + x-auditable: true + created_on: + description: When the version was created. + example: '2022-11-08T17:19:29.176266Z' + readOnly: true + type: string + x-auditable: true + hasPreview: + description: Whether the version can be previewed. + readOnly: true + type: boolean + modified_on: + description: When the version was last modified. + example: '2022-11-08T17:19:29.176266Z' + readOnly: true + type: string + x-auditable: true + source: + description: The source of the version upload. + enum: + - unknown + - api + - wrangler + - terraform + - dash + - dash_template + - integration + - quick_editor + - playground + - workersci + example: api + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + number: + description: Sequential version number. + example: 1 + readOnly: true + type: number + x-auditable: true + resources: + properties: + bindings: + type: array + description: 'List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.' + example: + - name: MY_ENV_VAR + text: my_data + type: plain_text + items: + $ref: '#/components/schemas/workersBindingItem' + script: + example: + etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794 + handlers: + - fetch + last_deployed_from: api + named_handlers: + - handlers: + - fetch + name: MyClass + properties: + etag: + description: Hashed script content + example: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794 + readOnly: true + type: string + x-auditable: true + handlers: + description: The names of handlers exported as part of the default export. + example: + - fetch + items: + example: fetch + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + last_deployed_from: + description: The client most recently used to deploy this Worker. + example: api + readOnly: true + type: string + x-auditable: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + example: + - handlers: + - fetch + name: MyClass + items: + example: + handlers: + - fetch + name: MyClass + properties: + handlers: + description: The names of handlers exported as part of the named export. + example: + - fetch + items: + example: fetch + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + name: + description: The name of the exported class or entrypoint. + example: MyClass + readOnly: true + type: string + readOnly: true + type: object + readOnly: true + type: array + x-stainless-collection-type: set + readOnly: true + type: object + script_runtime: + description: Runtime configuration for the Worker. + properties: + compatibility_date: + description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker. + example: '2022-11-08' + readOnly: true + type: string + x-auditable: true + compatibility_flags: + description: Flags that enable or disable certain features in the Workers runtime. + items: + example: x + readOnly: true + type: string + readOnly: true + type: array + x-stainless-collection-type: set + limits: + description: Resource limits for the Worker. + example: + cpu_ms: 50 + properties: + cpu_ms: + description: The amount of CPU time this Worker can use in milliseconds. + example: 50 + readOnly: true + type: integer + readOnly: true + type: object + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + example: v1 + readOnly: true + type: string + x-auditable: true + usage_model: + description: Usage model for the Worker invocations. + enum: + - bundled + - unbound + - standard + example: standard + readOnly: true + type: string + x-auditable: true + readOnly: true + type: object + readOnly: true + type: object + startup_time_ms: + description: Time in milliseconds spent on [Worker startup](https://developers.cloudflare.com/workers/platform/limits/#worker-startup-time). + example: 10 + type: integer + type: object + required: + - resources + - resources + workersVersionsListResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + items: + items: + $ref: '#/components/schemas/workersVersionItemShort' + type: array + type: object + required: + - success + - errors + - messages + - result + type: object + workersVersionsSingleResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersVersionItemFull' + required: + - success + - errors + - messages + - result + type: object + workersVersionsUploadResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersVersionItemUploaded' + required: + - success + - errors + - messages + - result + type: object + workersWorker: + properties: + created_on: + description: When the Worker was created. + format: date-time + readOnly: true + type: string + x-auditable: true + deployed_on: + description: When the Worker's most recent deployment was created. `null` if the Worker has never been deployed. + format: date-time + nullable: true + readOnly: true + type: string + id: + description: Immutable ID of the Worker. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + readOnly: true + type: string + x-auditable: true + logpush: + default: false + description: Whether logpush is enabled for the Worker. + type: boolean + x-auditable: true + name: + description: Name of the Worker. + example: my-worker + type: string + x-auditable: true + observability: + description: Observability settings for the Worker. + properties: + enabled: + default: false + description: Whether observability is enabled for the Worker. + type: boolean + x-auditable: true + head_sampling_rate: + default: 1 + description: The sampling rate for observability. From 0 to 1 (1 = 100%, 0.1 = 10%). + example: 1 + type: number + x-auditable: true + logs: + description: Log settings for the Worker. + properties: + destinations: + default: [] + description: A list of destinations where logs will be exported to. + items: + type: string + type: array + x-auditable: true + enabled: + default: false + description: Whether logs are enabled for the Worker. + type: boolean + x-auditable: true + head_sampling_rate: + default: 1 + description: The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). + example: 1 + type: number + x-auditable: true + invocation_logs: + default: true + description: Whether [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs) are enabled for the Worker. + type: boolean + x-auditable: true + persist: + default: true + description: Whether log persistence is enabled for the Worker. + type: boolean + x-auditable: true + type: object + traces: + description: Trace settings for the Worker. + properties: + destinations: + default: [] + description: A list of destinations where traces will be exported to. + items: + type: string + type: array + x-auditable: true + enabled: + default: false + description: Whether traces are enabled for the Worker. + type: boolean + x-auditable: true + head_sampling_rate: + default: 1 + description: The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). + example: 1 + type: number + x-auditable: true + persist: + default: true + description: Whether trace persistence is enabled for the Worker. + type: boolean + x-auditable: true + type: object + type: object + references: + description: Other resources that reference the Worker and depend on it existing. + properties: + dispatch_namespace_outbounds: + description: Other Workers that reference the Worker as an outbound for a dispatch namespace. + items: + properties: + namespace_id: + description: ID of the dispatch namespace. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + namespace_name: + description: Name of the dispatch namespace. + example: my-dispatch-namespace + type: string + worker_id: + description: ID of the Worker using the dispatch namespace. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + worker_name: + description: Name of the Worker using the dispatch namespace. + example: my-worker + type: string + required: + - worker_id + - worker_name + - namespace_id + - namespace_name + type: object + type: array + domains: + description: Custom domains connected to the Worker. + items: + properties: + certificate_id: + description: ID of the TLS certificate issued for the custom domain. + type: string + hostname: + description: Full hostname of the custom domain, including the zone name. + example: my-worker.example.com + type: string + id: + description: ID of the custom domain. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + zone_id: + description: ID of the zone. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + zone_name: + description: Name of the zone. + example: example.com + type: string + required: + - id + - hostname + - zone_id + - zone_name + - certificate_id + type: object + type: array + durable_objects: + description: Other Workers that reference Durable Object classes implemented by the Worker. + items: + properties: + namespace_id: + description: ID of the Durable Object namespace being used. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + namespace_name: + description: Name of the Durable Object namespace being used. + example: my-durable-object-namespace + type: string + worker_id: + description: ID of the Worker using the Durable Object implementation. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + worker_name: + description: Name of the Worker using the Durable Object implementation. + example: my-worker + type: string + required: + - worker_id + - worker_name + - namespace_id + - namespace_name + type: object + type: array + queues: + description: Queues that send messages to the Worker. + items: + properties: + queue_consumer_id: + description: ID of the queue consumer configuration. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + queue_id: + description: ID of the queue. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + queue_name: + description: Name of the queue. + example: my-queue + type: string + required: + - queue_id + - queue_name + - queue_consumer_id + type: object + type: array + workers: + description: Other Workers that reference the Worker using [service bindings](https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/). + items: + properties: + id: + description: ID of the referencing Worker. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + type: string + name: + description: Name of the referencing Worker. + example: my-worker + type: string + required: + - id + - name + type: object + type: array + readOnly: true + required: + - workers + - domains + - dispatch_namespace_outbounds + - durable_objects + - queues + type: object + subdomain: + description: Subdomain settings for the Worker. + properties: + enabled: + default: false + description: Whether the *.workers.dev subdomain is enabled for the Worker. + type: boolean + x-auditable: true + previews_enabled: + description: Whether [preview URLs](https://developers.cloudflare.com/workers/configuration/previews/) are enabled for the Worker. + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + tags: + default: [] + description: Tags associated with the Worker. + example: + - my-team + - my-public-api + items: + maxLength: 1024 + type: string + maxItems: 8 + type: array + x-stainless-collection-type: set + tail_consumers: + default: [] + description: Other Workers that should consume logs from the Worker. + items: + properties: + name: + description: Name of the consumer Worker. + example: my-tail-consumer + type: string + x-auditable: true + required: + - name + type: object + type: array + x-stainless-collection-type: set + updated_on: + description: When the Worker was most recently updated. + format: date-time + readOnly: true + type: string + x-auditable: true + required: + - id + - name + - tags + - subdomain + - observability + - logpush + - tail_consumers + - created_on + - updated_on + - references + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + limits: + id: cloudflare.workers.limits + name: limits + title: Limits + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1account~1limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/limits/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + builds_builds: + id: cloudflare.workers.builds_builds + name: builds_builds + title: Builds Builds + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/builds_builds/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + latest: + id: cloudflare.workers.latest + name: latest + title: Latest + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds~1latest/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/latest/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + builds: + id: cloudflare.workers.builds + name: builds + title: Builds + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds~1{build_uuid}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + cancel: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds~1{build_uuid}~1cancel/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_manual_build: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers~1{trigger_uuid}~1builds/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/builds/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/builds/methods/create_manual_build' + update: [] + delete: [] + replace: [] + logs: + id: cloudflare.workers.logs + name: logs + title: Logs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1builds~1{build_uuid}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + connections: + id: cloudflare.workers.connections + name: connections + title: Connections + methods: + upsert_repo_connection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1repos~1connections/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_repo_connection: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1repos~1connections~1{repo_connection_uuid}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_repo_connection' + replace: + - $ref: '#/components/x-stackQL-resources/connections/methods/upsert_repo_connection' + config_autofill: + id: cloudflare.workers.config_autofill + name: config_autofill + title: Config Autofill + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1repos~1{provider_type}~1{provider_account_id}~1{repo_id}~1config_autofill/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/config_autofill/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tokens: + id: cloudflare.workers.tokens + name: tokens + title: Tokens + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1tokens/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_build_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1tokens/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_build_token: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1tokens~1{build_token_uuid}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tokens/methods/create_build_token' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tokens/methods/delete_build_token' + replace: [] + triggers: + id: cloudflare.workers.triggers + name: triggers + title: Triggers + methods: + create_trigger: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_trigger: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers~1{trigger_uuid}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update_trigger: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers~1{trigger_uuid}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + purge_build_cache: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers~1{trigger_uuid}~1purge_build_cache/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{external_script_id}~1triggers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/triggers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/triggers/methods/create_trigger' + update: + - $ref: '#/components/x-stackQL-resources/triggers/methods/update_trigger' + delete: + - $ref: '#/components/x-stackQL-resources/triggers/methods/delete_trigger' + replace: [] + environment_variables: + id: cloudflare.workers.environment_variables + name: environment_variables + title: Environment Variables + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers~1{trigger_uuid}~1environment_variables/get' + response: + mediaType: application/json + openAPIDocKey: '200' + upsert_environment_variables: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers~1{trigger_uuid}~1environment_variables/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_environment_variable: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1triggers~1{trigger_uuid}~1environment_variables~1{environment_variable_key}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/environment_variables/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/environment_variables/methods/upsert_environment_variables' + delete: + - $ref: '#/components/x-stackQL-resources/environment_variables/methods/delete_environment_variable' + replace: [] + workers_builds: + id: cloudflare.workers.workers_builds + name: workers_builds + title: Workers Builds + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{external_script_id}~1builds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workers_builds/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + deploy_hooks: + id: cloudflare.workers.deploy_hooks + name: deploy_hooks + title: Deploy Hooks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{script_name}~1deploy_hooks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_deploy_hook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{script_name}~1deploy_hooks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_deploy_hook: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{script_name}~1deploy_hooks~1{deploy_hook_uuid}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{script_name}~1deploy_hooks~1{deploy_hook_uuid}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_deploy_hook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1builds~1workers~1{script_name}~1deploy_hooks~1{deploy_hook_uuid}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + trigger_deploy_hook: + operation: + $ref: '#/paths/~1workers~1builds~1deploy_hooks~1{deploy_hook_uuid}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/deploy_hooks/methods/get' + - $ref: '#/components/x-stackQL-resources/deploy_hooks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/deploy_hooks/methods/create_deploy_hook' + - $ref: '#/components/x-stackQL-resources/deploy_hooks/methods/trigger_deploy_hook' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/deploy_hooks/methods/delete_deploy_hook' + replace: + - $ref: '#/components/x-stackQL-resources/deploy_hooks/methods/update_deploy_hook' + containers: + id: cloudflare.workers.containers + name: containers + title: Containers + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1containers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_credentials: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1containers~1registries~1{domain}~1credentials/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/containers/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + account_settings: + id: cloudflare.workers.account_settings + name: account_settings + title: Account Settings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1account-settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1account-settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/account_settings/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/account_settings/methods/update' + workers: + id: cloudflare.workers.workers + name: workers + title: Workers + methods: + upload: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1assets~1upload/post' + response: + mediaType: application/json + openAPIDocKey: '201' + create_keys: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1telemetry~1keys/post' + response: + mediaType: application/json + openAPIDocKey: '200' + query: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1telemetry~1query/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_values: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1telemetry~1values/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_versions: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}~1versions~1{version_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workers/methods/get' + - $ref: '#/components/x-stackQL-resources/workers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/workers/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/workers/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/workers/methods/update' + scripts: + id: cloudflare.workers.scripts + name: scripts + title: Scripts + methods: + namespace_worker_delete_scripts: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}/get' + response: + mediaType: application/javascript + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_assets_upload_session: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1assets-upload-session/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scripts/methods/list' + - $ref: '#/components/x-stackQL-resources/scripts/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/scripts/methods/namespace_worker_delete_scripts' + - $ref: '#/components/x-stackQL-resources/scripts/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/scripts/methods/update' + domains: + id: cloudflare.workers.domains + name: domains + title: Domains + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1domains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1domains/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1domains~1{domain_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1domains~1{domain_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/domains/methods/update' + destinations: + id: cloudflare.workers.destinations + name: destinations + title: Destinations + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1destinations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1destinations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1destinations~1{slug}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1destinations~1{slug}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/destinations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/destinations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/destinations/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/destinations/methods/delete' + replace: [] + queries: + id: cloudflare.workers.queries + name: queries + title: Queries + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1queries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + queries_post: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1queries/post' + response: + mediaType: application/json + openAPIDocKey: '200' + queries_delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1queries~1{query_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1queries~1{query_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + queries_patch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1observability~1queries~1{query_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries/methods/get' + - $ref: '#/components/x-stackQL-resources/queries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/queries/methods/queries_post' + update: + - $ref: '#/components/x-stackQL-resources/queries/methods/queries_patch' + delete: + - $ref: '#/components/x-stackQL-resources/queries/methods/queries_delete' + replace: [] + regions: + id: cloudflare.workers.regions + name: regions + title: Regions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1placement~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.providers + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/regions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + workers_scripts: + id: cloudflare.workers.workers_scripts + name: workers_scripts + title: Workers Scripts + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workers_scripts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + workers_scripts_search: + id: cloudflare.workers.workers_scripts_search + name: workers_scripts_search + title: Workers Scripts Search + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts-search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workers_scripts_search/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + content: + id: cloudflare.workers.content + name: content + title: Content + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1content/put' + response: + mediaType: application/json + openAPIDocKey: '200' + worker_environment_put_script_content: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1services~1{service_name}~1environments~1{environment_name}~1content/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/content/methods/worker_environment_put_script_content' + - $ref: '#/components/x-stackQL-resources/content/methods/update' + v2s: + id: cloudflare.workers.v2s + name: v2s + title: V2s + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1content~1v2/get' + response: + mediaType: string + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/v2s/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + deployments: + id: cloudflare.workers.deployments + name: deployments + title: Deployments + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1deployments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.deployments + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1deployments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1deployments~1{deployment_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1deployments~1{deployment_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/deployments/methods/get' + - $ref: '#/components/x-stackQL-resources/deployments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' + replace: [] + schedules: + id: cloudflare.workers.schedules + name: schedules + title: Schedules + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1schedules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.schedules + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1schedules/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schedules/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/schedules/methods/update' + scripts_script_settings: + id: cloudflare.workers.scripts_script_settings + name: scripts_script_settings + title: Scripts Script Settings + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1script-settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scripts_script_settings/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + settings: + id: cloudflare.workers.settings + name: settings + title: Settings + methods: + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1script-settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + worker_script_environment_patch_settings: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1services~1{service_name}~1environments~1{environment_name}~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/worker_script_environment_patch_settings' + - $ref: '#/components/x-stackQL-resources/settings/methods/edit' + delete: [] + replace: [] + secrets: + id: cloudflare.workers.secrets + name: secrets + title: Secrets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1secrets/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1secrets~1{secret_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1secrets~1{secret_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secrets/methods/get' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/secrets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/secrets/methods/update' + script_and_version_settings: + id: cloudflare.workers.script_and_version_settings + name: script_and_version_settings + title: Script And Version Settings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/script_and_version_settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/script_and_version_settings/methods/edit' + delete: [] + replace: [] + subdomain: + id: cloudflare.workers.subdomain + name: subdomain + title: Subdomain + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1subdomain/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1subdomain/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1subdomain/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subdomain/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/subdomain/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/subdomain/methods/delete' + replace: [] + tail: + id: cloudflare.workers.tail + name: tail + title: Tail + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1tails/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1tails/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1tails~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tail/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tail/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tail/methods/delete' + replace: [] + usage_model: + id: cloudflare.workers.usage_model + name: usage_model + title: Usage Model + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1usage-model/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + worker_script_update_usage_model: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1usage-model/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/usage_model/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/usage_model/methods/worker_script_update_usage_model' + scripts_versions: + id: cloudflare.workers.scripts_versions + name: scripts_versions + title: Scripts Versions + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.items + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1versions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1scripts~1{script_name}~1versions~1{version_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scripts_versions/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/scripts_versions/methods/list_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/scripts_versions/methods/create_by_account' + update: [] + delete: [] + replace: [] + contents: + id: cloudflare.workers.contents + name: contents + title: Contents + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1services~1{service_name}~1environments~1{environment_name}~1content/get' + response: + mediaType: string + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/contents/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + environments_settings: + id: cloudflare.workers.environments_settings + name: environments_settings + title: Environments Settings + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1services~1{service_name}~1environments~1{environment_name}~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/environments_settings/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + subdomains: + id: cloudflare.workers.subdomains + name: subdomains + title: Subdomains + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1subdomain/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subdomains/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/subdomains/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/subdomains/methods/update' + workers_versions: + id: cloudflare.workers.workers_versions + name: workers_versions + title: Workers Versions + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}~1versions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1workers~1{worker_id}~1versions~1{version_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workers_versions/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/workers_versions/methods/list_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/workers_versions/methods/create_by_account' + update: [] + delete: [] + replace: [] + routes: + id: cloudflare.workers.routes + name: routes + title: Routes + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes~1{route_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes~1{route_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1workers~1routes~1{route_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes/methods/get' + - $ref: '#/components/x-stackQL-resources/routes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/routes/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/workers_for_platforms.yaml b/providers/src/cloudflare/v00.00.00000/services/workers_for_platforms.yaml new file mode 100644 index 00000000..c2eef485 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/workers_for_platforms.yaml @@ -0,0 +1,3315 @@ +openapi: 3.0.3 +info: + title: workers_for_platforms API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/workers/dispatch/namespaces: + get: + description: Fetch a list of Workers for Platforms namespaces. + operationId: namespace-worker-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersNamespaceListResponse' + description: Fetch a list of Workers for Platforms namespaces. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Failure to get list of Workers for Platforms namespaces. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List dispatch namespaces + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + method: list + post: + description: Create a new Workers for Platforms namespace. + operationId: namespace-worker-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + description: The name of the dispatch namespace. + type: string + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersNamespaceSingleResponse' + description: Fetch a list of Workers for Platforms namespaces. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Failure to get list of Workers for Platforms namespaces. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create dispatch namespace + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + method: create + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}: + delete: + description: Delete a Workers for Platforms namespace. + operationId: namespace-worker-delete-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseNullResult' + description: Delete a Workers for Platforms namespace. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Failure to delete Workers for Platforms namespace. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete dispatch namespace + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + method: delete + get: + description: Get a Workers for Platforms namespace. + operationId: namespace-worker-get-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersNamespaceSingleResponse' + description: Get a Workers for Platforms namespace. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Failure to get Workers for Platforms namespace. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get dispatch namespace + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + method: get + patch: + description: Patch a Workers for Platforms namespace. Omitted fields are left unchanged. + operationId: namespace-worker-patch-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + description: The name of the dispatch namespace. + type: string + x-auditable: true + trusted_workers: + $ref: '#/components/schemas/workersTrustedWorkers' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersNamespaceSingleResponse' + description: Patch a Workers for Platforms namespace. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Failure to patch Workers for Platforms namespace. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch dispatch namespace + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + put: + description: Update a Workers for Platforms namespace. + operationId: namespace-worker-put-namespace + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + description: The name of the dispatch namespace. + type: string + x-auditable: true + trusted_workers: + $ref: '#/components/schemas/workersTrustedWorkers' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersNamespaceSingleResponse' + description: Update a Workers for Platforms namespace. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Failure to update Workers for Platforms namespace. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update dispatch namespace + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}: + delete: + description: Delete a worker from a Workers for Platforms namespace. This call has no response body on a successful delete. + operationId: namespace-worker-script-delete-worker + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script. + in: query + name: force + schema: + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseNullResult' + description: Delete Worker response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete Worker response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Worker + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + method: delete + get: + description: Fetch information about a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-script-worker-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersNamespaceScriptResponseSingle' + description: Worker Details Response (Workers for Platforms). + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Worker Details Failure (Workers for Platforms). + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Worker Details + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + method: get + put: + description: 'Upload a worker module to a Workers for Platforms namespace. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.' + operationId: namespace-worker-script-upload-worker-module + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: When set to "strict", the upload will fail if any `inherit` type bindings cannot be resolved against the previous version of the script. Without this, unresolvable inherit bindings are silently dropped. + in: query + name: bindings_inherit + schema: + enum: + - strict + type: string + requestBody: + content: + application/javascript: + schema: + description: Raw javascript content comprising a Worker. Must be in service worker syntax. + type: string + multipart/form-data: + encoding: + files: + contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map + metadata: + contentType: application/json + schema: + $ref: '#/components/schemas/workersMultipartScript' + text/javascript: + schema: + description: Raw javascript content comprising a Worker. Must be in service worker syntax. + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptResponseUploadSingle' + type: object + description: Upload Worker Module response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Upload Worker Module response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload Worker Module + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + method: update + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/assets-upload-session: + post: + description: Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/. + operationId: namespace-worker-script-update-create-assets-upload-session + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersCreateAssetsUploadSessionObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersCreateAssetsUploadSessionResponse' + description: Create Assets Upload Session response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Create Assets Upload Session response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Assets Upload Session + tags: + - Workers for Platforms + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - asset_upload + method: create + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings: + get: + description: Fetch script bindings from a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-get-script-bindings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersBindings' + required: + - success + - errors + - messages + - result + type: object + description: Fetch script bindings (Workers for Platforms). + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script bindings failure (Workers for Platforms). + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Script Bindings + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - bindings + method: get + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content: + get: + description: Fetch script content from a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-get-script-content + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + string: + schema: + type: object + properties: + contents: + type: string + description: Get script content. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get script content failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Script Content + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - content + method: get + put: + description: Put script content for a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-put-script-content + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part. + in: header + name: CF-WORKER-BODY-PART + schema: + type: string + - description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part. + in: header + name: CF-WORKER-MAIN-MODULE-PART + schema: + type: string + requestBody: + content: + multipart/form-data: + encoding: + files: + contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map + metadata: + contentType: application/json + schema: + properties: + files: + description: 'An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.
Possible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.' + items: + format: binary + type: string + type: array + x-stainless-collection-type: set + metadata: + $ref: '#/components/schemas/unnamedSchemaRefEe1e79edcb234d14c4dd266880f2fd24' + required: + - metadata + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersScriptResponseSingle' + description: Put script content (Workers for Platforms). + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Put script content failure (Workers for Platforms). + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Put Script Content + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - content + method: update + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets: + get: + description: List secrets bound to a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-list-script-secrets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/workersSecret' + type: array + required: + - success + - errors + - messages + - result + type: object + description: List script secrets. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: List script secrets failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Script Secrets + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - secrets + method: list + put: + description: Add a secret to a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-put-script-secrets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersSecret' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSecret' + required: + - success + - errors + - messages + - result + type: object + description: Fetch script bindings (Workers for Platforms). + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Too many requests are currently modifying the script. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script bindings failure (Workers for Platforms). + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add script secret + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - secrets + method: update + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets/{secret_name}: + delete: + description: Remove a secret from a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-delete-script-secret + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: secret_name + schema: + $ref: '#/components/schemas/workersSecretName' + required: true + - in: query + name: url_encoded + schema: + $ref: '#/components/schemas/workersSecretNameUrlEncoded' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseNullResult' + description: Delete script secret binding (Workers for Platforms). + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete script secret failure (Workers for Platforms). + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete script secret + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - secrets + method: delete + get: + description: Get a given secret binding (value omitted) on a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-get-script-secrets + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: secret_name + schema: + $ref: '#/components/schemas/workersSecretName' + required: true + - in: query + name: url_encoded + schema: + $ref: '#/components/schemas/workersSecretNameUrlEncoded' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersSecret' + required: + - success + - errors + - messages + - result + type: object + description: Get script secret (Workers for Platforms). + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Get script secret failure (Workers for Platforms). + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get secret binding + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - secrets + method: get + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings: + get: + description: Get script settings from a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-get-script-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersNamespaceScriptAndVersionSettingsItem' + required: + - success + - errors + - messages + type: object + description: Fetch script settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Script Settings + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - settings + method: get + patch: + description: Patch script metadata, such as bindings. + operationId: namespace-worker-patch-script-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + multipart/form-data: + encoding: + settings: + contentType: application/json + schema: + properties: + settings: + $ref: '#/components/schemas/workersNamespaceScriptAndVersionSettingsItem' + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/workersNamespaceScriptAndVersionSettingsItem' + required: + - success + - errors + - messages + type: object + description: Patch script settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Patch script settings failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Script Settings + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - settings + method: edit + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags: + get: + description: Fetch tags from a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-get-script-tags + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/workersTag' + type: array + required: + - success + - errors + - messages + type: object + description: Fetch script tags. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script tags failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Script Tags + tags: + - Workers for Platforms + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - tags + method: update + put: + description: Put script tags for a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-put-script-tags + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/workersTags' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/workersTag' + type: array + required: + - success + - errors + - messages + - result + type: object + description: Fetch script tags. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Fetch script tags failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Put Script Tags + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}: + delete: + description: Delete script tag for a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-delete-script-tag + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: tag + schema: + $ref: '#/components/schemas/workersTag' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseNullResult' + description: Delete script tag. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Delete script tag failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Script Tag + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write + x-stackql-sdk: + service: workers_for_platforms + resource_chain: + - dispatch + - namespaces + - scripts + - tags + method: delete + put: + description: Put a single tag on a script uploaded to a Workers for Platforms namespace. + operationId: namespace-worker-put-script-tag + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dispatch_namespace + in: path + required: true + description: The Workers-for-Platforms dispatch namespace. + schema: + type: string + - name: script_name + in: path + required: true + description: The Worker script name. + schema: + type: string + - in: path + name: tag + schema: + $ref: '#/components/schemas/workersTag' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseNullResult' + description: Put script tag. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/workersApiResponseCommonFailure' + description: Put script tag failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Put Script Tag + tags: + - Workers for Platforms + x-api-token-group: + - Workers Scripts Write +components: + schemas: + unnamedSchemaRefEe1e79edcb234d14c4dd266880f2fd24: + description: JSON-encoded metadata about the uploaded parts and Worker configuration. + properties: + body_part: + description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker. + example: worker.js + type: string + main_module: + description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker. + example: worker.js + type: string + type: object + workersApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/workersMessages' + messages: + example: [] + $ref: '#/components/schemas/workersMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + workersApiResponseNullResult: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + type: object + workersAssets: + description: Configuration for assets within a Worker. + properties: + config: + description: Configuration for assets within a Worker. + properties: + _headers: + description: The contents of a _headers file (used to attach custom headers on asset responses). + example: '/dashboard/* + + X-Frame-Options: DENY + + + /static/* + + Access-Control-Allow-Origin: *' + type: string + _redirects: + description: The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving). + example: '/foo /bar 301 + + /news/* /blog/:splat' + type: string + html_handling: + description: Determines the redirects and rewrites of requests for HTML content. + enum: + - auto-trailing-slash + - force-trailing-slash + - drop-trailing-slash + - none + example: auto-trailing-slash + type: string + not_found_handling: + description: Determines the response when a request does not match a static asset, and there is no Worker script. + enum: + - none + - 404-page + - single-page-application + example: 404-page + type: string + run_worker_first: + type: array + description: Contains a list path rules to control routing to either the Worker or assets. Glob (*) and negative (!) rules are supported. Rules must start with either '/' or '!/'. At least one non-negative rule must be provided, and negative rules have higher precedence than non-negative rules. + items: + type: string + example: true + serve_directly: + deprecated: true + description: When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script. + example: true + type: boolean + type: object + jwt: + description: Token provided upon successful upload of all files from a registered manifest. + type: string + x-sensitive: true + type: object + workersBindingItem: + description: A binding to allow the Worker to communicate with resources. + type: object + properties: + name: + $ref: '#/components/schemas/workersBindingName' + type: + description: The kind of resource that the binding provides. + enum: + - ai + type: string + x-auditable: true + instance_name: + description: The user-chosen instance name. Must exist at deploy time. The worker can search, chat, update, and manage items/jobs on this instance. + example: cloudflare-blog + type: string + x-auditable: true + namespace: + description: The namespace the instance belongs to. Defaults to "default" if omitted. Customers who don't use namespaces can simply omit this field. + example: production + type: string + x-auditable: true + dataset: + description: The name of the dataset to bind to. + example: some_dataset + type: string + x-auditable: true + database_id: + description: Identifier of the D1 database to bind to. + example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + type: string + x-auditable: true + id: + deprecated: true + description: Identifier of the D1 database to bind to. + example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + type: string + x-auditable: true + x-stainless-deprecation-message: This property has been renamed to `database_id`. + part: + description: The name of the file containing the data content. Only accepted for `service worker syntax` Workers. + example: my-module.bin + type: string + x-auditable: true + outbound: + description: Outbound worker. + properties: + params: + description: Pass information from the Dispatch Worker to the Outbound Worker through the parameters. + items: + properties: + name: + description: Name of the parameter. + example: customer_name + type: string + x-auditable: true + required: + - name + type: object + type: array + worker: + description: Outbound worker. + properties: + entrypoint: + description: Entrypoint to invoke on the outbound worker. + type: string + x-auditable: true + environment: + description: Environment of the outbound worker. + type: string + x-auditable: true + service: + description: Name of the outbound worker. + type: string + x-auditable: true + type: object + type: object + class_name: + description: The exported class name of the Durable Object. + example: MyDurableObject + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + dispatch_namespace: + description: The dispatch namespace the Durable Object script belongs to. + example: my-dispatch-namespace + type: string + x-auditable: true + environment: + description: The environment of the script_name to bind to. + example: production + type: string + x-auditable: true + namespace_id: + $ref: '#/components/schemas/workersNamespaceIdentifier' + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + script_name: + description: The script where the Durable Object is defined, if it is external to this Worker. + example: my-other-worker + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + old_name: + description: The old name of the inherited binding. If set, the binding will be renamed from `old_name` to `name` in the new version. If not set, the binding will keep the same name between versions. + example: MY_OLD_BINDING + type: string + x-auditable: true + version_id: + default: latest + description: Identifier for the version to inherit the binding from, which can be the version ID or the literal "latest" to inherit from the latest version. Defaults to inheriting the binding from the latest version. + example: 8969331f-7192-434c-9938-6aea24ed58bf + type: string + x-auditable: true + json: + description: JSON data to use. + type: object + x-stainless-any: true + certificate_id: + description: Identifier of the certificate to bind to. + example: efwu2n6s-q69d-2kr9-184j-4913e8h391k6 + type: string + x-auditable: true + text: + description: The text value to use. + example: Hello, world! + type: string + x-auditable: true + pipeline: + description: Name of the Pipeline to bind to. + example: my-pipeline + type: string + x-auditable: true + queue_name: + description: Name of the Queue to bind to. + example: my-queue + type: string + simple: + description: The rate limit configuration. + properties: + limit: + description: The limit (requests per period). + example: 100 + type: number + x-auditable: true + mitigation_timeout: + description: Duration in seconds to apply the mitigation action after the rate limit is exceeded. Valid values are 0 (disabled), 10, or multiples of 60 up to 86400. Must be greater than or equal to the period when non-zero. + example: 60 + type: integer + x-auditable: true + period: + description: The period in seconds. + example: 60 + type: integer + x-auditable: true + required: + - limit + - period + type: object + bucket_name: + description: R2 bucket to bind to. + example: my-r2-bucket + type: string + x-auditable: true + jurisdiction: + description: The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket. + enum: + - eu + - fedramp + - fedramp-high + example: eu + type: string + x-auditable: true + allowed_destination_addresses: + description: List of allowed destination addresses. + example: + - user1@example.com + - user2@example.com + items: + format: email + type: string + type: array + x-auditable: true + allowed_sender_addresses: + description: List of allowed sender addresses. + example: + - user1@example.com + - user2@example.com + items: + format: email + type: string + type: array + x-auditable: true + destination_address: + description: Destination address for the email. + example: user@example.com + format: email + type: string + x-auditable: true + entrypoint: + description: Entrypoint to invoke on the target Worker. + example: MyHandler + type: string + x-auditable: true + service: + description: Name of Worker to bind to. + example: my-worker + type: string + x-auditable: true + index_name: + description: Name of the Vectorize index to bind to. + example: my-index-name + type: string + x-auditable: true + secret_name: + description: Name of the secret in the store. + example: my_secret + type: string + x-auditable: true + store_id: + description: ID of the store containing the secret. + example: 8c8b1387108e49be85669169793e7bd2 + type: string + x-auditable: true + app_id: + description: ID of the Flagship app to bind to for feature flag evaluation. + example: app-12345678-1234-1234-1234-123456789012 + maxLength: 128 + type: string + x-auditable: true + algorithm: + description: Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm). + type: object + x-auditable: true + format: + description: Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format). + enum: + - raw + - pkcs8 + - spki + - jwk + example: raw + type: string + x-auditable: true + key_base64: + description: Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki". + type: string + writeOnly: true + x-sensitive: true + key_jwk: + description: Key data in [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key) format. Required if `format` is "jwk". + type: object + writeOnly: true + x-sensitive: true + usages: + description: Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages). + example: + - encrypt + - decrypt + items: + enum: + - encrypt + - decrypt + - sign + - verify + - deriveKey + - deriveBits + - wrapKey + - unwrapKey + type: string + type: array + x-auditable: true + x-stainless-collection-type: set + workflow_name: + description: Name of the Workflow to bind to. + example: my-workflow + type: string + service_id: + description: Identifier of the VPC service to bind to. + example: 8c8b1387108e49be85669169793e7bd2 + type: string + x-auditable: true + network_id: + description: Identifier of the network to bind to. Only "cf1:network" is currently supported. Mutually exclusive with tunnel_id. + example: cf1:network + type: string + x-auditable: true + tunnel_id: + description: UUID of the Cloudflare Tunnel to bind to. Mutually exclusive with network_id. + example: abcd1234-5678-90ef-ghij-klmnopqrstuv + type: string + x-auditable: true + required: + - name + - type + workersBindingName: + description: A JavaScript variable name for the binding. + example: myBinding + type: string + x-auditable: true + workersBindings: + description: 'List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.' + example: + - name: MY_ENV_VAR + text: my_data + type: plain_text + items: + $ref: '#/components/schemas/workersBindingItem' + type: array + workersCompatibilityDate: + description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker. + example: '2021-01-01' + type: string + x-auditable: true + workersCompatibilityFlag: + description: Flag that enables or disables a specific feature in the Workers runtime. + example: nodejs_compat + type: string + x-auditable: true + workersCompatibilityFlags: + default: [] + description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`. + example: + - nodejs_compat + items: + $ref: '#/components/schemas/workersCompatibilityFlag' + type: array + x-stainless-collection-type: set + workersCreateAssetsUploadSessionObject: + properties: + manifest: + description: 'A manifest ([path]: {hash, size}) map of files to upload. As an example, `/blog/hello-world.html` would be a valid path key.' + type: object + required: + - manifest + type: object + workersCreateAssetsUploadSessionResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + buckets: + description: The requests to make to upload assets. + items: + description: The set of assets to include in each request while uploading. + items: + description: The file hash to include in this bucket. + type: string + type: array + x-stainless-collection-type: set + type: array + x-stainless-collection-type: set + jwt: + description: A JWT to use as authentication for uploading assets. + type: string + x-sensitive: true + type: object + required: + - success + - errors + - messages + type: object + workersCreatedOn: + description: When the script was created. + example: '2017-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + workersDispatchNamespaceName: + description: Name of the Workers for Platforms dispatch namespace. + example: my-dispatch-namespace + type: string + x-auditable: true + workersEtag: + description: Hashed script content, can be used in a If-None-Match header when updating. + example: ea95132c15732412d22c1476fa83f27a + readOnly: true + type: string + workersHasAssets: + description: Whether a Worker contains assets. + example: false + type: boolean + x-auditable: true + workersHasModules: + description: Whether a Worker contains modules. + example: false + type: boolean + x-auditable: true + workersIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + workersLimits: + description: Limits to apply for this Worker. + properties: + cpu_ms: + description: The amount of CPU time this Worker can use in milliseconds. + example: 50 + type: integer + x-auditable: true + subrequests: + description: The number of subrequests this Worker can make per request. + example: 1000 + type: integer + x-auditable: true + type: object + workersLogpush: + default: false + description: Whether Logpush is turned on for the Worker. + example: false + type: boolean + x-auditable: true + workersMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + workersMigrationStep: + properties: + deleted_classes: + description: A list of classes to delete Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_classes: + description: A list of classes to create Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_sqlite_classes: + description: A list of classes to create Durable Object namespaces with SQLite from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + renamed_classes: + description: A list of classes with Durable Object namespaces that were renamed. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + transferred_classes: + description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + from_script: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + type: object + workersModifiedOn: + description: When the script was last modified. + example: '2017-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + workersMultipartScript: + properties: + files: + description: 'An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.
Possible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.' + items: + format: binary + type: string + type: array + x-stainless-collection-type: set + metadata: + description: JSON-encoded metadata about the uploaded parts and Worker configuration. + properties: + assets: + $ref: '#/components/schemas/workersAssets' + bindings: + $ref: '#/components/schemas/workersBindings' + body_part: + description: Name of the uploaded file that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker. + example: worker.js + type: string + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + keep_assets: + description: Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token. + example: false + type: boolean + keep_bindings: + description: List of binding types to keep from previous_upload. + items: + type: string + type: array + x-stainless-collection-type: set + limits: + $ref: '#/components/schemas/workersLimits' + logpush: + $ref: '#/components/schemas/workersLogpush' + main_module: + description: Name of the uploaded file that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker. + example: worker.js + type: string + migrations: + description: Migrations to apply for Durable Objects associated with this Worker. + writeOnly: true + type: object + properties: + new_tag: + description: Tag to set as the latest migration tag. + example: v2 + type: string + writeOnly: true + x-auditable: true + old_tag: + description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected. + example: v1 + type: string + writeOnly: true + x-auditable: true + deleted_classes: + description: A list of classes to delete Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_classes: + description: A list of classes to create Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_sqlite_classes: + description: A list of classes to create Durable Object namespaces with SQLite from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + renamed_classes: + description: A list of classes with Durable Object namespaces that were renamed. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + transferred_classes: + description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + from_script: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + steps: + description: Migrations to apply in order. + items: + $ref: '#/components/schemas/workersMigrationStep' + type: array + writeOnly: true + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfo' + tags: + description: List of strings to use as tags for this Worker. + items: + type: string + type: array + x-stainless-collection-type: set + tail_consumers: + $ref: '#/components/schemas/workersTailConsumers' + usage_model: + $ref: '#/components/schemas/workersUsageModel' + type: object + required: + - metadata + type: object + workersNamespaceIdentifier: + description: Namespace identifier tag. + example: 0f2ac74b498b48028cb68387c421e279 + maxLength: 32 + type: string + x-auditable: true + workersNamespaceListResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/workersNamespaceResponse' + type: array + required: + - success + - errors + - messages + type: object + workersNamespaceResponse: + properties: + created_by: + $ref: '#/components/schemas/workersIdentifier' + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + modified_by: + $ref: '#/components/schemas/workersIdentifier' + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + namespace_id: + $ref: '#/components/schemas/workersUuid' + namespace_name: + $ref: '#/components/schemas/workersDispatchNamespaceName' + script_count: + $ref: '#/components/schemas/workersScriptCount' + trusted_workers: + $ref: '#/components/schemas/workersTrustedWorkers' + type: object + workersNamespaceScriptAndVersionSettingsItem: + description: Script and version settings for Workers for Platforms namespace scripts. Same as script-and-version-settings-item but without annotations, which are not supported for namespace scripts. + properties: + bindings: + description: 'List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.' + example: + - name: MY_ENV_VAR + text: my_data + type: plain_text + items: + $ref: '#/components/schemas/workersBindingItem' + type: array + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + default: '' + type: string + x-auditable: true + compatibility_flags: + default: [] + description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`. + example: + - nodejs_compat + items: + $ref: '#/components/schemas/workersCompatibilityFlag' + type: string + x-auditable: true + type: array + x-stainless-collection-type: set + limits: + $ref: '#/components/schemas/workersLimits' + logpush: + $ref: '#/components/schemas/workersLogpush' + migrations: + description: Migrations to apply for Durable Objects associated with this Worker. + writeOnly: true + type: object + properties: + new_tag: + description: Tag to set as the latest migration tag. + example: v2 + type: string + writeOnly: true + x-auditable: true + old_tag: + description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected. + example: v1 + type: string + writeOnly: true + x-auditable: true + deleted_classes: + description: A list of classes to delete Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_classes: + description: A list of classes to create Durable Object namespaces from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + new_sqlite_classes: + description: A list of classes to create Durable Object namespaces with SQLite from. + items: + type: string + x-auditable: true + type: array + writeOnly: true + renamed_classes: + description: A list of classes with Durable Object namespaces that were renamed. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + transferred_classes: + description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. + items: + properties: + from: + type: string + writeOnly: true + x-auditable: true + from_script: + type: string + writeOnly: true + x-auditable: true + to: + type: string + writeOnly: true + x-auditable: true + type: object + type: array + writeOnly: true + steps: + description: Migrations to apply in order. + items: + $ref: '#/components/schemas/workersMigrationStep' + type: array + writeOnly: true + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfoNoStatus' + type: object + tags: + description: Tags associated with the Worker. + example: + - my-team + - my-public-api + items: + $ref: '#/components/schemas/workersTag' + type: string + x-auditable: true + maxItems: 10 + nullable: true + type: array + x-auditable: true + x-stainless-collection-type: set + tail_consumers: + description: List of Workers that will consume logs from the attached Worker. + items: + $ref: '#/components/schemas/workersTailConsumersScript' + nullable: true + type: array + x-stainless-collection-type: set + usage_model: + $ref: '#/components/schemas/workersUsageModel' + type: object + workersNamespaceScriptResponse: + description: Details about a worker uploaded to a Workers for Platforms namespace. + properties: + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + dispatch_namespace: + $ref: '#/components/schemas/workersDispatchNamespaceName' + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + script: + $ref: '#/components/schemas/workersScriptResponse' + type: object + workersNamespaceScriptResponseSingle: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersNamespaceScriptResponse' + required: + - success + - errors + - messages + - result + type: object + workersNamespaceSingleResponse: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersNamespaceResponse' + required: + - success + - errors + - messages + type: object + workersObservability: + description: Observability settings for the Worker. + properties: + enabled: + description: Whether observability is enabled for the Worker. + example: true + type: boolean + x-auditable: true + head_sampling_rate: + description: The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. + example: 0.1 + nullable: true + type: number + x-auditable: true + logs: + description: Log settings for the Worker. + nullable: true + properties: + destinations: + description: A list of destinations where logs will be exported to. + example: + - cloudflare + items: + type: string + type: array + x-auditable: true + enabled: + description: Whether logs are enabled for the Worker. + example: true + type: boolean + x-auditable: true + head_sampling_rate: + description: The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. + example: 0.1 + nullable: true + type: number + x-auditable: true + invocation_logs: + description: Whether [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs) are enabled for the Worker. + example: true + type: boolean + x-auditable: true + persist: + default: true + description: Whether log persistence is enabled for the Worker. + example: true + type: boolean + x-auditable: true + required: + - enabled + - invocation_logs + type: object + traces: + description: Trace settings for the Worker. + nullable: true + properties: + destinations: + description: A list of destinations where traces will be exported to. + example: + - cloudflare + items: + type: string + type: array + x-auditable: true + enabled: + description: Whether traces are enabled for the Worker. + example: true + type: boolean + x-auditable: true + head_sampling_rate: + description: The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. + example: 0.1 + nullable: true + type: number + x-auditable: true + persist: + default: true + description: Whether trace persistence is enabled for the Worker. + example: true + type: boolean + x-auditable: true + type: object + required: + - enabled + type: object + workersPlacementInfo: + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + type: object + properties: + last_analyzed_at: + description: The last time the script was analyzed for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + example: '2025-01-01T00:00:00Z' + format: date-time + readOnly: true + type: string + status: + $ref: '#/components/schemas/workersPlacementStatus' + mode: + description: Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - smart + type: string + x-auditable: true + region: + description: Cloud region for targeted placement in format 'provider:region'. + example: aws:us-east-1 + type: string + x-auditable: true + hostname: + description: HTTP hostname for targeted placement. + example: api.example.com + type: string + x-auditable: true + host: + description: TCP host and port for targeted placement. + example: db.example.com:5432 + type: string + x-auditable: true + target: + description: Array of placement targets (currently limited to single target). + items: + $ref: '#/components/schemas/workersPlacementTarget' + maxItems: 1 + minItems: 1 + type: array + x-auditable: true + required: [] + workersPlacementInfoNoStatus: + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + type: object + properties: + mode: + description: Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - smart + type: string + x-auditable: true + region: + description: Cloud region for targeted placement in format 'provider:region'. + example: aws:us-east-1 + type: string + x-auditable: true + hostname: + description: HTTP hostname for targeted placement. + example: api.example.com + type: string + x-auditable: true + host: + description: TCP host and port for targeted placement. + example: db.example.com:5432 + type: string + x-auditable: true + target: + description: Array of placement targets (currently limited to single target). + items: + $ref: '#/components/schemas/workersPlacementTarget' + maxItems: 1 + minItems: 1 + type: array + x-auditable: true + required: [] + workersPlacementMode: + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + enum: + - smart + - targeted + type: string + x-auditable: true + workersPlacementStatus: + description: Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - SUCCESS + - UNSUPPORTED_APPLICATION + - INSUFFICIENT_INVOCATIONS + readOnly: true + type: string + x-auditable: true + workersPlacementTarget: + description: A target to run your Worker near. + type: object + properties: + region: + description: Cloud region in format 'provider:region'. + example: aws:us-east-1 + type: string + hostname: + description: HTTP hostname for targeted placement. + example: api.example.com + type: string + host: + description: TCP host:port for targeted placement. + example: db.example.com:5432 + type: string + required: [] + workersScriptCount: + description: The current number of scripts in this Dispatch Namespace. + example: 800 + type: integer + workersScriptResponse: + properties: + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + etag: + $ref: '#/components/schemas/workersEtag' + handlers: + description: The names of handlers exported as part of the default export. + example: + - fetch + - scheduled + items: + type: string + type: array + has_assets: + $ref: '#/components/schemas/workersHasAssets' + has_modules: + $ref: '#/components/schemas/workersHasModules' + id: + description: The name used to identify the script. + example: my-workers-script + readOnly: true + type: string + x-auditable: true + last_deployed_from: + description: The client most recently used to deploy this Worker. + example: wrangler + type: string + logpush: + $ref: '#/components/schemas/workersLogpush' + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + example: v1 + type: string + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + items: + properties: + handlers: + description: The names of handlers exported as part of the named export. + example: + - class + items: + type: string + type: array + name: + description: The name of the export. + example: MyDurableObject + type: string + type: object + type: array + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfo' + placement_mode: + $ref: '#/components/schemas/workersPlacementMode' + deprecated: true + type: string + placement_status: + $ref: '#/components/schemas/workersPlacementStatus' + deprecated: true + type: string + tag: + description: The immutable ID of the script. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + readOnly: true + type: string + tags: + $ref: '#/components/schemas/workersTags' + tail_consumers: + $ref: '#/components/schemas/workersTailConsumers' + usage_model: + $ref: '#/components/schemas/workersUsageModel' + type: object + workersScriptResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersScriptResponse' + required: + - success + - errors + - messages + - result + workersScriptResponseUpload: + properties: + compatibility_date: + $ref: '#/components/schemas/workersCompatibilityDate' + compatibility_flags: + $ref: '#/components/schemas/workersCompatibilityFlags' + created_on: + $ref: '#/components/schemas/workersCreatedOn' + readOnly: true + etag: + $ref: '#/components/schemas/workersEtag' + handlers: + description: The names of handlers exported as part of the default export. + example: + - fetch + - scheduled + items: + type: string + type: array + has_assets: + $ref: '#/components/schemas/workersHasAssets' + has_modules: + $ref: '#/components/schemas/workersHasModules' + id: + description: The name used to identify the script. + example: my-workers-script + readOnly: true + type: string + x-auditable: true + last_deployed_from: + description: The client most recently used to deploy this Worker. + example: wrangler + type: string + logpush: + $ref: '#/components/schemas/workersLogpush' + migration_tag: + description: The tag of the Durable Object migration that was most recently applied for this Worker. + example: v1 + type: string + modified_on: + $ref: '#/components/schemas/workersModifiedOn' + readOnly: true + named_handlers: + description: Named exports, such as Durable Object class implementations and named entrypoints. + items: + properties: + handlers: + description: The names of handlers exported as part of the named export. + example: + - class + items: + type: string + type: array + name: + description: The name of the export. + example: MyDurableObject + type: string + type: object + type: array + observability: + $ref: '#/components/schemas/workersObservability' + placement: + $ref: '#/components/schemas/workersPlacementInfo' + placement_mode: + type: string + description: Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Specify mode='smart' for Smart Placement, or one of region/hostname/host. + enum: + - smart + - targeted + placement_status: + type: string + description: Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). + enum: + - SUCCESS + - UNSUPPORTED_APPLICATION + - INSUFFICIENT_INVOCATIONS + tag: + description: The immutable ID of the script. + example: e8f70fdbc8b1fb0b8ddb1af166186758 + readOnly: true + type: string + tags: + $ref: '#/components/schemas/workersTags' + tail_consumers: + $ref: '#/components/schemas/workersTailConsumers' + usage_model: + $ref: '#/components/schemas/workersUsageModel' + entry_point: + description: The entry point for the script. + example: index.js + readOnly: true + type: string + startup_time_ms: + example: 10 + readOnly: true + type: integer + x-auditable: true + type: object + required: + - startup_time_ms + workersScriptResponseUploadSingle: + properties: + errors: + $ref: '#/components/schemas/workersMessages' + messages: + $ref: '#/components/schemas/workersMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/workersScriptResponseUpload' + required: + - success + - errors + - messages + - result + type: object + workersSecret: + description: A secret value accessible through a binding. + type: object + properties: + name: + $ref: '#/components/schemas/workersBindingName' + text: + description: The secret value to use. + example: My secret. + type: string + writeOnly: true + x-sensitive: true + type: + description: The kind of resource that the binding provides. + enum: + - secret_text + type: string + x-auditable: true + algorithm: + description: Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm). + type: object + x-auditable: true + format: + description: Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format). + enum: + - raw + - pkcs8 + - spki + - jwk + example: raw + type: string + x-auditable: true + key_base64: + description: Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki". + type: string + writeOnly: true + x-sensitive: true + key_jwk: + description: Key data in [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key) format. Required if `format` is "jwk". + type: object + writeOnly: true + x-sensitive: true + usages: + description: Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages). + example: + - encrypt + - decrypt + items: + enum: + - encrypt + - decrypt + - sign + - verify + - deriveKey + - deriveBits + - wrapKey + - unwrapKey + type: string + type: array + x-auditable: true + x-stainless-collection-type: set + required: + - name + - type + workersSecretName: + description: A JavaScript variable name for the secret binding. + example: mySecret + readOnly: true + type: string + x-auditable: true + workersSecretNameUrlEncoded: + description: Flag that indicates whether the secret name is URL encoded. + example: true + readOnly: true + type: boolean + x-auditable: true + workersTag: + example: my-tag + maxLength: 1024 + type: string + workersTags: + description: Tags associated with the Worker. + example: + - my-team + - my-public-api + items: + $ref: '#/components/schemas/workersTag' + maxItems: 10 + nullable: true + type: array + x-auditable: true + x-stainless-collection-type: set + workersTailConsumers: + description: List of Workers that will consume logs from the attached Worker. + items: + $ref: '#/components/schemas/workersTailConsumersScript' + nullable: true + type: array + x-stainless-collection-type: set + workersTailConsumersScript: + description: A reference to a script that will consume logs from the attached Worker. + properties: + environment: + description: Optional environment if the Worker utilizes one. + example: production + type: string + x-auditable: true + namespace: + description: Optional dispatch namespace the script belongs to. + example: my-namespace + type: string + x-auditable: true + service: + description: Name of Worker that is to be the consumer. + example: my-log-consumer + type: string + x-auditable: true + required: + - service + type: object + workersTrustedWorkers: + default: false + description: Whether the Workers in the namespace are executed in a "trusted" manner. When a Worker is trusted, it has access to the shared caches for the zone in the Cache API, and has access to the `request.cf` object on incoming Requests. When a Worker is untrusted, caches are not shared across the zone, and `request.cf` is undefined. By default, Workers in a namespace are "untrusted". + example: false + type: boolean + x-auditable: true + workersUsageModel: + default: standard + description: Usage model for the Worker invocations. + enum: + - standard + - bundled + - unbound + example: standard + type: string + x-auditable: true + workersUuid: + description: API Resource UUID tag. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + namespaces: + id: cloudflare.workers_for_platforms.namespaces + name: namespaces + title: Namespaces + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + namespace_worker_patch_namespace: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + namespace_worker_put_namespace: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/get' + - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/namespace_worker_patch_namespace' + delete: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/namespace_worker_put_namespace' + scripts: + id: cloudflare.workers_for_platforms.scripts + name: scripts + title: Scripts + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_assets_upload_session: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1assets-upload-session/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scripts/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/scripts/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/scripts/methods/update' + bindings: + id: cloudflare.workers_for_platforms.bindings + name: bindings + title: Bindings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1bindings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bindings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + content: + id: cloudflare.workers_for_platforms.content + name: content + title: Content + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1content/get' + response: + mediaType: string + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1content/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/content/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/content/methods/update' + secrets: + id: cloudflare.workers_for_platforms.secrets + name: secrets + title: Secrets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1secrets/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1secrets~1{secret_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1secrets~1{secret_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secrets/methods/get' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/secrets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/secrets/methods/update' + settings: + id: cloudflare.workers_for_platforms.settings + name: settings + title: Settings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/edit' + delete: [] + replace: [] + tags: + id: cloudflare.workers_for_platforms.tags + name: tags + title: Tags + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + namespace_worker_put_script_tags: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1tags/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1tags~1{tag}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + namespace_worker_put_script_tag: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workers~1dispatch~1namespaces~1{dispatch_namespace}~1scripts~1{script_name}~1tags~1{tag}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/tags/methods/namespace_worker_put_script_tag' + - $ref: '#/components/x-stackQL-resources/tags/methods/namespace_worker_put_script_tags' diff --git a/providers/src/cloudflare/v00.00.00000/services/workflows.yaml b/providers/src/cloudflare/v00.00.00000/services/workflows.yaml new file mode 100644 index 00000000..f361b99c --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/workflows.yaml @@ -0,0 +1,4106 @@ +openapi: 3.0.3 +info: + title: workflows API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /accounts/{account_id}/workflows: + get: + description: Lists all workflows configured for the account. + operationId: wor-list-workflows + parameters: + - in: query + name: per_page + schema: + default: 10 + maximum: 100 + minimum: 1 + type: number + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Allows filtering workflows` name. + in: query + name: search + schema: + description: Allows filtering workflows` name. + maxLength: 64 + minLength: 1 + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + items: + properties: + class_name: + type: string + created_on: + format: date-time + type: string + readOnly: true + id: + format: uuid + type: string + instances: + properties: + complete: + type: number + errored: + type: number + paused: + type: number + queued: + type: number + running: + type: number + terminated: + type: number + waiting: + type: number + waitingForPause: + type: number + type: object + modified_on: + format: date-time + type: string + readOnly: true + name: + maxLength: 64 + minLength: 1 + type: string + script_name: + type: string + triggered_on: + format: date-time + nullable: true + type: string + required: + - name + - id + - created_on + - modified_on + - script_name + - class_name + - triggered_on + - instances + type: object + type: array + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: List of all Workflows belonging to a account. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Input Validation Error. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all Workflows + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: [] + method: list + /accounts/{account_id}/workflows/{workflow_name}: + delete: + description: >- + Deletes a Workflow. This only deletes the Workflow and does not delete + or modify any Worker associated to this Workflow or bounded to it. + operationId: wor-delete-workflow + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + status: + enum: + - ok + type: string + success: + nullable: true + type: boolean + required: + - success + - status + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Deletes a Workflow. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow has no deployed versions. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Deletes a Workflow + tags: + - Workflows + x-api-token-group: + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: [] + method: delete + get: + description: Retrieves configuration and metadata for a specific workflow. + operationId: wor-get-workflow-details + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + class_name: + type: string + created_on: + format: date-time + type: string + readOnly: true + id: + format: uuid + type: string + instances: + properties: + complete: + type: number + errored: + type: number + paused: + type: number + queued: + type: number + running: + type: number + terminated: + type: number + waiting: + type: number + waitingForPause: + type: number + type: object + modified_on: + format: date-time + type: string + readOnly: true + name: + maxLength: 64 + minLength: 1 + type: string + script_name: + type: string + triggered_on: + format: date-time + nullable: true + type: string + required: + - name + - id + - created_on + - modified_on + - script_name + - class_name + - triggered_on + - instances + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Get Workflow details. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow has no deployed versions. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workflow details + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: [] + method: get + put: + description: Creates a new workflow or updates an existing workflow definition. + operationId: wor-create-or-modify-workflow + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + class_name: + maxLength: 255 + minLength: 1 + type: string + limits: + properties: + steps: + minimum: 1 + type: integer + type: object + script_name: + maxLength: 255 + minLength: 1 + type: string + required: + - script_name + - class_name + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + class_name: + type: string + created_on: + format: date-time + type: string + readOnly: true + id: + format: uuid + type: string + is_deleted: + type: number + modified_on: + format: date-time + type: string + readOnly: true + name: + maxLength: 64 + minLength: 1 + type: string + script_name: + type: string + terminator_running: + type: number + triggered_on: + format: date-time + nullable: true + type: string + version_id: + format: uuid + type: string + required: + - version_id + - name + - id + - created_on + - modified_on + - script_name + - class_name + - triggered_on + - is_deleted + - terminator_running + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: >- + Create/modify a Workflow based on a deployed script with an existing + `WorkflowEntrypoint` class. Must be done after deploying the + corresponding script. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Bad Request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create/modify Workflow + tags: + - Workflows + x-api-token-group: + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: [] + method: update + /accounts/{account_id}/workflows/{workflow_name}/instances: + get: + description: Lists all instances of a workflow with their execution status. + operationId: wor-list-workflow-instances + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - in: query + name: page + schema: + deprecated: true + description: 'Deprecated: use `cursor` for pagination instead.' + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 50 + maximum: 100 + minimum: 1 + type: number + - description: >- + Opaque token for cursor-based pagination. Mutually exclusive with + `page`. + in: query + name: cursor + schema: + description: >- + Opaque token for cursor-based pagination. Mutually exclusive with + `page`. + type: string + - description: Defines the direction for cursor-based pagination. + in: query + name: direction + schema: + description: Defines the direction for cursor-based pagination. + enum: + - asc + - desc + type: string + - in: query + name: status + schema: + enum: + - queued + - running + - paused + - errored + - terminated + - complete + - waitingForPause + - waiting + type: string + - description: Accepts ISO 8601 with no timezone offsets and in UTC. + in: query + name: date_start + schema: + description: Accepts ISO 8601 with no timezone offsets and in UTC. + format: date-time + type: string + - description: Accepts ISO 8601 with no timezone offsets and in UTC. + in: query + name: date_end + schema: + description: Accepts ISO 8601 with no timezone offsets and in UTC. + format: date-time + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + items: + properties: + created_on: + format: date-time + type: string + readOnly: true + ended_on: + format: date-time + nullable: true + type: string + id: + maxLength: 100 + minLength: 1 + type: string + modified_on: + format: date-time + type: string + readOnly: true + started_on: + format: date-time + nullable: true + type: string + status: + enum: + - queued + - running + - paused + - errored + - terminated + - complete + - waitingForPause + - waiting + type: string + version_id: + format: uuid + type: string + workflow_id: + format: uuid + type: string + required: + - id + - created_on + - modified_on + - started_on + - ended_on + - workflow_id + - version_id + - status + type: object + type: array + result_info: + properties: + count: + type: number + cursor: + type: string + page: + deprecated: true + description: 'Deprecated: use cursor-based pagination instead.' + type: number + per_page: + type: number + total_count: + deprecated: true + description: >- + Deprecated: total count is not reliable with + cursor-based pagination. + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: List of workflow instances. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Input Validation Error. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow Name not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List of workflow instances + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: + - instances + method: list + post: + description: Creates a new instance of a workflow, starting its execution. + operationId: wor-create-new-workflow-instance + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + instance_id: + maximum: 100 + minimum: 1 + type: string + instance_retention: + properties: + error_retention: + description: >- + Specifies the duration in milliseconds or as a string + like '5 minutes'. + type: integer + success_retention: + description: >- + Specifies the duration in milliseconds or as a string + like '5 minutes'. + type: integer + type: object + params: + type: object + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + id: + maxLength: 100 + minLength: 1 + type: string + status: + enum: + - queued + - running + - paused + - errored + - terminated + - complete + - waitingForPause + - waiting + type: string + version_id: + format: uuid + type: string + workflow_id: + format: uuid + type: string + required: + - id + - workflow_id + - version_id + - status + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: >- + Create workflow instance. Body is a JSON parsable string that it's + passed into the new instance as the event payload. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Provided Workflow ID is not valid. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow Name not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new workflow instance + tags: + - Workflows + x-api-token-group: + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: + - instances + method: create + /accounts/{account_id}/workflows/{workflow_name}/instances/batch: + post: + description: Creates multiple workflow instances in a single batch operation. + operationId: wor-batch-create-workflow-instance + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + properties: + instance_id: + maximum: 100 + minimum: 1 + type: string + instance_retention: + properties: + error_retention: + description: >- + Specifies the duration in milliseconds or as a string + like '5 minutes'. + type: integer + success_retention: + description: >- + Specifies the duration in milliseconds or as a string + like '5 minutes'. + type: integer + type: object + params: + type: object + type: object + maxItems: 100 + minItems: 1 + type: array + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + items: + properties: + id: + maxLength: 100 + minLength: 1 + type: string + status: + enum: + - queued + - running + - paused + - errored + - terminated + - complete + - waitingForPause + - waiting + type: string + version_id: + format: uuid + type: string + workflow_id: + format: uuid + type: string + required: + - id + - workflow_id + - version_id + - status + type: object + type: array + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: >- + Batch create workflow instances. Body is a JSON list that contain + all payloads and ids that are passed into the new instance as the + event payload. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Provided Workflow ID is not valid. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow Name not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Batch create new Workflow instances + tags: + - Workflows + x-api-token-group: + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/workflows/{workflow_name}/instances/batch/terminate: + post: + description: Terminates multiple workflow instances in a single batch operation. + operationId: wor-batch-terminate-workflow-instances + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + maximum: 100 + minimum: 1 + type: string + maxItems: 100 + minItems: 1 + type: array + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + instancesTerminated: + type: number + status: + enum: + - ok + - already_running + type: string + required: + - status + - instancesTerminated + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: >- + Batch terminate instances of a workflow, via a async job. Body is a + JSON list that contain the ids of the instances to terminate. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Provided Workflow ID is not valid. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow Name not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Batch terminate instances of a workflow + tags: + - Workflows + x-api-token-group: + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/workflows/{workflow_name}/instances/terminate: + get: + description: Gets the status of a bulk workflow instance termination job. + operationId: wor-status-terminate-workflow-instances + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + status: + enum: + - running + - not_running + type: string + required: + - status + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: >- + Get status of the job responsible for terminate all instances of a + workflow. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Input Validation Error. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow Name not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: >- + Get status of the job responsible for terminate all instances of a + workflow + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}: + get: + description: Retrieves logs and execution status for a specific workflow instance. + operationId: wor-describe-workflow-instance + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: instance_id + in: path + required: true + description: The Workflow instance ID. + schema: + type: string + - description: >- + When true, omits step details and returns only metadata with + step_count. + in: query + name: simple + schema: + default: 'false' + description: >- + When true, omits step details and returns only metadata with + step_count. + enum: + - 'true' + - 'false' + type: string + - description: >- + Step ordering: "asc" (default, oldest first) or "desc" (newest + first). + in: query + name: order + schema: + default: asc + description: >- + Step ordering: "asc" (default, oldest first) or "desc" (newest + first). + enum: + - asc + - desc + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + end: + format: date-time + nullable: true + type: string + error: + nullable: true + properties: + message: + type: string + name: + type: string + required: + - name + - message + type: object + output: + type: string + params: + type: object + queued: + format: date-time + type: string + start: + format: date-time + nullable: true + type: string + status: + enum: + - queued + - running + - paused + - errored + - terminated + - complete + - waitingForPause + - waiting + type: string + step_count: + type: integer + steps: + items: + type: object + properties: + attempts: + items: + properties: + end: + format: date-time + nullable: true + type: string + error: + nullable: true + properties: + message: + type: string + name: + type: string + required: + - name + - message + type: object + start: + format: date-time + type: string + success: + nullable: true + type: boolean + required: + - start + - end + - success + - error + type: object + type: array + config: + properties: + retries: + properties: + backoff: + enum: + - constant + - linear + - exponential + type: string + delay: + description: Specifies the delay duration. + type: string + limit: + type: number + required: + - limit + - delay + type: object + timeout: + description: Specifies the timeout duration. + type: string + required: + - retries + - timeout + type: object + end: + format: date-time + nullable: true + type: string + name: + type: string + output: + nullable: true + type: string + start: + format: date-time + type: string + success: + nullable: true + type: boolean + type: + enum: + - step + type: string + error: + nullable: true + properties: + message: + type: string + name: + type: string + required: + - name + - message + type: object + finished: + type: boolean + trigger: + properties: + source: + type: string + required: + - source + type: object + required: + - type + type: array + success: + nullable: true + type: boolean + trigger: + properties: + source: + enum: + - unknown + - api + - binding + - event + - cron + type: string + required: + - source + type: object + versionId: + format: uuid + type: string + required: + - params + - trigger + - versionId + - queued + - start + - end + - step_count + - steps + - success + - error + - status + - output + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Get all logs and status from the instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Instance not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get logs and status from instance + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: + - instances + method: get + /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}: + post: + description: >- + Sends an event to a running workflow instance to trigger state + transitions. + operationId: wor-send-event-workflow-instance + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: instance_id + in: path + required: true + description: The Workflow instance ID. + schema: + type: string + - in: path + name: event_type + schema: + maxLength: 100 + minLength: 1 + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - messages + type: object + description: Send an event to an instance. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Workflow not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Send event to instance + tags: + - Workflows + x-api-token-group: + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: + - instances + - events + method: create + /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status: + patch: + description: >- + Changes the execution status of a workflow instance (e.g., pause, + resume, terminate). + operationId: wor-change-status-workflow-instance + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - name: instance_id + in: path + required: true + description: The Workflow instance ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + from: + description: >- + Step to restart from. Only applicable when status is + "restart". + properties: + count: + exclusiveMinimum: true + minimum: 0 + type: integer + name: + maxLength: 256 + minLength: 1 + type: string + type: + enum: + - do + - sleep + - waitForEvent + type: string + required: + - name + type: object + status: + description: Apply action to instance. + enum: + - resume + - pause + - terminate + - restart + type: string + required: + - status + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + status: + enum: + - queued + - running + - paused + - errored + - terminated + - complete + - waitingForPause + - waiting + type: string + timestamp: + description: Accepts ISO 8601 with no timezone offsets and in UTC. + format: date-time + type: string + required: + - status + - timestamp + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Change status of instance - it can be paused, resumed or terminated. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Instance not found. + '409': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Instance not in a restartable state. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Change status of instance + tags: + - Workflows + x-api-token-group: + - Workers Scripts Write + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: + - instances + - status + method: edit + /accounts/{account_id}/workflows/{workflow_name}/versions: + get: + description: Lists all deployed versions of a workflow. + operationId: wor-list-workflow-versions + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - in: query + name: per_page + schema: + default: 50 + maximum: 100 + minimum: 1 + type: number + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + items: + properties: + class_name: + type: string + created_on: + format: date-time + type: string + readOnly: true + has_dag: + type: boolean + id: + format: uuid + type: string + language: + description: >- + The programming language of the workflow + implementation + enum: + - javascript + - python + type: string + limits: + properties: + steps: + minimum: 1 + type: integer + type: object + modified_on: + format: date-time + type: string + readOnly: true + workflow_id: + format: uuid + type: string + required: + - created_on + - modified_on + - id + - workflow_id + - class_name + - has_dag + - language + type: object + type: array + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: List deployed workflow versions. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Bad Request. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List deployed Workflow versions + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: + - versions + method: list + /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}: + get: + description: Retrieves details for a specific deployed workflow version. + operationId: wor-describe-workflow-versions + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - in: path + name: version_id + schema: + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + class_name: + type: string + created_on: + format: date-time + type: string + readOnly: true + has_dag: + type: boolean + id: + format: uuid + type: string + language: + description: >- + The programming language of the workflow + implementation + enum: + - javascript + - python + type: string + limits: + properties: + steps: + minimum: 1 + type: integer + type: object + modified_on: + format: date-time + type: string + readOnly: true + workflow_id: + format: uuid + type: string + required: + - created_on + - modified_on + - id + - workflow_id + - class_name + - has_dag + - language + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Get specific version details. + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Bad Request. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Version not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workflow version details + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: workflows + resource_chain: + - versions + method: get + /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/dag: + get: + description: >- + Retrieves the directed acyclic graph (DAG) representation of a workflow + version. + operationId: wor-describe-workflow-versions-dag + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - in: path + name: version_id + schema: + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + class_name: + type: string + created_on: + format: date-time + type: string + readOnly: true + dag: + nullable: true + type: object + id: + format: uuid + type: string + modified_on: + format: date-time + type: string + readOnly: true + workflow_id: + format: uuid + type: string + required: + - created_on + - modified_on + - id + - workflow_id + - class_name + - dag + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Get the parsed DAG for a specific workflow version. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Version not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workflow version dag + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/graph: + get: + description: Retrieves the graph visualization of a workflow version. + operationId: wor-describe-workflow-versions-graph + parameters: + - name: workflow_name + in: path + required: true + description: The Workflow name. + schema: + type: string + - in: path + name: version_id + schema: + format: uuid + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + result: + properties: + class_name: + type: string + created_on: + format: date-time + type: string + readOnly: true + graph: + description: Versioned workflow graph payload. + nullable: true + properties: + version: + type: number + workflow: + description: A parsed workflow entrypoint with its step graph. + properties: + class_name: + type: string + functions: + type: object + nodes: + items: + type: object + properties: + duration: + description: >- + Duration as milliseconds (number) or + human-readable string. + type: number + name: + type: string + resolves: + type: number + starts: + type: number + type: + enum: + - step_sleep + type: string + config: + description: >- + Configuration for a step (retries and + timeout). + properties: + retries: + description: Retry policy for a step. + properties: + backoff: + description: Backoff strategy for step retries. + enum: + - constant + - linear + - exponential + type: string + delay: + description: >- + Duration as milliseconds (number) or + human-readable string. + type: number + limit: + type: number + required: + - limit + - delay + - backoff + type: object + timeout: + description: >- + Duration as milliseconds (number) or + human-readable string. + type: number + required: + - retries + - timeout + type: object + nodes: + description: Child nodes (recursive). + items: + type: object + type: array + options: + description: Options for a waitForEvent step. + nullable: true + properties: + event_type: + type: string + timeout: + description: >- + Duration as milliseconds (number) or + human-readable string. + type: number + required: + - event_type + - timeout + type: object + payload: + description: Shape descriptor for JSON payloads. + type: object + properties: + type: + enum: + - unknown + type: string + fields: + description: >- + Nested JsonShape fields (recursive + structure). + type: object + required: + - type + timestamp: + type: string + kind: + description: Parallel execution strategy. + enum: + - all + - any + - all_settled + - race + type: string + catch_block: + nullable: true + properties: + nodes: + description: Child nodes (recursive). + items: + type: object + type: array + type: + enum: + - block + type: string + required: + - type + - nodes + type: object + finally_block: + nullable: true + properties: + nodes: + description: Child nodes (recursive). + items: + type: object + type: array + type: + enum: + - block + type: string + required: + - type + - nodes + type: object + try_block: + nullable: true + properties: + nodes: + description: Child nodes (recursive). + items: + type: object + type: array + type: + enum: + - block + type: string + required: + - type + - nodes + type: object + branches: + items: + properties: + condition: + nullable: true + type: string + nodes: + description: Child nodes (recursive). + items: + type: object + type: array + required: + - condition + - nodes + type: object + type: array + discriminant: + type: string + class_name: + type: string + functions: + type: object + required: + - type + type: array + payload: + description: Shape descriptor for JSON payloads. + type: object + properties: + type: + enum: + - unknown + type: string + fields: + description: >- + Nested JsonShape fields (recursive + structure). + type: object + required: + - type + required: + - class_name + - functions + - nodes + type: object + required: + - version + - workflow + type: object + id: + format: uuid + type: string + modified_on: + format: date-time + type: string + readOnly: true + workflow_id: + format: uuid + type: string + required: + - created_on + - modified_on + - id + - workflow_id + - class_name + - graph + type: object + result_info: + properties: + count: + type: number + cursor: + type: string + page: + type: number + per_page: + type: number + total_count: + type: number + total_pages: + type: number + required: + - per_page + - count + - total_count + type: object + success: + enum: + - true + type: boolean + required: + - success + - errors + - result + - messages + type: object + description: Get the parsed graph for a specific workflow version. + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + messages: + items: + type: string + type: array + result: + enum: + - null + nullable: true + type: object + success: + enum: + - false + type: boolean + required: + - success + - messages + - errors + - result + type: object + description: Version not found. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Workflow version graph + tags: + - Workflows + x-api-token-group: + - Workers Tail Read + - Workers Scripts Write + - Workers Scripts Read + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.workers.write + - com.cloudflare.api.workers.read + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true +components: + schemas: {} + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + workflows: + id: cloudflare.workflows.workflows + name: workflows + title: Workflows + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workflows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workflows/methods/get' + - $ref: '#/components/x-stackQL-resources/workflows/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/workflows/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/workflows/methods/update' + instances: + id: cloudflare.workflows.instances + name: instances + title: Instances + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances~1batch/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances~1{instance_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_status: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances~1{instance_id}~1status/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + workflows_instances: + id: cloudflare.workflows.workflows_instances + name: workflows_instances + title: Workflows Instances + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/workflows_instances/methods/create_by_account + update: [] + delete: [] + replace: [] + terminate: + id: cloudflare.workflows.terminate + name: terminate + title: Terminate + methods: + wor_batch_terminate_workflow_instances: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances~1batch~1terminate/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances~1terminate/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/terminate/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/terminate/methods/wor_batch_terminate_workflow_instances + update: [] + delete: [] + replace: [] + instances_events: + id: cloudflare.workflows.instances_events + name: instances_events + title: Instances Events + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1instances~1{instance_id}~1events~1{event_type}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + versions: + id: cloudflare.workflows.versions + name: versions + title: Versions + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1versions~1{version_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dag: + id: cloudflare.workflows.dag + name: dag + title: Dag + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1versions~1{version_id}~1dag/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dag/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + graph: + id: cloudflare.workflows.graph + name: graph + title: Graph + methods: + list: + operation: + $ref: >- + #/paths/~1accounts~1{account_id}~1workflows~1{workflow_name}~1versions~1{version_id}~1graph/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/graph/methods/list' + insert: [] + update: [] + delete: [] + replace: [] diff --git a/providers/src/cloudflare/v00.00.00000/services/zaraz.yaml b/providers/src/cloudflare/v00.00.00000/services/zaraz.yaml new file mode 100644 index 00000000..9964e8d2 --- /dev/null +++ b/providers/src/cloudflare/v00.00.00000/services/zaraz.yaml @@ -0,0 +1,1271 @@ +openapi: 3.0.3 +info: + title: zaraz API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones/{zone_id}/settings/zaraz/config: + get: + description: >- + Gets latest Zaraz configuration for a zone. It can be preview or + published configuration, whichever was the last updated. Secret + variables values will not be included. + operationId: get-zones-zone_identifier-zaraz-config + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazConfigResponse' + description: Get Zaraz configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Get Zaraz configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zaraz configuration + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - config + method: get + put: + description: Updates Zaraz configuration for a zone. + operationId: put-zones-zone_identifier-zaraz-config + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazConfigBody' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazConfigResponse' + description: Update Zaraz configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Update Zaraz configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Zaraz configuration + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - config + method: update + /zones/{zone_id}/settings/zaraz/default: + get: + description: Gets default Zaraz configuration for a zone. + operationId: get-zones-zone_identifier-zaraz-default + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazConfigResponse' + description: Get Zaraz default configuration response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Get Zaraz default configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get default Zaraz configuration + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - default + method: get + /zones/{zone_id}/settings/zaraz/export: + get: + description: >- + Exports full current published Zaraz configuration for a zone, secret + variables included. + operationId: get-zones-zone_identifier-zaraz-export + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazConfigReturn' + description: Get Zaraz configuration response. + headers: + Content-Disposition: + schema: + type: string + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Get Zaraz configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Export Zaraz configuration + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - export + method: get + /zones/{zone_id}/settings/zaraz/history: + get: + description: Lists a history of published Zaraz configuration records for a zone. + operationId: get-zones-zone_identifier-zaraz-history + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: >- + Ordinal number to start listing the results with. Default value is + 0. + in: query + name: offset + schema: + minimum: 0 + type: integer + - description: Maximum amount of results to list. Default value is 10. + in: query + name: limit + schema: + minimum: 1 + type: integer + - description: The field to sort by. Default is updated_at. + in: query + name: sortField + schema: + enum: + - id + - user_id + - description + - created_at + - updated_at + type: string + - description: Sorting order. Default is DESC. + in: query + name: sortOrder + schema: + enum: + - DESC + - ASC + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazHistoryResponse' + description: List Zaraz historical configuration records response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: List Zaraz historical configuration records failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zaraz historical configuration records + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - history + method: list + put: + description: Restores a historical published Zaraz configuration by ID for a zone. + operationId: put-zones-zone_identifier-zaraz-history + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + description: ID of the Zaraz configuration to restore. + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazConfigResponse' + description: Restore Zaraz historical configuration by ID response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Restore Zaraz historical configuration by ID failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Restore Zaraz historical configuration by ID + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - history + method: update + /zones/{zone_id}/settings/zaraz/history/configs: + get: + description: Gets a history of published Zaraz configurations by ID(s) for a zone. + operationId: get-zones-zone_identifier-zaraz-config-history + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Comma separated list of Zaraz configuration IDs. + explode: false + in: query + name: ids + schema: + items: + type: integer + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazConfigHistoryResponse' + description: Get Zaraz historical configurations by ID(s) response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Get Zaraz historical configurations by ID(s) failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zaraz historical configurations by ID(s) + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - history + - configs + method: get + /zones/{zone_id}/settings/zaraz/publish: + post: + description: Publish current Zaraz preview configuration for a zone. + operationId: post-zones-zone_identifier-zaraz-publish + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + description: Zaraz configuration description. + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/zarazMessages' + messages: + $ref: '#/components/schemas/zarazMessages' + success: + description: Whether the API call was successful. + type: boolean + x-auditable: true + result: + type: string + required: + - success + - errors + - messages + - result + type: object + description: Update Zaraz workflow response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Update Zaraz workflow response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Publish Zaraz preview configuration + tags: + - Zaraz + x-api-token-group: + - Zaraz Admin + x-cfPermissionsRequired: + enum: + - '#zaraz:publish' + x-stackql-sdk: + service: zaraz + resource_chain: + - publish + method: create + /zones/{zone_id}/settings/zaraz/workflow: + get: + description: Gets Zaraz workflow for a zone. + operationId: get-zones-zone_identifier-zaraz-workflow + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazWorkflowResponse' + description: Get Zaraz workflow response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Get Zaraz workflow response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zaraz workflow + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: + - workflow + method: get + put: + description: Updates Zaraz workflow for a zone. + operationId: put-zones-zone_identifier-zaraz-workflow + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazWorkflow' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zarazZarazWorkflowResponse' + description: Update Zaraz workflow response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zarazApiResponseCommonFailure' + description: Update Zaraz workflow response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Zaraz workflow + tags: + - Zaraz + x-api-token-group: + - Zaraz Edit + - Zaraz Admin + x-stackql-sdk: + service: zaraz + resource_chain: [] + method: update +components: + schemas: + unnamedSchemaRef3caeef70a38a3ad696413c7d97d9c394: + properties: + accept_all: + description: Object where keys are language codes. + type: object + confirm_my_choices: + description: Object where keys are language codes. + type: object + reject_all: + description: Object where keys are language codes. + type: object + required: + - accept_all + - reject_all + - confirm_my_choices + type: object + zarazApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/zarazMessages' + messages: + example: [] + $ref: '#/components/schemas/zarazMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + zarazMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + zarazZarazConfigBody: + x-stainless-variantName: trigger_worker + description: Zaraz configuration. + properties: + analytics: + description: Cloudflare Monitoring settings. + properties: + defaultPurpose: + description: Consent purpose assigned to Monitoring. + type: string + x-auditable: true + enabled: + description: Whether Advanced Monitoring reports are enabled. + type: boolean + x-auditable: true + sessionExpTime: + description: Session expiration time (seconds). + maximum: 86400 + minimum: 60 + type: integer + x-auditable: true + type: object + consent: + description: Consent management configuration. + properties: + buttonTextTranslations: + $ref: >- + #/components/schemas/unnamedSchemaRef3caeef70a38a3ad696413c7d97d9c394 + companyEmail: + type: string + x-auditable: true + companyName: + type: string + x-auditable: true + companyStreetAddress: + type: string + x-auditable: true + consentModalIntroHTML: + type: string + x-auditable: true + consentModalIntroHTMLWithTranslations: + description: Object where keys are language codes. + type: object + cookieName: + type: string + x-auditable: true + customCSS: + type: string + x-auditable: true + customIntroDisclaimerDismissed: + type: boolean + x-auditable: true + defaultLanguage: + type: string + x-auditable: true + enabled: + type: boolean + hideModal: + type: boolean + x-auditable: true + purposes: + description: Object where keys are purpose alpha-numeric IDs. + type: object + purposesWithTranslations: + description: Object where keys are purpose alpha-numeric IDs. + type: object + tcfCompliant: + type: boolean + required: + - enabled + type: object + dataLayer: + description: Data layer compatibility mode enabled. + type: boolean + x-auditable: true + debugKey: + description: The key for Zaraz debug mode. + type: string + x-auditable: true + historyChange: + description: Single Page Application support enabled. + type: boolean + x-auditable: true + settings: + description: General Zaraz settings. + properties: + autoInjectScript: + description: Automatic injection of Zaraz scripts enabled. + type: boolean + x-auditable: true + contextEnricher: + description: >- + Details of the worker that receives and edits Zaraz Context + object. + properties: + escapedWorkerName: + type: string + x-auditable: true + workerTag: + type: string + x-auditable: true + required: + - escapedWorkerName + - workerTag + type: object + cookieDomain: + description: The domain Zaraz will use for writing and reading its cookies. + type: string + x-auditable: true + ecommerce: + description: Ecommerce API enabled. + type: boolean + x-auditable: true + eventsApiPath: + description: Custom endpoint for server-side track events. + type: string + x-auditable: true + hideExternalReferer: + description: Hiding external referrer URL enabled. + type: boolean + x-auditable: true + hideIPAddress: + description: Trimming IP address enabled. + type: boolean + x-auditable: true + hideQueryParams: + description: Removing URL query params enabled. + type: boolean + x-auditable: true + hideUserAgent: + description: Removing sensitive data from User Agent string enabled. + type: boolean + initPath: + description: Custom endpoint for Zaraz init script. + type: string + x-auditable: true + injectIframes: + description: Injection of Zaraz scripts into iframes enabled. + type: boolean + x-auditable: true + mcRootPath: + description: Custom path for Managed Components server functionalities. + type: string + x-auditable: true + scriptPath: + description: Custom endpoint for Zaraz main script. + type: string + x-auditable: true + trackPath: + description: Custom endpoint for Zaraz tracking requests. + type: string + x-auditable: true + required: + - autoInjectScript + type: object + triggers: + description: >- + Triggers set up under Zaraz configuration, where key is the trigger + alpha-numeric ID and value is the trigger configuration. + type: object + variables: + description: >- + Variables set up under Zaraz configuration, where key is the + variable alpha-numeric ID and value is the variable configuration. + Values of variables of type secret are not included. + type: object + zarazVersion: + description: Zaraz internal version of the config. + type: integer + x-auditable: true + tools: + description: >- + Tools set up under Zaraz configuration, where key is the + alpha-numeric tool ID and value is the tool configuration object. + type: object + required: + - tools + - triggers + - variables + - settings + - dataLayer + - debugKey + - zarazVersion + type: object + zarazZarazConfigHistoryResponse: + properties: + errors: + $ref: '#/components/schemas/zarazMessages' + messages: + $ref: '#/components/schemas/zarazMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + description: Object where keys are numeric configuration IDs. + type: object + required: + - success + - errors + - messages + - result + type: object + zarazZarazConfigResponse: + properties: + errors: + $ref: '#/components/schemas/zarazMessages' + messages: + $ref: '#/components/schemas/zarazMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/zarazZarazConfigReturn' + required: + - success + - errors + - messages + - result + type: object + zarazZarazConfigReturn: + description: Zaraz configuration. + properties: + analytics: + description: Cloudflare Monitoring settings. + properties: + defaultPurpose: + description: Consent purpose assigned to Monitoring. + type: string + x-auditable: true + enabled: + description: Whether Advanced Monitoring reports are enabled. + type: boolean + x-auditable: true + sessionExpTime: + description: Session expiration time (seconds). + maximum: 86400 + minimum: 60 + type: integer + x-auditable: true + type: object + consent: + description: Consent management configuration. + properties: + buttonTextTranslations: + $ref: >- + #/components/schemas/unnamedSchemaRef3caeef70a38a3ad696413c7d97d9c394 + companyEmail: + type: string + x-auditable: true + companyName: + type: string + x-auditable: true + companyStreetAddress: + type: string + x-auditable: true + consentModalIntroHTML: + type: string + x-auditable: true + consentModalIntroHTMLWithTranslations: + description: Object where keys are language codes. + type: object + cookieName: + type: string + x-auditable: true + customCSS: + type: string + x-auditable: true + customIntroDisclaimerDismissed: + type: boolean + x-auditable: true + defaultLanguage: + type: string + x-auditable: true + enabled: + type: boolean + hideModal: + type: boolean + x-auditable: true + purposes: + description: Object where keys are purpose alpha-numeric IDs. + type: object + purposesWithTranslations: + description: Object where keys are purpose alpha-numeric IDs. + type: object + tcfCompliant: + type: boolean + required: + - enabled + type: object + dataLayer: + description: Data layer compatibility mode enabled. + type: boolean + x-auditable: true + debugKey: + description: The key for Zaraz debug mode. + type: string + x-auditable: true + historyChange: + description: Single Page Application support enabled. + type: boolean + x-auditable: true + settings: + description: General Zaraz settings. + properties: + autoInjectScript: + description: Automatic injection of Zaraz scripts enabled. + type: boolean + x-auditable: true + contextEnricher: + description: >- + Details of the worker that receives and edits Zaraz Context + object. + properties: + escapedWorkerName: + type: string + x-auditable: true + workerTag: + type: string + x-auditable: true + required: + - escapedWorkerName + - workerTag + type: object + cookieDomain: + description: The domain Zaraz will use for writing and reading its cookies. + type: string + x-auditable: true + ecommerce: + description: Ecommerce API enabled. + type: boolean + x-auditable: true + eventsApiPath: + description: Custom endpoint for server-side track events. + type: string + x-auditable: true + hideExternalReferer: + description: Hiding external referrer URL enabled. + type: boolean + x-auditable: true + hideIPAddress: + description: Trimming IP address enabled. + type: boolean + x-auditable: true + hideQueryParams: + description: Removing URL query params enabled. + type: boolean + x-auditable: true + hideUserAgent: + description: Removing sensitive data from User Agent string enabled. + type: boolean + initPath: + description: Custom endpoint for Zaraz init script. + type: string + x-auditable: true + injectIframes: + description: Injection of Zaraz scripts into iframes enabled. + type: boolean + x-auditable: true + mcRootPath: + description: Custom path for Managed Components server functionalities. + type: string + x-auditable: true + scriptPath: + description: Custom endpoint for Zaraz main script. + type: string + x-auditable: true + trackPath: + description: Custom endpoint for Zaraz tracking requests. + type: string + x-auditable: true + required: + - autoInjectScript + type: object + triggers: + description: >- + Triggers set up under Zaraz configuration, where key is the trigger + alpha-numeric ID and value is the trigger configuration. + type: object + variables: + description: >- + Variables set up under Zaraz configuration, where key is the + variable alpha-numeric ID and value is the variable configuration. + Values of variables of type secret are not included. + type: object + zarazVersion: + description: Zaraz internal version of the config. + type: integer + x-auditable: true + tools: + description: >- + Tools set up under Zaraz configuration, where key is the + alpha-numeric tool ID and value is the tool configuration object. + type: object + required: + - tools + - triggers + - variables + - settings + - dataLayer + - debugKey + - zarazVersion + type: object + zarazZarazHistoryResponse: + properties: + errors: + $ref: '#/components/schemas/zarazMessages' + messages: + $ref: '#/components/schemas/zarazMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + items: + $ref: '#/components/schemas/zarazZarazHistoryResponse_result_item' + type: array + required: + - success + - errors + - messages + - result + type: object + zarazZarazHistoryResponse_result_item: + properties: + createdAt: + description: Date and time the configuration was created. + format: date-time + type: string + x-auditable: true + id: + description: ID of the configuration. + type: integer + x-auditable: true + updatedAt: + description: Date and time the configuration was last updated. + format: date-time + type: string + x-auditable: true + userId: + description: >- + Alpha-numeric ID of the account user who published the + configuration. + type: string + x-auditable: true + description: + description: >- + Configuration description provided by the user who published this + configuration. + type: string + required: + - id + - createdAt + - updatedAt + - userId + - description + type: object + zarazZarazWorkflow: + description: Zaraz workflow. + enum: + - realtime + - preview + type: string + x-auditable: true + zarazZarazWorkflowResponse: + properties: + errors: + $ref: '#/components/schemas/zarazMessages' + messages: + $ref: '#/components/schemas/zarazMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/zarazZarazWorkflow' + required: + - success + - errors + - messages + - result + type: object + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + config: + id: cloudflare.zaraz.config + name: config + title: Config + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1config/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/config/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/config/methods/update' + default: + id: cloudflare.zaraz.default + name: default + title: Default + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1default/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/default/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + export: + id: cloudflare.zaraz.export + name: export + title: Export + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1export/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/export/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + history: + id: cloudflare.zaraz.history + name: history + title: History + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1history/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1history/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/history/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/history/methods/update' + configs: + id: cloudflare.zaraz.configs + name: configs + title: Configs + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1history~1configs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + settings: + id: cloudflare.zaraz.settings + name: settings + title: Settings + methods: + publish: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1publish/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + workflow: + id: cloudflare.zaraz.workflow + name: workflow + title: Workflow + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1workflow/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1zaraz~1workflow/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workflow/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/workflow/methods/update' diff --git a/providers/src/cloudflare/v00.00.00000/services/zero_trust.yaml b/providers/src/cloudflare/v00.00.00000/services/zero_trust.yaml index 4f106567..22736ed4 100644 --- a/providers/src/cloudflare/v00.00.00000/services/zero_trust.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/zero_trust.yaml @@ -1,3457 +1,51679 @@ -openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' -info: - description: Zero Trust Gateway Application and Application Type mappings - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - zero_trust - version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - app-types_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/app-types' - type: array - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - app-types: - oneOf: - - $ref: '#/components/schemas/application' - - $ref: '#/components/schemas/application_type' - readOnly: true - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: - type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - application: - properties: - application_type_id: - $ref: '#/components/schemas/app_type_id' - created_at: - $ref: '#/components/schemas/timestamp' - id: - $ref: '#/components/schemas/components-schemas-app_id' - name: - $ref: '#/components/schemas/app-types_components-schemas-name' - type: object - application_type: - properties: - created_at: - $ref: '#/components/schemas/timestamp' - description: - description: A short summary of applications with this type. - example: Applications used to communicate or collaborate in a business setting. - type: string - id: - $ref: '#/components/schemas/app_type_id' - name: - $ref: '#/components/schemas/app-types_components-schemas-name' - type: object - app_type_id: - description: The identifier for the type of this application. There can be many applications with the same type. This refers to the `id` of an Application Type that has been returned. - type: integer - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - components-schemas-app_id: - description: The identifier for this application. There is only one application per id. - type: integer - app-types_components-schemas-name: - description: The name of the application or application type. - example: Facebook - type: string - categories_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-categories' - type: array - schemas-categories: - properties: - beta: - $ref: '#/components/schemas/beta' - class: - $ref: '#/components/schemas/class' - description: - $ref: '#/components/schemas/categories_components-schemas-description' - id: - $ref: '#/components/schemas/categories_components-schemas-id' - name: - $ref: '#/components/schemas/categories_components-schemas-name' - subcategories: - description: All subcategories for this category. - items: - $ref: '#/components/schemas/subcategory' - type: array - readOnly: true - type: object - beta: - description: Whether the category is in beta and subject to change. - example: false - type: boolean - class: - description: Which account types are allowed to create policies based on this categories. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked. - enum: - - free - - premium - - blocked - - removalPending - - noBlock - example: premium - type: string - categories_components-schemas-description: - description: A short summary of domains in the category. - example: 'Sites related to educational content that are not included in other categories like Science, Technology or Educational institutions.' - type: string - categories_components-schemas-id: - description: The identifier for this category. There is only one category per id. - type: integer - categories_components-schemas-name: - description: The name of the category. - example: Education - type: string - subcategory: - properties: - beta: - $ref: '#/components/schemas/beta' - class: - $ref: '#/components/schemas/class' - description: - $ref: '#/components/schemas/categories_components-schemas-description' - id: - $ref: '#/components/schemas/categories_components-schemas-id' - name: - $ref: '#/components/schemas/categories_components-schemas-name' - type: object - locations_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - locations_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/locations' - type: array - locations: - properties: - client_default: - $ref: '#/components/schemas/client-default' - created_at: - $ref: '#/components/schemas/timestamp' - doh_subdomain: - $ref: '#/components/schemas/subdomain' - ecs_support: - $ref: '#/components/schemas/ecs-support' - id: - $ref: '#/components/schemas/locations_components-schemas-uuid' - ip: - $ref: '#/components/schemas/locations_components-schemas-ip' - name: - $ref: '#/components/schemas/locations_components-schemas-name' - networks: - $ref: '#/components/schemas/network' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - client-default: - description: Set if the location is the default one. - example: false - type: boolean - subdomain: - description: The DNS Over HTTPS domain to send DNS requests to. (auto-generated). - example: oli3n9zkz5 - type: string - ecs-support: - description: Set if the location needs to resolve EDNS queries. - example: false - type: boolean - locations_components-schemas-uuid: - example: ed35569b41ce4d1facfe683550f54086 - locations_components-schemas-ip: - description: IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. (auto-generated). - example: '2001:0db8:85a3:0000:0000:8a2e:0370:7334' - type: string - locations_components-schemas-name: - description: The name of the Location. - example: Austin Office Location - type: string - network: - description: A list of network ranges that requests from this location would originate from. - items: - description: The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24. - example: 192.0.2.1/32 - type: string - type: array - locations_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/locations' - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - locations_components-schemas-empty_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - proxy-endpoints_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - proxy-endpoints_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/proxy-endpoints' - type: array - proxy-endpoints: - properties: - created_at: - $ref: '#/components/schemas/timestamp' - id: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid' - ips: - $ref: '#/components/schemas/components-schemas-ips' - name: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-name' - subdomain: - $ref: '#/components/schemas/schemas-subdomain' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - proxy-endpoints_components-schemas-uuid: - example: ed35569b41ce4d1facfe683550f54086 - components-schemas-ips: - description: A list of CIDRs to restrict ingress connections. - items: - description: The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4 CIDRs are limited to a maximum of /25. - example: 192.0.2.1/32 - type: string - type: array - proxy-endpoints_components-schemas-name: - description: The name of the Proxy Endpoint. - example: Devops team - type: string - schemas-subdomain: - description: The subdomain to be used as the destination in the proxy client. - example: oli3n9zkz5.proxy.cloudflare-gateway.com - type: string - proxy-endpoints_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/proxy-endpoints' - proxy-endpoints_components-schemas-empty_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - rules_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - rules_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/rules_components-schemas-rules' - type: array - rules_components-schemas-rules: - properties: - action: - $ref: '#/components/schemas/rules_components-schemas-action-2' - created_at: - $ref: '#/components/schemas/timestamp' - deleted_at: - $ref: '#/components/schemas/deleted_at' - description: - $ref: '#/components/schemas/rules_components-schemas-description-2' - device_posture: - $ref: '#/components/schemas/device_posture' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled-3' - filters: - $ref: '#/components/schemas/schemas-filters' - id: - $ref: '#/components/schemas/rules_components-schemas-uuid' - identity: - $ref: '#/components/schemas/identity' - name: - $ref: '#/components/schemas/rules_components-schemas-name-2' - precedence: - $ref: '#/components/schemas/schemas-precedence' - rule_settings: - $ref: '#/components/schemas/rule-settings' - traffic: - $ref: '#/components/schemas/traffic' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - rules_components-schemas-action-2: - description: 'The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to ''true''.' - enum: - - 'on' - - 'off' - - allow - - block - - scan - - noscan - - safesearch - - ytrestricted - - isolate - - noisolate - - override - - l4_override - example: allow - type: string - deleted_at: - description: 'Date of deletion, if any.' - format: date-time - nullable: true - readOnly: true - type: string - rules_components-schemas-description-2: - description: The description of the Rule. - example: Block the bad websites based on host name - type: string - device_posture: - description: The wirefilter expression to be used for device posture check matching. - example: 'any(device_posture.checks.passed[*] in {"1308749e-fcfb-4ebc-b051-fe022b632644"})' - type: string - rules_components-schemas-enabled-3: - description: Set if the rule is enabled. - example: true - type: boolean - schemas-filters: - description: 'The protocol or layer to evaluate the traffic, identity, and device posture expressions.' - example: - - http - items: - description: The protocol or layer to use. - enum: - - http - - dns - - l4 - example: http - type: string - type: array - rules_components-schemas-uuid: - description: API Resource UUID tag. - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - type: string - identity: - description: The wirefilter expression to be used for identity matching. - example: 'any(identity.groups.name[*] in {"finance"})' - type: string - rules_components-schemas-name-2: - description: The name of the Rule. - example: block bad websites - type: string - schemas-precedence: - description: 'Precedence sets the ordering of the rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value.' - type: integer - rule-settings: - description: Additional settings that modify the rule's action. - properties: - add_headers: - description: 'Add custom headers to allowed requests, in the form of key-value pairs. Keys are header names, pointing to an array with its header value(s).' - example: - My-Next-Header: - - foo - - bar - X-Custom-Header-Name: - - somecustomvalue - type: object - biso_admin_controls: - description: Configure how browser isolation behaves. - properties: - dcp: - description: Disable copy-paste. - example: false - type: boolean - dd: - description: Disable download. - example: false - type: boolean - dk: - description: Disable keyboard usage. - example: false - type: boolean - dp: - description: Disable printing. - example: false - type: boolean - du: - description: Disable upload. - example: false - type: boolean - type: object - block_page_enabled: - description: Enable the custom block page. - example: true - type: boolean - block_reason: - description: The text describing why this block occurred that will be displayed on the custom block page (if enabled). - example: This website is a security risk - type: string - check_session: - description: Configure how session check behaves. - properties: - duration: - description: Configure how fresh the session needs to be to be considered valid. - example: 300s - type: string - enforce: - description: Enable session enforcement for this fule. - example: true - type: boolean - type: object - insecure_disable_dnssec_validation: - description: INSECURE - disable DNSSEC validation (for allow actions). - example: false - type: boolean - ip_categories: - description: Include IPs in DNS resolver category blocks. By default categories only block on domain names. - example: true - type: boolean - l4override: - description: Send matching traffic to the supplied destination IP address and port. - properties: - ip: - description: IPv4 or IPv6 address. - example: 1.1.1.1 - type: string - port: - description: A port number to use for TCP/UDP overrides. - type: integer - type: object - override_host: - description: Override matching DNS queries with this. - example: example.com - type: string - override_ips: - description: Override matching DNS queries with this. - example: - - 1.1.1.1 - - 2.2.2.2 - items: - description: IPv4 or IPv6 address. - example: 1.1.1.1 - type: string - type: array - type: object - traffic: - description: The wirefilter expression to be used for traffic matching. - example: http.request.uri matches ".*a/partial/uri.*" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10 - type: string - rules_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/rules_components-schemas-rules' - rules_components-schemas-empty_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - lists_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - lists_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/lists' - type: array - lists: - properties: - count: - $ref: '#/components/schemas/count' - created_at: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/lists_components-schemas-description-2' - id: - $ref: '#/components/schemas/lists_components-schemas-uuid' - name: - $ref: '#/components/schemas/lists_components-schemas-name-2' - type: - $ref: '#/components/schemas/lists_components-schemas-type' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - count: - description: The number of items in the List. - example: 20 - readOnly: true - type: number - lists_components-schemas-description-2: - description: The description of the List. - example: The serial numbers for administrators - type: string - lists_components-schemas-uuid: - description: API Resource UUID tag. - example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 - maxLength: 36 - type: string - lists_components-schemas-name-2: - description: The name of the List. - example: Admin Serial Numbers - type: string - lists_components-schemas-type: - description: The type of List. - enum: - - SERIAL - - URL - - DOMAIN - - EMAIL - - IP - example: SERIAL - type: string - schemas-items: - description: The items in the List. - items: - properties: - created_at: - $ref: '#/components/schemas/timestamp' - value: - $ref: '#/components/schemas/lists_components-schemas-value' - type: object - type: array - single_response_with_list_items: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - created_at: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/lists_components-schemas-description-2' - id: - $ref: '#/components/schemas/lists_components-schemas-uuid' - items: - $ref: '#/components/schemas/schemas-items' - name: - $ref: '#/components/schemas/lists_components-schemas-name-2' - type: - $ref: '#/components/schemas/lists_components-schemas-type' - updated_at: - $ref: '#/components/schemas/timestamp' - lists_components-schemas-value: - description: The value of the item in a List. - example: 8GE8721REF - type: string - lists_components-schemas-empty_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - lists_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/lists' - list_item_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-items' - type: array - - properties: - result_info: - properties: - count: - description: Total results returned based on your search parameters. - example: 1 - type: number - page: - description: Current page within paginated list of results. - example: 1 - type: number - per_page: - description: Number of results per page of results. - example: 20 - type: number - total_count: - description: Total results available without any search parameters. - example: 2000 - type: number - type: object - accounts_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - gateway-account-device-settings-response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/gateway-account-device-settings' - gateway-account-device-settings: - properties: - gateway_proxy_enabled: - description: Enable gateway proxy filtering on TCP. - example: true - type: boolean - gateway_udp_proxy_enabled: - description: Enable gateway proxy filtering on UDP. - example: true - type: boolean - type: object - gateway_account: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - gateway_tag: - $ref: '#/components/schemas/gateway_tag' - id: - $ref: '#/components/schemas/cf_account_id' - provider_name: - $ref: '#/components/schemas/provider_name' - type: object - gateway_tag: - description: Gateway internal id. - example: f174e90afafe4643bbbc4a0ed4fc8415 - maxLength: 32 - type: string - cf_account_id: - description: Cloudflare account tag. - example: 699d98642c564d2e855e9661899b7252 - maxLength: 32 - type: string - provider_name: - description: The name of provider. Usually cloudflare. - example: Cloudflare - type: string - gateway_account_config: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - $ref: '#/components/schemas/gateway-account-settings' - - properties: - created_at: - $ref: '#/components/schemas/timestamp' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - gateway-account-settings: - description: account settings. - properties: - settings: - description: account settings. - properties: - activity_log: - $ref: '#/components/schemas/activity-log-settings' - antivirus: - $ref: '#/components/schemas/anti-virus-settings' - block_page: - $ref: '#/components/schemas/block-page-settings' - browser_isolation: - $ref: '#/components/schemas/browser-isolation-settings' - fips: - $ref: '#/components/schemas/fips-settings' - tls_decrypt: - $ref: '#/components/schemas/tls-settings' - type: object - type: object - activity-log-settings: - description: Activity log settings. - properties: - enabled: - description: Enable activity logging. - example: true - type: boolean - type: object - anti-virus-settings: - description: Anti virus settings. - properties: - enabled_download_phase: - $ref: '#/components/schemas/enabled_download_phase' - enabled_upload_phase: - $ref: '#/components/schemas/enabled_upload_phase' - fail_closed: - $ref: '#/components/schemas/fail_closed' - type: object - block-page-settings: - description: Block page layout settings. - properties: - background_color: - description: 'Block page background color in #rrggbb format.' - type: string - enabled: - description: Enable only cipher suites and TLS versions compliant with FIPS 140-2. - example: true - type: boolean - footer_text: - description: Block page footer text. - example: '--footer--' - type: string - header_text: - description: Block page header text. - example: '--header--' - type: string - logo_path: - description: Full URL to the logo file. - example: 'https://logos.com/a.png' - type: string - mailto_address: - description: Admin email for users to contact. - example: admin@example.com - type: string - mailto_subject: - description: Subject line for emails created from block page. - example: Blocked User Inquiry - type: string - name: - description: Block page title. - example: Cloudflare - type: string - suppress_footer: - description: Suppress detailed info at the bottom of the block page. - example: false - type: boolean - type: object - browser-isolation-settings: - description: Browser isolation settings. - properties: - url_browser_isolation_enabled: - description: Enable Browser Isolation. - example: true - type: boolean - type: object - fips-settings: - description: FIPS settings. - properties: - tls: - description: Enable only cipher suites and TLS versions compliant with FIPS 140-2. - example: true - type: boolean - type: object - tls-settings: - description: TLS interception settings. - properties: - enabled: - description: Enable inspecting encrypted HTTP traffic. - example: true - type: boolean - type: object - enabled_download_phase: - description: Set to enable antivirus scan on downloads. - example: false - type: boolean - enabled_upload_phase: - description: Set to enable antivirus scan on uploads. - example: false - type: boolean - fail_closed: - description: Block requests for files that cannot be scanned. - example: false - type: boolean - gateway-account-logging-settings-response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/gateway-account-logging-settings' - gateway-account-logging-settings: - properties: - redact_pii: - description: 'Redact personally identifiable information from activity logging (PII fields are: source IP, user email, user ID, device ID, URL, referrer, user agent).' - example: true - type: boolean - settings_by_rule_type: - description: Logging settings by rule type. - properties: - dns: - description: Logging settings for DNS firewall. - type: object - http: - description: Logging settings for HTTP/HTTPS firewall. - type: object - l4: - description: Logging settings for Network firewall. - type: object - type: object - type: object - organizations_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - organizations_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/organizations' - organizations: - properties: - auth_domain: - $ref: '#/components/schemas/auth_domain' - created_at: - $ref: '#/components/schemas/timestamp' - is_ui_read_only: - $ref: '#/components/schemas/is_ui_read_only' - login_design: - $ref: '#/components/schemas/login_design' - name: - $ref: '#/components/schemas/organizations_components-schemas-name' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - auth_domain: - description: The unique subdomain assigned to your Zero Trust organization. - example: test.cloudflareaccess.com - type: string - is_ui_read_only: - description: 'Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.' - example: 'false' - type: boolean - login_design: - properties: - background_color: - description: The background color on your login page. - example: '#c5ed1b' - type: string - footer_text: - description: The text at the bottom of your login page. - example: This is an example description. - type: string - header_text: - description: The text at the top of your login page. - example: This is an example description. - type: string - logo_path: - description: The URL of the logo on your login page. - example: 'https://example.com/logo.png' - type: string - text_color: - description: The text color on your login page. - example: '#c5ed1b' - type: string - organizations_components-schemas-name: - description: The name of your Zero Trust organization. - example: Widget Corps Internal Applications - type: string - schemas-empty_response: - allOf: - - properties: - result: - enum: - - true - - false - example: true - type: boolean - success: - enum: - - true - - false - example: true - type: boolean - seats_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - seats_definition: - items: - $ref: '#/components/schemas/seat' - required: - - seat_uid - - gateway_seat - - access_seat - type: array - seats_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/seats' - type: array - seat: - properties: - access_seat: - $ref: '#/components/schemas/access_seat' - gateway_seat: - $ref: '#/components/schemas/gateway_seat' - seat_uid: - $ref: '#/components/schemas/seat_uid' - required: - - seat_uid - - gateway_seat - - access_seat - type: object - seats: - properties: - access_seat: - $ref: '#/components/schemas/access_seat' - created_at: - $ref: '#/components/schemas/timestamp' - gateway_seat: - $ref: '#/components/schemas/gateway_seat' - seat_uid: - $ref: '#/components/schemas/seat_uid' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - access_seat: - description: True if the seat is part of Access. - example: false - type: boolean - gateway_seat: - description: True if the seat is part of Gateway. - example: false - type: boolean - seat_uid: - description: The unique API identifier for the Zero Trust seat. - users_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - users_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result_info: - properties: - count: - example: 1 - page: - example: 1 - per_page: - example: 100 - total_count: - example: 1 - type: object - - properties: - result: - items: - $ref: '#/components/schemas/users' - type: array - users: - properties: - access_seat: - $ref: '#/components/schemas/schemas-access_seat' - active_device_count: - $ref: '#/components/schemas/active_device_count' - created_at: - $ref: '#/components/schemas/timestamp' - email: - $ref: '#/components/schemas/components-schemas-email' - gateway_seat: - $ref: '#/components/schemas/schemas-gateway_seat' - id: - $ref: '#/components/schemas/users_components-schemas-id' - last_successful_login: - $ref: '#/components/schemas/last_successful_login' - name: - $ref: '#/components/schemas/users_components-schemas-name' - seat_uid: - $ref: '#/components/schemas/seat_uid' - uid: - $ref: '#/components/schemas/uid' - updated_at: - $ref: '#/components/schemas/timestamp' - type: object - schemas-access_seat: - description: True if the user has authenticated with Cloudflare Access. - example: false - type: boolean - active_device_count: - description: The number of active devices registered to the user. - example: 2 - type: number - components-schemas-email: - description: The email of the user. - example: jdoe@example.com - format: email - type: string - schemas-gateway_seat: - description: True if the user has logged into the WARP client. - example: false - type: boolean - users_components-schemas-id: - description: The ID of the user. - example: f3b12456-80dd-4e89-9f5f-ba3dfff12365 - last_successful_login: - description: The time at which the user last successfully logged in. - example: '2020-07-01T05:20:00Z' - format: date-time - type: string - users_components-schemas-name: - description: The name of the user. - example: Jane Doe - type: string - uid: - description: The unique API identifier for the user. - failed_login_response: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - properties: - expiration: - type: integer - metadata: - example: - app_name: Test App - aud: 39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04 - datetime: '2022-02-02T21:54:34.914Z' - ray_id: 6d76a8a42ead4133 - user_email: test@cloudflare.com - user_uuid: 57171132-e453-4ee8-b2a5-8cbaad333207 - type: object - type: object - type: array - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - accounts_gateway_app_types: - id: cloudflare.zero_trust.accounts_gateway_app_types - name: accounts_gateway_app_types - title: Accounts Gateway App Types - methods: - gateway_application_and_application_type_mappings_list_application_and_application_type_mappings: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1app_types/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _gateway_application_and_application_type_mappings_list_application_and_application_type_mappings: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1app_types/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_app_types/methods/gateway_application_and_application_type_mappings_list_application_and_application_type_mappings' - insert: [] - update: [] - delete: [] - accounts_gateway_categories: - id: cloudflare.zero_trust.accounts_gateway_categories - name: accounts_gateway_categories - title: Accounts Gateway Categories - methods: - gateway_categories_list_categories: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1gateway~1categories/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _gateway_categories_list_categories: - operation: - $ref: '#/paths/~1accounts~1{account_id}~1gateway~1categories/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_categories/methods/gateway_categories_list_categories' - insert: [] - update: [] - delete: [] - accounts_gateway_locations: - id: cloudflare.zero_trust.accounts_gateway_locations - name: accounts_gateway_locations - title: Accounts Gateway Locations - methods: - gateway_locations_list_zero_trust_gateway_locations: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _gateway_locations_list_zero_trust_gateway_locations: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_locations_create_zero_trust_gateway_location: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1locations/post' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_locations_delete_zero_trust_gateway_location: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1locations~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_locations_zero_trust_gateway_location_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1locations~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _gateway_locations_zero_trust_gateway_location_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1locations~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_locations_update_zero_trust_gateway_location: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1locations~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_locations/methods/gateway_locations_list_zero_trust_gateway_locations' - - $ref: '#/components/x-stackQL-resources/accounts_gateway_locations/methods/gateway_locations_zero_trust_gateway_location_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_locations/methods/gateway_locations_create_zero_trust_gateway_location' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_locations/methods/gateway_locations_delete_zero_trust_gateway_location' - accounts_gateway_proxy_endpoints: - id: cloudflare.zero_trust.accounts_gateway_proxy_endpoints - name: accounts_gateway_proxy_endpoints - title: Accounts Gateway Proxy Endpoints - methods: - gateway_proxy_endpoints_list_proxy_endpoints: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1proxy_endpoints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _gateway_proxy_endpoints_list_proxy_endpoints: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1proxy_endpoints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_proxy_endpoints_create_proxy_endpoint: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1proxy_endpoints/post' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_proxy_endpoints_delete_proxy_endpoint: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1proxy_endpoints~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_proxy_endpoints_proxy_endpoint_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1proxy_endpoints~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _gateway_proxy_endpoints_proxy_endpoint_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1proxy_endpoints~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_proxy_endpoints_update_proxy_endpoint: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1proxy_endpoints~1{uuid}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_proxy_endpoints/methods/gateway_proxy_endpoints_list_proxy_endpoints' - - $ref: '#/components/x-stackQL-resources/accounts_gateway_proxy_endpoints/methods/gateway_proxy_endpoints_proxy_endpoint_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_proxy_endpoints/methods/gateway_proxy_endpoints_create_proxy_endpoint' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_proxy_endpoints/methods/gateway_proxy_endpoints_delete_proxy_endpoint' - accounts_gateway_rules: - id: cloudflare.zero_trust.accounts_gateway_rules - name: accounts_gateway_rules - title: Accounts Gateway Rules - methods: - gateway_rules_list_zero_trust_gateway_rules: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _gateway_rules_list_zero_trust_gateway_rules: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_rules_create_zero_trust_gateway_rule: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_rules_delete_zero_trust_gateway_rule: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1rules~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_rules_zero_trust_gateway_rule_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1rules~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _gateway_rules_zero_trust_gateway_rule_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1rules~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - gateway_rules_update_zero_trust_gateway_rule: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1rules~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_rules/methods/gateway_rules_list_zero_trust_gateway_rules' - - $ref: '#/components/x-stackQL-resources/accounts_gateway_rules/methods/gateway_rules_zero_trust_gateway_rule_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_rules/methods/gateway_rules_create_zero_trust_gateway_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_rules/methods/gateway_rules_delete_zero_trust_gateway_rule' - accounts_gateway_lists: - id: cloudflare.zero_trust.accounts_gateway_lists - name: accounts_gateway_lists - title: Accounts Gateway Lists - methods: - lists_list_zero_trust_lists: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _lists_list_zero_trust_lists: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists/get' - response: - mediaType: application/json - openAPIDocKey: '200' - lists_create_zero_trust_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists/post' - response: - mediaType: application/json - openAPIDocKey: '200' - lists_delete_zero_trust_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists~1{uuid}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - lists_zero_trust_list_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _lists_zero_trust_list_details: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists~1{uuid}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - lists_patch_zero_trust_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists~1{uuid}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - lists_update_zero_trust_list: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists~1{uuid}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_lists/methods/lists_list_zero_trust_lists' - - $ref: '#/components/x-stackQL-resources/accounts_gateway_lists/methods/lists_zero_trust_list_details' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_lists/methods/lists_create_zero_trust_list' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_lists/methods/lists_delete_zero_trust_list' - accounts_gateway_lists_items: - id: cloudflare.zero_trust.accounts_gateway_lists_items - name: accounts_gateway_lists_items - title: Accounts Gateway Lists Items - methods: - lists_zero_trust_list_items: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists~1{uuid}~1items/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _lists_zero_trust_list_items: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1lists~1{uuid}~1items/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_lists_items/methods/lists_zero_trust_list_items' - insert: [] - update: [] - delete: [] - accounts_devices_settings: - id: cloudflare.zero_trust.accounts_devices_settings - name: accounts_devices_settings - title: Accounts Devices Settings - methods: - accounts_get_device_settings_for_zero_trust_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _accounts_get_device_settings_for_zero_trust_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - accounts_update_device_settings_for_the_zero_trust_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1devices~1settings/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_devices_settings/methods/accounts_get_device_settings_for_zero_trust_account' - insert: [] - update: [] - delete: [] - accounts_gateway: - id: cloudflare.zero_trust.accounts_gateway - name: accounts_gateway - title: Accounts Gateway - methods: - accounts_get_zero_trust_account_information: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _accounts_get_zero_trust_account_information: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway/get' - response: - mediaType: application/json - openAPIDocKey: '200' - accounts_create_zero_trust_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway/methods/accounts_get_zero_trust_account_information' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_gateway/methods/accounts_create_zero_trust_account' - update: [] - delete: [] - accounts_gateway_configuration: - id: cloudflare.zero_trust.accounts_gateway_configuration - name: accounts_gateway_configuration - title: Accounts Gateway Configuration - methods: - accounts_get_zero_trust_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1configuration/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _accounts_get_zero_trust_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1configuration/get' - response: - mediaType: application/json - openAPIDocKey: '200' - accounts_update_zero_trust_account_configuration: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1configuration/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_configuration/methods/accounts_get_zero_trust_account_configuration' - insert: [] - update: [] - delete: [] - accounts_gateway_logging: - id: cloudflare.zero_trust.accounts_gateway_logging - name: accounts_gateway_logging - title: Accounts Gateway Logging - methods: - accounts_get_logging_settings_for_the_zero_trust_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1logging/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _accounts_get_logging_settings_for_the_zero_trust_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1logging/get' - response: - mediaType: application/json - openAPIDocKey: '200' - accounts_update_logging_settings_for_the_zero_trust_account: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1gateway~1logging/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_gateway_logging/methods/accounts_get_logging_settings_for_the_zero_trust_account' - insert: [] - update: [] - delete: [] - accounts_access_organizations: - id: cloudflare.zero_trust.accounts_access_organizations - name: accounts_access_organizations - title: Accounts Access Organizations - methods: - organization_get_your_zero_trust_organization: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _organization_get_your_zero_trust_organization: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organization_create_your_zero_trust_organization: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1organizations/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organization_update_your_zero_trust_organization: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1organizations/put' - response: - mediaType: application/json - openAPIDocKey: '200' - organization_revoke_all_access_tokens_for_a_user: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1organizations~1revoke_user/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_access_organizations/methods/organization_get_your_zero_trust_organization' - insert: - - $ref: '#/components/x-stackQL-resources/accounts_access_organizations/methods/organization_create_your_zero_trust_organization' - update: [] - delete: [] - accounts_access_seats: - id: cloudflare.zero_trust.accounts_access_seats - name: accounts_access_seats - title: Accounts Access Seats - methods: - seats_update_a_user_seat: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1seats/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - accounts_access_users: - id: cloudflare.zero_trust.accounts_access_users - name: accounts_access_users - title: Accounts Access Users - methods: - users_get_users: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1users/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _users_get_users: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1users/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_access_users/methods/users_get_users' - insert: [] - update: [] - delete: [] - accounts_access_users_failed_logins: - id: cloudflare.zero_trust.accounts_access_users_failed_logins - name: accounts_access_users_failed_logins - title: Accounts Access Users Failed Logins - methods: - users_get_failed_logins: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1users~1{id}~1failed_logins/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _users_get_failed_logins: - operation: - $ref: '#/paths/~1accounts~1{identifier}~1access~1users~1{id}~1failed_logins/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts_access_users_failed_logins/methods/users_get_failed_logins' - insert: [] - update: [] - delete: [] - zones_access_organizations: - id: cloudflare.zero_trust.zones_access_organizations - name: zones_access_organizations - title: Zones Access Organizations - methods: - zone_level_zero_trust_organization_get_your_zero_trust_organization: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_level_zero_trust_organization_get_your_zero_trust_organization: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_zero_trust_organization_create_your_zero_trust_organization: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1organizations/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_zero_trust_organization_update_your_zero_trust_organization: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1organizations/put' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_level_zero_trust_organization_revoke_all_access_tokens_for_a_user: - operation: - $ref: '#/paths/~1zones~1{identifier}~1access~1organizations~1revoke_user/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones_access_organizations/methods/zone_level_zero_trust_organization_get_your_zero_trust_organization' - insert: - - $ref: '#/components/x-stackQL-resources/zones_access_organizations/methods/zone_level_zero_trust_organization_create_your_zero_trust_organization' - update: [] - delete: [] -paths: - '/accounts/{identifier}/gateway/app_types': - get: - description: List all Application and Application Type mappings. - operationId: zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/app-types_components-schemas-response_collection' - description: List Application and Application Type mappings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/app-types_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Application and Application Type mappings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Application and Application Type mappings - tags: - - Zero Trust Gateway Application and Application Type mappings - '/accounts/{account_id}/gateway/categories': - get: - description: List all Categories. - operationId: zero-trust-gateway-categories-list-categories - parameters: - - in: path - name: account_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/categories_components-schemas-response_collection' - description: List Categories response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/categories_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Categories response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Categories - tags: - - Zero Trust Gateway Categories - '/accounts/{identifier}/gateway/locations': - get: - description: List Zero Trust Gateway Locations for an account. - operationId: zero-trust-gateway-locations-list-zero-trust-gateway-locations - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/locations_components-schemas-response_collection' - description: List Zero Trust Gateway Locations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/locations_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Zero Trust Gateway Locations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Zero Trust Gateway Locations - tags: - - Zero Trust Gateway Locations - post: - description: Create a new Zero Trust Gateway Location. - operationId: zero-trust-gateway-locations-create-zero-trust-gateway-location - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - client_default: - $ref: '#/components/schemas/client-default' - ecs_support: - $ref: '#/components/schemas/ecs-support' - name: - $ref: '#/components/schemas/locations_components-schemas-name' - networks: - $ref: '#/components/schemas/network' - required: - - name - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/locations_components-schemas-single_response' - description: Create Zero Trust Gateway Location response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/locations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Zero Trust Gateway Location response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Zero Trust Gateway Location - tags: - - Zero Trust Gateway Locations - '/accounts/{identifier}/gateway/locations/{uuid}': - delete: - description: Delete a Zero Trust Gateway Location. - operationId: zero-trust-gateway-locations-delete-zero-trust-gateway-location - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/locations_components-schemas-empty_response' - description: Delete Zero Trust Gateway Location response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/locations_components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Zero Trust Gateway Location response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Zero Trust Gateway Location - tags: - - Zero Trust Gateway Locations - get: - description: Fetch a single Zero Trust Gateway Location. - operationId: zero-trust-gateway-locations-zero-trust-gateway-location-details - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/locations_components-schemas-single_response' - description: Zero Trust Gateway Location Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/locations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Zero Trust Gateway Location Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Zero Trust Gateway Location Details - tags: - - Zero Trust Gateway Locations - put: - description: Update a configured Zero Trust Gateway Location. - operationId: zero-trust-gateway-locations-update-zero-trust-gateway-location - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/locations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - client_default: - $ref: '#/components/schemas/client-default' - ecs_support: - $ref: '#/components/schemas/ecs-support' - name: - $ref: '#/components/schemas/locations_components-schemas-name' - networks: - $ref: '#/components/schemas/network' - required: - - name - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/locations_components-schemas-single_response' - description: Update Zero Trust Gateway Location response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/locations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Zero Trust Gateway Location response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Zero Trust Gateway Location - tags: - - Zero Trust Gateway Locations - '/accounts/{identifier}/gateway/proxy_endpoints': - get: - description: Fetch a single Zero Trust Gateway Proxy Endpoint. - operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-response_collection' - description: List Proxy Endpoints response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/proxy-endpoints_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Proxy Endpoints response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Proxy Endpoints - tags: - - Zero Trust Gateway Proxy Endpoints - post: - description: Create a new Zero Trust Gateway Proxy Endpoint. - operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - ips: - $ref: '#/components/schemas/components-schemas-ips' - name: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-name' - subdomain: - $ref: '#/components/schemas/schemas-subdomain' - required: - - name - - ips - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response' - description: Create Proxy Endpoint response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Proxy Endpoint response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Proxy Endpoint - tags: - - Zero Trust Gateway Proxy Endpoints - '/accounts/{identifier}/gateway/proxy_endpoints/{uuid}': - delete: - description: Delete a Zero Trust Gateway Proxy Endpoint. - operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-empty_response' - description: Delete Proxy Endpoint response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/proxy-endpoints_components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Proxy Endpoint response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Proxy Endpoint - tags: - - Zero Trust Gateway Proxy Endpoints - get: - description: List Zero Trust Gateway Proxy Endpoints for an account. - operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response' - description: Proxy Endpoint Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Proxy Endpoint Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Proxy Endpoint Details - tags: - - Zero Trust Gateway Proxy Endpoints - patch: - description: Update a new Zero Trust Gateway Proxy Endpoint. - operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - ips: - $ref: '#/components/schemas/components-schemas-ips' - name: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-name' - subdomain: - $ref: '#/components/schemas/schemas-subdomain' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response' - description: Update Proxy Endpoint response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Proxy Endpoint response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Proxy Endpoint - tags: - - Zero Trust Gateway Proxy Endpoints - '/accounts/{identifier}/gateway/rules': - get: - description: List Zero Trust Gateway Rules for an account. - operationId: zero-trust-gateway-rules-list-zero-trust-gateway-rules - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rules_components-schemas-response_collection' - description: List Zero Trust Gateway Rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rules_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Zero Trust Gateway Rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Zero Trust Gateway Rules - tags: - - Zero Trust Gateway Rules - post: - description: Create a new Zero Trust Gateway Rule. - operationId: zero-trust-gateway-rules-create-zero-trust-gateway-rule - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - action: - $ref: '#/components/schemas/rules_components-schemas-action-2' - description: - $ref: '#/components/schemas/rules_components-schemas-description-2' - device_posture: - $ref: '#/components/schemas/device_posture' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled-3' - filters: - $ref: '#/components/schemas/schemas-filters' - identity: - $ref: '#/components/schemas/identity' - name: - $ref: '#/components/schemas/rules_components-schemas-name-2' - precedence: - $ref: '#/components/schemas/schemas-precedence' - rule_settings: - $ref: '#/components/schemas/rule-settings' - traffic: - $ref: '#/components/schemas/traffic' - required: - - name - - action - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rules_components-schemas-single_response' - description: Create Zero Trust Gateway Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rules_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Zero Trust Gateway Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Zero Trust Gateway Rule - tags: - - Zero Trust Gateway Rules - '/accounts/{identifier}/gateway/rules/{uuid}': - delete: - description: Delete a Zero Trust Gateway Rule. - operationId: zero-trust-gateway-rules-delete-zero-trust-gateway-rule - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rules_components-schemas-empty_response' - description: Delete Zero Trust Gateway Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rules_components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Zero Trust Gateway Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Zero Trust Gateway Rule - tags: - - Zero Trust Gateway Rules - get: - description: Fetch a single Zero Trust Gateway Rule. - operationId: zero-trust-gateway-rules-zero-trust-gateway-rule-details - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rules_components-schemas-single_response' - description: Zero Trust Gateway Rule Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rules_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Zero Trust Gateway Rule Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Zero Trust Gateway Rule Details - tags: - - Zero Trust Gateway Rules - put: - description: Update a configured Zero Trust Gateway Rule. - operationId: zero-trust-gateway-rules-update-zero-trust-gateway-rule - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/rules_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - action: - $ref: '#/components/schemas/rules_components-schemas-action-2' - description: - $ref: '#/components/schemas/rules_components-schemas-description-2' - device_posture: - $ref: '#/components/schemas/device_posture' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled-3' - filters: - $ref: '#/components/schemas/schemas-filters' - identity: - $ref: '#/components/schemas/identity' - name: - $ref: '#/components/schemas/rules_components-schemas-name-2' - precedence: - $ref: '#/components/schemas/schemas-precedence' - rule_settings: - $ref: '#/components/schemas/rule-settings' - traffic: - $ref: '#/components/schemas/traffic' - required: - - name - - action - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/rules_components-schemas-single_response' - description: Update Zero Trust Gateway Rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/rules_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Zero Trust Gateway Rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Zero Trust Gateway Rule - tags: - - Zero Trust Gateway Rules - '/accounts/{identifier}/gateway/lists': - get: - description: List Zero Trust Lists for an account. - operationId: zero-trust-lists-list-zero-trust-lists - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists_components-schemas-response_collection' - description: List Zero Trust Lists response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Zero Trust Lists response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Zero Trust Lists - tags: - - Zero Trust Lists - post: - description: Create a new Zero Trust List. - operationId: zero-trust-lists-create-zero-trust-list - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/lists_components-schemas-description-2' - items: - $ref: '#/components/schemas/schemas-items' - name: - $ref: '#/components/schemas/lists_components-schemas-name-2' - type: - $ref: '#/components/schemas/lists_components-schemas-type' - required: - - name - - type - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/single_response_with_list_items' - description: Create Zero Trust List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/single_response_with_list_items' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Zero Trust List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Zero Trust List - tags: - - Zero Trust Lists - '/accounts/{identifier}/gateway/lists/{uuid}': - delete: - description: Delete a Zero Trust List. - operationId: zero-trust-lists-delete-zero-trust-list - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists_components-schemas-empty_response' - description: Delete Zero Trust List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists_components-schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Zero Trust List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Zero Trust List - tags: - - Zero Trust Lists - get: - description: Fetch a single Zero Trust List. - operationId: zero-trust-lists-zero-trust-list-details - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists_components-schemas-single_response' - description: Zero Trust List Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Zero Trust List Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Zero Trust List Details - tags: - - Zero Trust Lists - patch: - description: Append or remove an item from a configured Zero Trust List. - operationId: zero-trust-lists-patch-zero-trust-list - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - append: - $ref: '#/components/schemas/schemas-items' - remove: - description: A list of the item values you want to remove. - items: - $ref: '#/components/schemas/lists_components-schemas-value' - type: array - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists_components-schemas-single_response' - description: Patch Zero Trust List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Zero Trust List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Patch Zero Trust List - tags: - - Zero Trust Lists - put: - description: Update a configured Zero Trust List. - operationId: zero-trust-lists-update-zero-trust-list - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - description: - $ref: '#/components/schemas/lists_components-schemas-description-2' - name: - $ref: '#/components/schemas/lists_components-schemas-name-2' - required: - - name - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/lists_components-schemas-single_response' - description: Update Zero Trust List response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/lists_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Zero Trust List response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Zero Trust List - tags: - - Zero Trust Lists - '/accounts/{identifier}/gateway/lists/{uuid}/items': - get: - description: Fetch all items of a single Zero Trust List. - operationId: zero-trust-lists-zero-trust-list-items - parameters: - - in: path - name: uuid - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-uuid' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/lists_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/list_item_response_collection' - description: Zero Trust List Items response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/list_item_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Zero Trust List Items response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Zero Trust List Items - tags: - - Zero Trust Lists - '/accounts/{identifier}/devices/settings': - get: - description: Describes the current device settings Zero Trust account. - operationId: zero-trust-accounts-get-device-settings-for-zero-trust-account - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway-account-device-settings-response' - description: Get device settings for Zero Trust account response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway-account-device-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get device settings for Zero Trust account response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get device settings for Zero Trust account - tags: - - Zero Trust accounts - put: - description: Updates the current device settings for Zero Trust account. - operationId: zero-trust-accounts-update-device-settings-for-the-zero-trust-account - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/gateway-account-device-settings' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway-account-device-settings-response' - description: Update device settings for the Zero Trust account response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway-account-device-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update device settings for the Zero Trust account response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update device settings for the Zero Trust account - tags: - - Zero Trust accounts - '/accounts/{identifier}/gateway': - get: - description: Get Zero Trust account information. - operationId: zero-trust-accounts-get-zero-trust-account-information - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway_account' - description: Get Zero Trust account information response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway_account' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Zero Trust account information response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Zero Trust account information - tags: - - Zero Trust accounts - post: - description: Create Zero Trust account with existing cloudflare account. - operationId: zero-trust-accounts-create-zero-trust-account - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - account_id: - $ref: '#/components/schemas/cf_account_id' - required: - - account_id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway_account' - description: Create Zero Trust account response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway_account' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Zero Trust account response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Zero Trust account - tags: - - Zero Trust accounts - '/accounts/{identifier}/gateway/configuration': - get: - description: Describes current Zero Trust account configuration. - operationId: zero-trust-accounts-get-zero-trust-account-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway_account_config' - description: Get Zero Trust account configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway_account_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Zero Trust account configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Zero Trust account configuration - tags: - - Zero Trust accounts - put: - description: Updates the current Zero Trust account configuration. - operationId: zero-trust-accounts-update-zero-trust-account-configuration - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/gateway-account-settings' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway_account_config' - description: Update Zero Trust account configuration response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway_account_config' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Zero Trust account configuration response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Zero Trust account configuration - tags: - - Zero Trust accounts - '/accounts/{identifier}/gateway/logging': - get: - description: Describes the current logging settings for Zero Trust account. - operationId: zero-trust-accounts-get-logging-settings-for-the-zero-trust-account - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway-account-logging-settings-response' - description: Get logging settings for the Zero Trust account response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway-account-logging-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get logging settings for the Zero Trust account response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get logging settings for the Zero Trust account - tags: - - Zero Trust accounts - put: - description: Updates the current logging settings for the Zero Trust accounty. - operationId: zero-trust-accounts-update-logging-settings-for-the-zero-trust-account - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/accounts_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/gateway-account-logging-settings' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/gateway-account-logging-settings-response' - description: Update logging settings for the Zero Trust account response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/gateway-account-logging-settings-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update logging settings for the Zero Trust account response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update logging settings for the Zero Trust account - tags: - - Zero Trust accounts - '/accounts/{identifier}/access/organizations': - get: - description: Returns the configuration for your Zero Trust organization. - operationId: zero-trust-organization-get-your-zero-trust-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/organizations_components-schemas-single_response' - description: Get your Zero Trust organization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/organizations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get your Zero Trust organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get your Zero Trust organization - tags: - - Zero Trust organization - post: - description: Sets up a Zero Trust organization for your account. - operationId: zero-trust-organization-create-your-zero-trust-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - auth_domain: - $ref: '#/components/schemas/auth_domain' - is_ui_read_only: - $ref: '#/components/schemas/is_ui_read_only' - login_design: - $ref: '#/components/schemas/login_design' - name: - $ref: '#/components/schemas/organizations_components-schemas-name' - required: - - name - - auth_domain - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/organizations_components-schemas-single_response' - description: Create your Zero Trust organization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/organizations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create your Zero Trust organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create your Zero Trust organization - tags: - - Zero Trust organization - put: - description: Updates the configuration for your Zero Trust organization. - operationId: zero-trust-organization-update-your-zero-trust-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - auth_domain: - $ref: '#/components/schemas/auth_domain' - is_ui_read_only: - $ref: '#/components/schemas/is_ui_read_only' - login_design: - $ref: '#/components/schemas/login_design' - name: - $ref: '#/components/schemas/organizations_components-schemas-name' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/organizations_components-schemas-single_response' - description: Update your Zero Trust organization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/organizations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update your Zero Trust organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update your Zero Trust organization - tags: - - Zero Trust organization - '/accounts/{identifier}/access/organizations/revoke_user': - post: - description: Revokes a user's access across all applications. - operationId: zero-trust-organization-revoke-all-access-tokens-for-a-user - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - email: - description: The email of the user to revoke. - example: test@example.com - type: string - required: - - email - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-empty_response' - description: Revoke all Access tokens for a user response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Revoke all Access tokens for a user response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Revoke all Access tokens for a user - tags: - - Zero Trust organization - '/accounts/{identifier}/access/seats': - patch: - description: Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false. - operationId: zero-trust-seats-update-a-user-seat - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/seats_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/seats_definition' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/seats_components-schemas-response_collection' - description: Update a user seat response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/seats_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a user seat response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a user seat - tags: - - Zero Trust seats - '/accounts/{identifier}/access/users': - get: - description: Gets a list of users for an account. - operationId: zero-trust-users-get-users - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/users_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/users_components-schemas-response_collection' - description: Get users response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/users_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get users response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get users - tags: - - Zero Trust users - '/accounts/{identifier}/access/users/{id}/failed_logins': - get: - description: Get all failed login attempts for a single user. - operationId: zero-trust-users-get-failed-logins - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/users_components-schemas-id' - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/users_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/failed_login_response' - description: Get failed logins response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/failed_login_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get failed logins response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get failed logins - tags: - - Zero Trust users - '/zones/{identifier}/access/organizations': - get: - description: Returns the configuration for your Zero Trust organization. - operationId: zone-level-zero-trust-organization-get-your-zero-trust-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/organizations_components-schemas-single_response' - description: Get your Zero Trust organization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/organizations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get your Zero Trust organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get your Zero Trust organization - tags: - - Zone-Level Zero Trust organization - post: - description: Sets up a Zero Trust organization for your account. - operationId: zone-level-zero-trust-organization-create-your-zero-trust-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - auth_domain: - $ref: '#/components/schemas/auth_domain' - is_ui_read_only: - $ref: '#/components/schemas/is_ui_read_only' - login_design: - $ref: '#/components/schemas/login_design' - name: - $ref: '#/components/schemas/organizations_components-schemas-name' - required: - - name - - auth_domain - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/organizations_components-schemas-single_response' - description: Create your Zero Trust organization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/organizations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create your Zero Trust organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create your Zero Trust organization - tags: - - Zone-Level Zero Trust organization - put: - description: Updates the configuration for your Zero Trust organization. - operationId: zone-level-zero-trust-organization-update-your-zero-trust-organization - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - auth_domain: - $ref: '#/components/schemas/auth_domain' - is_ui_read_only: - $ref: '#/components/schemas/is_ui_read_only' - login_design: - $ref: '#/components/schemas/login_design' - name: - $ref: '#/components/schemas/organizations_components-schemas-name' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/organizations_components-schemas-single_response' - description: Update your Zero Trust organization response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/organizations_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update your Zero Trust organization response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update your Zero Trust organization - tags: - - Zone-Level Zero Trust organization - '/zones/{identifier}/access/organizations/revoke_user': - post: - description: Revokes a user's access across all applications. - operationId: zone-level-zero-trust-organization-revoke-all-access-tokens-for-a-user - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/organizations_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - email: - description: The email of the user to revoke. - example: test@example.com - type: string - required: - - email - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-empty_response' - description: Revoke all Access tokens for a user response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-empty_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Revoke all Access tokens for a user response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Revoke all Access tokens for a user - tags: - - Zone-Level Zero Trust organization +openapi: 3.0.3 +info: + title: zero_trust API + description: Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience. To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources. Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API. To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). For information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/). + version: 4.0.0 + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: +- url: https://api.cloudflare.com/client/v4 +security: +- api_token: [] +paths: + /accounts/{account_id}/access/ai-controls/mcp/portals: + get: + description: Lists all MCP portals configured for the account. + operationId: mcp-portals-api-list-portals + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: search + schema: + description: Search by id, name, hostname + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + allow_code_mode: + default: true + description: Allow remote code execution in Dynamic Workers (beta) + type: boolean + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + type: string + hostname: + type: string + id: + description: portal id + maxLength: 32 + minLength: 1 + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + secure_web_gateway: + default: false + description: Route outbound MCP traffic through Zero Trust Secure Web Gateway + type: boolean + servers: + items: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + default_disabled: + default: false + type: boolean + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + on_behalf: + default: true + type: boolean + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + type: array + required: + - id + - name + - hostname + - servers + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: List objects + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List MCP Portals + tags: + - MCP Portal + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - portals + method: list + post: + description: Creates a new MCP portal for managing AI tool access through Cloudflare Access. + operationId: mcp-portals-api-create-portals + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_code_mode: + default: true + description: Allow remote code execution in Dynamic Workers (beta) + type: boolean + description: + maxLength: 512 + type: string + hostname: + type: string + id: + description: portal id + maxLength: 32 + minLength: 1 + type: string + name: + maxLength: 350 + type: string + secure_web_gateway: + default: false + description: Route outbound MCP traffic through Zero Trust Secure Web Gateway + type: boolean + servers: + items: + properties: + default_disabled: + default: false + type: boolean + on_behalf: + default: true + type: boolean + server_id: + description: server id + maxLength: 32 + minLength: 1 + type: string + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - server_id + type: object + maxItems: 20 + type: array + required: + - id + - name + - hostname + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + allow_code_mode: + default: true + description: Allow remote code execution in Dynamic Workers (beta) + type: boolean + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + type: string + hostname: + type: string + id: + description: portal id + maxLength: 32 + minLength: 1 + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + secure_web_gateway: + default: false + description: Route outbound MCP traffic through Zero Trust Secure Web Gateway + type: boolean + servers: + items: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + default_disabled: + default: false + type: boolean + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + on_behalf: + default: true + type: boolean + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + type: array + required: + - id + - name + - hostname + - servers + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the created Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new MCP Portal + tags: + - MCP Portal + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - portals + method: create + /accounts/{account_id}/access/ai-controls/mcp/portals/{id}: + delete: + description: Deletes an MCP portal from the account. + operationId: mcp-portals-api-delete-portals + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + allow_code_mode: + default: true + description: Allow remote code execution in Dynamic Workers (beta) + type: boolean + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + type: string + hostname: + type: string + id: + description: portal id + maxLength: 32 + minLength: 1 + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + secure_web_gateway: + default: false + description: Route outbound MCP traffic through Zero Trust Secure Web Gateway + type: boolean + required: + - id + - name + - hostname + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the Object if it was successfully deleted + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a MCP Portal + tags: + - MCP Portal + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - portals + method: delete + get: + operationId: mcp-portals-api-fetch-gateways + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + allow_code_mode: + default: true + description: Allow remote code execution in Dynamic Workers (beta) + type: boolean + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + type: string + hostname: + type: string + id: + description: portal id + maxLength: 32 + minLength: 1 + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + secure_web_gateway: + default: false + description: Route outbound MCP traffic through Zero Trust Secure Web Gateway + type: boolean + servers: + items: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + default_disabled: + default: false + type: boolean + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + on_behalf: + default: true + type: boolean + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + type: array + required: + - id + - name + - hostname + - servers + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a single object if found + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read details of an MCP Portal + tags: + - MCP Portal + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - portals + method: read + put: + description: Updates an MCP portal configuration. + operationId: mcp-portals-api-update-portals + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_code_mode: + default: true + description: Allow remote code execution in Dynamic Workers (beta) + type: boolean + description: + maxLength: 512 + type: string + hostname: + type: string + name: + maxLength: 350 + type: string + secure_web_gateway: + default: false + description: Route outbound MCP traffic through Zero Trust Secure Web Gateway + type: boolean + servers: + items: + properties: + default_disabled: + default: false + type: boolean + on_behalf: + default: true + type: boolean + server_id: + description: server id + maxLength: 32 + minLength: 1 + type: string + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - server_id + type: object + maxItems: 20 + type: array + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + allow_code_mode: + default: true + description: Allow remote code execution in Dynamic Workers (beta) + type: boolean + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + type: string + hostname: + type: string + id: + description: portal id + maxLength: 32 + minLength: 1 + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + secure_web_gateway: + default: false + description: Route outbound MCP traffic through Zero Trust Secure Web Gateway + type: boolean + servers: + items: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + default_disabled: + default: false + type: boolean + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + on_behalf: + default: true + type: boolean + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + description: + type: string + enabled: + type: boolean + name: + type: string + portal_alias: + type: string + server_alias: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + type: array + required: + - id + - name + - hostname + - servers + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a MCP Portal + tags: + - MCP Portal + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - portals + method: update + /accounts/{account_id}/access/ai-controls/mcp/servers: + get: + description: Lists all MCP portals configured for the account. + operationId: mcp-portals-api-list-servers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + - in: query + name: search + schema: + description: Search by id, name + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + items: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + type: array + success: + type: boolean + required: + - success + - result + type: object + description: List objects + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + message: + type: string + required: + - message + type: object + type: array + result: + type: object + success: + type: boolean + required: + - result + - success + - errors + type: object + description: Bad Request + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List MCP Servers + tags: + - MCP Portal Servers + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - servers + method: list + post: + description: Creates a new MCP portal for managing AI tool access through Cloudflare Access. + operationId: mcp-portals-api-create-servers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + auth_credentials: + type: string + x-sensitive: true + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + description: + maxLength: 512 + nullable: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + name: + maxLength: 350 + type: string + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + type: object + responses: + '201': + content: + application/json: + schema: + properties: + result: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the created Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new MCP Server + tags: + - MCP Portal Servers + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - servers + method: create + /accounts/{account_id}/access/ai-controls/mcp/servers/{id}: + delete: + description: Deletes an MCP portal from the account. + operationId: mcp-portals-api-delete-servers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the Object if it was successfully deleted + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a MCP Server + tags: + - MCP Portal Servers + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - servers + method: delete + get: + description: Retrieves gateway configuration for MCP portals. + operationId: mcp-portals-api-fetch-servers + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns a single object if found + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Read the details of a MCP Server + tags: + - MCP Portal Servers + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - servers + method: read + put: + description: Updates an MCP portal configuration. + operationId: mcp-portals-api-update-servers + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + auth_credentials: + type: string + x-sensitive: true + description: + maxLength: 512 + nullable: true + type: string + name: + maxLength: 350 + type: string + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + auth_type: + enum: + - oauth + - bearer + - unauthenticated + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + readOnly: true + type: string + description: + maxLength: 512 + nullable: true + type: string + error: + readOnly: true + type: string + hostname: + format: uri + type: string + id: + description: server id + maxLength: 32 + minLength: 1 + type: string + last_successful_sync: + format: date-time + readOnly: true + type: string + last_synced: + format: date-time + readOnly: true + type: string + modified_at: + format: date-time + readOnly: true + type: string + modified_by: + readOnly: true + type: string + name: + maxLength: 350 + type: string + prompts: + items: + type: object + readOnly: true + type: array + status: + default: waiting + readOnly: true + type: string + tools: + items: + type: object + readOnly: true + type: array + updated_prompts: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + updated_tools: + items: + properties: + alias: + maxLength: 40 + type: string + description: + type: string + enabled: + type: boolean + name: + type: string + required: + - name + type: object + type: array + required: + - id + - name + - hostname + - auth_type + - tools + - prompts + type: object + success: + type: boolean + required: + - success + - result + type: object + description: Returns the updated Object + '400': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + path: + items: + type: string + type: array + required: + - code + - message + - path + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Input Validation Error + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a MCP Server + tags: + - MCP Portal Servers + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - servers + method: update + /accounts/{account_id}/access/ai-controls/mcp/servers/{id}/sync: + post: + description: Syncs an MCP server's tool catalog with the portal. + operationId: mcp-portals-api-sync-server + parameters: + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + result: + type: object + success: + type: boolean + required: + - success + - result + type: object + description: '' + '404': + content: + application/json: + schema: + properties: + errors: + items: + properties: + code: + type: number + message: + type: string + required: + - code + - message + type: object + type: array + success: + enum: + - false + type: boolean + required: + - success + - errors + type: object + description: Not Found + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Sync MCP Server Capabilities + tags: + - MCP Portal Servers + x-cfPermissionsRequired: + enum: + - com.cloudflare.api.account.mcp_portals + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - ai_controls + - mcp + - servers + method: sync + /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}/make_reusable: + put: + description: Converts an application-scoped policy to a reusable policy. The policy will no longer be exclusively scoped to the application. Further updates to the policy should go through the /accounts/{account_id}/policies/{uid} endpoint. + operationId: access-policies-convert-reusable + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasResponseCollection' + description: Convert an Access application policy to a reusable policy + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Convert an Access application policy to a reusable policy failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Convert an Access application policy to a reusable policy + tags: + - Access application-scoped policies + x-api-token-group: + - 'Access: Apps and Policies Write' + /accounts/{account_id}/access/authenticator_device_aaguids: + get: + description: Returns a list of Authenticator Device AAGUIDs for MFA configuration. + operationId: access-authenticator-device-aaguids-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAuthenticatorDeviceAaguidsComponentsSchemasResponseCollection' + description: List authenticator device AAGUIDs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List authenticator device AAGUIDs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List authenticator device AAGUIDs + tags: + - Access Authenticator Device AAGUIDs + /accounts/{account_id}/access/bookmarks: + get: + deprecated: true + description: Lists Bookmark applications. + operationId: access-bookmark-applications-(-deprecated)-list-bookmark-applications + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessBookmarksComponentsSchemasResponseCollection' + description: List Bookmark applications response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Bookmark applications response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Bookmark applications + tags: + - Access Bookmark applications (Deprecated) + x-api-token-group: + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-cfDeprecation: + description: This endpoint is deprecated in favor of using a specialized Access Application App Type. + display: true + eol: '2023-03-19' + id: bookmarks_deprecation + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - bookmarks + method: list + /accounts/{account_id}/access/bookmarks/{bookmark_id}: + delete: + deprecated: true + description: Deletes a Bookmark application. + operationId: access-bookmark-applications-(-deprecated)-delete-a-bookmark-application + parameters: + - in: path + name: bookmark_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete a Bookmark application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete a Bookmark application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Bookmark application + tags: + - Access Bookmark applications (Deprecated) + x-api-token-group: + - 'Access: Apps and Policies Write' + x-cfDeprecation: + description: This endpoint is deprecated in favor of using a specialized Access Application App Type. + display: true + eol: '2023-03-19' + id: bookmarks_deprecation + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - bookmarks + method: delete + get: + deprecated: true + description: Fetches a single Bookmark application. + operationId: access-bookmark-applications-(-deprecated)-get-a-bookmark-application + parameters: + - in: path + name: bookmark_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessBookmarksComponentsSchemasSingleResponse' + description: Get a Bookmark application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get a Bookmark application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Bookmark application + tags: + - Access Bookmark applications (Deprecated) + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-cfDeprecation: + description: This endpoint is deprecated in favor of using a specialized Access Application App Type. + display: true + eol: '2023-03-19' + id: bookmarks_deprecation + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - bookmarks + method: get + post: + deprecated: true + description: Create a new Bookmark application. + operationId: access-bookmark-applications-(-deprecated)-create-a-bookmark-application + parameters: + - in: path + name: bookmark_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessBookmarksComponentsSchemasSingleResponse' + description: Create a Bookmark application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create a Bookmark application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Bookmark application + tags: + - Access Bookmark applications (Deprecated) + x-cfDeprecation: + description: This endpoint is deprecated in favor of using a specialized Access Application App Type. + display: true + eol: '2023-03-19' + id: bookmarks_deprecation + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - bookmarks + method: create + put: + deprecated: true + description: Updates a configured Bookmark application. + operationId: access-bookmark-applications-(-deprecated)-update-a-bookmark-application + parameters: + - in: path + name: bookmark_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessBookmarksComponentsSchemasSingleResponse' + description: Update a Bookmark application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update a Bookmark application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Bookmark application + tags: + - Access Bookmark applications (Deprecated) + x-api-token-group: + - 'Access: Apps and Policies Write' + x-cfDeprecation: + description: This endpoint is deprecated in favor of using a specialized Access Application App Type. + display: true + eol: '2023-03-19' + id: bookmarks_deprecation + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - bookmarks + method: update + /accounts/{account_id}/access/custom_pages: + get: + description: List custom pages + operationId: access-custom-pages-list-custom-pages + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 50 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCustomPagesComponentsSchemasResponseCollection' + description: List custom pages response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List custom pages response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List custom pages + tags: + - Access custom pages + x-api-token-group: + - 'Access: Custom Pages Write' + - 'Access: Custom Pages Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - custom_pages + method: list + post: + description: Create a custom page + operationId: access-custom-pages-create-a-custom-page + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessCustomPage' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponseWithoutHtml' + description: Create a custom page response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create a custom page response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a custom page + tags: + - Access custom pages + x-api-token-group: + - 'Access: Custom Pages Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - custom_pages + method: create + /accounts/{account_id}/access/custom_pages/{custom_page_id}: + delete: + description: Delete a custom page + operationId: access-custom-pages-delete-a-custom-page + parameters: + - in: path + name: custom_page_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasIdResponse' + description: Delete a custom page response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete a custom page response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a custom page + tags: + - Access custom pages + x-api-token-group: + - 'Access: Custom Pages Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - custom_pages + method: delete + get: + description: Fetches a custom page and also returns its HTML. + operationId: access-custom-pages-get-a-custom-page + parameters: + - in: path + name: custom_page_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCustomPagesComponentsSchemasSingleResponse' + description: Get a custom page response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get a custom page response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a custom page + tags: + - Access custom pages + x-api-token-group: + - 'Access: Custom Pages Write' + - 'Access: Custom Pages Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - custom_pages + method: get + put: + description: Update a custom page + operationId: access-custom-pages-update-a-custom-page + parameters: + - in: path + name: custom_page_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessCustomPage' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponseWithoutHtml' + description: Update a custom page response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update a custom page response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a custom page + tags: + - Access custom pages + x-api-token-group: + - 'Access: Custom Pages Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - custom_pages + method: update + /accounts/{account_id}/access/gateway_ca: + get: + description: Lists SSH Certificate Authorities (CA). + operationId: access-gateway-ca-list-SSH-ca + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGatewayCaComponentsSchemasResponseCollection' + description: List SSH Certificate Authorities (CA) response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List SSH Certificate Authorities (CA) response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List SSH Certificate Authorities (CA) + tags: + - Gateway CA + x-api-token-group: + - 'Access: SSH Auditing Write' + - 'Access: SSH Auditing Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - gateway_ca + method: list + post: + description: Adds a new SSH Certificate Authority (CA). + operationId: access-gateway-ca-add-an-SSH-ca + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGatewayCaComponentsSchemasSingleResponse' + description: Add a new SSH Certificate Authority (CA) response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Add a new SSH Certificate Authority (CA) response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add a new SSH Certificate Authority (CA) + tags: + - Gateway CA + x-api-token-group: + - 'Access: SSH Auditing Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - gateway_ca + method: create + /accounts/{account_id}/access/gateway_ca/{certificate_id}: + delete: + description: Deletes an SSH Certificate Authority. + operationId: access-gateway-ca-delete-an-SSH-ca + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete an SSH Certificate Authority (CA) response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an SSH Certificate Authority (CA) response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an SSH Certificate Authority (CA) + tags: + - Gateway CA + x-api-token-group: + - 'Access: SSH Auditing Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - gateway_ca + method: delete + /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/groups: + get: + description: Lists SCIM Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM). + operationId: access-identity-providers-list-scim-group-resources + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: cf_resource_id + schema: + $ref: '#/components/schemas/accessCfResourceId' + - in: query + name: idp_resource_id + schema: + $ref: '#/components/schemas/accessIdpResourceId' + - in: query + name: name + schema: + $ref: '#/components/schemas/accessGroupsName' + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 100 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessScimGroupsResponse' + description: List SCIM Group resources response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List SCIM Group resources response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List SCIM Group resources + tags: + - Access identity providers + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + - scim + - groups + method: list + /accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/users: + get: + description: Lists SCIM User resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM). + operationId: access-identity-providers-list-scim-user-resources + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: cf_resource_id + schema: + $ref: '#/components/schemas/accessUsersCfResourceId' + - in: query + name: idp_resource_id + schema: + $ref: '#/components/schemas/accessUsersIdpResourceId' + - in: query + name: username + schema: + $ref: '#/components/schemas/accessUsername' + - in: query + name: email + schema: + $ref: '#/components/schemas/accessEmail' + - in: query + name: name + schema: + $ref: '#/components/schemas/accessUsersName' + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 100 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessScimUsersResponse' + description: List SCIM User resources response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List SCIM User resources response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List SCIM User resources + tags: + - Access identity providers + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + - scim + - users + method: list + /accounts/{account_id}/access/keys: + get: + description: Gets the Access key rotation settings for an account. + operationId: access-key-configuration-get-the-access-key-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessKeysComponentsSchemasSingleResponse' + description: Get the Access key configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get the Access key configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Access key configuration + tags: + - Access key configuration + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - keys + method: get + put: + description: Updates the Access key rotation settings for an account. + operationId: access-key-configuration-update-the-access-key-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + key_rotation_interval_days: + $ref: '#/components/schemas/accessKeyRotationIntervalDays' + required: + - key_rotation_interval_days + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessKeysComponentsSchemasSingleResponse' + description: Update the Access key configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update the Access key configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update the Access key configuration + tags: + - Access key configuration + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - keys + method: update + /accounts/{account_id}/access/keys/rotate: + post: + description: Perfoms a key rotation for an account. + operationId: access-key-configuration-rotate-access-keys + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessKeysComponentsSchemasSingleResponse' + description: Rotate Access keys response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Rotate Access keys response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Rotate Access keys + tags: + - Access key configuration + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - keys + method: rotate + /accounts/{account_id}/access/logs/access_requests: + get: + description: Gets a list of Access authentication audit logs for an account. + operationId: access-authentication-logs-get-access-authentication-logs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The maximum number of log entries to retrieve. + in: query + name: limit + schema: + default: 25 + type: integer + - description: The chronological sorting order for the logs. + in: query + name: direction + schema: + default: desc + enum: + - desc + - asc + type: string + - description: The earliest event timestamp to query. + in: query + name: since + schema: + format: date-time + type: string + - description: The latest event timestamp to query. + in: query + name: until + schema: + format: date-time + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 25 + description: Number of results per page. + type: integer + - description: 'Filter by user email. Defaults to substring matching. To force exact matching, set `email_exact=true`. Example (default): `email=@example.com` returns all events with that domain. Example (exact): `email=user@example.com&email_exact=true` returns only that user.' + in: query + name: email + schema: + $ref: '#/components/schemas/accessComponentsSchemasEmail' + - description: When true, `email` is matched exactly instead of substring matching. + in: query + name: email_exact + schema: + default: false + type: boolean + - description: Filter by user UUID. + in: query + name: user_id + schema: + $ref: '#/components/schemas/accessUserId' + - description: Operator for the `allowed` filter. + in: query + name: allowedOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `country_code` filter. + in: query + name: country_codeOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `app_type` filter. + in: query + name: app_typeOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `app_uid` filter. + in: query + name: app_uidOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `ray_id` filter. + in: query + name: ray_idOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `email` filter. + in: query + name: emailOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `idp` filter. + in: query + name: idpOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `non_identity` filter. + in: query + name: non_identityOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Operator for the `user_id` filter. + in: query + name: user_idOp + schema: + default: eq + enum: + - eq + - neq + type: string + - description: Comma-separated list of fields to include in the response. When omitted, all fields are returned. + in: query + name: fields + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAccessRequestsComponentsSchemasResponseCollection' + description: Get Access authentication logs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get Access authentication logs response failure + security: + - api_email: [] + api_key: [] + summary: Get Access authentication logs + tags: + - Access authentication logs + x-api-token-group: + - 'Access: Audit Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - logs + - access_requests + method: list + /accounts/{account_id}/access/logs/scim/updates: + get: + description: Lists Access SCIM update logs that maintain a record of updates made to User and Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM). + operationId: access-scim-update-logs-list-access-scim-update-logs + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: limit + schema: + $ref: '#/components/schemas/accessLimit' + - in: query + name: direction + schema: + $ref: '#/components/schemas/accessDirection' + - in: query + name: since + schema: + $ref: '#/components/schemas/accessSince' + - in: query + name: until + schema: + $ref: '#/components/schemas/accessUntil' + - in: query + name: idp_id + schema: + $ref: '#/components/schemas/accessIdpId' + - in: query + name: status + schema: + $ref: '#/components/schemas/accessRequestsStatus' + - in: query + name: resource_type + schema: + $ref: '#/components/schemas/accessResourceType' + - in: query + name: request_method + schema: + $ref: '#/components/schemas/accessRequestMethod' + - in: query + name: resource_user_email + schema: + $ref: '#/components/schemas/accessResourceUserEmail' + - in: query + name: resource_group_name + schema: + $ref: '#/components/schemas/accessResourceGroupName' + - in: query + name: cf_resource_id + schema: + $ref: '#/components/schemas/accessRequestsCfResourceId' + - in: query + name: idp_resource_id + schema: + $ref: '#/components/schemas/accessRequestsIdpResourceId' + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 20 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessScimUpdateLogsResponse' + description: Get Access SCIM update logs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get Access SCIM update logs response failure + security: + - api_email: [] + api_key: [] + summary: List Access SCIM update logs + tags: + - Access SCIM update logs + x-api-token-group: + - 'Access: SCIM Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - logs + - scim + - updates + method: list + /accounts/{account_id}/access/organizations/doh: + get: + description: Returns the DoH settings for your Zero Trust organization. + operationId: zero-trust-organization-get-your-zero-trust-organization-doh-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + client_id: + $ref: '#/components/schemas/accessClientId' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + duration: + $ref: '#/components/schemas/accessDuration' + expires_at: + $ref: '#/components/schemas/accessTimestamp' + id: + description: The ID of the service token. + $ref: '#/components/schemas/accessUuid' + last_seen_at: + x-stainless-skip: true + $ref: '#/components/schemas/accessTimestamp' + name: + $ref: '#/components/schemas/accessSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + doh_jwt_duration: + description: "The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or \xB5s), ms, s, m, h. Note that the maximum duration for this setting is the same as the key rotation period on the account." + type: string + type: object + required: + - success + - errors + - messages + description: Get your Zero Trust organization DoH settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get your Zero Trust organization DoH settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get your Zero Trust organization DoH settings + tags: + - Zero Trust organization + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Revoke' + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + - doh + method: get + put: + description: Updates the DoH settings for your Zero Trust organization. + operationId: zero-trust-organization-update-your-zero-trust-organization-doh-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + doh_jwt_duration: + $ref: '#/components/schemas/accessDohJwtDuration' + service_token_id: + description: The uuid of the service token you want to use for DoH authentication + type: string + type: object + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + client_id: + $ref: '#/components/schemas/accessClientId' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + duration: + $ref: '#/components/schemas/accessDuration' + expires_at: + $ref: '#/components/schemas/accessTimestamp' + id: + description: The ID of the service token. + $ref: '#/components/schemas/accessUuid' + last_seen_at: + x-stainless-skip: true + $ref: '#/components/schemas/accessTimestamp' + name: + $ref: '#/components/schemas/accessSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + doh_jwt_duration: + $ref: '#/components/schemas/accessDohJwtDuration' + type: object + required: + - success + - errors + - messages + description: Update your Zero Trust organization DoH settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update your Zero Trust organization DoH settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update your Zero Trust organization DoH settings + tags: + - Zero Trust organization + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + - doh + method: update + /accounts/{account_id}/access/policies: + get: + description: Lists Access reusable policies. + operationId: access-policies-list-access-reusable-policies + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 100 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessReusablePoliciesComponentsSchemasResponseCollection' + description: List Access reusable policies response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access reusable policies response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access reusable policies + tags: + - Access reusable policies + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - policies + method: list + post: + description: Creates a new Access reusable policy. + operationId: access-policies-create-an-access-reusable-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyReq' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessReusablePoliciesComponentsSchemasSingleResponse' + description: Create an Access reusable policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create an Access reusable policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an Access reusable policy + tags: + - Access reusable policies + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - policies + method: create + /accounts/{account_id}/access/policies/{policy_id}: + delete: + description: Deletes an Access reusable policy. + operationId: access-policies-delete-an-access-reusable-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessReusablePoliciesComponentsSchemasIdResponse' + description: Delete an Access reusable policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access reusable policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access reusable policy + tags: + - Access reusable policies + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - policies + method: delete + get: + description: Fetches a single Access reusable policy. + operationId: access-policies-get-an-access-reusable-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessReusablePoliciesComponentsSchemasSingleResponse' + description: Get an Access reusable policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access reusable policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access reusable policy + tags: + - Access reusable policies + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - policies + method: get + put: + description: Updates a Access reusable policy. + operationId: access-policies-update-an-access-reusable-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessReusablePoliciesComponentsSchemasSingleResponse' + description: Update an Access reusable policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access reusable policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access reusable policy + tags: + - Access reusable policies + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - policies + method: update + /accounts/{account_id}/access/policy-tests: + post: + description: Starts an Access policy test. + operationId: access-policy-tests + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyInitReq' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyInitResp' + description: Start Access policy test response. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Start Access policy test response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Start Access policy test + tags: + - Access policy tester + x-api-token-group: + - 'Access: Policy Test Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policy_tests + method: create + /accounts/{account_id}/access/policy-tests/{policy_test_id}: + get: + description: Fetches the current status of a given Access policy test. + operationId: access-policy-tests-get-an-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: policy_test_id + schema: + $ref: '#/components/schemas/accessPolicyTestId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyUpdateResp' + description: Get an Access policy test update response. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access policy test update response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the current status of a given Access policy test + tags: + - Access policy tester + x-api-token-group: + - 'Access: Policy Test Write' + - 'Access: Policy Test Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policy_tests + method: get + /accounts/{account_id}/access/policy-tests/{policy_test_id}/users: + get: + description: Fetches a single page of user results from an Access policy test. + operationId: access-policy-tests-get-a-user-page + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: policy_test_id + schema: + $ref: '#/components/schemas/accessPolicyTestId' + required: true + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 25 + type: integer + - description: Filter users by their policy evaluation status. + in: query + name: status + schema: + enum: + - success + - fail + - error + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyUsersResp' + description: Get an Access policy tester users page response. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access policy tester users page response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access policy test users page + tags: + - Access policy tester + x-api-token-group: + - 'Access: Policy Test Write' + - 'Access: Policy Test Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policy_tests + - users + method: list + /accounts/{account_id}/access/seats: + patch: + description: Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false. + operationId: zero-trust-seats-update-a-user-seat + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessSeatsDefinition' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSeatsComponentsSchemasResponseCollection' + description: Update a user seat response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update a user seat response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a user seat + tags: + - Zero Trust seats + x-api-token-group: + - 'Zero Trust: Seats Write' + /accounts/{account_id}/access/service_tokens/{service_token_id}/refresh: + post: + description: Refreshes the expiration of a service token. + operationId: access-service-tokens-refresh-a-service-token + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasSingleResponse' + description: Refresh a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Refresh a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Refresh a service token + tags: + - Access service tokens + x-api-token-group: + - 'Access: Service Tokens Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: refresh + /accounts/{account_id}/access/service_tokens/{service_token_id}/rotate: + post: + description: Generates a new Client Secret for a service token and revokes the old one. + operationId: access-service-tokens-rotate-a-service-token + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + previous_client_secret_expires_at: + description: The expiration of the previous `client_secret`. If not provided, it defaults to the current timestamp in order to immediately expire the previous secret. + format: date-time + type: string + x-auditable: true + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCreateResponse' + description: Rotate a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Rotate a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Rotate a service token + tags: + - Access service tokens + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: rotate + /accounts/{account_id}/access/tags: + get: + description: List tags + operationId: access-tags-list-tags + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 50 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessTagsComponentsSchemasResponseCollection' + description: List tags response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List tags response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List tags + tags: + - Access tags + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - tags + method: list + post: + description: Create a tag + operationId: access-tags-create-tag + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + $ref: '#/components/schemas/accessTagsComponentsSchemasName' + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessTagsComponentsSchemasSingleResponse' + description: Create a tag response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create a tag response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a tag + tags: + - Access tags + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - tags + method: create + /accounts/{account_id}/access/tags/{tag_name}: + delete: + description: Delete a tag + operationId: access-tags-delete-a-tag + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: tag_name + schema: + $ref: '#/components/schemas/accessTagsComponentsSchemasName' + required: true + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessNameResponse' + description: Delete a tag response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete a tag response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a tag + tags: + - Access tags + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - tags + method: delete + get: + description: Get a tag + operationId: access-tags-get-a-tag + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: tag_name + schema: + $ref: '#/components/schemas/accessTagsComponentsSchemasName' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessTagsComponentsSchemasSingleResponse' + description: Get a tag response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get a tag response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a tag + tags: + - Access tags + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - tags + method: get + put: + description: Update a tag + operationId: access-tags-update-a-tag + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: tag_name + schema: + $ref: '#/components/schemas/accessTagsComponentsSchemasName' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessTagWithoutAppCount' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessTagsComponentsSchemasSingleResponse' + description: Update a tag response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update a tag response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a tag + tags: + - Access tags + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - tags + method: update + /accounts/{account_id}/access/users: + get: + description: Gets a list of users for an account. + operationId: zero-trust-users-get-users + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: The name of the user. + type: string + - in: query + name: email + schema: + description: The email of the user. + type: string + - in: query + name: search + schema: + description: Search for users by other listed query parameters. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 1000 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessUsersComponentsSchemasResponseCollection' + description: Get users response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get users response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get users + tags: + - Zero Trust users + x-api-token-group: + - 'Access: Audit Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + method: list + post: + description: Creates a new user. + operationId: zero-trust-users-create-user + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + email: + $ref: '#/components/schemas/accessSchemasEmail' + name: + $ref: '#/components/schemas/accessUsersComponentsSchemasName' + required: + - email + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleUserResponse' + description: Create user response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create user response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a user + tags: + - Zero Trust users + x-api-token-group: null + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + method: create + /accounts/{account_id}/access/users/{user_id}: + delete: + description: Deletes a specific user for an account. This will also revoke any active seats and tokens for the user. + operationId: zero-trust-users-delete-user + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessDeleteUserResponse' + description: Delete user response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete user response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a user + tags: + - Zero Trust users + x-api-token-group: null + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + method: delete + get: + description: Gets a specific user for an account. + operationId: zero-trust-users-get-user + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleUserResponse' + description: Get user response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get user response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a user + tags: + - Zero Trust users + x-api-token-group: + - 'Access: Audit Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + method: get + put: + description: Updates a specific user's name for an account. Requires the user's current email as confirmation (email cannot be changed). + operationId: zero-trust-users-update-user + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + email: + $ref: '#/components/schemas/accessSchemasEmail' + name: + $ref: '#/components/schemas/accessUsersComponentsSchemasName' + required: + - name + - email + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleUserResponse' + description: Update user response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update user response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a user + tags: + - Zero Trust users + x-api-token-group: + - 'Zero Trust: Seats Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + method: update + /accounts/{account_id}/access/users/{user_id}/active_sessions: + get: + description: Get active sessions for a single user. + operationId: zero-trust-users-get-active-sessions + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessActiveSessionsResponse' + description: Get active sessions response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get active sessions response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get active sessions + tags: + - Zero Trust users + x-api-token-group: + - 'Access: Audit Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + - active_sessions + method: list + /accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}: + get: + description: Get an active session for a single user. + operationId: zero-trust-users-get-active-session + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: nonce + schema: + $ref: '#/components/schemas/accessNonce' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessActiveSessionResponse' + description: Get active session response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get active session response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get single active session + tags: + - Zero Trust users + x-api-token-group: + - 'Access: Audit Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + - active_sessions + method: get + /accounts/{account_id}/access/users/{user_id}/failed_logins: + get: + description: Get all failed login attempts for a single user. + operationId: zero-trust-users-get-failed-logins + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessFailedLoginResponse' + description: Get failed logins response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get failed logins response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get failed logins + tags: + - Zero Trust users + x-api-token-group: + - 'Access: Audit Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + - failed_logins + method: list + /accounts/{account_id}/access/users/{user_id}/last_seen_identity: + get: + description: Get last seen identity for a single user. + operationId: zero-trust-users-get-last-seen-identity + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessLastSeenIdentityResponse' + description: Get active session response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get active session response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get last seen identity + tags: + - Zero Trust users + x-api-token-group: + - 'Access: Audit Logs Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - users + - last_seen_identity + method: get + /accounts/{account_id}/access/users/{user_id}/mfa_authenticators/{authenticator_id}: + delete: + description: Deletes a specific MFA device for a user. This action is only available if MFA is turned on for the organization. + operationId: zero-trust-users-delete-mfa-authenticator + parameters: + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: authenticator_id + schema: + $ref: '#/components/schemas/accessAuthenticatorId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessDeleteAuthenticatorResponse' + description: Delete authenticator response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete authenticator response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a user's MFA device + tags: + - Zero Trust users + x-api-token-group: null + /accounts/{account_id}/cfd_tunnel: + get: + description: Lists and filters Cloudflare Tunnels in an account. + operationId: cloudflare-tunnel-list-cloudflare-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + $ref: '#/components/schemas/tunnelTunnelName' + - in: query + name: is_deleted + schema: + description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included. + type: boolean + - in: query + name: existed_at + schema: + $ref: '#/components/schemas/tunnelExistedAt' + - in: query + name: uuid + schema: + $ref: '#/components/schemas/tunnelTunnelId' + - in: query + name: was_active_at + schema: + format: date-time + type: string + - in: query + name: was_inactive_at + schema: + format: date-time + type: string + - in: query + name: include_prefix + schema: + type: string + - in: query + name: exclude_prefix + schema: + type: string + - in: query + name: status + schema: + $ref: '#/components/schemas/tunnelStatus' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/tunnelPerPage' + - in: query + name: page + schema: + $ref: '#/components/schemas/tunnelPageNumber' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelCfdTunnelResponseCollection' + description: List Cloudflare Tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelCfdTunnel' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Cloudflare Tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Cloudflare Tunnels + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: cloudflared Write' + - 'Cloudflare One Connector: cloudflared Read' + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + method: list + post: + description: Creates a new Cloudflare Tunnel in an account. + operationId: cloudflare-tunnel-create-a-cloudflare-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + name: + $ref: '#/components/schemas/tunnelTunnelName' + tunnel_secret: + $ref: '#/components/schemas/tunnelTunnelSecret' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelCfdTunnelResponseSingle' + description: Create a Cloudflare Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + remote_config: + $ref: '#/components/schemas/tunnelRemoteConfig' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create a Cloudflare Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Cloudflare Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + method: create + /accounts/{account_id}/cfd_tunnel/{tunnel_id}: + delete: + description: Deletes a Cloudflare Tunnel from an account. + operationId: cloudflare-tunnel-delete-a-cloudflare-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelCfdTunnelResponseSingle' + description: Delete a Cloudflare Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + remote_config: + $ref: '#/components/schemas/tunnelRemoteConfig' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete a Cloudflare Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Cloudflare Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + method: delete + get: + description: Fetches a single Cloudflare Tunnel. + operationId: cloudflare-tunnel-get-a-cloudflare-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelCfdTunnelResponseSingle' + description: Get a Cloudflare Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + remote_config: + $ref: '#/components/schemas/tunnelRemoteConfig' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get a Cloudflare Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Cloudflare Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: cloudflared Write' + - 'Cloudflare One Connector: cloudflared Read' + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + method: get + patch: + description: Updates an existing Cloudflare Tunnel. + operationId: cloudflare-tunnel-update-a-cloudflare-tunnel + parameters: + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + $ref: '#/components/schemas/tunnelTunnelName' + tunnel_secret: + $ref: '#/components/schemas/tunnelTunnelSecret' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelCfdTunnelResponseSingle' + description: Update a Cloudflare Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + remote_config: + $ref: '#/components/schemas/tunnelRemoteConfig' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update a Cloudflare Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Cloudflare Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + method: edit + /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations: + get: + description: Gets the configuration for a remotely-managed tunnel + operationId: cloudflare-tunnel-configuration-get-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelConfigurationResponse' + description: Get configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSchemasApiResponseCommonFailure' + description: Get configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get configuration + tags: + - Cloudflare Tunnel Configuration + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: cloudflared Write' + - 'Cloudflare One Connector: cloudflared Read' + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + - configurations + method: get + put: + description: Adds or updates the configuration for a remotely-managed tunnel. + operationId: cloudflare-tunnel-configuration-put-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config: + $ref: '#/components/schemas/tunnelConfig' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelConfigurationResponse' + description: Put configuration response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSchemasApiResponseCommonFailure' + description: Put configuration response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Put configuration + tags: + - Cloudflare Tunnel Configuration + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + - configurations + method: update + /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections: + delete: + description: Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens. + operationId: cloudflare-tunnel-clean-up-cloudflare-tunnel-connections + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + - in: query + name: client_id + schema: + $ref: '#/components/schemas/tunnelClientId' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelEmptyResponse' + description: Clean up Cloudflare Tunnel connections response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Clean up Cloudflare Tunnel connections response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Clean up Cloudflare Tunnel connections + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + - connections + method: delete + get: + description: Fetches connection details for a Cloudflare Tunnel. + operationId: cloudflare-tunnel-list-cloudflare-tunnel-connections + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelConnectionsResponse' + description: List Cloudflare Tunnel connections response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelTunnelClient' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Cloudflare Tunnel connections response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Cloudflare Tunnel connections + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: cloudflared Write' + - 'Cloudflare One Connector: cloudflared Read' + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + - connections + method: get + /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}: + get: + description: Fetches connector and connection details for a Cloudflare Tunnel. + operationId: cloudflare-tunnel-get-cloudflare-tunnel-connector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + - in: path + name: connector_id + schema: + $ref: '#/components/schemas/tunnelClientId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelClientResponse' + description: Get Cloudflare Tunnel connector response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A client (typically cloudflared) that maintains connections to a Cloudflare data center. + properties: + arch: + $ref: '#/components/schemas/tunnelArch' + config_version: + $ref: '#/components/schemas/tunnelConfigVersion' + conns: + $ref: '#/components/schemas/tunnelConnections' + features: + $ref: '#/components/schemas/tunnelFeatures' + id: + $ref: '#/components/schemas/tunnelConnectionId' + run_at: + $ref: '#/components/schemas/tunnelRunAt' + version: + $ref: '#/components/schemas/tunnelVersion' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get Cloudflare Tunnel connector response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Cloudflare Tunnel connector + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: cloudflared Write' + - 'Cloudflare One Connector: cloudflared Read' + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + - connectors + method: get + /accounts/{account_id}/cfd_tunnel/{tunnel_id}/management: + post: + description: Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel. + operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-management-token + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + resources: + items: + $ref: '#/components/schemas/tunnelManagementResources' + type: array + required: + - resources + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelResponseToken' + description: Get a Cloudflare Tunnel management token response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel. + readOnly: true + type: string + x-sensitive: true + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Cloudflare API response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Cloudflare Tunnel management token + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + - management + method: create + /accounts/{account_id}/cfd_tunnel/{tunnel_id}/token: + get: + description: Gets the token used to associate cloudflared with a specific tunnel. + operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-token + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelResponseToken' + description: Get a Cloudflare Tunnel token response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel. + readOnly: true + type: string + x-sensitive: true + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get a Cloudflare Tunnel token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Cloudflare Tunnel token + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - cloudflared + - token + method: get + /accounts/{account_id}/devices: + get: + deprecated: true + description: 'List WARP devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account. **Deprecated**: please use one of the following endpoints instead: - GET /accounts/{account_id}/devices/physical-devices - GET /accounts/{account_id}/devices/registrations' + operationId: devices-list-devices + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDevicesResponse' + description: List devices response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDevices' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List devices response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List devices (deprecated) + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + method: list + /accounts/{account_id}/devices/client-versions: + get: + description: Lists available WARP client versions for a specific target environment and release track. This endpoint is in Beta. + operationId: list-client-versions + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The target environment for the client version (e.g., windows, macos). + in: query + name: target_environment + schema: + type: string + - description: The release track (ga for General Availability, beta for Beta releases). + in: query + name: release_track + schema: + enum: + - ga + - beta + type: string + - description: The page number to return. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The maximum number of versions to return per page. + in: query + name: per_page + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + items: + $ref: '#/components/schemas/teamsDevicesClientVersion' + type: array + result_info: + $ref: '#/components/schemas/teamsDevicesPaginationInfo' + success: + description: Indicates whether the API call was successful. + type: boolean + required: + - result + - result_info + - success + - errors + - messages + type: object + description: List client versions response. + security: + - api_token: [] + summary: List client versions + tags: + - Client Versions + /accounts/{account_id}/devices/client-versions/target-environments: + get: + description: Retrieves a list of all available target environments with their display names. This endpoint is in Beta. + operationId: list-client-target-environments + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + items: + $ref: '#/components/schemas/teamsDevicesTargetEnvironmentInfo' + type: array + success: + description: Indicates whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: List target environments response. + security: + - api_token: [] + summary: List available target environments + tags: + - Client Versions + /accounts/{account_id}/devices/deployment-groups: + get: + description: Lists all deployment groups for an account. Use deployment groups to assign target WARP client versions to specific devices. This endpoint is in Beta. + operationId: list-deployment-groups + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The page number to return. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: integer + - description: The maximum number of deployment groups to return per page. + in: query + name: per_page + schema: + default: 50 + maximum: 100 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + items: + $ref: '#/components/schemas/teamsDevicesDeploymentGroup' + type: array + result_info: + $ref: '#/components/schemas/teamsDevicesPaginationInfo' + success: + description: Indicates whether the API call was successful. + type: boolean + required: + - result + - result_info + - success + - errors + - messages + type: object + description: Lists deployment group response. + security: + - api_token: [] + summary: List deployment groups + tags: + - Deployment Groups + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - deployment_groups + method: list + post: + description: Creates a new deployment group. Policy IDs must be unique across all deployment groups. This endpoint is in Beta. + operationId: create-deployment-group + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupCreateRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesDeploymentGroup' + success: + description: Indicates whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Creates deployment group response. + security: + - api_token: [] + summary: Create deployment group + tags: + - Deployment Groups + x-auditable: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - deployment_groups + method: create + /accounts/{account_id}/devices/deployment-groups/{group_id}: + delete: + description: Deletes a deployment group. Associated policies no longer apply and devices stop receiving version targets. This endpoint is in Beta. + operationId: delete-deployment-group + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + properties: + id: + description: The ID of a deleted deployment group. + type: string + x-auditable: true + type: object + success: + description: Indicates whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Deletes deployment group response. + security: + - api_token: [] + summary: Delete deployment group + tags: + - Deployment Groups + x-auditable: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - deployment_groups + method: delete + get: + description: Fetches a single deployment group by its ID. This endpoint is in Beta. + operationId: get-deployment-group + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesDeploymentGroup' + success: + description: Indicates whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Gets deployment group response. + security: + - api_token: [] + summary: Get deployment group + tags: + - Deployment Groups + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - deployment_groups + method: get + patch: + description: Updates a deployment group. Returns 409 if any newly added policy IDs already belong to another deployment group. This endpoint is in Beta. + operationId: update-deployment-group + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupUpdateRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesDeploymentGroup' + success: + description: Indicates whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Updates deployment group response. + security: + - api_token: [] + summary: Update deployment group + tags: + - Deployment Groups + x-auditable: true + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - deployment_groups + method: edit + /accounts/{account_id}/devices/ip-profiles: + get: + description: Lists WARP Device IP profiles. + operationId: list-ip-profiles + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: The number of IP profiles to return per page. + in: query + name: per_page + schema: + default: 50 + maximum: 100 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + items: + $ref: '#/components/schemas/teamsDevicesIpProfile' + type: array + result_info: + $ref: '#/components/schemas/teamsDevicesPaginationInfo' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: List Device IP profiles response. + security: + - api_token: [] + summary: List IP profiles + tags: + - IP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - ip_profiles + method: list + post: + description: Creates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated. + operationId: create-ip-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesIpProfileCreateRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesIpProfile' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Create Device IP profile response. + security: + - api_token: [] + summary: Create IP profile + tags: + - IP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - ip_profiles + method: create + /accounts/{account_id}/devices/ip-profiles/{profile_id}: + delete: + description: Delete a WARP Device IP profile. + operationId: delete-ip-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + properties: + id: + description: ID of the deleted Device IP profile. + type: string + x-auditable: true + type: object + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Delete Device IP profile response. + security: + - api_token: [] + summary: Delete IP profile + tags: + - IP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - ip_profiles + method: delete + get: + description: Fetches a single WARP Device IP profile. + operationId: get-ip-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesIpProfile' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Get Device IP profile response. + security: + - api_token: [] + summary: Get IP profile + tags: + - IP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - ip_profiles + method: get + patch: + description: Updates a WARP Device IP profile. Currently, only IPv4 Device subnets can be associated. + operationId: update-ip-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesIpProfileUpdateRequest' + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesIpProfile' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Update Device IP profile response. + security: + - api_token: [] + summary: Update IP profile + tags: + - IP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - ip_profiles + method: update + /accounts/{account_id}/devices/networks: + get: + description: Fetches a list of managed networks for an account. + operationId: device-managed-networks-list-device-managed-networks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasResponseCollection' + description: List your device managed networks response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworks' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List your device managed networks response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List your device managed networks + tags: + - Device Managed Networks + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - networks + method: list + post: + description: Creates a new device managed network. + operationId: device-managed-networks-create-device-managed-network + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config: + $ref: '#/components/schemas/teamsDevicesSchemasConfigRequest' + name: + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworksComponentsSchemasName' + type: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasType' + required: + - name + - type + - config + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasSingleResponse' + description: Create a device managed networks response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefD2b048663faf5e0cd5c90501b71171de' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create a device managed networks response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a device managed network + tags: + - Device Managed Networks + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - networks + method: create + /accounts/{account_id}/devices/networks/{network_id}: + delete: + description: Deletes a device managed network and fetches a list of the remaining device managed networks for an account. + operationId: device-managed-networks-delete-device-managed-network + parameters: + - in: path + name: network_id + schema: + $ref: '#/components/schemas/teamsDevicesUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasResponseCollection' + description: Delete a device managed network response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworks' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a device managed network response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a device managed network + tags: + - Device Managed Networks + x-api-token-group: + - Zero Trust Write + get: + description: Fetches details for a single managed network. + operationId: device-managed-networks-device-managed-network-details + parameters: + - in: path + name: network_id + schema: + $ref: '#/components/schemas/teamsDevicesUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasSingleResponse' + description: Get device managed network details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefD2b048663faf5e0cd5c90501b71171de' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get device managed network details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get device managed network details + tags: + - Device Managed Networks + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - networks + method: delete + put: + description: Updates a configured device managed network. + operationId: device-managed-networks-update-device-managed-network + parameters: + - in: path + name: network_id + schema: + $ref: '#/components/schemas/teamsDevicesUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config: + $ref: '#/components/schemas/teamsDevicesSchemasConfigRequest' + name: + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworksComponentsSchemasName' + type: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasType' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasSingleResponse' + description: Update a device managed network response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefD2b048663faf5e0cd5c90501b71171de' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a device managed network response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a device managed network + tags: + - Device Managed Networks + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - networks + method: update + /accounts/{account_id}/devices/physical-devices: + get: + description: Lists WARP devices. + operationId: list-devices + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Opaque token indicating the starting position when requesting the next set of records. A cursor value can be obtained from the result_info.cursor field in the response. + explode: false + in: query + name: cursor + schema: + type: string + - description: The device field to order results by. + explode: false + in: query + name: sort_by + schema: + enum: + - name + - id + - client_version + - last_seen_user.email + - last_seen_at + - active_registrations + - created_at + type: string + - description: Sort direction. + explode: false + in: query + name: sort_order + schema: + enum: + - asc + - desc + type: string + - description: Filter by the last seen user's email. + explode: false + in: query + name: last_seen_user.email + schema: + type: string + - description: Filter by the last_seen timestamp - returns only devices last seen after this timestamp. + explode: false + in: query + name: seen_after + schema: + type: string + - description: Filter by the last_seen timestamp - returns only devices last seen before this timestamp. + explode: false + in: query + name: seen_before + schema: + type: string + - description: The maximum number of devices to return in a single response. + explode: false + in: query + name: per_page + schema: + format: uint64 + type: integer + - description: Search by device details. + explode: false + in: query + name: search + schema: + type: string + - description: Include or exclude devices with active registrations. The default is "only" - return only devices with active registrations. + explode: false + in: query + name: active_registrations + schema: + enum: + - include + - only + - exclude + type: string + - description: Filter by a one or more device IDs. + explode: true + in: query + name: id + schema: + items: + type: string + type: array + - description: 'Comma-separated list of additional information that should be included in the device response. Supported values are: "last_seen_registration.policy".' + in: query + name: include + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + items: + $ref: '#/components/schemas/teamsDevicesPhysicalDevice' + type: array + result_info: + $ref: '#/components/schemas/teamsDevicesCursorResultInfo' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Returns a list of Devices. + security: + - api_token: [] + summary: List devices + tags: + - Physical Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - devices_ + method: list + /accounts/{account_id}/devices/physical-devices/{device_id}: + delete: + description: Deletes a WARP device. + operationId: delete-device + parameters: + - in: path + name: device_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesEmptyBody' + success: + description: Whether the API call was successful. + type: boolean + required: + - success + - errors + - messages + type: object + description: Device was successfully deleted. + security: + - api_token: [] + summary: Delete device + tags: + - Physical Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - devices_ + method: delete + get: + description: Fetches a single WARP device. + operationId: get-device + parameters: + - in: path + name: device_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: 'Comma-separated list of additional information that should be included in the device response. Supported values are: "last_seen_registration.policy".' + in: query + name: include + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesPhysicalDevice' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Returns a Device. + security: + - api_token: [] + summary: Get device + tags: + - Physical Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - devices_ + method: get + /accounts/{account_id}/devices/physical-devices/{device_id}/revoke: + post: + description: Revokes all WARP registrations associated with the specified device. + operationId: revoke-device + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: device_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesEmptyBody' + success: + description: Whether the API call was successful. + type: boolean + required: + - success + - errors + - messages + type: object + description: Revoke device registrations response. + security: + - api_token: [] + summary: Revoke device registrations + tags: + - Physical Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - devices_ + method: revoke + /accounts/{account_id}/devices/policies: + get: + description: Fetches a list of the device settings profiles for an account. + operationId: devices-list-device-settings-policies + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeviceSettingsResponseCollection' + description: List device settings profiles response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDeviceSettingsPolicy' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List device settings profiles response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List device settings profiles + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - custom + method: list + /accounts/{account_id}/devices/policy: + get: + description: Fetches the default device settings profile for an account. + operationId: devices-get-default-device-settings-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDefaultDeviceSettingsResponse' + description: Get the default device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + default: + description: Whether the policy will be applied to matching devices. + type: boolean + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + enabled: + default: true + description: Whether the policy will be applied to matching devices. + type: boolean + exclude: + $ref: '#/components/schemas/teamsDevicesExclude' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + fallback_domains: + $ref: '#/components/schemas/teamsDevicesFallbackDomains' + gateway_unique_id: + $ref: '#/components/schemas/teamsDevicesGatewayUniqueId' + include: + $ref: '#/components/schemas/teamsDevicesInclude' + policy_id: + $ref: '#/components/schemas/teamsDevicesSchemasUuid' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get the default device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the default device settings profile + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - default + method: get + patch: + description: Updates the default device settings profile for an account. + operationId: devices-update-default-device-settings-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + exclude: + $ref: '#/components/schemas/teamsDevicesExcludeRequest' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + include: + $ref: '#/components/schemas/teamsDevicesIncludeRequest' + lan_allow_minutes: + $ref: '#/components/schemas/teamsDevicesLanAllowMinutes' + lan_allow_subnet_size: + $ref: '#/components/schemas/teamsDevicesLanAllowSubnetSize' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDefaultDeviceSettingsResponse' + description: Update the default device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + default: + description: Whether the policy will be applied to matching devices. + type: boolean + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + enabled: + default: true + description: Whether the policy will be applied to matching devices. + type: boolean + exclude: + $ref: '#/components/schemas/teamsDevicesExclude' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + fallback_domains: + $ref: '#/components/schemas/teamsDevicesFallbackDomains' + gateway_unique_id: + $ref: '#/components/schemas/teamsDevicesGatewayUniqueId' + include: + $ref: '#/components/schemas/teamsDevicesInclude' + policy_id: + $ref: '#/components/schemas/teamsDevicesSchemasUuid' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update the default device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update the default device settings profile + tags: + - Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - default + method: edit + post: + description: Creates a device settings profile to be applied to certain devices matching the criteria. + operationId: devices-create-device-settings-policy + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + description: + $ref: '#/components/schemas/teamsDevicesSchemasDescription' + default: '' + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + enabled: + default: true + description: Whether the policy will be applied to matching devices. + type: boolean + exclude: + $ref: '#/components/schemas/teamsDevicesExcludeRequest' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + include: + $ref: '#/components/schemas/teamsDevicesIncludeRequest' + lan_allow_minutes: + $ref: '#/components/schemas/teamsDevicesLanAllowMinutes' + lan_allow_subnet_size: + $ref: '#/components/schemas/teamsDevicesLanAllowSubnetSize' + match: + $ref: '#/components/schemas/teamsDevicesSchemasMatch' + name: + description: The name of the device settings profile. + maxLength: 100 + type: string + precedence: + $ref: '#/components/schemas/teamsDevicesPrecedence' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + required: + - name + - precedence + - match + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeviceSettingsResponse' + description: Create a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefF636ff9f2cb41ff4b715cf8ed8515581' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a device settings profile + tags: + - Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - custom + method: create + /accounts/{account_id}/devices/policy/exclude: + get: + description: Fetches the list of routes excluded from the WARP client's tunnel. + operationId: devices-get-split-tunnel-exclude-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelResponseCollection' + description: Get the Split Tunnel exclude list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef0462afe1a32ee90b1999d4277af59fa8' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get the Split Tunnel exclude list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Split Tunnel exclude list + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - default + - excludes + method: update + put: + description: Sets the list of routes excluded from the WARP client's tunnel. + operationId: devices-set-split-tunnel-exclude-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnel' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelResponseCollection' + description: Set the Split Tunnel exclude list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef0462afe1a32ee90b1999d4277af59fa8' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set the Split Tunnel exclude list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set the Split Tunnel exclude list + tags: + - Devices + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/devices/policy/fallback_domains: + get: + description: Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. + operationId: devices-get-local-domain-fallback-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesFallbackDomainResponseCollection' + description: Get your Local Domain Fallback list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef1fbf91ecd61792c751fead58dc8005e6' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get your Local Domain Fallback list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get your Local Domain Fallback list + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - default + - fallback_domains + method: update + put: + description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. + operationId: devices-set-local-domain-fallback-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/teamsDevicesFallbackDomain' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesFallbackDomainResponseCollection' + description: Set your Local Domain Fallback list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef1fbf91ecd61792c751fead58dc8005e6' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set your Local Domain Fallback list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set your Local Domain Fallback list + tags: + - Devices + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/devices/policy/include: + get: + description: Fetches the list of routes included in the WARP client's tunnel. + operationId: devices-get-split-tunnel-include-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelIncludeResponseCollection' + description: Get the Split Tunnel include list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef5e0c6134a624678286f4a424b001870a' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get the Split Tunnel include list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Split Tunnel include list + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - default + - includes + method: update + put: + description: Sets the list of routes included in the WARP client's tunnel. + operationId: devices-set-split-tunnel-include-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnelInclude' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelIncludeResponseCollection' + description: Set the Split Tunnel include list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef5e0c6134a624678286f4a424b001870a' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set the Split Tunnel include list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set the Split Tunnel include list + tags: + - Devices + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/devices/policy/{policy_id}: + delete: + description: Deletes a device settings profile and fetches a list of the remaining profiles for an account. + operationId: devices-delete-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeviceSettingsResponseCollection' + description: Delete a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDeviceSettingsPolicy' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a device settings profile + tags: + - Devices + x-api-token-group: + - Zero Trust Write + get: + description: Fetches a device settings profile by ID. + operationId: devices-get-device-settings-policy-by-id + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeviceSettingsResponse' + description: Get device settings profile by ID response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefF636ff9f2cb41ff4b715cf8ed8515581' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get device settings profile by ID response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get device settings profile by ID + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - custom + method: delete + patch: + description: Updates a configured device settings profile. + operationId: devices-update-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + description: + $ref: '#/components/schemas/teamsDevicesSchemasDescription' + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + enabled: + description: Whether the policy will be applied to matching devices. + type: boolean + exclude: + $ref: '#/components/schemas/teamsDevicesExcludeRequest' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + include: + $ref: '#/components/schemas/teamsDevicesIncludeRequest' + lan_allow_minutes: + $ref: '#/components/schemas/teamsDevicesLanAllowMinutes' + lan_allow_subnet_size: + $ref: '#/components/schemas/teamsDevicesLanAllowSubnetSize' + match: + $ref: '#/components/schemas/teamsDevicesSchemasMatch' + name: + description: The name of the device settings profile. + maxLength: 100 + type: string + precedence: + $ref: '#/components/schemas/teamsDevicesPrecedence' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeviceSettingsResponse' + description: Update a device settings profile Policy response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefF636ff9f2cb41ff4b715cf8ed8515581' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a device settings profile Policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a device settings profile + tags: + - Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - custom + method: edit + /accounts/{account_id}/devices/policy/{policy_id}/exclude: + get: + description: Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile. + operationId: devices-get-split-tunnel-exclude-list-for-a-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelResponseCollection' + description: Get the Split Tunnel exclude list for a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef0462afe1a32ee90b1999d4277af59fa8' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get the Split Tunnel exclude list for a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Split Tunnel exclude list for a device settings profile + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - custom + - excludes + method: update + put: + description: Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile. + operationId: devices-set-split-tunnel-exclude-list-for-a-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnel' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelResponseCollection' + description: Set the Split Tunnel exclude list for a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef0462afe1a32ee90b1999d4277af59fa8' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set the Split Tunnel exclude list for a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set the Split Tunnel exclude list for a device settings profile + tags: + - Devices + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains: + get: + description: Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead. + operationId: devices-get-local-domain-fallback-list-for-a-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesFallbackDomainResponseCollection' + description: Get the Local Domain Fallback list for a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef1fbf91ecd61792c751fead58dc8005e6' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get the Local Domain Fallback list for a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Local Domain Fallback list for a device settings profile + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - custom + - fallback_domains + method: update + put: + description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile. + operationId: devices-set-local-domain-fallback-list-for-a-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/teamsDevicesFallbackDomain' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesFallbackDomainResponseCollection' + description: Set the Local Domain Fallback list for a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef1fbf91ecd61792c751fead58dc8005e6' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set the Local Domain Fallback list for a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set the Local Domain Fallback list for a device settings profile + tags: + - Devices + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/devices/policy/{policy_id}/include: + get: + description: Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile. + operationId: devices-get-split-tunnel-include-list-for-a-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelIncludeResponseCollection' + description: Get the Split Tunnel include list for a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef5e0c6134a624678286f4a424b001870a' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get the Split Tunnel include list for a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the Split Tunnel include list for a device settings profile + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - custom + - includes + method: update + put: + description: Sets the list of routes included in the WARP client's tunnel for a specific device settings profile. + operationId: devices-set-split-tunnel-include-list-for-a-device-settings-policy + parameters: + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnelInclude' + type: array + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSplitTunnelIncludeResponseCollection' + description: Set the Split Tunnel include list for a device settings profile response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef5e0c6134a624678286f4a424b001870a' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set the Split Tunnel include list for a device settings profile response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set the Split Tunnel include list for a device settings profile + tags: + - Devices + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/devices/posture: + get: + description: Fetches device posture rules for a Zero Trust account. + operationId: device-posture-rules-list-device-posture-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesResponseCollection' + description: List device posture rules response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDevicePostureRules' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List device posture rules response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List device posture rules + tags: + - Device posture rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + method: list + post: + description: Creates a new device posture rule. + operationId: device-posture-rules-create-device-posture-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/teamsDevicesDescription' + expiration: + $ref: '#/components/schemas/teamsDevicesExpiration' + input: + $ref: '#/components/schemas/teamsDevicesInput' + match: + $ref: '#/components/schemas/teamsDevicesMatch' + name: + $ref: '#/components/schemas/teamsDevicesName' + schedule: + $ref: '#/components/schemas/teamsDevicesSchedule' + type: + $ref: '#/components/schemas/teamsDevicesType' + required: + - name + - type + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSingleResponse' + description: Create device posture rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef9e35ef84511131488ae286ce78ac4b27' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create device posture rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a device posture rule + tags: + - Device posture rules + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + method: create + /accounts/{account_id}/devices/posture/integration: + get: + description: Fetches the list of device posture integrations for an account. + operationId: device-posture-integrations-list-device-posture-integrations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSchemasResponseCollection' + description: List your device posture integrations response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDevicePostureIntegrations' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List your device posture integrations response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List your device posture integrations + tags: + - Device Posture Integrations + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + - integrations + method: list + post: + description: Create a new device posture integration. + operationId: device-posture-integrations-create-device-posture-integration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config: + $ref: '#/components/schemas/teamsDevicesConfigRequest' + interval: + $ref: '#/components/schemas/teamsDevicesInterval' + name: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasName' + type: + $ref: '#/components/schemas/teamsDevicesSchemasType' + required: + - name + - type + - interval + - config + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSchemasSingleResponse' + description: Create a device posture integration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefB84b377dfc9454d455b646d4bc9ab507' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create a device posture integration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a device posture integration + tags: + - Device Posture Integrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + - integrations + method: create + /accounts/{account_id}/devices/posture/integration/{integration_id}: + delete: + description: Delete a configured device posture integration. + operationId: device-posture-integrations-delete-device-posture-integration + parameters: + - in: path + name: integration_id + schema: + $ref: '#/components/schemas/teamsDevicesUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSchemasIdResponse' + description: Delete a device posture integration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a device posture integration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a device posture integration + tags: + - Device Posture Integrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + - integrations + method: delete + get: + description: Fetches details for a single device posture integration. + operationId: device-posture-integrations-device-posture-integration-details + parameters: + - in: path + name: integration_id + schema: + $ref: '#/components/schemas/teamsDevicesUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSchemasSingleResponse' + description: Get device posture integration details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefB84b377dfc9454d455b646d4bc9ab507' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get device posture integration details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get device posture integration details + tags: + - Device Posture Integrations + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + - integrations + method: get + patch: + description: Updates a configured device posture integration. + operationId: device-posture-integrations-update-device-posture-integration + parameters: + - in: path + name: integration_id + schema: + $ref: '#/components/schemas/teamsDevicesUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + config: + $ref: '#/components/schemas/teamsDevicesConfigRequest' + interval: + $ref: '#/components/schemas/teamsDevicesInterval' + name: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasName' + type: + $ref: '#/components/schemas/teamsDevicesSchemasType' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSchemasSingleResponse' + description: Update a device posture integration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefB84b377dfc9454d455b646d4bc9ab507' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a device posture integration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a device posture integration + tags: + - Device Posture Integrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + - integrations + method: edit + /accounts/{account_id}/devices/posture/{rule_id}: + delete: + description: Deletes a device posture rule. + operationId: device-posture-rules-delete-device-posture-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesIdResponse' + description: Delete a device posture rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + id: + $ref: '#/components/schemas/teamsDevicesUuid' + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete a device posture rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a device posture rule + tags: + - Device posture rules + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + method: delete + get: + description: Fetches a single device posture rule. + operationId: device-posture-rules-device-posture-rules-details + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSingleResponse' + description: Get device posture rule details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef9e35ef84511131488ae286ce78ac4b27' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get device posture rule details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get device posture rule details + tags: + - Device posture rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + method: get + put: + description: Updates a device posture rule. + operationId: device-posture-rules-update-device-posture-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/teamsDevicesDescription' + expiration: + $ref: '#/components/schemas/teamsDevicesExpiration' + input: + $ref: '#/components/schemas/teamsDevicesInput' + match: + $ref: '#/components/schemas/teamsDevicesMatch' + name: + $ref: '#/components/schemas/teamsDevicesName' + schedule: + $ref: '#/components/schemas/teamsDevicesSchedule' + type: + $ref: '#/components/schemas/teamsDevicesType' + required: + - name + - type + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesSingleResponse' + description: Update a device posture rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRef9e35ef84511131488ae286ce78ac4b27' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update a device posture rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a device posture rule + tags: + - Device posture rules + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - posture + method: update + /accounts/{account_id}/devices/registrations: + delete: + description: Deletes a list of WARP registrations. + operationId: delete-registrations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: A list of registration IDs to delete. + in: query + name: id + schema: + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesEmptyBody' + result_info: + $ref: '#/components/schemas/teamsDevicesCursorResultInfo' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Delete a list of registrations response. + security: + - api_token: [] + summary: Delete registrations + tags: + - Physical Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - registrations + method: bulk_delete + get: + description: Lists WARP registrations. + operationId: list-registrations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Filter by user ID. + explode: true + in: query + name: user.id + schema: + items: + type: string + type: array + - description: Filter by the last_seen timestamp - returns only registrations last seen after this timestamp. + explode: false + in: query + name: seen_after + schema: + type: string + - description: Filter by the last_seen timestamp - returns only registrations last seen before this timestamp. + explode: false + in: query + name: seen_before + schema: + type: string + - description: Filter by registration status. Defaults to 'active'. + explode: false + in: query + name: status + schema: + enum: + - active + - all + - revoked + type: string + - description: The maximum number of devices to return in a single response. + explode: false + in: query + name: per_page + schema: + format: uint64 + type: integer + - description: Filter by registration details. + explode: false + in: query + name: search + schema: + type: string + - description: The registration field to order results by. + explode: false + in: query + name: sort_by + schema: + enum: + - id + - user.name + - user.email + - last_seen_at + - created_at + type: string + - description: Sort direction. + explode: false + in: query + name: sort_order + schema: + enum: + - asc + - desc + type: string + - description: Opaque token indicating the starting position when requesting the next set of records. A cursor value can be obtained from the result_info.cursor field in the response. + explode: false + in: query + name: cursor + schema: + type: string + - description: Filter by registration ID. + explode: true + in: query + name: id + schema: + items: + type: string + type: array + - description: Filter by WARP device ID. + explode: false + in: query + name: device.id + schema: + type: string + - description: 'Comma-separated list of additional information that should be included in the registration response. Supported values are: "policy".' + in: query + name: include + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + items: + $ref: '#/components/schemas/teamsDevicesRegistration' + type: array + result_info: + $ref: '#/components/schemas/teamsDevicesCursorResultInfo' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: List of registrations response. + security: + - api_token: [] + summary: List registrations + tags: + - Registrations + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - registrations + method: list + /accounts/{account_id}/devices/registrations/revoke: + post: + description: Revokes a list of WARP registrations. + operationId: revoke-registrations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: A list of registration IDs to revoke. + in: query + name: id + schema: + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesEmptyBody' + result_info: + $ref: '#/components/schemas/teamsDevicesCursorResultInfo' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Revoke registrations response. + security: + - api_token: [] + summary: Revoke registrations + tags: + - Registrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - registrations + method: revoke + /accounts/{account_id}/devices/registrations/unrevoke: + post: + description: Unrevokes a list of WARP registrations. + operationId: unrevoke-registrations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: A list of registration IDs to unrevoke. + in: query + name: id + schema: + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesEmptyBody' + result_info: + $ref: '#/components/schemas/teamsDevicesCursorResultInfo' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Unrevoke registrations response. + security: + - api_token: [] + summary: Unrevoke registrations + tags: + - Registrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - registrations + method: unrevoke + /accounts/{account_id}/devices/registrations/{registration_id}: + delete: + description: Deletes a WARP registration. + operationId: delete-registration + parameters: + - in: path + name: registration_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesEmptyBody' + success: + description: Whether the API call was successful. + type: boolean + required: + - success + - errors + - messages + type: object + description: Registration deleted response. + security: + - api_token: [] + summary: Delete registration + tags: + - Registrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - registrations + method: delete + get: + description: Fetches a single WARP registration. + operationId: get-registration + parameters: + - in: path + name: registration_id + schema: + type: string + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: 'Comma-separated list of additional information that should be included in the registration response. Supported values are: "policy".' + in: query + name: include + schema: + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesRegistration' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Returns a Registration. + security: + - api_token: [] + summary: Get registration + tags: + - Registrations + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - registrations + method: get + /accounts/{account_id}/devices/registrations/{registration_id}/override_codes: + get: + description: Fetches one-time use admin override codes for a registration. This relies on the **Admin Override** setting being enabled in your device configuration. + operationId: get-registration-override-codes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: registration_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + errors: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + messages: + items: + $ref: '#/components/schemas/teamsDevicesV4ResponseMessage' + type: array + result: + $ref: '#/components/schemas/teamsDevicesOverrideCodes' + success: + description: Whether the API call was successful. + type: boolean + required: + - result + - success + - errors + - messages + type: object + description: Get admin override codes for a registration response. + security: + - api_token: [] + summary: Get override codes + tags: + - warp-teams-device-api_other + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - override_codes + method: get + /accounts/{account_id}/devices/resilience/disconnect: + get: + description: Fetch the Global WARP override state. + operationId: devices-resilience-retrieve-global-warp-override + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesGlobalWarpOverrideResponse' + description: Fetch Global WARP override state response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesApiResponseCommonFailure' + description: Fetch Global WARP override state failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve Global WARP override state + tags: + - Devices Resilience + x-api-token-group: + - Zero Trust Resilience Read + - Zero Trust Resilience Write + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - resilience + - global_warp_override + method: get + post: + description: Sets the Global WARP override state. + operationId: devices-resilience-set-global-warp-override + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesGlobalWarpOverrideRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesGlobalWarpOverrideResponse' + description: Set Global WARP override state response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesApiResponseCommonFailure' + description: Set Global WARP override state response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set Global WARP override state + tags: + - Devices Resilience + x-api-token-group: + - Zero Trust Resilience Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - resilience + - global_warp_override + method: create + /accounts/{account_id}/devices/revoke: + post: + deprecated: true + description: 'Revokes a list of devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled. **Deprecated**: please use POST /accounts/{account_id}/devices/registrations/revoke instead.' + operationId: devices-revoke-devices + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesRevokeDevicesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesApiResponseSingle' + description: Revoke devices response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Revoke devices response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Revoke devices (deprecated) + tags: + - Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - revoke + method: create + /accounts/{account_id}/devices/settings: + delete: + description: Resets the current device settings for a Zero Trust account. + operationId: zero-trust-accounts-delete-device-settings-for-zero-trust-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesZeroTrustAccountDeviceSettingsResponse' + description: Reset response for device settings for a Zero Trust account. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + disable_for_time: + description: Sets the time limit, in seconds, that a user can use an override code to bypass WARP. + type: number + external_emergency_signal_enabled: + description: Controls whether the external emergency disconnect feature is enabled. + type: boolean + external_emergency_signal_fingerprint: + description: The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value. + type: string + external_emergency_signal_interval: + description: The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds. + type: string + external_emergency_signal_url: + description: The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host. + type: string + gateway_proxy_enabled: + description: Enable gateway proxy filtering on TCP. + type: boolean + gateway_udp_proxy_enabled: + description: Enable gateway proxy filtering on UDP. + type: boolean + root_certificate_installation_enabled: + description: Enable installation of cloudflare managed root certificate. + type: boolean + use_zt_virtual_ip: + description: Enable using CGNAT virtual IPv4. + type: boolean + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Reset failure response device settings for a Zero Trust account. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Reset device settings for a Zero Trust account with defaults. This turns off all proxying. + tags: + - Zero Trust accounts + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - settings + method: delete + get: + description: Describes the current device settings for a Zero Trust account. + operationId: zero-trust-accounts-get-device-settings-for-zero-trust-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesZeroTrustAccountDeviceSettingsResponse' + description: Get device settings for a Zero Trust account response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + disable_for_time: + description: Sets the time limit, in seconds, that a user can use an override code to bypass WARP. + type: number + external_emergency_signal_enabled: + description: Controls whether the external emergency disconnect feature is enabled. + type: boolean + external_emergency_signal_fingerprint: + description: The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value. + type: string + external_emergency_signal_interval: + description: The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds. + type: string + external_emergency_signal_url: + description: The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host. + type: string + gateway_proxy_enabled: + description: Enable gateway proxy filtering on TCP. + type: boolean + gateway_udp_proxy_enabled: + description: Enable gateway proxy filtering on UDP. + type: boolean + root_certificate_installation_enabled: + description: Enable installation of cloudflare managed root certificate. + type: boolean + use_zt_virtual_ip: + description: Enable using CGNAT virtual IPv4. + type: boolean + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get device settings for a Zero Trust account response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get device settings for a Zero Trust account + tags: + - Zero Trust accounts + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - settings + method: get + patch: + description: Patches the current device settings for a Zero Trust account. + operationId: zero-trust-accounts-patch-device-settings-for-the-zero-trust-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesZeroTrustAccountDeviceSettings' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesZeroTrustAccountDeviceSettingsResponse' + description: Patch device settings for a Zero Trust account response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + disable_for_time: + description: Sets the time limit, in seconds, that a user can use an override code to bypass WARP. + type: number + external_emergency_signal_enabled: + description: Controls whether the external emergency disconnect feature is enabled. + type: boolean + external_emergency_signal_fingerprint: + description: The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value. + type: string + external_emergency_signal_interval: + description: The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds. + type: string + external_emergency_signal_url: + description: The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host. + type: string + gateway_proxy_enabled: + description: Enable gateway proxy filtering on TCP. + type: boolean + gateway_udp_proxy_enabled: + description: Enable gateway proxy filtering on UDP. + type: boolean + root_certificate_installation_enabled: + description: Enable installation of cloudflare managed root certificate. + type: boolean + use_zt_virtual_ip: + description: Enable using CGNAT virtual IPv4. + type: boolean + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch device settings for a Zero Trust account response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch device settings for a Zero Trust account + tags: + - Zero Trust accounts + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - settings + method: edit + put: + description: Updates the current device settings for a Zero Trust account. + operationId: zero-trust-accounts-update-device-settings-for-the-zero-trust-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesZeroTrustAccountDeviceSettings' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesZeroTrustAccountDeviceSettingsResponse' + description: Update device settings for a Zero Trust account response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + disable_for_time: + description: Sets the time limit, in seconds, that a user can use an override code to bypass WARP. + type: number + external_emergency_signal_enabled: + description: Controls whether the external emergency disconnect feature is enabled. + type: boolean + external_emergency_signal_fingerprint: + description: The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value. + type: string + external_emergency_signal_interval: + description: The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds. + type: string + external_emergency_signal_url: + description: The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host. + type: string + gateway_proxy_enabled: + description: Enable gateway proxy filtering on TCP. + type: boolean + gateway_udp_proxy_enabled: + description: Enable gateway proxy filtering on UDP. + type: boolean + root_certificate_installation_enabled: + description: Enable installation of cloudflare managed root certificate. + type: boolean + use_zt_virtual_ip: + description: Enable using CGNAT virtual IPv4. + type: boolean + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update device settings for a Zero Trust account response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update device settings for a Zero Trust account + tags: + - Zero Trust accounts + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - settings + method: update + /accounts/{account_id}/devices/unrevoke: + post: + deprecated: true + description: 'Unrevokes a list of devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled. **Deprecated**: please use POST /accounts/{account_id}/devices/registrations/unrevoke instead.' + operationId: devices-unrevoke-devices + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesUnrevokeDevicesRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesApiResponseSingle' + description: Unrevoke devices response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Unrevoke devices response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Unrevoke devices (deprecated) + tags: + - Devices + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - unrevoke + method: create + /accounts/{account_id}/devices/{device_id}: + get: + deprecated: true + description: 'Fetches a single WARP device. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account. **Deprecated**: please use one of the following endpoints instead: - GET /accounts/{account_id}/devices/physical-devices/{device_id} - GET /accounts/{account_id}/devices/registrations/{registration_id}' + operationId: devices-device-details + parameters: + - in: path + name: device_id + schema: + $ref: '#/components/schemas/teamsDevicesRegistrationId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDeviceResponse' + description: Get device details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + account: + $ref: '#/components/schemas/teamsDevicesAccount' + created: + $ref: '#/components/schemas/teamsDevicesCreated' + deleted: + $ref: '#/components/schemas/teamsDevicesDeleted' + device_type: + $ref: '#/components/schemas/teamsDevicesDeviceType' + gateway_device_id: + $ref: '#/components/schemas/teamsDevicesGatewayDeviceId' + id: + $ref: '#/components/schemas/teamsDevicesRegistrationId' + ip: + $ref: '#/components/schemas/teamsDevicesIp' + key: + $ref: '#/components/schemas/teamsDevicesKey' + key_type: + $ref: '#/components/schemas/teamsDevicesKeyType' + last_seen: + $ref: '#/components/schemas/teamsDevicesLastSeen' + mac_address: + $ref: '#/components/schemas/teamsDevicesMacAddress' + model: + $ref: '#/components/schemas/teamsDevicesModel' + name: + $ref: '#/components/schemas/teamsDevicesSchemasName' + os_version: + $ref: '#/components/schemas/teamsDevicesOsVersion' + serial_number: + $ref: '#/components/schemas/teamsDevicesSerialNumber' + tunnel_type: + $ref: '#/components/schemas/teamsDevicesTunnelType' + updated: + $ref: '#/components/schemas/teamsDevicesUpdated' + user: + $ref: '#/components/schemas/teamsDevicesUser' + version: + $ref: '#/components/schemas/teamsDevicesVersion' + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get device details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get device (deprecated) + tags: + - Devices + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + method: get + /accounts/{account_id}/devices/{device_id}/override_codes: + get: + deprecated: true + description: Fetches a one-time use admin override code for a device. This relies on the **Admin Override** setting being enabled in your device configuration. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account. **Deprecated:** please use GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codes instead. + operationId: devices-list-admin-override-code-for-device + parameters: + - in: path + name: device_id + schema: + $ref: '#/components/schemas/teamsDevicesRegistrationId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesOverrideCodesResponse' + description: Get an admin override code for a device response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + nullable: true + type: array + properties: + disable_for_time: + $ref: '#/components/schemas/teamsDevicesDisableForTime' + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get an admin override code for a device response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get override codes (deprecated) + tags: + - Devices + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - override_codes + method: list + /accounts/{account_id}/dex/colos: + get: + description: List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically. + operationId: dex-endpoints-list-colos + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Start time for connection period in ISO (RFC3339 - ISO 8601) format + in: query + name: from + schema: + type: string + - description: End time for connection period in ISO (RFC3339 - ISO 8601) format + in: query + name: to + schema: + type: string + - description: Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically. + in: query + name: sortBy + schema: + enum: + - fleet-status-usage + - application-tests-usage + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringColosResponse' + required: + - success + - errors + - messages + type: object + description: List colos response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: List colos failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Cloudflare colos + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - colos + method: list + /accounts/{account_id}/dex/commands: + get: + description: Retrieves a paginated list of commands issued to devices under the specified account, optionally filtered by time range, device, or other parameters + operationId: get-commands + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number for pagination + in: query + name: page + schema: + type: number + - description: Number of results per page + in: query + name: per_page + schema: + type: number + - description: Start time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: from + schema: + format: date-time + type: string + - description: End time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: to + schema: + format: date-time + type: string + - description: Unique identifier for a device + in: query + name: device_id + schema: + type: string + - description: Email tied to the device + in: query + name: user_email + schema: + type: string + - description: Optionally filter executed commands by command type + in: query + name: command_type + schema: + type: string + - description: Optionally filter executed commands by status + in: query + name: status + schema: + enum: + - PENDING_EXEC + - PENDING_UPLOAD + - SUCCESS + - FAILED + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/digitalExperienceMonitoringGetCommandsResponse' + required: + - success + - errors + - messages + description: Get commands response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: Get commands failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List account commands + tags: + - DEX Remote Commands + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - commands + method: list + post: + description: Initiate commands for up to 10 devices per account + operationId: post-commands + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + commands: + description: List of device-level commands to execute + items: + properties: + command_args: + properties: + interfaces: + description: List of interfaces to capture packets on + items: + enum: + - default + - tunnel + type: string + x-auditable: true + type: array + max-file-size-mb: + default: 5 + description: Maximum file size (in MB) for the capture file. Specifies the maximum file size of the warp-diag zip artifact that can be uploaded. If the zip artifact exceeds the specified max file size, it will NOT be uploaded + minimum: 1 + type: number + x-auditable: true + packet-size-bytes: + default: 160 + description: Maximum number of bytes to save for each packet + minimum: 1 + type: number + x-auditable: true + test-all-routes: + default: true + description: Test an IP address from all included or excluded ranges. Tests an IP address from all included or excluded ranges. Essentially the same as running 'route get '' and collecting the results. This option may increase the time taken to collect the warp-diag + type: boolean + x-auditable: true + time-limit-min: + default: 5 + description: Limit on capture duration (in minutes) + minimum: 1 + type: number + x-auditable: true + type: object + command_type: + description: Type of command to execute on the device + enum: + - pcap + - warp-diag + type: string + x-auditable: true + device_id: + description: Unique identifier for the physical device + type: string + registration_id: + description: Unique identifier for the device registration. Required for multi-user devices to target the correct user session. + type: string + user_email: + description: Email tied to the device + type: string + required: + - device_id + - user_email + - command_type + type: object + maxItems: 20 + type: array + required: + - commands + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/digitalExperienceMonitoringPostCommandsResponse' + required: + - success + - errors + - messages + description: Create commands response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: Create commands failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create account commands + tags: + - DEX Remote Commands + x-api-token-group: + - Cloudflare DEX Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - commands + method: create + /accounts/{account_id}/dex/commands/devices: + get: + description: List devices with WARP client support for remote captures which have been connected in the last 1 hour. + operationId: get-commands-eligible-devices + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number of paginated results + in: query + name: page + schema: + minimum: 1 + type: number + - description: Number of items per page + in: query + name: per_page + schema: + maximum: 50 + minimum: 1 + type: number + - description: Filter devices by name or email + in: query + name: search + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/digitalExperienceMonitoringCommandsDevicesResponse' + required: + - success + - errors + - messages + description: List of eligible devices + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: List eligible devices failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List devices eligible for remote captures + tags: + - DEX Remote Commands + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - commands + - devices + method: list + /accounts/{account_id}/dex/commands/quota: + get: + description: Retrieves the current quota usage and limits for device commands within a specific account, including the time when the quota will reset + operationId: get-commands-quota + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/digitalExperienceMonitoringGetCommandsQuotaResponse' + required: + - success + - errors + - messages + description: Get commands quota response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: Get commands quota failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Returns account commands usage, quota, and reset time + tags: + - DEX Remote Commands + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - commands + - quota + method: get + /accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}: + get: + description: Downloads artifacts for an executed command. Bulk downloads are not supported + operationId: get-commands-command-id-downloads-filename + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Unique identifier for command + in: path + name: command_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringCommandId' + required: true + - description: The name of the file to be downloaded, including the `.zip` extension + in: path + name: filename + schema: + type: string + required: true + responses: + '200': + content: + application/zip: + schema: + type: object + properties: + contents: + type: string + description: Get command artifacts response + headers: + Accept-Ranges: + description: Indicates that the file supports byte-range requests + schema: + type: string + Content-Disposition: + description: Indicates that the file should be treated as an attachment for downloading + schema: + type: string + Content-Encoding: + description: Specifies the encoding of the file content, if any + schema: + type: string + Content-Length: + description: The size of the file in bytes + schema: + type: integer + Content-Type: + description: Specifies the media type of the file + schema: + type: string + ETag: + description: The entity tag of the file for cache validation + schema: + type: string + Last-Modified: + description: The last modification date of the file + schema: + format: date-time + type: string + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: Get downloaded commands failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Download command output file + tags: + - DEX Remote Commands + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - commands + - downloads + method: get + /accounts/{account_id}/dex/devices/dex_tests: + get: + description: Fetch all DEX tests + operationId: device-dex-test-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number of paginated results + in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Number of items per page + in: query + name: per_page + schema: + default: 10 + maximum: 50 + minimum: 1 + type: number + - description: Filter by test name + in: query + name: testName + schema: + type: string + - description: Filter by test type + in: query + name: kind + schema: + enum: + - http + - traceroute + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDexResponseCollection' + description: Device DEX test details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + data: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasData' + description: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasDescription' + enabled: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasEnabled' + interval: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasInterval' + name: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasName' + target_policies: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestTargetPolicies' + targeted: + type: boolean + x-stainless-terraform-configurability: computed + test_id: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasTestId' + required: + - name + - interval + - enabled + - data + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Device DEX test response failure + security: + - api_email: [] + api_key: [] + summary: List Device DEX tests + tags: + - Device DEX Tests + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - dex_tests + method: list + post: + description: Create a DEX test. + operationId: device-dex-test-create-device-dex-test + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasHttp' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDexSingleResponse' + description: Update Dex test response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + data: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasData' + description: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasDescription' + enabled: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasEnabled' + interval: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasInterval' + name: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasName' + target_policies: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestTargetPolicies' + targeted: + type: boolean + x-stainless-terraform-configurability: computed + test_id: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasTestId' + required: + - name + - interval + - enabled + - data + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Dex test response failure + security: + - api_email: [] + api_key: [] + summary: Create Device DEX test + tags: + - Device DEX Tests + x-api-token-group: + - Cloudflare DEX Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - dex_tests + method: create + /accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}: + delete: + description: Delete a Device DEX test. Returns the remaining device dex tests for the account. + operationId: device-dex-test-delete-device-dex-test + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: dex_test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDexDeleteResponseCollection' + description: Delete Device DEX test response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasHttp' + nullable: true + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete DEX test response failure + security: + - api_email: [] + api_key: [] + summary: Delete Device DEX test + tags: + - Device DEX Tests + x-api-token-group: + - Cloudflare DEX Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - dex_tests + method: delete + get: + description: Fetch a single DEX test. + operationId: device-dex-test-get-device-dex-test + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: dex_test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasTestId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDexSingleResponse' + description: Device DEX test details response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + data: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasData' + description: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasDescription' + enabled: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasEnabled' + interval: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasInterval' + name: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasName' + target_policies: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestTargetPolicies' + targeted: + type: boolean + x-stainless-terraform-configurability: computed + test_id: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasTestId' + required: + - name + - interval + - enabled + - data + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Device DEX test response failure + security: + - api_email: [] + api_key: [] + summary: Get Device DEX test + tags: + - Device DEX Tests + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - dex_tests + method: get + put: + description: Update a DEX test. + operationId: device-dex-test-update-device-dex-test + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: dex_test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasHttp' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDexSingleResponse' + description: Update Dex test response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + data: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasData' + description: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasDescription' + enabled: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasEnabled' + interval: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasInterval' + name: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasName' + target_policies: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestTargetPolicies' + targeted: + type: boolean + x-stainless-terraform-configurability: computed + test_id: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasTestId' + required: + - name + - interval + - enabled + - data + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Dex test response failure + security: + - api_email: [] + api_key: [] + summary: Update Device DEX test + tags: + - Device DEX Tests + x-api-token-group: + - Cloudflare DEX Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - dex_tests + method: update + /accounts/{account_id}/dex/devices/{device_id}/fleet-status/live: + get: + description: Get the live status of a latest device given device_id from the device_state table + operationId: devices-live-status + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Unique identifier for device + in: path + name: device_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceId' + required: true + - description: Number of minutes before current time + in: query + name: since_minutes + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringSinceMinutes' + - description: Number of minutes before current time + in: query + name: time_now + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringTimeNow' + - description: List of data centers to filter results + in: query + name: colo + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringColo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDevice' + description: Get the live status of a latest device + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get the live status of a latest device failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get the live status of a latest device + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - fleet_status + method: get + /accounts/{account_id}/dex/fleet-status/devices: + get: + description: List details for devices using WARP + operationId: dex-fleet-status-devices + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Time range end in ISO format + in: query + name: to + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + - description: Time range beginning in ISO format + in: query + name: from + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + - description: Page number + in: query + name: page + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringPage' + - description: Number of results per page + in: query + name: per_page + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringPerPage' + - description: Dimension to sort results by + in: query + name: sort_by + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringSortBy' + - description: Cloudflare colo + in: query + name: colo + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringColo' + - description: Device-specific ID, given as UUID v4 + in: query + name: device_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceId' + - description: The mode under which the WARP client is run + in: query + name: mode + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringMode' + - description: Network status + in: query + name: status + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringStatus' + - description: Operating system + in: query + name: platform + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringPlatform' + - description: WARP client version + in: query + name: version + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringVersion' + - description: 'Source: * `hourly` - device details aggregated hourly, up to 7 days prior * `last_seen` - device details, up to 60 minutes prior. Time windows exceeding 60 minutes will be rejected from June 1st, 2026. Please use ''hourly'' or ''raw'' instead for longer time ranges. * `raw` - device details, up to 7 days prior' + in: query + name: source + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringSource' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringFleetStatusDevicesResponse' + description: List devices response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List devices response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List fleet status devices + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - fleet_status + - devices + method: list + /accounts/{account_id}/dex/fleet-status/live: + get: + description: List details for live (up to 60 minutes) devices using WARP + operationId: dex-fleet-status-live + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Number of minutes before current time + in: query + name: since_minutes + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringSinceMinutes' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringFleetStatusLiveResponse' + description: List device details (live) response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List device details (live) response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List fleet status details by dimension + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - fleet_status + method: live + /accounts/{account_id}/dex/fleet-status/over-time: + get: + description: List details for devices using WARP, up to 7 days + operationId: dex-fleet-status-over-time + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Time range end in ISO format + in: query + name: to + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + - description: Time range beginning in ISO format + in: query + name: from + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + - description: Cloudflare colo + in: query + name: colo + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringColo' + - description: Device-specific ID, given as UUID v4 + in: query + name: device_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceId' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringFleetStatusOverTimeResponse' + description: List DEX devices response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: DEX HTTP test details failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List fleet status aggregate details by dimension + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - fleet_status + method: over_time + /accounts/{account_id}/dex/http-tests/{test_id}: + get: + description: Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days. + operationId: dex-endpoints-http-test-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: unique identifier for a specific test + in: path + name: test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. + in: query + name: deviceId + schema: + items: + type: string + type: array + explode: true + - description: Start time for aggregate metrics in ISO ms + in: query + name: from + schema: + type: string + - description: End time for aggregate metrics in ISO ms + in: query + name: to + schema: + type: string + - description: Time interval for aggregate time slots. + in: query + name: interval + schema: + enum: + - minute + - hour + type: string + - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. + in: query + name: colo + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringHttpDetailsResponse' + required: + - success + - errors + - messages + description: DEX HTTP test details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: DEX HTTP test details failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get details and aggregate metrics for an http test + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - http_tests + method: get + /accounts/{account_id}/dex/http-tests/{test_id}/percentiles: + get: + description: Get percentiles for an http test for a given time period between 1 hour and 7 days. + operationId: dex-endpoints-http-test-percentiles + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: unique identifier for a specific test + in: path + name: test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. + in: query + name: deviceId + schema: + items: + type: string + type: array + explode: true + - description: Start time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: from + schema: + type: string + - description: End time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: to + schema: + type: string + - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. + in: query + name: colo + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringHttpDetailsPercentilesResponse' + required: + - success + - errors + - messages + description: DEX HTTP test percentiles response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: DEX HTTP test percentiles failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get percentiles for an http test + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - http_tests + - percentiles + method: get + /accounts/{account_id}/dex/rules: + get: + description: List DEX Rules + operationId: list-dex-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number of paginated results + in: query + name: page + schema: + minimum: 1 + type: number + - description: Number of items per page + in: query + name: per_page + schema: + maximum: 50 + minimum: 1 + type: number + - description: Sort direction for sort_by property + in: query + name: sort_order + schema: + default: ASC + enum: + - ASC + - DESC + type: string + - description: Which property to sort results by + in: query + name: sort_by + schema: + default: name + enum: + - name + - created_at + - updated_at + type: string + - description: Filter results by rule name + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/digitalExperienceMonitoringListRulesResponse' + required: + - success + - errors + - messages + description: success response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: List DEX Rules failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List DEX Rules + tags: + - DEX Rules + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - rules + method: list + post: + description: Create a DEX Rule + operationId: create-dex-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringCreateRuleBody' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringDexRule' + required: + - success + - errors + - messages + description: success response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: Create DEX Rule failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a DEX Rule + tags: + - DEX Rules + x-api-token-group: + - Cloudflare DEX Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - rules + method: create + /accounts/{account_id}/dex/rules/{rule_id}: + delete: + description: Delete a DEX Rule + operationId: delete-dex-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + nullable: true + type: boolean + required: + - success + - errors + - messages + description: success response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: Update DEX Rule failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a DEX Rule + tags: + - DEX Rules + x-api-token-group: + - Cloudflare DEX Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - rules + method: delete + get: + description: Get details for a DEX Rule + operationId: get-dex-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringDexRule' + required: + - success + - errors + - messages + description: success response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: List DEX Rule failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DEX Rule + tags: + - DEX Rules + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - rules + method: get + patch: + description: Update a DEX Rule + operationId: update-dex-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringPatchRuleBody' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringDexRule' + required: + - success + - errors + - messages + description: success response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: Update DEX Rule failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a DEX Rule + tags: + - DEX Rules + x-api-token-group: + - Cloudflare DEX Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - rules + method: update + /accounts/{account_id}/dex/tests/overview: + get: + description: List DEX tests with overview metrics + operationId: dex-endpoints-list-tests-overview + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. + in: query + name: colo + schema: + type: string + - description: Optionally filter results by test name + in: query + name: testName + schema: + type: string + - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. + in: query + name: deviceId + schema: + items: + type: string + type: array + explode: true + - description: Optionally filter results to a specific device registration. Must be used in combination with a single deviceId. + in: query + name: registration_id + schema: + type: string + - description: Page number of paginated results + in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Number of items per page + in: query + name: per_page + schema: + default: 10 + maximum: 50 + minimum: 1 + type: number + - description: Filter by test type + in: query + name: kind + schema: + enum: + - http + - traceroute + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringTestsResponse' + required: + - success + - errors + - messages + description: success response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List DEX test analytics + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - tests + method: list + /accounts/{account_id}/dex/tests/unique-devices: + get: + description: Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days. + operationId: dex-endpoints-tests-unique-devices + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Optionally filter results by test name + in: query + name: testName + schema: + type: string + - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. + in: query + name: deviceId + schema: + items: + type: string + type: array + explode: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringUniqueDevicesResponse' + required: + - success + - errors + - messages + description: DEX unique devices targeted response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: DEX unique devices targeted failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get count of devices targeted + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - tests + - unique_devices + method: list + /accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path: + get: + description: Get a breakdown of hops and performance metrics for a specific traceroute test run + operationId: dex-endpoints-traceroute-test-result-network-path + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: unique identifier for a specific traceroute test + in: path + name: test_result_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringTracerouteTestResultNetworkPathResponse' + required: + - success + - errors + - messages + description: DEX traceroute test result network path response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: DEX traceroute test result network path failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get details for a specific traceroute test run + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - traceroute_test_results + - network_path + method: get + /accounts/{account_id}/dex/traceroute-tests/{test_id}: + get: + description: Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days. + operationId: dex-endpoints-traceroute-test-details + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Unique identifier for a specific test + in: path + name: test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. + in: query + name: deviceId + schema: + items: + type: string + type: array + explode: true + - description: Start time for aggregate metrics in ISO ms + in: query + name: from + schema: + type: string + - description: End time for aggregate metrics in ISO ms + in: query + name: to + schema: + type: string + - description: Time interval for aggregate time slots. + in: query + name: interval + schema: + enum: + - minute + - hour + type: string + - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. + in: query + name: colo + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringTracerouteDetailsResponse' + required: + - success + - errors + - messages + description: DEX traceroute test details response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: DEX traceroute test details response failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get details and aggregate metrics for a traceroute test + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - traceroute_tests + method: get + /accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path: + get: + description: Get a breakdown of metrics by hop for individual traceroute test runs + operationId: dex-endpoints-traceroute-test-network-path + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: unique identifier for a specific test + in: path + name: test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + - description: Device to filter tracroute result runs to + in: query + name: deviceId + schema: + type: string + - description: Start time for aggregate metrics in ISO ms + in: query + name: from + schema: + type: string + - description: End time for aggregate metrics in ISO ms + in: query + name: to + schema: + type: string + - description: Time interval for aggregate time slots. + in: query + name: interval + schema: + enum: + - minute + - hour + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringTracerouteTestNetworkPathResponse' + required: + - success + - errors + - messages + description: DEX traceroute test network path response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: DEX traceroute test network path failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get network path breakdown for a traceroute test + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - traceroute_tests + method: network_path + /accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles: + get: + description: Get percentiles for a traceroute test for a given time period between 1 hour and 7 days. + operationId: dex-endpoints-traceroute-test-percentiles + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: unique identifier for a specific test + in: path + name: test_id + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + required: true + - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. + in: query + name: deviceId + schema: + items: + type: string + type: array + explode: true + - description: Start time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: from + schema: + type: string + - description: End time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: to + schema: + type: string + - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. + in: query + name: colo + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringTracerouteDetailsPercentilesResponse' + required: + - success + - errors + - messages + description: DEX Traceroute test percentiles response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: DEX Traceroute test percentiles failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get percentiles for a traceroute test + tags: + - DEX Synthetic Application Monitoring + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - traceroute_tests + method: percentiles + /accounts/{account_id}/dex/warp-change-events: + get: + description: List WARP configuration and enablement toggle change events by device. + operationId: list-warp-change-events + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Page number of paginated results + in: query + name: page + schema: + minimum: 1 + type: number + - description: Number of items per page + in: query + name: per_page + schema: + maximum: 50 + minimum: 1 + type: number + - description: Start time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: from + schema: + type: string + - description: End time for the query in ISO (RFC3339 - ISO 8601) format + in: query + name: to + schema: + type: string + - description: Filter events by type 'config' or 'toggle' + in: query + name: type + schema: + enum: + - config + - toggle + type: string + - description: Filter events by type toggle value. Applicable to type='toggle' events only. + in: query + name: toggle + schema: + enum: + - 'on' + - 'off' + type: string + - description: Filter events by WARP configuration name changed from or to. Applicable to type='config' events only. + in: query + name: config_name + schema: + type: string + - description: Filter events by account name. + in: query + name: account_name + schema: + type: string + - description: Sort response by event timestamp. + in: query + name: sort_order + schema: + default: ASC + enum: + - ASC + - DESC + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/digitalExperienceMonitoringWarpEventsResponse' + required: + - success + - errors + - messages + description: success response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/digitalExperienceMonitoringApiResponseCommonFailure' + description: List WARP change events failure response + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List WARP change events. + tags: + - WARP Change Events + x-api-token-group: + - Cloudflare DEX Write + - Cloudflare DEX Read + - Zero Trust Report + - Zero Trust Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - dex + - warp_change_events + method: get + /accounts/{account_id}/dlp/datasets: + get: + description: Lists all DLP datasets configured for the account, including custom word lists and EDM datasets. + operationId: dlp-datasets-read-all + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDatasetArray' + required: + - success + - errors + - messages + description: Datasets read successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Datasets read failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch all datasets + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + method: list + post: + description: Creates a new DLP (Data Loss Prevention) dataset for storing custom detection patterns. Datasets can contain exact match data, word lists, or EDM (Exact Data Match) configurations. + operationId: dlp-datasets-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + case_sensitive: + description: Only applies to custom word lists. Determines if the words should be matched in a case-sensitive manner Cannot be set to false if `secret` is true or undefined + type: boolean + description: + description: The description of the dataset. + nullable: true + type: string + encoding_version: + description: Dataset encoding version Non-secret custom word lists with no header are always version 1. Secret EDM lists with no header are version 1. Multicolumn CSV with headers are version 2. Omitting this field provides the default value 0, which is interpreted the same as 1. + format: int32 + minimum: 0 + type: integer + name: + type: string + secret: + description: Generate a secret dataset. If true, the response will include a secret to use with the EDM encoder. If false, the response has no secret and the dataset is uploaded in plaintext. + type: boolean + required: + - name + type: object + description: Dataset description. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDatasetCreation' + required: + - success + - errors + - messages + description: Dataset created successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset creation failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a new dataset + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + method: create + /accounts/{account_id}/dlp/datasets/{dataset_id}: + delete: + description: This deletes all versions of the dataset. + operationId: dlp-datasets-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + description: Dataset deleted successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset delete failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a dataset + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + method: delete + get: + operationId: dlp-datasets-read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDataset' + required: + - success + - errors + - messages + description: Dataset read successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset read failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch a specific dataset + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + method: get + put: + description: Updates the configuration of an existing DLP dataset, such as its name, description, or detection settings. + operationId: dlp-datasets-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + case_sensitive: + description: Determines if the words should be matched in a case-sensitive manner. Only required for custom word lists. + type: boolean + description: + description: The description of the dataset. + nullable: true + type: string + name: + description: The name of the dataset, must be unique. + nullable: true + type: string + type: object + description: Dataset description. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDataset' + required: + - success + - errors + - messages + description: Dataset updated successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset update failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update details about a dataset + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + method: update + /accounts/{account_id}/dlp/datasets/{dataset_id}/upload: + post: + description: Creates a new version of a DLP dataset, allowing you to stage changes before activation. Used for single-column EDM and custom word lists. + operationId: dlp-datasets-create-version + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDatasetNewVersion' + required: + - success + - errors + - messages + description: Dataset version created successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset version creation failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Prepare to upload a new version of a dataset + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + - upload + method: create + /accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}: + post: + description: This is used for single-column EDMv1 and Custom Word Lists. The EDM format can only be created in the Cloudflare dashboard. For other clients, this operation can only be used for non-secret Custom Word Lists. The body must be a UTF-8 encoded, newline (NL or CRNL) separated list of words to be matched. + operationId: dlp-datasets-upload-version + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - in: path + name: version + schema: + format: int64 + type: integer + required: true + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + description: Dataset. For custom wordlists this contains UTF-8 patterns separated by newline characters. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDataset' + required: + - success + - errors + - messages + description: Dataset version uploaded successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset version upload failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload a new version of a dataset + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + - upload + method: edit + /accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}: + post: + description: This is used for multi-column EDMv2 datasets. The EDMv2 format can only be created in the Cloudflare dashboard. The columns in the response appear in the same order as in the request. + operationId: dlp-datasets-define-columns + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - in: path + name: version + schema: + format: int64 + type: integer + required: true + requestBody: + content: + application/json: + schema: + items: + properties: + header_name: + type: string + num_cells: + format: int64 + minimum: 0 + type: integer + entry_id: + format: uuid + type: string + entry_name: + type: string + required: [] + type: object + title: Existing Column + type: array + description: array of new columns to create for this dataset version. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDatasetColumnArray' + required: + - success + - errors + - messages + description: Dataset columns created successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to create dataset columns. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Sets the column information for a multi-column upload + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}: + post: + description: This is used for multi-column EDMv2 datasets. The EDMv2 format can only be created in the Cloudflare dashboard. + operationId: dlp-datasets-upload-dataset-column + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: dataset_id + in: path + required: true + description: The dataset ID. + schema: + type: string + - in: path + name: version + schema: + format: int64 + type: integer + required: true + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + description: Dataset content. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDatasetColumn' + required: + - success + - errors + - messages + description: Dataset column uploaded successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to upload dataset column. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Upload a new version of a multi-column dataset + tags: + - DLP Datasets + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - datasets + - versions + - entries + method: create + /accounts/{account_id}/dlp/document_fingerprints: + get: + description: Lists all document fingerprints configured for DLP scanning in the account. + operationId: dlp-document-fingerprints-read-all + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDocumentFingerprintArray' + required: + - success + - errors + - messages + description: Document fingerprint read was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Document fingerprint read failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve data about all document fingerprints. + tags: + - DLP Document Fingerprints + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + post: + description: Creates a new document fingerprint for DLP scanning. Document fingerprints detect documents that are structurally similar to the uploaded sample. + operationId: dlp-document-fingerprints-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + default: '' + type: string + match_percent: + format: int32 + type: integer + name: + type: string + required: + - name + - match_percent + type: object + description: Attributes of the new document fingerprint. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDocumentFingerprint' + required: + - success + - errors + - messages + description: Document fingerprint created successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Document fingerprint creation failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Creates a new document fingerprint. + tags: + - DLP Document Fingerprints + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id}: + delete: + description: Removes a document fingerprint from DLP configuration. Documents matching this fingerprint will no longer be detected. + operationId: dlp-document-fingerprints-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: document_fingerprint_id + schema: + format: uuid + type: string + required: true + responses: + '200': + description: Document fingerprint delete was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Document fingerprint delete failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a single document fingerprint. + tags: + - DLP Document Fingerprints + x-api-token-group: + - Zero Trust Write + get: + operationId: dlp-document-fingerprints-read + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: document_fingerprint_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDocumentFingerprint' + required: + - success + - errors + - messages + description: Document fingerprint read was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Document fingerprint read failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Retrieve data about a specific document fingerprint. + tags: + - DLP Document Fingerprints + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + post: + description: Updates metadata for an existing document fingerprint, such as its name or description. + operationId: dlp-document-fingerprints-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: document_fingerprint_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpUpdateDocumentFingerprint' + description: Attributes of the document fingerprint to update. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDocumentFingerprint' + required: + - success + - errors + - messages + description: Document fingerprint read was successful. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Document fingerprint read failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update the attributes of a single document fingerprint. + tags: + - DLP Document Fingerprints + x-api-token-group: + - Zero Trust Write + put: + description: Uploads a new document to create or update a fingerprint. The document structure is analyzed to enable detection of similar documents. + operationId: dlp-document-fingerprints-upload + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: document_fingerprint_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + multipart/form-data: + schema: + properties: + file: + format: binary + type: string + required: + - file + type: object + description: File used for document fingerprinting. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDocumentFingerprintUpload' + required: + - success + - errors + - messages + description: File uploaded successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to upload file. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Uploads a new version for a document fingerprint. + tags: + - DLP Document Fingerprints + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/dlp/email/account_mapping: + get: + description: Retrieves the email provider mapping configuration for DLP email scanning. + operationId: dlp-email-scanner-get-account-mapping + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpAddinAccountMapping' + required: + - success + - errors + - messages + description: Get Email Scanner Account Mapping response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Get Email Scanner Account Mapping failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get mapping + tags: + - DLP Email + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - account_mapping + method: get + post: + description: Creates a mapping between a Cloudflare account and an email provider for DLP email scanning integration. + operationId: dlp-email-scanner-create-account-mapping + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpUpdateAddinAccountMapping' + description: Account mapping. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpAddinAccountMapping' + required: + - success + - errors + - messages + description: New Email Scanner Account Mapping response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: New Email Scanner Account Mapping failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create mapping + tags: + - DLP Email + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - account_mapping + method: create + /accounts/{account_id}/dlp/email/rules: + get: + description: Lists all email scanner rules for an account. + operationId: dlp-email-scanner-list-all-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmailRuleArray' + required: + - success + - errors + - messages + description: List all email scanner rules response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: List all email scanner rules failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all email scanner rules + tags: + - DLP Email + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - rules + method: list + patch: + description: Reorders DLP email scanning rules by updating their priority values. Higher priority rules are evaluated first. + operationId: dlp-email-scanner-update-rule-priorities + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpUpdateEmailRulePriorities' + description: Rule priorities. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmailRule' + required: + - success + - errors + - messages + description: Update Email Scanner Rule priorities response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update Email Scanner Rule priorities failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update email scanner rule priorities + tags: + - DLP Email + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - rules + method: bulk_edit + post: + description: Creates a new DLP email scanning rule that defines what content patterns to detect in email messages and what actions to take. + operationId: dlp-email-scanner-create-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpCreateEmailRule' + description: Rule description. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmailRule' + required: + - success + - errors + - messages + description: New Email Scanner Rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: New Email Scanner Rule failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create email scanner rule + tags: + - DLP Email + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - rules + method: create + /accounts/{account_id}/dlp/email/rules/{rule_id}: + delete: + description: Removes a DLP email scanning rule. The rule will no longer be applied to email messages. + operationId: dlp-email-scanner-delete-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmailRule' + required: + - success + - errors + - messages + description: Delete Email Scanner Rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Delete Email Scanner Rule failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete email scanner rule + tags: + - DLP Email + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - rules + method: delete + get: + description: Gets detailed configuration for a specific DLP email scanning rule, including detection patterns and actions. + operationId: dlp-email-scanner-get-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmailRule' + required: + - success + - errors + - messages + description: Get Email Scanner Rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Get Email Scanner Rule failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an email scanner rule + tags: + - DLP Email + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - rules + method: get + put: + operationId: dlp-email-scanner-update-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpCreateEmailRule' + description: Rule description. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmailRule' + required: + - success + - errors + - messages + description: Update Email Scanner Rule response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update Email Scanner Rule failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update email scanner rule + tags: + - DLP Email + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - email + - rules + method: update + /accounts/{account_id}/dlp/entries: + get: + description: Lists all DLP entries in an account. + operationId: dlp-entries-list-all-entries + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + items: + $ref: '#/components/schemas/dlpEntryWithUploadStatus' + type: array + required: + - success + - errors + - messages + description: List all entries response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: List all entries failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all entries + tags: + - DLP Entries + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - custom + method: list + post: + description: Creates a DLP custom entry. + operationId: dlp-entries-create-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpNewEntry' + description: A new entry to create. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpCustomEntry' + required: + - success + - errors + - messages + description: Create new custom entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Create new custom entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create custom entry + tags: + - DLP Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - custom + method: create + /accounts/{account_id}/dlp/entries/custom/{entry_id}: + put: + description: Updates a DLP custom entry. + operationId: dlp-entries-update-custom-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpCustomEntryUpdate' + description: Update to be applied to the entry. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpCustomEntry' + required: + - success + - errors + - messages + description: Update entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update custom entry + tags: + - DLP Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - custom + method: update + /accounts/{account_id}/dlp/entries/integration: + post: + description: Integration entries can't be created, this will update an existing integration entry. This is needed for our generated terraform API. + operationId: dlp-entries-create-integration-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpNewPredefinedEntry' + description: This endpoint will update an existing integration entry. It is not possible to create new integration entries. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpIntegrationEntry' + required: + - success + - errors + - messages + description: Create integration entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Create entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create integration entry + tags: + - DLP Integration Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - integration + method: create + /accounts/{account_id}/dlp/entries/integration/{entry_id}: + delete: + description: This is a no-op as integration entires can't be deleted but is needed for our generated terraform API. + operationId: dlp-entries-delete-integration-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmpty' + required: + - success + - errors + - messages + description: Delete integration entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Delete entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete integration entry + tags: + - DLP Integration Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - integration + method: delete + put: + description: Updates a DLP entry. + operationId: dlp-entries-update-integration-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpPredefinedEntryUpdate' + description: Enable or disable integration entry in owning profile. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpIntegrationEntry' + required: + - success + - errors + - messages + description: Update integration entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update integration entry + tags: + - DLP Integration Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - integration + method: update + /accounts/{account_id}/dlp/entries/predefined: + post: + description: Predefined entries can't be created, this will update an existing predefined entry. This is needed for our generated terraform API. + operationId: dlp-entries-create-predefined-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpNewPredefinedEntry' + description: This endpoint will update an existing predefined entry. It is not possible to create new predefined entries. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpPredefinedEntry' + required: + - success + - errors + - messages + description: Create predefined entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Create entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create predefined entry + tags: + - DLP Predefined Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - predefined + method: create + /accounts/{account_id}/dlp/entries/predefined/{entry_id}: + delete: + description: This is a no-op as predefined entires can't be deleted but is needed for our generated terraform API. + operationId: dlp-entries-delete-predefined-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmpty' + required: + - success + - errors + - messages + description: Delete predefined entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Delete entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete predefined entry + tags: + - DLP Predefined Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - predefined + method: delete + put: + description: Updates a DLP entry. + operationId: dlp-entries-update-predefined-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpPredefinedEntryUpdate' + description: Settings to enable or disable predefined entry in owning profile. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpPredefinedEntry' + required: + - success + - errors + - messages + description: Update predefined entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update predefined entry + tags: + - DLP Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - predefined + method: update + /accounts/{account_id}/dlp/entries/{entry_id}: + delete: + description: Deletes a DLP custom entry. + operationId: dlp-entries-delete-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmpty' + required: + - success + - errors + - messages + description: Delete custom entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Delete custom entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete custom entry + tags: + - DLP Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - custom + method: delete + get: + description: Fetches a DLP entry by ID. + operationId: dlp-entries-get-dlp-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEntryWithSharedProfiles' + required: + - success + - errors + - messages + description: Get entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Get entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DLP Entry + tags: + - DLP Entries + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + - custom + method: get + put: + description: Updates a DLP entry. + operationId: dlp-entries-update-entry + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: entry_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpEntryUpdate' + description: Update to be applied to the entry. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEntry' + required: + - success + - errors + - messages + description: Update entry response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update entry failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update entry + tags: + - DLP Entries + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - entries + method: update + /accounts/{account_id}/dlp/limits: + get: + description: Retrieves current DLP usage limits and quotas for the account, including maximum allowed counts and current usage for custom entries, dataset cells, and document fingerprints. + operationId: dlp-limits-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpLimits' + required: + - success + - errors + - messages + description: Limits retrieved successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Limits get failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Fetch limits associated with DLP for account + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - limits + method: list + /accounts/{account_id}/dlp/patterns/validate: + post: + description: Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. The regex will be rejected if it uses `*` or `+`. Bound the maximum number of characters that can be matched using a range, e.g. `{1,100}`. + operationId: dlp-pattern-validate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpRegexValidationQuery' + description: Validation query. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpRegexValidationResult' + required: + - success + - errors + - messages + description: Validation response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to validate. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Validate a DLP regex pattern + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - patterns + method: validate + /accounts/{account_id}/dlp/payload_log: + get: + description: Gets the current payload logging configuration for DLP, showing whether matched content is being logged. + operationId: dlp-payload-log-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpPayloadLogSetting' + required: + - success + - errors + - messages + description: Payload log settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to get payload log settings. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get payload log settings + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - payload_logs + method: get + put: + description: Enables or disables payload logging for DLP matches. When enabled, matched content is stored for review. + operationId: dlp-payload-log-put + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpPayloadLogSettingUpdateLegacy' + description: New payload log settings. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpPayloadLogSetting' + required: + - success + - errors + - messages + description: Payload log settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to set payload log settings. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set payload log settings + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - payload_logs + method: update + /accounts/{account_id}/dlp/profiles: + get: + description: Lists all DLP profiles in an account. + operationId: dlp-profiles-list-all-profiles + parameters: + - description: Return all profiles, including those that current account does not have access to. + in: query + name: all + schema: + type: boolean + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfileArray' + required: + - success + - errors + - messages + description: List all profiles response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: List all profiles failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all profiles + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + method: list + /accounts/{account_id}/dlp/profiles/custom: + get: + description: Lists all DLP custom profiles in an account. + operationId: dlp-profiles-list-all-custom-profiles + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpCustomProfileArray' + required: + - success + - errors + - messages + description: List all custom profiles response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: List all profiles failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all custom profiles + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + post: + description: Creates a DLP custom profile. + operationId: dlp-profiles-create-custom-profiles + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpNewCustomProfile' + description: A new profile to create. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfile' + required: + - success + - errors + - messages + description: New custom profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: New custom profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create custom profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + - custom + method: create + /accounts/{account_id}/dlp/profiles/custom/{profile_id}: + delete: + description: Deletes a DLP custom profile. + operationId: dlp-profiles-delete-custom-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmpty' + required: + - success + - errors + - messages + description: Delete custom profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Delete custom profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete custom profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + - custom + method: delete + get: + description: Fetches a custom DLP profile by id. + operationId: dlp-profiles-get-custom-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfile' + required: + - success + - errors + - messages + description: Custom profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Custom profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get custom profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + - custom + method: get + put: + description: Updates a DLP custom profile. + operationId: dlp-profiles-update-custom-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpCustomProfileUpdate' + description: The updated parameters for the profile. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfile' + required: + - success + - errors + - messages + description: Update custom profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update custom profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update custom profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + - custom + method: update + /accounts/{account_id}/dlp/profiles/predefined: + post: + description: Creates a DLP predefined profile. Only supports enabling/disabling entries. + operationId: dlp-profiles-create-predefined-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpNewPredefinedProfile' + description: Predefined profiles can not be created. This endpoint will only update an existing predefined profiles settings. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfile' + required: + - success + - errors + - messages + description: Create predefined profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Create predefined profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create predefined profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/dlp/profiles/predefined/{profile_id}: + delete: + description: This is a no-op as predefined profiles can't be deleted but is needed for our generated terraform API. + operationId: dlp-profiles-delete-predefined-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmpty' + required: + - success + - errors + - messages + description: Delete predefined profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Delete predefined profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete predefined profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + - predefined + method: delete + get: + description: Fetches a predefined DLP profile by id. + operationId: dlp-profiles-get-predefined-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfile' + required: + - success + - errors + - messages + description: Predefined profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Predefined profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get predefined profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + put: + description: Updates a DLP predefined profile. Only supports enabling/disabling entries. + operationId: dlp-profiles-update-predefined-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpPredefinedProfileUpdate' + description: The updated parameters for the predefined profile. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfile' + required: + - success + - errors + - messages + description: Update predefined profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update predefined profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update predefined profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + /accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config: + get: + description: This is similar to `get_predefined` but only returns entries that are enabled. This is needed for our terraform API Fetches a predefined DLP profile by id. + operationId: dlp-profiles-get-predefined-profile-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpPredefinedProfileConfig' + required: + - success + - errors + - messages + description: Predefined profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Predefined profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get predefined profile config + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + - predefined + method: get + post: + description: This is similar to `update_predefined` but only returns entries that are enabled. This is needed for our terraform API Creates a DLP predefined profile. Only supports enabling/disabling entries. + operationId: dlp-profiles-create-predefined-profile-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpPredefinedProfileConfigUpdate' + description: Predefined profiles can not be created. This endpoint will only update an existing predefined profiles settings. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpPredefinedProfileConfig' + required: + - success + - errors + - messages + description: Create predefined profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Create predefined profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create predefined profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + put: + description: This is similar to `update_predefined` but only returns entries that are enabled. This is needed for our terraform API Updates a DLP predefined profile. Only supports enabling/disabling entries. + operationId: dlp-profiles-update-predefined-profile-config + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpPredefinedProfileConfigUpdate' + description: The updated parameters for the predefined profile. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpPredefinedProfileConfig' + required: + - success + - errors + - messages + description: Update predefined profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update predefined profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update predefined profile config + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + - predefined + method: update + /accounts/{account_id}/dlp/profiles/{profile_id}: + get: + description: Fetches a DLP profile by ID. + operationId: dlp-profiles-get-dlp-profile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: profile_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpProfile' + required: + - success + - errors + - messages + description: Get profile response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Get profile failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DLP Profile + tags: + - DLP Profiles + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - profiles + method: get + /accounts/{account_id}/dlp/settings: + delete: + operationId: dlp-settings-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDlpSettings' + required: + - success + - errors + - messages + description: DLP settings reset. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to delete DLP settings. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete (reset) DLP account-level settings to initial values. + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - settings + method: delete + get: + operationId: dlp-settings-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDlpSettings' + required: + - success + - errors + - messages + description: DLP settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to get DLP settings. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get DLP account-level settings. + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - settings + method: get + patch: + description: Missing fields keep their existing values. + operationId: dlp-settings-edit + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpDlpSettingsUpdate' + description: DLP settings fields to update. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDlpSettings' + required: + - success + - errors + - messages + description: DLP settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to update DLP settings. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Partially update DLP account-level settings. + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - settings + method: edit + put: + description: Missing fields are reset to initial (unconfigured) values. + operationId: dlp-settings-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpDlpSettingsUpdate' + description: New DLP settings. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpDlpSettings' + required: + - success + - errors + - messages + description: DLP settings. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to update DLP settings. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update DLP account-level settings (full replacement). + tags: + - DLP Settings + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - dlp + - settings + method: update + /accounts/{account_id}/gateway: + get: + description: Retrieve information about the current Zero Trust account. + operationId: zero-trust-accounts-get-zero-trust-account-information + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccount' + description: Zero Trust account information response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + gateway_tag: + $ref: '#/components/schemas/zeroTrustGatewayGatewayTag' + id: + $ref: '#/components/schemas/zeroTrustGatewayCfAccountId' + provider_name: + $ref: '#/components/schemas/zeroTrustGatewayProviderName' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Zero Trust account information response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust account information + tags: + - Zero Trust accounts + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + method: list + post: + description: Create a Zero Trust account for an existing Cloudflare account. + operationId: zero-trust-accounts-create-zero-trust-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccount' + description: Create Zero Trust account response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + gateway_tag: + $ref: '#/components/schemas/zeroTrustGatewayGatewayTag' + id: + $ref: '#/components/schemas/zeroTrustGatewayCfAccountId' + provider_name: + $ref: '#/components/schemas/zeroTrustGatewayProviderName' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Zero Trust account response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Zero Trust account + tags: + - Zero Trust accounts + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + method: create + /accounts/{account_id}/gateway/app_types: + get: + description: List all application and application type mappings. + operationId: zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayAppTypesComponentsSchemasResponseCollection' + description: List application and application type mappings response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayAppTypes' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List application and application type mappings response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List application and application type mappings + tags: + - Zero Trust Gateway application and application type mappings + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - app_types + method: list + /accounts/{account_id}/gateway/apps/review_status: + get: + description: Retrieve the statuses of your applications. + operationId: zero-trust-applications-review-status-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayApplicationsReviewStatusResponse' + description: List applications review status response. + 4XX: + content: + application/json: + schema: + type: object + x-auditable: true + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + approved_apps: + $ref: '#/components/schemas/zeroTrustGatewayApprovedApps' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + in_review_apps: + $ref: '#/components/schemas/zeroTrustGatewayInReviewApps' + unapproved_apps: + $ref: '#/components/schemas/zeroTrustGatewayUnapprovedApps' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List applications review status failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List applications review statuses + tags: + - Zero Trust applications review status + put: + description: Update the statuses of your applications. + operationId: zero-trust-applications-review-status-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + approved_apps: + $ref: '#/components/schemas/zeroTrustGatewayApprovedApps' + in_review_apps: + $ref: '#/components/schemas/zeroTrustGatewayInReviewApps' + unapproved_apps: + $ref: '#/components/schemas/zeroTrustGatewayUnapprovedApps' + required: + - approved_apps + - unapproved_apps + - in_review_apps + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayApplicationsReviewStatusResponse' + description: Update applications review status response. + 4XX: + content: + application/json: + schema: + type: object + x-auditable: true + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + approved_apps: + $ref: '#/components/schemas/zeroTrustGatewayApprovedApps' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + in_review_apps: + $ref: '#/components/schemas/zeroTrustGatewayInReviewApps' + unapproved_apps: + $ref: '#/components/schemas/zeroTrustGatewayUnapprovedApps' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update applications review status failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update applications review statuses + tags: + - Zero Trust applications review status + /accounts/{account_id}/gateway/audit_ssh_settings: + get: + description: Retrieve all Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account. + operationId: zero-trust-get-audit-ssh-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayAuditSshSettingsComponentsSchemasSingleResponse' + description: Get Zero Trust SSH settings response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + public_key: + $ref: '#/components/schemas/zeroTrustGatewayPublicKey' + seed_id: + $ref: '#/components/schemas/zeroTrustGatewayAuditSshSettingsComponentsSchemasUuid' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Zero Trust SSH settings response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust SSH settings + tags: + - Zero Trust SSH Settings + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - audit_ssh_settings + method: get + put: + description: Update Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account. + operationId: zero-trust-update-audit-ssh-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + public_key: + $ref: '#/components/schemas/zeroTrustGatewayPublicKey' + required: + - public_key + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayAuditSshSettingsComponentsSchemasSingleResponse' + description: Update Zero Trust SSH settings response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + public_key: + $ref: '#/components/schemas/zeroTrustGatewayPublicKey' + seed_id: + $ref: '#/components/schemas/zeroTrustGatewayAuditSshSettingsComponentsSchemasUuid' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Zero Trust SSH settings response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Zero Trust SSH settings + tags: + - Zero Trust SSH Settings + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - audit_ssh_settings + method: update + /accounts/{account_id}/gateway/audit_ssh_settings/rotate_seed: + post: + description: Rotate the SSH account seed that generates the host key identity when connecting through the Cloudflare SSH Proxy. + operationId: zero-trust-rotate-ssh-account-seed + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayAuditSshSettingsComponentsSchemasSingleResponse' + description: Rotate Zero Trust SSH account seed response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + public_key: + $ref: '#/components/schemas/zeroTrustGatewayPublicKey' + seed_id: + $ref: '#/components/schemas/zeroTrustGatewayAuditSshSettingsComponentsSchemasUuid' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Rotate Zero Trust SSH account seed response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Rotate Zero Trust SSH account seed + tags: + - Zero Trust SSH Settings + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - audit_ssh_settings + method: rotate_seed + /accounts/{account_id}/gateway/categories: + get: + description: List all categories. + operationId: zero-trust-gateway-categories-list-categories + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayCategoriesComponentsSchemasResponseCollection' + description: List categories response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayCategories' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List categories response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List categories + tags: + - Zero Trust Gateway categories + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - categories + method: list + /accounts/{account_id}/gateway/certificates: + get: + description: List all Zero Trust certificates for an account. + operationId: zero-trust-certificates-list-zero-trust-certificates + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayResponseCollection' + description: Lists Zero Trust certificates response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayCertificates' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Lists Zero Trust certificates response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zero Trust certificates + tags: + - Zero Trust certificates + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - certificates + method: list + post: + description: Create a new Zero Trust certificate. + operationId: zero-trust-certificates-create-zero-trust-certificate + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGenerateCertRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySingleResponse' + description: Creates Zero Trust certificate response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + binding_status: + $ref: '#/components/schemas/zeroTrustGatewayBindingStatus' + certificate: + description: Provide the CA certificate (read-only). + readOnly: true + type: string + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + expires_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + fingerprint: + description: Provide the SHA256 fingerprint of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/zeroTrustGatewayUuid' + in_use: + description: Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only). + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + issuer_org: + description: Indicate the organization that issued the certificate (read-only). + readOnly: true + type: string + x-auditable: true + issuer_raw: + description: Provide the entire issuer field of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + type: + $ref: '#/components/schemas/zeroTrustGatewayType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + uploaded_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Creates Zero Trust certificate response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Zero Trust certificate + tags: + - Zero Trust certificates + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - certificates + method: create + /accounts/{account_id}/gateway/certificates/{certificate_id}: + delete: + description: Delete a gateway-managed Zero Trust certificate. You must deactivate the certificate from the edge (inactive) before deleting it. + operationId: zero-trust-certificates-delete-zero-trust-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySingleResponse' + description: Deletes Zero Trust certificate response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + binding_status: + $ref: '#/components/schemas/zeroTrustGatewayBindingStatus' + certificate: + description: Provide the CA certificate (read-only). + readOnly: true + type: string + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + expires_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + fingerprint: + description: Provide the SHA256 fingerprint of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/zeroTrustGatewayUuid' + in_use: + description: Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only). + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + issuer_org: + description: Indicate the organization that issued the certificate (read-only). + readOnly: true + type: string + x-auditable: true + issuer_raw: + description: Provide the entire issuer field of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + type: + $ref: '#/components/schemas/zeroTrustGatewayType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + uploaded_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Deletes Zero Trust certificate response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Zero Trust certificate + tags: + - Zero Trust certificates + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - certificates + method: delete + get: + description: Get a single Zero Trust certificate. + operationId: zero-trust-certificates-zero-trust-certificate-details + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySingleResponse' + description: Gets Zero Trust certificate details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + binding_status: + $ref: '#/components/schemas/zeroTrustGatewayBindingStatus' + certificate: + description: Provide the CA certificate (read-only). + readOnly: true + type: string + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + expires_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + fingerprint: + description: Provide the SHA256 fingerprint of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/zeroTrustGatewayUuid' + in_use: + description: Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only). + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + issuer_org: + description: Indicate the organization that issued the certificate (read-only). + readOnly: true + type: string + x-auditable: true + issuer_raw: + description: Provide the entire issuer field of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + type: + $ref: '#/components/schemas/zeroTrustGatewayType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + uploaded_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Gets Zero Trust certificate details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust certificate details + tags: + - Zero Trust certificates + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - certificates + method: get + /accounts/{account_id}/gateway/certificates/{certificate_id}/activate: + post: + description: Bind a single Zero Trust certificate to the edge. + operationId: zero-trust-certificates-activate-zero-trust-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySingleResponse' + description: Activates Zero Trust certificate details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + binding_status: + $ref: '#/components/schemas/zeroTrustGatewayBindingStatus' + certificate: + description: Provide the CA certificate (read-only). + readOnly: true + type: string + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + expires_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + fingerprint: + description: Provide the SHA256 fingerprint of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/zeroTrustGatewayUuid' + in_use: + description: Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only). + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + issuer_org: + description: Indicate the organization that issued the certificate (read-only). + readOnly: true + type: string + x-auditable: true + issuer_raw: + description: Provide the entire issuer field of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + type: + $ref: '#/components/schemas/zeroTrustGatewayType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + uploaded_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Activates Zero Trust certificate details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Activate a Zero Trust certificate + tags: + - Zero Trust certificates + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - certificates + method: activate + /accounts/{account_id}/gateway/certificates/{certificate_id}/deactivate: + post: + description: Unbind a single Zero Trust certificate from the edge. + operationId: zero-trust-certificates-deactivate-zero-trust-certificate + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: {} + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySingleResponse' + description: Deactivate Zero Trust certificate details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + binding_status: + $ref: '#/components/schemas/zeroTrustGatewayBindingStatus' + certificate: + description: Provide the CA certificate (read-only). + readOnly: true + type: string + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + expires_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + fingerprint: + description: Provide the SHA256 fingerprint of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/zeroTrustGatewayUuid' + in_use: + description: Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only). + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + issuer_org: + description: Indicate the organization that issued the certificate (read-only). + readOnly: true + type: string + x-auditable: true + issuer_raw: + description: Provide the entire issuer field of the certificate (read-only). + readOnly: true + type: string + x-auditable: true + type: + $ref: '#/components/schemas/zeroTrustGatewayType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + uploaded_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Deactivate Zero Trust certificate details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Deactivate a Zero Trust certificate + tags: + - Zero Trust certificates + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - certificates + method: deactivate + /accounts/{account_id}/gateway/configuration: + get: + description: Retrieve the current Zero Trust account configuration. + operationId: zero-trust-accounts-get-zero-trust-account-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountConfig' + description: Zero Trust account configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + description: Specify account settings. + properties: + settings: + $ref: '#/components/schemas/unnamedSchemaRef055aaf3918bf29f81c09d394a864182e' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Zero Trust account configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust account configuration + tags: + - Zero Trust accounts + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - configurations + method: get + patch: + description: Update (PATCH) a single subcollection of settings such as `antivirus`, `tls_decrypt`, `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or `certificate` without updating the entire configuration object. This endpoint returns an error if any settings collection lacks proper configuration. + operationId: zero-trust-accounts-patch-zero-trust-account-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountSettings' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountConfig' + description: Zero Trust account configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + description: Specify account settings. + properties: + settings: + $ref: '#/components/schemas/unnamedSchemaRef055aaf3918bf29f81c09d394a864182e' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Zero Trust account configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Zero Trust account configuration + tags: + - Zero Trust accounts + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - configurations + method: edit + put: + description: Update the current Zero Trust account configuration. + operationId: zero-trust-accounts-update-zero-trust-account-configuration. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountSettings' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountConfig' + description: Zero Trust account configuration response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + description: Specify account settings. + properties: + settings: + $ref: '#/components/schemas/unnamedSchemaRef055aaf3918bf29f81c09d394a864182e' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Zero Trust account configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Zero Trust account configuration + tags: + - Zero Trust accounts + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - configurations + method: update + /accounts/{account_id}/gateway/configuration/custom_certificate: + get: + deprecated: true + description: Retrieve the current Zero Trust certificate configuration. + operationId: zero-trust-accounts-get-zero-trust-certificate-configuration + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayCustomCertificateSettings' + description: Zero Trust account configuration response. + 4XX: + content: + application/json: + schema: + deprecated: true + description: Specify custom certificate settings for BYO-PKI. This field is deprecated; use `certificate` instead. + nullable: true + properties: + binding_status: + description: Indicate the internal certificate status. + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + enabled: + description: Specify whether to enable a custom certificate authority for signing Gateway traffic. + nullable: true + type: boolean + x-auditable: true + id: + description: Specify the UUID of the certificate (ID from MTLS certificate store). + type: string + x-auditable: true + updated_at: + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + errors: + minLength: 1 + type: object + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + type: object + $ref: '#/components/schemas/zeroTrustGatewayMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Indicate whether the API call was successful. + enum: + - false + type: boolean + required: + - enabled + - success + - errors + - messages + - result + type: object + x-stainless-terraform-configurability: optional + description: Zero Trust account configuration response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust certificate configuration + tags: + - Zero Trust accounts + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - configurations + - custom_certificate + method: get + /accounts/{account_id}/gateway/lists: + get: + description: Fetch all Zero Trust lists for an account. + operationId: zero-trust-lists-list-zero-trust-lists + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: type + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasResponseCollection' + description: List Zero Trust lists response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayLists' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Zero Trust lists response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zero Trust lists + tags: + - Zero Trust lists + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - lists + method: list + post: + description: Creates a new Zero Trust list. + operationId: zero-trust-lists-create-zero-trust-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + items: + $ref: '#/components/schemas/zeroTrustGatewayItemsInput' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + type: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + required: + - name + - type + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySingleResponseWithListItems' + description: Create Zero Trust list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + type: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create Zero Trust list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Zero Trust list + tags: + - Zero Trust lists + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - lists + method: create + /accounts/{account_id}/gateway/lists/{list_id}: + delete: + description: Deletes a Zero Trust list. + operationId: zero-trust-lists-delete-zero-trust-list + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayEmptyResponse' + description: Delete Zero Trust list response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete Zero Trust list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Zero Trust list + tags: + - Zero Trust lists + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - lists + method: delete + get: + description: Fetch a single Zero Trust list. + operationId: zero-trust-lists-zero-trust-list-details + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayListSingleResponse' + description: Get Zero Trust list details response. + 4XX: + content: + application/json: + schema: + type: object + x-auditable: true + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + count: + $ref: '#/components/schemas/zeroTrustGatewayCount' + x-stainless-naming: + terraform: + property_name: list_count + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + type: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Zero Trust list details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust list details + tags: + - Zero Trust lists + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - lists + method: get + patch: + description: Appends or removes an item from a configured Zero Trust list. + operationId: zero-trust-lists-patch-zero-trust-list + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + append: + $ref: '#/components/schemas/zeroTrustGatewayItemsInput' + remove: + description: Lists of item values you want to remove. + items: + $ref: '#/components/schemas/zeroTrustGatewayValue' + type: array + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayListSingleResponse' + description: Patch Zero Trust list response. + 4XX: + content: + application/json: + schema: + type: object + x-auditable: true + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + count: + $ref: '#/components/schemas/zeroTrustGatewayCount' + x-stainless-naming: + terraform: + property_name: list_count + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + type: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Patch Zero Trust list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Patch Zero Trust list. + tags: + - Zero Trust lists + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - lists + method: edit + put: + description: Updates a configured Zero Trust list. Skips updating list items if not included in the payload. A non empty list items will overwrite the existing list. + operationId: zero-trust-lists-update-zero-trust-list + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + items: + $ref: '#/components/schemas/zeroTrustGatewayItemsInput' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayListSingleResponse' + description: Update Zero Trust list response. + 4XX: + content: + application/json: + schema: + type: object + x-auditable: true + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + count: + $ref: '#/components/schemas/zeroTrustGatewayCount' + x-stainless-naming: + terraform: + property_name: list_count + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + type: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update Zero Trust list response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Zero Trust list + tags: + - Zero Trust lists + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - lists + method: update + /accounts/{account_id}/gateway/lists/{list_id}/items: + get: + description: Fetch all items in a single Zero Trust list. + operationId: zero-trust-lists-zero-trust-list-items + parameters: + - in: path + name: list_id + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayListItemResponseCollection' + description: Get Zero Trust list items response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Shows the total results returned based on your search parameters. + type: number + page: + description: Show the current page within paginated list of results. + type: number + per_page: + description: Show the number of results per page of results. + type: number + total_count: + description: Show the total results available without any search parameters. + type: number + type: object + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Zero Trust list items response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust list items + tags: + - Zero Trust lists + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - lists + - items + method: list + /accounts/{account_id}/gateway/locations: + get: + description: List Zero Trust Gateway locations for an account. + operationId: zero-trust-gateway-locations-list-zero-trust-gateway-locations + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasResponseCollection' + description: Lists Zero Trust Gateway locations response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayLocations' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Lists Zero Trust Gateway locations response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zero Trust Gateway locations + tags: + - Zero Trust Gateway locations + x-api-token-group: + - Cloudflare Zero Trust Secure DNS Locations Write + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - locations + method: list + post: + description: Create a new Zero Trust Gateway location. + operationId: zero-trust-gateway-locations-create-zero-trust-gateway-location + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + client_default: + $ref: '#/components/schemas/zeroTrustGatewayClientDefault' + dns_destination_ips_id: + $ref: '#/components/schemas/zeroTrustGatewayDnsDestinationIpsIdWrite' + ecs_support: + $ref: '#/components/schemas/zeroTrustGatewayEcsSupport' + endpoints: + $ref: '#/components/schemas/zeroTrustGatewayEndpoints' + name: + $ref: '#/components/schemas/zeroTrustGatewaySchemasName' + networks: + $ref: '#/components/schemas/zeroTrustGatewayIpv4Networks' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasSingleResponse' + description: Creates a Zero Trust Gateway location response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef1b37523fdb0ae5806cd8e062492aab66' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Creates a Zero Trust Gateway location response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Zero Trust Gateway location + tags: + - Zero Trust Gateway locations + x-api-token-group: + - Cloudflare Zero Trust Secure DNS Locations Write + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - locations + method: create + /accounts/{account_id}/gateway/locations/{location_id}: + delete: + description: Delete a configured Zero Trust Gateway location. + operationId: zero-trust-gateway-locations-delete-zero-trust-gateway-location + parameters: + - in: path + name: location_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayEmptyResponse' + description: Deletes a Zero Trust Gateway location response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Deletes a Zero Trust Gateway location response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Zero Trust Gateway location + tags: + - Zero Trust Gateway locations + x-api-token-group: + - Cloudflare Zero Trust Secure DNS Locations Write + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - locations + method: delete + get: + description: Get a single Zero Trust Gateway location. + operationId: zero-trust-gateway-locations-zero-trust-gateway-location-details + parameters: + - in: path + name: location_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasSingleResponse' + description: Gets Zero Trust Gateway location details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef1b37523fdb0ae5806cd8e062492aab66' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Gets Zero Trust Gateway location details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust Gateway location details + tags: + - Zero Trust Gateway locations + x-api-token-group: + - Cloudflare Zero Trust Secure DNS Locations Write + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - locations + method: get + put: + description: Update a configured Zero Trust Gateway location. + operationId: zero-trust-gateway-locations-update-zero-trust-gateway-location + parameters: + - in: path + name: location_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + client_default: + $ref: '#/components/schemas/zeroTrustGatewayClientDefault' + dns_destination_ips_id: + $ref: '#/components/schemas/zeroTrustGatewayDnsDestinationIpsIdWrite' + ecs_support: + $ref: '#/components/schemas/zeroTrustGatewayEcsSupport' + endpoints: + $ref: '#/components/schemas/zeroTrustGatewayEndpoints' + name: + $ref: '#/components/schemas/zeroTrustGatewaySchemasName' + networks: + $ref: '#/components/schemas/zeroTrustGatewayIpv4Networks' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewaySchemasSingleResponse' + description: Updates a Zero Trust Gateway location response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef1b37523fdb0ae5806cd8e062492aab66' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Updates a Zero Trust Gateway location response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Zero Trust Gateway location + tags: + - Zero Trust Gateway locations + x-api-token-group: + - Cloudflare Zero Trust Secure DNS Locations Write + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - locations + method: update + /accounts/{account_id}/gateway/logging: + get: + description: Retrieve the current logging settings for the Zero Trust account. + operationId: zero-trust-accounts-get-logging-settings-for-the-zero-trust-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountLoggingSettingsResponse' + description: Logging settings retrieval response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + redact_pii: + default: false + description: Indicate whether to redact personally identifiable information from activity logging (PII fields include source IP, user email, user ID, device ID, URL, referrer, and user agent). + type: boolean + x-auditable: true + settings_by_rule_type: + $ref: '#/components/schemas/unnamedSchemaRefE86eeb84b7e922c35cfb0031a6309f7b' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Logging settings retrieval response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get logging settings for the Zero Trust account + tags: + - Zero Trust accounts + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - logging + method: get + put: + description: Update logging settings for the current Zero Trust account. + operationId: zero-trust-accounts-update-logging-settings-for-the-zero-trust-account + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountLoggingSettings' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountLoggingSettingsResponse' + description: Logging settings update response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + redact_pii: + default: false + description: Indicate whether to redact personally identifiable information from activity logging (PII fields include source IP, user email, user ID, device ID, URL, referrer, and user agent). + type: boolean + x-auditable: true + settings_by_rule_type: + $ref: '#/components/schemas/unnamedSchemaRefE86eeb84b7e922c35cfb0031a6309f7b' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Logging settings update response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Zero Trust account logging settings + tags: + - Zero Trust accounts + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - logging + method: update + /accounts/{account_id}/gateway/pacfiles: + get: + description: List all Zero Trust Gateway PAC files for an account. + operationId: zero-trust-gateway-pacfiles-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasResponseCollection' + description: Returns a list of PAC files response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + slug: + $ref: '#/components/schemas/zeroTrustGatewaySlug' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + url: + $ref: '#/components/schemas/zeroTrustGatewayUrl' + type: object + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a list of PAC files response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List PAC files + tags: + - Zero Trust Gateway PAC files + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - pacfiles + method: list + post: + description: Create a new Zero Trust Gateway PAC file. + operationId: zero-trust-gateway-pacfiles-create-pacfile + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + contents: + $ref: '#/components/schemas/zeroTrustGatewayContents' + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + slug: + description: URL-friendly version of the PAC file name. If not provided, it will be auto-generated + type: string + x-auditable: true + required: + - name + - contents + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasSingleResponse' + description: Returns a created PAC file response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + contents: + $ref: '#/components/schemas/zeroTrustGatewayContents' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + slug: + $ref: '#/components/schemas/zeroTrustGatewaySlug' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + url: + $ref: '#/components/schemas/zeroTrustGatewayUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a created PAC file response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a PAC file + tags: + - Zero Trust Gateway PAC files + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - pacfiles + method: create + /accounts/{account_id}/gateway/pacfiles/{pacfile_id}: + delete: + description: Delete a configured Zero Trust Gateway PAC file. + operationId: zero-trust-gateway-pacfiles-delete + parameters: + - in: path + name: pacfile_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayEmptyResponse' + description: Returns a deleted PAC file response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a deleted PAC file response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a PAC file + tags: + - Zero Trust Gateway PAC files + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - pacfiles + method: delete + get: + description: Get a single Zero Trust Gateway PAC file. + operationId: zero-trust-gateway-pacfiles-details + parameters: + - in: path + name: pacfile_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasSingleResponse' + description: Returns a PAC file response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + contents: + $ref: '#/components/schemas/zeroTrustGatewayContents' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + slug: + $ref: '#/components/schemas/zeroTrustGatewaySlug' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + url: + $ref: '#/components/schemas/zeroTrustGatewayUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a PAC file response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a PAC file + tags: + - Zero Trust Gateway PAC files + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - pacfiles + method: get + put: + description: Update a configured Zero Trust Gateway PAC file. + operationId: zero-trust-gateway-pacfiles-update + parameters: + - in: path + name: pacfile_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + contents: + $ref: '#/components/schemas/zeroTrustGatewayContents' + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + required: + - name + - description + - contents + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasSingleResponse' + description: Update a Zero Trust Gateway PAC file response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + contents: + $ref: '#/components/schemas/zeroTrustGatewayContents' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + slug: + $ref: '#/components/schemas/zeroTrustGatewaySlug' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + url: + $ref: '#/components/schemas/zeroTrustGatewayUrl' + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update a Zero Trust Gateway PAC file response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Zero Trust Gateway PAC file + tags: + - Zero Trust Gateway PAC files + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - pacfiles + method: update + /accounts/{account_id}/gateway/proxy_endpoints: + get: + description: List all Zero Trust Gateway proxy endpoints for an account. + operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasResponseCollection' + description: Returns a list of proxy endpoints response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpoints' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a list of proxy endpoints response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List proxy endpoints + tags: + - Zero Trust Gateway proxy endpoints + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - proxy_endpoints + method: list + post: + description: Create a new Zero Trust Gateway proxy endpoint. + operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + kind: + default: ip + description: The proxy endpoint kind. + enum: + - ip + - identity + type: string + name: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasName' + type: object + required: + - name + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasSingleResponse' + description: Returns a created proxy endpoint response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef4753ee81779d0e57189420079abab61e' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a created proxy endpoint response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a proxy endpoint + tags: + - Zero Trust Gateway proxy endpoints + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - proxy_endpoints + method: create + /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}: + delete: + description: Delete a configured Zero Trust Gateway proxy endpoint. + operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint + parameters: + - in: path + name: proxy_endpoint_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayEmptyResponse' + description: Returns a deleted proxy endpoint response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a deleted proxy endpoint response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a proxy endpoint + tags: + - Zero Trust Gateway proxy endpoints + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - proxy_endpoints + method: delete + get: + description: Get a single Zero Trust Gateway proxy endpoint. + operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details + parameters: + - in: path + name: proxy_endpoint_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasSingleResponse' + description: Returns a proxy endpoint response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef4753ee81779d0e57189420079abab61e' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns a proxy endpoint response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a proxy endpoint + tags: + - Zero Trust Gateway proxy endpoints + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - proxy_endpoints + method: get + patch: + description: Update a configured Zero Trust Gateway proxy endpoint. + operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint + parameters: + - in: path + name: proxy_endpoint_id + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ips: + $ref: '#/components/schemas/zeroTrustGatewayIps' + name: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasName' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasSingleResponse' + description: Returns an updated proxy endpoint response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + $ref: '#/components/schemas/unnamedSchemaRef4753ee81779d0e57189420079abab61e' + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Returns an updated proxy endpoint response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a proxy endpoint + tags: + - Zero Trust Gateway proxy endpoints + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - proxy_endpoints + method: edit + /accounts/{account_id}/gateway/rules: + get: + description: List Zero Trust Gateway rules for an account. + operationId: zero-trust-gateway-rules-list-zero-trust-gateway-rules + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayRulesComponentsSchemasResponseCollection' + description: List Zero Trust Gateway rules response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayRules' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Zero Trust Gateway rules response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zero Trust Gateway rules + tags: + - Zero Trust Gateway rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - rules + method: list + post: + description: Create a new Zero Trust Gateway rule. + operationId: zero-trust-gateway-rules-create-zero-trust-gateway-rule + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + $ref: '#/components/schemas/zeroTrustGatewayAction' + description: + $ref: '#/components/schemas/zeroTrustGatewaySchemasDescription' + device_posture: + $ref: '#/components/schemas/zeroTrustGatewayDevicePosture' + enabled: + $ref: '#/components/schemas/zeroTrustGatewayEnabled' + expiration: + $ref: '#/components/schemas/zeroTrustGatewayExpiration' + filters: + $ref: '#/components/schemas/zeroTrustGatewayFilters' + identity: + $ref: '#/components/schemas/zeroTrustGatewayIdentity' + name: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasName' + precedence: + $ref: '#/components/schemas/zeroTrustGatewayPrecedence' + rule_settings: + $ref: '#/components/schemas/zeroTrustGatewayRuleSettings' + schedule: + $ref: '#/components/schemas/zeroTrustGatewaySchedule' + traffic: + $ref: '#/components/schemas/zeroTrustGatewayTraffic' + required: + - name + - action + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasSingleResponse' + description: Create a Zero Trust Gateway rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + action: + $ref: '#/components/schemas/zeroTrustGatewayAction' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + deleted_at: + $ref: '#/components/schemas/zeroTrustGatewayDeletedAt' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewaySchemasDescription' + device_posture: + $ref: '#/components/schemas/zeroTrustGatewayDevicePosture' + enabled: + $ref: '#/components/schemas/zeroTrustGatewayEnabled' + expiration: + $ref: '#/components/schemas/zeroTrustGatewayExpiration' + filters: + $ref: '#/components/schemas/zeroTrustGatewayFilters' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + identity: + $ref: '#/components/schemas/zeroTrustGatewayIdentity' + name: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasName' + precedence: + $ref: '#/components/schemas/zeroTrustGatewayPrecedence' + read_only: + $ref: '#/components/schemas/zeroTrustGatewayReadOnly' + rule_settings: + $ref: '#/components/schemas/zeroTrustGatewayRuleSettings' + schedule: + $ref: '#/components/schemas/zeroTrustGatewaySchedule' + sharable: + $ref: '#/components/schemas/zeroTrustGatewaySharable' + source_account: + $ref: '#/components/schemas/zeroTrustGatewaySourceAccount' + traffic: + $ref: '#/components/schemas/zeroTrustGatewayTraffic' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + version: + $ref: '#/components/schemas/zeroTrustGatewayVersion' + warning_status: + $ref: '#/components/schemas/zeroTrustGatewayWarningStatus' + required: + - name + - precedence + - enabled + - action + - traffic + - filters + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Create a Zero Trust Gateway rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Zero Trust Gateway rule + tags: + - Zero Trust Gateway rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - rules + method: create + /accounts/{account_id}/gateway/rules/tenant: + get: + description: List Zero Trust Gateway rules for the parent account of an account in the MSP configuration. + operationId: zero-trust-gateway-rules-list-zero-trust-gateway-rules-tenant + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayRulesComponentsSchemasResponseCollection' + description: List Zero Trust Gateway rules response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayRules' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: List Zero Trust Gateway rules response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zero Trust Gateway rules inherited from the parent account + tags: + - Zero Trust Gateway rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - rules + method: list_tenant + /accounts/{account_id}/gateway/rules/{rule_id}: + delete: + description: Delete a Zero Trust Gateway rule. + operationId: zero-trust-gateway-rules-delete-zero-trust-gateway-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayEmptyResponse' + description: Delete a Zero Trust Gateway rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + type: object + enum: + - null + nullable: true + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Delete a Zero Trust Gateway rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Zero Trust Gateway rule + tags: + - Zero Trust Gateway rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - rules + method: delete + get: + description: Get a single Zero Trust Gateway rule. + operationId: zero-trust-gateway-rules-zero-trust-gateway-rule-details + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasSingleResponse' + description: Get Zero Trust Gateway rule details response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + action: + $ref: '#/components/schemas/zeroTrustGatewayAction' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + deleted_at: + $ref: '#/components/schemas/zeroTrustGatewayDeletedAt' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewaySchemasDescription' + device_posture: + $ref: '#/components/schemas/zeroTrustGatewayDevicePosture' + enabled: + $ref: '#/components/schemas/zeroTrustGatewayEnabled' + expiration: + $ref: '#/components/schemas/zeroTrustGatewayExpiration' + filters: + $ref: '#/components/schemas/zeroTrustGatewayFilters' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + identity: + $ref: '#/components/schemas/zeroTrustGatewayIdentity' + name: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasName' + precedence: + $ref: '#/components/schemas/zeroTrustGatewayPrecedence' + read_only: + $ref: '#/components/schemas/zeroTrustGatewayReadOnly' + rule_settings: + $ref: '#/components/schemas/zeroTrustGatewayRuleSettings' + schedule: + $ref: '#/components/schemas/zeroTrustGatewaySchedule' + sharable: + $ref: '#/components/schemas/zeroTrustGatewaySharable' + source_account: + $ref: '#/components/schemas/zeroTrustGatewaySourceAccount' + traffic: + $ref: '#/components/schemas/zeroTrustGatewayTraffic' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + version: + $ref: '#/components/schemas/zeroTrustGatewayVersion' + warning_status: + $ref: '#/components/schemas/zeroTrustGatewayWarningStatus' + required: + - name + - precedence + - enabled + - action + - traffic + - filters + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Zero Trust Gateway rule details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust Gateway rule details. + tags: + - Zero Trust Gateway rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - rules + method: get + put: + description: Update a configured Zero Trust Gateway rule. + operationId: zero-trust-gateway-rules-update-zero-trust-gateway-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + action: + $ref: '#/components/schemas/zeroTrustGatewayAction' + description: + $ref: '#/components/schemas/zeroTrustGatewaySchemasDescription' + device_posture: + $ref: '#/components/schemas/zeroTrustGatewayDevicePosture' + enabled: + $ref: '#/components/schemas/zeroTrustGatewayEnabled' + expiration: + $ref: '#/components/schemas/zeroTrustGatewayExpiration' + filters: + $ref: '#/components/schemas/zeroTrustGatewayFilters' + identity: + $ref: '#/components/schemas/zeroTrustGatewayIdentity' + name: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasName' + precedence: + $ref: '#/components/schemas/zeroTrustGatewayPrecedence' + rule_settings: + $ref: '#/components/schemas/zeroTrustGatewayRuleSettings' + schedule: + $ref: '#/components/schemas/zeroTrustGatewaySchedule' + traffic: + $ref: '#/components/schemas/zeroTrustGatewayTraffic' + required: + - name + - action + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasSingleResponse' + description: Update a Zero Trust Gateway rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + action: + $ref: '#/components/schemas/zeroTrustGatewayAction' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + deleted_at: + $ref: '#/components/schemas/zeroTrustGatewayDeletedAt' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewaySchemasDescription' + device_posture: + $ref: '#/components/schemas/zeroTrustGatewayDevicePosture' + enabled: + $ref: '#/components/schemas/zeroTrustGatewayEnabled' + expiration: + $ref: '#/components/schemas/zeroTrustGatewayExpiration' + filters: + $ref: '#/components/schemas/zeroTrustGatewayFilters' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + identity: + $ref: '#/components/schemas/zeroTrustGatewayIdentity' + name: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasName' + precedence: + $ref: '#/components/schemas/zeroTrustGatewayPrecedence' + read_only: + $ref: '#/components/schemas/zeroTrustGatewayReadOnly' + rule_settings: + $ref: '#/components/schemas/zeroTrustGatewayRuleSettings' + schedule: + $ref: '#/components/schemas/zeroTrustGatewaySchedule' + sharable: + $ref: '#/components/schemas/zeroTrustGatewaySharable' + source_account: + $ref: '#/components/schemas/zeroTrustGatewaySourceAccount' + traffic: + $ref: '#/components/schemas/zeroTrustGatewayTraffic' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + version: + $ref: '#/components/schemas/zeroTrustGatewayVersion' + warning_status: + $ref: '#/components/schemas/zeroTrustGatewayWarningStatus' + required: + - name + - precedence + - enabled + - action + - traffic + - filters + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Update a Zero Trust Gateway rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Zero Trust Gateway rule + tags: + - Zero Trust Gateway rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - rules + method: update + /accounts/{account_id}/gateway/rules/{rule_id}/reset_expiration: + post: + description: Resets the expiration of a Zero Trust Gateway Rule if its duration elapsed and it has a default duration. The Zero Trust Gateway Rule must have values for both `expiration.expires_at` and `expiration.duration`. + operationId: zero-trust-gateway-rules-reset-expiration-zero-trust-gateway-rule + parameters: + - name: rule_id + in: path + required: true + description: The rule ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasSingleResponse' + description: Reset the expiration of a Zero Trust Gateway rule response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + action: + $ref: '#/components/schemas/zeroTrustGatewayAction' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + deleted_at: + $ref: '#/components/schemas/zeroTrustGatewayDeletedAt' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewaySchemasDescription' + device_posture: + $ref: '#/components/schemas/zeroTrustGatewayDevicePosture' + enabled: + $ref: '#/components/schemas/zeroTrustGatewayEnabled' + expiration: + $ref: '#/components/schemas/zeroTrustGatewayExpiration' + filters: + $ref: '#/components/schemas/zeroTrustGatewayFilters' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + identity: + $ref: '#/components/schemas/zeroTrustGatewayIdentity' + name: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasName' + precedence: + $ref: '#/components/schemas/zeroTrustGatewayPrecedence' + read_only: + $ref: '#/components/schemas/zeroTrustGatewayReadOnly' + rule_settings: + $ref: '#/components/schemas/zeroTrustGatewayRuleSettings' + schedule: + $ref: '#/components/schemas/zeroTrustGatewaySchedule' + sharable: + $ref: '#/components/schemas/zeroTrustGatewaySharable' + source_account: + $ref: '#/components/schemas/zeroTrustGatewaySourceAccount' + traffic: + $ref: '#/components/schemas/zeroTrustGatewayTraffic' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + version: + $ref: '#/components/schemas/zeroTrustGatewayVersion' + warning_status: + $ref: '#/components/schemas/zeroTrustGatewayWarningStatus' + required: + - name + - precedence + - enabled + - action + - traffic + - filters + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Reset the expiration of a Zero Trust Gateway rule response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Reset the expiration of a Zero Trust Gateway Rule + tags: + - Zero Trust Gateway rules + x-stackql-sdk: + service: zero_trust + resource_chain: + - gateway + - rules + method: reset_expiration + /accounts/{account_id}/infrastructure/targets: + get: + description: "Lists and sorts an account\u2019s targets. Filters are optional and are ANDed together." + operationId: infra-targets-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Hostname of a target + in: query + name: hostname + schema: + nullable: true + type: string + - description: Partial match to the hostname of a target + in: query + name: hostname_contains + schema: + nullable: true + type: string + - description: Private virtual network identifier of the target + in: query + name: virtual_network_id + schema: + format: uuid + nullable: true + type: string + - description: IPv4 address of the target + in: query + name: ip_v4 + schema: + nullable: true + type: string + - description: IPv6 address of the target + in: query + name: ip_v6 + schema: + nullable: true + type: string + - description: Date and time at which the target was created before (inclusive) + in: query + name: created_before + schema: + format: date-time + nullable: true + type: string + - description: Date and time at which the target was created after (inclusive) + in: query + name: created_after + schema: + format: date-time + nullable: true + type: string + - description: Date and time at which the target was modified before (inclusive) + in: query + name: modified_before + schema: + format: date-time + nullable: true + type: string + - description: Date and time at which the target was modified after (inclusive) + in: query + name: modified_after + schema: + format: date-time + nullable: true + type: string + - description: Filters for targets that have any of the following IP addresses. Specify `ips` multiple times in query parameter to build list of candidates. + in: query + name: ips + schema: + items: + type: string + type: array + explode: true + - description: Filters for targets that have any of the following UUIDs. Specify `target_ids` multiple times in query parameter to build list of candidates. + in: query + name: target_ids + schema: + items: + format: uuid + type: string + type: array + explode: true + - description: Filters for targets whose IP addresses look like the specified string. Supports `*` as a wildcard character + in: query + name: ip_like + schema: + nullable: true + type: string + - description: Defines an IPv4 filter range's starting value (inclusive). Requires `ipv4_end` to be specified as well. + in: query + name: ipv4_start + schema: + nullable: true + type: string + - description: Defines an IPv4 filter range's ending value (inclusive). Requires `ipv4_start` to be specified as well. + in: query + name: ipv4_end + schema: + nullable: true + type: string + - description: Defines an IPv6 filter range's starting value (inclusive). Requires `ipv6_end` to be specified as well. + in: query + name: ipv6_start + schema: + nullable: true + type: string + - description: Defines an IPv6 filter range's ending value (inclusive). Requires `ipv6_start` to be specified as well. + in: query + name: ipv6_end + schema: + nullable: true + type: string + - description: Current page in the response + in: query + name: page + schema: + default: 1 + format: int32 + minimum: 1 + type: integer + - description: Max amount of entries returned per page + in: query + name: per_page + schema: + default: 1000 + format: int32 + maximum: 1000 + minimum: 1 + type: integer + - description: The field to sort by. + in: query + name: order + schema: + enum: + - hostname + - created_at + type: string + - description: The sorting direction. + in: query + name: direction + schema: + $ref: '#/components/schemas/infraSortingDirection' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/infraTargetArray' + required: + - success + - errors + - messages + description: Successfully retrieved all targets in the account + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to retrieve all targets in the account + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all targets + tags: + - Infrastructure Access Targets + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - infrastructure + - targets + method: list + post: + operationId: infra-targets-post + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + hostname: + description: A non-unique field that refers to a target. Case insensitive, maximum length of 255 characters, supports the use of special characters dash and period, does not support spaces, and must start and end with an alphanumeric character. + type: string + x-auditable: true + ip: + $ref: '#/components/schemas/infraIPInfo' + required: + - hostname + - ip + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/infraTarget' + required: + - success + - errors + - messages + description: Successfully created the target + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to create the target + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new target + tags: + - Infrastructure Access Targets + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - infrastructure + - targets + method: create + /accounts/{account_id}/infrastructure/targets/batch: + delete: + deprecated: true + description: Removes one or more targets. + operationId: infra-targets-delete-batch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + description: Successfully deleted the targets + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to delete the targets + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete targets (Deprecated) + tags: + - Infrastructure Access Targets + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - infrastructure + - targets + method: bulk_delete + put: + description: Adds one or more targets. + operationId: infra-targets-put-batch + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + items: + properties: + hostname: + description: A non-unique field that refers to a target. Case insensitive, maximum length of 255 characters, supports the use of special characters dash and period, does not support spaces, and must start and end with an alphanumeric character. + type: string + x-auditable: true + ip: + $ref: '#/components/schemas/infraIPInfo' + required: + - hostname + - ip + type: object + type: array + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/infraTargetArray' + required: + - success + - errors + - messages + description: Successfully created the targets + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to create the targets + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new targets + tags: + - Infrastructure Access Targets + /accounts/{account_id}/infrastructure/targets/batch_delete: + post: + description: Removes one or more targets. + operationId: infra-targets-delete-batch-post + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + target_ids: + description: List of target IDs to bulk delete + items: + $ref: '#/components/schemas/infraTargetId' + type: array + required: + - target_ids + type: object + responses: + '200': + description: Successfully deleted the targets + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to delete the targets + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete targets + tags: + - Infrastructure Access Targets + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - infrastructure + - targets + method: bulk_delete_v2 + /accounts/{account_id}/infrastructure/targets/{target_id}: + delete: + operationId: infra-targets-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: target_id + schema: + $ref: '#/components/schemas/infraTargetId' + required: true + responses: + '200': + description: Successfully deleted the target + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to delete the target + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete target + tags: + - Infrastructure Access Targets + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - infrastructure + - targets + method: delete + get: + operationId: infra-targets-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: target_id + schema: + $ref: '#/components/schemas/infraTargetId' + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/infraTarget' + required: + - success + - errors + - messages + description: Successfully retrieved the target + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to retrieve the target + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get target + tags: + - Infrastructure Access Targets + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - infrastructure + - targets + method: get + put: + operationId: infra-targets-put + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: target_id + schema: + $ref: '#/components/schemas/infraTargetId' + required: true + requestBody: + content: + application/json: + schema: + properties: + hostname: + description: A non-unique field that refers to a target. Case insensitive, maximum length of 255 characters, supports the use of special characters dash and period, does not support spaces, and must start and end with an alphanumeric character. + type: string + x-auditable: true + ip: + $ref: '#/components/schemas/infraIPInfo' + required: + - hostname + - ip + type: object + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/infraMessages' + messages: + $ref: '#/components/schemas/infraMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/infraTarget' + required: + - success + - errors + - messages + description: Successfully updated the target + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/infraApiResponseCommonFailure' + description: Failed to update the target + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update target + tags: + - Infrastructure Access Targets + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - infrastructure + - targets + method: update + /accounts/{account_id}/resource-library/applications: + get: + description: List applications with different filters. + operationId: getApplications + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: "Filter applications using key:value format. Supported filter keys: - name: Filter by application name (e.g., name:HR) - id: Filter by application ID (e.g., id:0b63249c-95bf-4cc0-a7cc-d7faaaf1dac0) - human_id: Filter by human-readable ID (e.g., human_id:HR) - hostname: Filter by hostname or support domain (e.g., hostname:portal.example.com) - source: Filter by application source name (e.g., source:cloudflare) - ip_subnet: Filter by IP subnet using CIDR containment \u2014 returns applications where any stored subnet contains the search value (e.g., ip_subnet:10.0.1.5/32 matches apps with 10.0.0.0/16) - intel_id: Filter by Intel API ID (e.g., intel_id:498). ." + in: query + name: filter + schema: + type: string + - description: Limit of number of results to return (max 250). + in: query + name: limit + schema: + default: 25 + type: integer + - description: Offset of results to return. + in: query + name: offset + schema: + default: 0 + type: integer + - description: Order by result by field name and order (e.g., name:asc). + in: query + name: order_by + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/alexandriaGetApplicationsResponse' + description: Get the application response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Returns the total number of results for the requested service. + type: number + page: + description: Returns the current page within paginated list of results. + type: number + per_page: + description: Returns the number of results per page of results. + type: number + total_count: + description: Returns the total results available without any search parameters. + type: number + type: object + result: + description: Returns the list of applications. + items: + $ref: '#/components/schemas/alexandriaApplication' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get application response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List applications + tags: + - Applications + x-stackql-sdk: + service: zero_trust + resource_chain: + - resource_library + - applications + method: list + /accounts/{account_id}/resource-library/applications/{id}: + get: + description: Get application by ID. + operationId: getApplicationById + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/alexandriaGetApplicationResponse' + description: Get the application response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + application_confidence_score: + $ref: '#/components/schemas/alexandriaApplicationConfidenceScore' + application_score_composition: + $ref: '#/components/schemas/alexandriaApplicationScoreComposition' + application_source: + $ref: '#/components/schemas/alexandriaApplicationSource' + application_type: + $ref: '#/components/schemas/alexandriaApplicationType' + application_type_description: + $ref: '#/components/schemas/alexandriaApplicationTypeDescription' + created_at: + $ref: '#/components/schemas/alexandriaApplicationCreatedAt' + readOnly: true + gen_ai_score: + $ref: '#/components/schemas/alexandriaApplicationGenAiScore' + hostnames: + $ref: '#/components/schemas/alexandriaApplicationHostnames' + human_id: + $ref: '#/components/schemas/alexandriaApplicationHumanId' + id: + $ref: '#/components/schemas/alexandriaApplicationId' + intel_id: + $ref: '#/components/schemas/alexandriaApplicationIntelId' + ip_subnets: + $ref: '#/components/schemas/alexandriaApplicationIpSubnets' + name: + $ref: '#/components/schemas/alexandriaApplicationName' + port_protocols: + $ref: '#/components/schemas/alexandriaApplicationPortProtocols' + support_domains: + $ref: '#/components/schemas/alexandriaApplicationSupportDomains' + updated_at: + $ref: '#/components/schemas/alexandriaApplicationUpdatedAt' + readOnly: true + version: + $ref: '#/components/schemas/alexandriaApplicationVersion' + required: + - application_source + - application_type + - application_type_description + - gen_ai_score + - application_confidence_score + - created_at + - hostnames + - human_id + - id + - ip_subnets + - name + - port_protocols + - support_domains + - updated_at + - version + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Get application by id response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get application + tags: + - Applications + x-stackql-sdk: + service: zero_trust + resource_chain: + - resource_library + - applications + method: get + /accounts/{account_id}/resource-library/categories: + get: + description: List application categories. + operationId: getCategories + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: Limit of number of results to return. + in: query + name: limit + schema: + default: 25 + type: integer + - description: Offset of results to return. + in: query + name: offset + schema: + default: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/alexandriaGetCategoriesResponse' + description: Get all application categories response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + - false + type: boolean + result: + description: Returns the list of categories. + items: + $ref: '#/components/schemas/alexandriaCategory' + type: array + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Get application categories response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List application categories + tags: + - Category + x-stackql-sdk: + service: zero_trust + resource_chain: + - resource_library + - categories + method: list + /accounts/{account_id}/resource-library/categories/{id}: + get: + description: Get application category by ID. + operationId: getCategoryById + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: id + in: path + required: true + description: Resource ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/alexandriaGetCategoryResponse' + description: Get application category by id response. + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + - false + type: boolean + result: + properties: + created_at: + $ref: '#/components/schemas/alexandriaCategoryCreatedAt' + readOnly: true + description: + $ref: '#/components/schemas/alexandriaCategoryDescription' + id: + $ref: '#/components/schemas/alexandriaCategoryId' + name: + $ref: '#/components/schemas/alexandriaCategoryName' + required: + - created_at + - description + - id + - name + type: object + enum: + - null + required: + - success + - errors + - messages + - success + - errors + - messages + - result + type: object + description: Get application category by id response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get application category + tags: + - Category + x-stackql-sdk: + service: zero_trust + resource_chain: + - resource_library + - categories + method: get + /accounts/{account_id}/teamnet/routes: + get: + description: Lists and filters private network routes in an account. + operationId: tunnel-route-list-tunnel-routes + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: comment + schema: + $ref: '#/components/schemas/tunnelRouteComment' + - in: query + name: is_deleted + schema: + description: If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included. + type: boolean + - in: query + name: network_subset + schema: + description: If set, only list routes that are contained within this IP range. + $ref: '#/components/schemas/tunnelIpNetwork' + - in: query + name: network_superset + schema: + description: If set, only list routes that contain this IP range. + $ref: '#/components/schemas/tunnelIpNetwork' + - in: query + name: existed_at + schema: + $ref: '#/components/schemas/tunnelExistedAt' + - in: query + name: tunnel_id + schema: + $ref: '#/components/schemas/tunnelTunnelId' + - in: query + name: route_id + schema: + $ref: '#/components/schemas/tunnelRouteId' + - in: query + name: tun_types + schema: + $ref: '#/components/schemas/tunnelTunnelTypes' + - in: query + name: virtual_network_id + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/tunnelPerPage' + - in: query + name: page + schema: + $ref: '#/components/schemas/tunnelPageNumber' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTeamnetResponseCollection' + description: List tunnel routes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelTeamnet' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List tunnel routes response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List tunnel routes + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare One Networks Read + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + method: list + post: + description: Routes a private network through a Cloudflare Tunnel. + operationId: tunnel-route-create-a-tunnel-route + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelRouteComment' + network: + $ref: '#/components/schemas/tunnelIpNetwork' + tunnel_id: + $ref: '#/components/schemas/tunnelTunnelId' + virtual_network_id: + $ref: '#/components/schemas/tunnelVirtualNetworkIdComputedOptional' + required: + - network + - tunnel_id + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelRouteResponseSingle' + description: Create a tunnel route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create a tunnel route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a tunnel route + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + method: create + /accounts/{account_id}/teamnet/routes/ip/{ip}: + get: + description: Fetches routes that contain the given IP address. + operationId: tunnel-route-get-tunnel-route-by-ip + parameters: + - in: path + name: ip + schema: + $ref: '#/components/schemas/tunnelIp' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: virtual_network_id + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + - description: When the virtual_network_id parameter is not provided the request filter will default search routes that are in the default virtual network for the account. If this parameter is set to false, the search will include routes that do not have a virtual network. + in: query + name: default_virtual_network_fallback + schema: + default: true + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTeamnetResponseSingle' + description: Get tunnel route by IP response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelRouteComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelRouteId' + network: + $ref: '#/components/schemas/tunnelIpNetwork' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + tunnel_id: + $ref: '#/components/schemas/tunnelTunnelId' + tunnel_name: + $ref: '#/components/schemas/tunnelTunnelName' + virtual_network_id: + $ref: '#/components/schemas/tunnelVirtualNetworkIdComputedOptional' + virtual_network_name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get tunnel route by IP response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get tunnel route by IP + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare One Networks Read + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + - ips + method: get + /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}: + delete: + deprecated: true + description: Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type. + operationId: tunnel-route-delete-a-tunnel-route-with-cidr + parameters: + - in: path + name: ip_network_encoded + schema: + $ref: '#/components/schemas/tunnelIpNetworkEncoded' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: virtual_network_id + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + - in: query + name: tun_type + schema: + $ref: '#/components/schemas/tunnelTunnelType' + - in: query + name: tunnel_id + schema: + $ref: '#/components/schemas/tunnelTunnelId' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelRouteResponseSingle' + description: Delete a tunnel route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete a tunnel route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a tunnel route (CIDR Endpoint) + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stainless-deprecation-message: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs. + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + - networks + method: delete + patch: + deprecated: true + description: Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. + operationId: tunnel-route-update-a-tunnel-route-with-cidr + parameters: + - in: path + name: ip_network_encoded + schema: + $ref: '#/components/schemas/tunnelIpNetworkEncoded' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelRouteResponseSingle' + description: Update a tunnel route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update a tunnel route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a tunnel route (CIDR Endpoint) + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stainless-deprecation-message: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs. + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + - networks + method: edit + post: + deprecated: true + description: Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format. + operationId: tunnel-route-create-a-tunnel-route-with-cidr + parameters: + - in: path + name: ip_network_encoded + schema: + $ref: '#/components/schemas/tunnelIpNetworkEncoded' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelRouteComment' + tunnel_id: + $ref: '#/components/schemas/tunnelTunnelId' + virtual_network_id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + required: + - tunnel_id + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelRouteResponseSingle' + description: Create a tunnel route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create a tunnel route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a tunnel route (CIDR Endpoint) + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stainless-deprecation-message: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs. + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + - networks + method: create + /accounts/{account_id}/teamnet/routes/{route_id}: + delete: + description: Deletes a private network route from an account. + operationId: tunnel-route-delete-a-tunnel-route + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/tunnelRouteId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelRouteResponseSingle' + description: Delete a tunnel route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete a tunnel route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a tunnel route + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + method: delete + get: + description: Get a private network route in an account. + operationId: tunnel-route-get-tunnel-route + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: route_id + schema: + $ref: '#/components/schemas/tunnelRouteId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelRouteResponseSingle' + description: Get a tunnel route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get a tunnel route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get tunnel route + tags: + - Tunnel Routing + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + method: get + patch: + description: Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request. + operationId: tunnel-route-update-a-tunnel-route + parameters: + - in: path + name: route_id + schema: + $ref: '#/components/schemas/tunnelRouteId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelRouteComment' + network: + $ref: '#/components/schemas/tunnelIpNetwork' + tunnel_id: + $ref: '#/components/schemas/tunnelTunnelId' + virtual_network_id: + $ref: '#/components/schemas/tunnelVirtualNetworkIdComputedOptional' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelRouteResponseSingle' + description: Update a tunnel route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6' + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update a tunnel route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a tunnel route + tags: + - Tunnel Routing + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - routes + method: edit + /accounts/{account_id}/teamnet/virtual_networks: + get: + description: Lists and filters virtual networks in an account. + operationId: tunnel-virtual-network-list-virtual-networks + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: id + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + - in: query + name: name + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + - deprecated: true + in: query + name: is_default + schema: + description: If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included. + type: boolean + x-stainless-deprecation-message: Use the is_default_network property instead. + x-stainless-ignore: true + - in: query + name: is_default_network + schema: + description: If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included. + type: boolean + - in: query + name: is_deleted + schema: + description: If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelVnetResponseCollection' + description: List virtual networks response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelVirtualNetwork' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List virtual networks response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List virtual networks + tags: + - Tunnel Virtual Network + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare One Networks Read + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - virtual_networks + method: list + post: + description: Adds a new virtual network to an account. + operationId: tunnel-virtual-network-create-a-virtual-network + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelVirtualNetworkComment' + is_default: + deprecated: true + description: If `true`, this virtual network is the default for the account. + type: boolean + x-auditable: true + x-stainless-deprecation-message: Use the is_default_network property instead. + x-stainless-ignore: true + is_default_network: + $ref: '#/components/schemas/tunnelIsDefaultNetworkOptional' + name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelVnetResponseSingle' + description: Create a virtual network response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelVirtualNetworkComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + is_default_network: + $ref: '#/components/schemas/tunnelIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + required: + - id + - name + - is_default_network + - comment + - created_at + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create a virtual network response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a virtual network + tags: + - Tunnel Virtual Network + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - virtual_networks + method: create + /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}: + delete: + description: Deletes an existing virtual network. + operationId: tunnel-virtual-network-delete + parameters: + - in: path + name: virtual_network_id + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelVnetResponseSingle' + description: Delete a virtual network response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelVirtualNetworkComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + is_default_network: + $ref: '#/components/schemas/tunnelIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + required: + - id + - name + - is_default_network + - comment + - created_at + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete a virtual network response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a virtual network + tags: + - Tunnel Virtual Network + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - virtual_networks + method: delete + get: + description: Get a virtual network. + operationId: tunnel-virtual-network-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: virtual_network_id + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelVnetResponseSingle' + description: A virtual network response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelVirtualNetworkComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + is_default_network: + $ref: '#/components/schemas/tunnelIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + required: + - id + - name + - is_default_network + - comment + - created_at + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: A virtual network response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a virtual network + tags: + - Tunnel Virtual Network + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - virtual_networks + method: get + patch: + description: Updates an existing virtual network. + operationId: tunnel-virtual-network-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: virtual_network_id + schema: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + required: true + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelVirtualNetworkComment' + is_default_network: + $ref: '#/components/schemas/tunnelIsDefaultNetworkOptional' + name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelVnetResponseSingle' + description: Update a virtual network response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelVirtualNetworkComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + is_default_network: + $ref: '#/components/schemas/tunnelIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + required: + - id + - name + - is_default_network + - comment + - created_at + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update a virtual network response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a virtual network + tags: + - Tunnel Virtual Network + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - virtual_networks + method: edit + /accounts/{account_id}/tunnels: + get: + description: Lists and filters all types of Tunnels in an account. + operationId: cloudflare-tunnel-list-all-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: A user-friendly name for the tunnel. + type: string + - in: query + name: is_deleted + schema: + description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included. + type: boolean + - in: query + name: existed_at + schema: + $ref: '#/components/schemas/tunnelExistedAt' + - in: query + name: uuid + schema: + $ref: '#/components/schemas/tunnelTunnelId' + - in: query + name: was_active_at + schema: + format: date-time + type: string + - in: query + name: was_inactive_at + schema: + format: date-time + type: string + - in: query + name: include_prefix + schema: + type: string + - in: query + name: exclude_prefix + schema: + type: string + - in: query + name: tun_types + schema: + $ref: '#/components/schemas/tunnelTunnelTypes' + - in: query + name: status + schema: + $ref: '#/components/schemas/tunnelStatus' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/tunnelPerPage' + - in: query + name: page + schema: + $ref: '#/components/schemas/tunnelPageNumber' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelResponseCollection' + description: List Tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + type: object + description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + remote_config: + $ref: '#/components/schemas/tunnelRemoteConfig' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List All Tunnels + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: cloudflared Write' + - 'Cloudflare One Connector: cloudflared Read' + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + method: list + /accounts/{account_id}/warp_connector: + get: + description: Lists and filters Warp Connector Tunnels in an account. + operationId: cloudflare-tunnel-list-warp-connector-tunnels + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: A user-friendly name for the tunnel. + type: string + - in: query + name: is_deleted + schema: + description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included. + type: boolean + - in: query + name: existed_at + schema: + $ref: '#/components/schemas/tunnelExistedAt' + - in: query + name: uuid + schema: + $ref: '#/components/schemas/tunnelTunnelId' + - in: query + name: was_active_at + schema: + format: date-time + type: string + - in: query + name: was_inactive_at + schema: + format: date-time + type: string + - in: query + name: include_prefix + schema: + type: string + - in: query + name: exclude_prefix + schema: + type: string + - in: query + name: status + schema: + $ref: '#/components/schemas/tunnelStatus' + - in: query + name: per_page + schema: + $ref: '#/components/schemas/tunnelPerPage' + - in: query + name: page + schema: + $ref: '#/components/schemas/tunnelPageNumber' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelWarpConnectorResponseCollection' + description: List Warp Connector Tunnels response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelWarpConnectorTunnel' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Warp Connector Tunnels response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Warp Connector Tunnels + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: WARP Write' + - 'Cloudflare One Connector: WARP Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + method: list + post: + description: Creates a new Warp Connector Tunnel in an account. + operationId: cloudflare-tunnel-create-a-warp-connector-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + ha: + default: false + description: Indicates that the tunnel will be created to be highly available. If omitted, defaults to false. + type: boolean + name: + $ref: '#/components/schemas/tunnelTunnelName' + required: + - name + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelWarpConnectorResponseSingle' + description: Create a Warp Connector Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create a Warp Connector Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a Warp Connector Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: WARP Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + method: create + /accounts/{account_id}/warp_connector/{tunnel_id}: + delete: + description: Deletes a Warp Connector Tunnel from an account. + operationId: cloudflare-tunnel-delete-a-warp-connector-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelWarpConnectorResponseSingle' + description: Delete a Warp Connector Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete a Warp Connector Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a Warp Connector Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: WARP Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + method: delete + get: + description: Fetches a single Warp Connector Tunnel. + operationId: cloudflare-tunnel-get-a-warp-connector-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelWarpConnectorResponseSingle' + description: Get a Warp Connector Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get a Warp Connector Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Warp Connector Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: WARP Write' + - 'Cloudflare One Connector: WARP Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + method: get + patch: + description: Updates an existing Warp Connector Tunnel. + operationId: cloudflare-tunnel-update-a-warp-connector-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + name: + $ref: '#/components/schemas/tunnelTunnelName' + tunnel_secret: + $ref: '#/components/schemas/tunnelTunnelSecret' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelWarpConnectorResponseSingle' + description: Update a Warp Connector Tunnel response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update a Warp Connector Tunnel response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a Warp Connector Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: WARP Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + method: edit + /accounts/{account_id}/warp_connector/{tunnel_id}/connections: + get: + description: Fetches connection details for a WARP Connector Tunnel. + operationId: cloudflare-tunnel-list-warp-connector-tunnel-connections + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelWarpConnectorConnectionsResponse' + description: List WARP Connector Tunnel connections response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelTunnelWarpConnectorClient' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List WARP Connector connections response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List WARP Connector Tunnel connections + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: WARP Write' + - 'Cloudflare One Connector: WARP Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + - connections + method: get + /accounts/{account_id}/warp_connector/{tunnel_id}/connectors/{connector_id}: + get: + description: Fetches connector and connection details for a WARP Connector Tunnel. + operationId: cloudflare-tunnel-get-warp-connector-tunnel-connector + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + - in: path + name: connector_id + schema: + $ref: '#/components/schemas/tunnelClientId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelWarpConnectorClientResponse' + description: Get WARP Connector Tunnel connector response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: A WARP Connector client that maintains a connection to a Cloudflare data center. + properties: + arch: + $ref: '#/components/schemas/tunnelArch' + conns: + $ref: '#/components/schemas/tunnelWarpConnectorConnections' + features: + $ref: '#/components/schemas/tunnelFeatures' + ha_status: + $ref: '#/components/schemas/tunnelHaStatus' + id: + $ref: '#/components/schemas/tunnelClientId' + run_at: + $ref: '#/components/schemas/tunnelRunAt' + version: + $ref: '#/components/schemas/tunnelVersion' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get WARP Connector Tunnel connector response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get WARP Connector Tunnel connector + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - Cloudflare One Connectors Read + - 'Cloudflare One Connector: WARP Write' + - 'Cloudflare One Connector: WARP Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + - connectors + method: get + /accounts/{account_id}/warp_connector/{tunnel_id}/failover: + put: + description: Triggers a manual failover for a specific WARP Connector Tunnel, setting the specified client as the active connector. The tunnel must be configured for high availability (HA) and the client must be linked to the tunnel. + operationId: cloudflare-tunnel-manual-failover-warp-connector-tunnel + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + client_id: + $ref: '#/components/schemas/tunnelClientIdInput' + required: + - client_id + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelEmptyResponse' + description: Manual failover response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Manual failover response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Trigger a manual failover for a WARP Connector Tunnel + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: WARP Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + - failover + method: update + /accounts/{account_id}/warp_connector/{tunnel_id}/token: + get: + description: Gets the token used to associate warp device with a specific Warp Connector tunnel. + operationId: cloudflare-tunnel-get-a-warp-connector-tunnel-token + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: tunnel_id + in: path + required: true + description: The Cloudflare Tunnel ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelTunnelResponseToken' + description: Get a Warp Connector Tunnel token response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + description: The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel. + readOnly: true + type: string + x-sensitive: true + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get a Warp Connector Tunnel token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a Warp Connector Tunnel token + tags: + - Cloudflare Tunnel + x-api-token-group: + - Cloudflare One Connectors Write + - 'Cloudflare One Connector: cloudflared Write' + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - tunnels + - warp_connector + - token + method: get + /accounts/{account_id}/zerotrust/connectivity_settings: + get: + description: Gets the Zero Trust Connectivity Settings for the given account. + operationId: zero-trust-accounts-get-connectivity-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelZeroTrustConnectivitySettingsResponse' + description: Get Zero Trust Connectivity Settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelApiResponseCommonFailure' + description: Get Zero Trust Connectivity Settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zero Trust Connectivity Settings + tags: + - Zero Trust Connectivity Settings + x-api-token-group: + - Zero Trust Report + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - connectivity_settings + method: get + patch: + description: Updates the Zero Trust Connectivity Settings for the given account. + operationId: zero-trust-accounts-patch-connectivity-settings + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + icmp_proxy_enabled: + $ref: '#/components/schemas/tunnelIcmpProxyEnabled' + offramp_warp_enabled: + $ref: '#/components/schemas/tunnelOfframpWarpEnabled' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelZeroTrustConnectivitySettingsResponse' + description: Update Zero Trust Connectivity Settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelApiResponseCommonFailure' + description: Update Zero Trust Connectivity Settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Updates the Zero Trust Connectivity Settings + tags: + - Zero Trust Connectivity Settings + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - connectivity_settings + method: edit + /accounts/{account_id}/zerotrust/routes/hostname: + get: + description: Lists and filters hostname routes in an account. + operationId: zero-trust-networks-route-hostname-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: id + schema: + $ref: '#/components/schemas/tunnelHostnameRouteId' + - description: If set, only list hostname routes that contain a substring of the given value, the filter is case-insensitive. + in: query + name: hostname + schema: + $ref: '#/components/schemas/tunnelHostname' + - description: If set, only list hostname routes that point to a specific tunnel. + in: query + name: tunnel_id + schema: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + - in: query + name: comment + schema: + $ref: '#/components/schemas/tunnelHostnameQueryComment' + - in: query + name: existed_at + schema: + $ref: '#/components/schemas/tunnelExistedAt' + - in: query + name: is_deleted + schema: + default: false + description: If `true`, only return deleted hostname routes. If `false`, exclude deleted hostname routes. + type: boolean + - in: query + name: per_page + schema: + $ref: '#/components/schemas/tunnelPerPage' + - in: query + name: page + schema: + $ref: '#/components/schemas/tunnelPageNumber' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelHostnameRouteResponseCollection' + description: List hostname routes response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelHostnameRoute' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List hostname routes failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List hostname routes + tags: + - Zero Trust Hostname Route + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare One Networks Read + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - hostname_routes + method: list + post: + description: Create a hostname route. + operationId: zero-trust-networks-route-hostname-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelHostnameComment' + hostname: + $ref: '#/components/schemas/tunnelHostname' + tunnel_id: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelHostnameRouteResponseSingle' + description: Create hostname route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelHostnameComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + hostname: + $ref: '#/components/schemas/tunnelHostname' + id: + $ref: '#/components/schemas/tunnelHostnameRouteId' + tunnel_id: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + tunnel_name: + $ref: '#/components/schemas/tunnelSchemasTunnelName' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create hostname route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create hostname route + tags: + - Zero Trust Hostname Route + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - hostname_routes + method: create + /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}: + delete: + description: Delete a hostname route. + operationId: zero-trust-networks-route-hostname-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: hostname_route_id + schema: + $ref: '#/components/schemas/tunnelHostnameRouteId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelHostnameRouteResponseSingle' + description: Delete hostname route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelHostnameComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + hostname: + $ref: '#/components/schemas/tunnelHostname' + id: + $ref: '#/components/schemas/tunnelHostnameRouteId' + tunnel_id: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + tunnel_name: + $ref: '#/components/schemas/tunnelSchemasTunnelName' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete hostname route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete hostname route + tags: + - Zero Trust Hostname Route + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - hostname_routes + method: delete + get: + description: Get a hostname route. + operationId: zero-trust-networks-route-hostname-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: hostname_route_id + schema: + $ref: '#/components/schemas/tunnelHostnameRouteId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelHostnameRouteResponseSingle' + description: Get hostname route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelHostnameComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + hostname: + $ref: '#/components/schemas/tunnelHostname' + id: + $ref: '#/components/schemas/tunnelHostnameRouteId' + tunnel_id: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + tunnel_name: + $ref: '#/components/schemas/tunnelSchemasTunnelName' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get hostname route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get hostname route + tags: + - Zero Trust Hostname Route + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare One Networks Read + - Cloudflare Tunnel Write + - Cloudflare Tunnel Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - hostname_routes + method: get + patch: + description: Updates a hostname route. + operationId: zero-trust-networks-route-hostname-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: hostname_route_id + schema: + $ref: '#/components/schemas/tunnelHostnameRouteId' + required: true + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelHostnameComment' + hostname: + $ref: '#/components/schemas/tunnelHostname' + tunnel_id: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelHostnameRouteResponseSingle' + description: Update hostname route response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelHostnameComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + hostname: + $ref: '#/components/schemas/tunnelHostname' + id: + $ref: '#/components/schemas/tunnelHostnameRouteId' + tunnel_id: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + tunnel_name: + $ref: '#/components/schemas/tunnelSchemasTunnelName' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update hostname route response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update hostname route + tags: + - Zero Trust Hostname Route + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare Tunnel Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - hostname_routes + method: edit + /accounts/{account_id}/zerotrust/subnets: + get: + description: Lists and filters subnets in an account. + operationId: zero-trust-networks-subnets-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: If set, only list subnets with the given name + in: query + name: name + schema: + $ref: '#/components/schemas/tunnelSubnetQueryName' + - in: query + name: comment + schema: + $ref: '#/components/schemas/tunnelSubnetQueryComment' + - in: query + name: network + schema: + description: If set, only list the subnet whose network exactly matches the given CIDR. + $ref: '#/components/schemas/tunnelIpNetworkEncoded' + - in: query + name: existed_at + schema: + $ref: '#/components/schemas/tunnelExistedAt' + - description: If set, only include subnets in the given address family - `v4` or `v6` + in: query + name: address_family + schema: + $ref: '#/components/schemas/tunnelAddressFamily' + - in: query + name: is_default_network + schema: + description: If `true`, only include default subnets. If `false`, exclude default subnets subnets. If not set, all subnets will be included. + type: boolean + - in: query + name: is_deleted + schema: + description: If `true`, only include deleted subnets. If `false`, exclude deleted subnets. If not set, all subnets will be included. + type: boolean + - in: query + name: sort_order + schema: + description: Sort order of the results. `asc` means oldest to newest, `desc` means newest to oldest. If not set, they will not be in any particular order. + enum: + - asc + - desc + type: string + - in: query + name: subnet_types + schema: + description: If set, the types of subnets to include, separated by comma. + enum: + - cloudflare_source + - warp + type: string + - in: query + name: per_page + schema: + $ref: '#/components/schemas/tunnelPerPage' + - in: query + name: page + schema: + $ref: '#/components/schemas/tunnelPageNumber' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSubnetResponseCollection' + description: List subnets response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelSubnet' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List subnets response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Subnets + tags: + - Zero Trust Subnets + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare One Networks Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - subnets + method: list + /accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family}: + patch: + description: Updates the Cloudflare Source subnet of the given address family + operationId: zero-trust-networks-subnet-update-cloudflare-source + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: address_family + schema: + $ref: '#/components/schemas/tunnelAddressFamily' + required: true + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSubnetResponseSingle' + description: Update subnet response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelSubnetId' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + subnet_type: + $ref: '#/components/schemas/tunnelSubnetType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update subnet response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Cloudflare Source Subnet + tags: + - Zero Trust Subnets + x-api-token-group: + - Cloudflare One Networks Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - subnets + - cloudflare_source + method: update + /accounts/{account_id}/zerotrust/subnets/warp: + post: + description: 'Create a WARP IP assignment subnet. Currently, only IPv4 subnets can be created. **Network constraints:** - The network must be within one of the following private IP ranges: - `10.0.0.0/8` (RFC 1918) - `172.16.0.0/12` (RFC 1918) - `192.168.0.0/16` (RFC 1918) - `100.64.0.0/10` (RFC 6598 - CGNAT) - The subnet must have a prefix length of `/24` or larger (e.g., `/16`, `/20`, `/24` are valid; `/25`, `/28` are not)' + operationId: zero-trust-networks-subnet-create-warp + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + required: + - name + - network + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSubnetResponseSingle' + description: Create subnet response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelSubnetId' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + subnet_type: + $ref: '#/components/schemas/tunnelSubnetType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Create subnet response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create WARP IP subnet + tags: + - Zero Trust Subnets + x-api-token-group: + - Cloudflare One Networks Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - subnets + - warp + method: create + /accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}: + delete: + description: Delete a WARP IP assignment subnet. This operation is idempotent - deleting an already-deleted or non-existent subnet will return success with a null result. + operationId: zero-trust-networks-subnet-delete-warp + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: subnet_id + schema: + $ref: '#/components/schemas/tunnelSubnetId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSubnetResponseSingleNullable' + description: Delete subnet response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + nullable: true + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelSubnetId' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + subnet_type: + $ref: '#/components/schemas/tunnelSubnetType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Delete subnet response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete WARP IP subnet + tags: + - Zero Trust Subnets + x-api-token-group: + - Cloudflare One Networks Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - subnets + - warp + method: delete + get: + description: Get a WARP IP assignment subnet. + operationId: zero-trust-networks-subnet-get-warp + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: subnet_id + schema: + $ref: '#/components/schemas/tunnelSubnetId' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSubnetResponseSingle' + description: Get subnet response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelSubnetId' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + subnet_type: + $ref: '#/components/schemas/tunnelSubnetType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Get subnet response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get WARP IP subnet + tags: + - Zero Trust Subnets + x-api-token-group: + - Cloudflare One Networks Write + - Cloudflare One Networks Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - subnets + - warp + method: get + patch: + description: Updates a WARP IP assignment subnet. **Update constraints:** - The `network` field cannot be modified for WARP subnets. Only `name`, `comment`, and `is_default_network` can be updated. - IPv6 subnets cannot be updated + operationId: zero-trust-networks-subnet-update-warp + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: subnet_id + schema: + $ref: '#/components/schemas/tunnelSubnetId' + required: true + requestBody: + content: + application/json: + schema: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tunnelSubnetResponseSingle' + description: Update subnet response + 4XX: + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelSubnetId' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + subnet_type: + $ref: '#/components/schemas/tunnelSubnetType' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Update subnet response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update WARP IP subnet + tags: + - Zero Trust Subnets + x-api-token-group: + - Cloudflare One Networks Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - networks + - subnets + - warp + method: edit + /accounts/{account_id}/zt_risk_scoring/behaviors: + get: + description: Retrieves configured risk score behaviors that define how user actions affect their overall risk score. + operationId: dlp-risk-score-behaviors-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpBehaviors' + required: + - success + - errors + - messages + description: Risk scoring behaviors. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to get risk scoring behaviors. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get all behaviors and associated configuration + tags: + - Zero Trust Risk Scoring + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - behaviours + method: get + put: + description: Updates risk score behavior configurations, defining weights and thresholds for risk calculation. + operationId: dlp-risk-score-behaviors-put + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpUpdateBehaviors' + description: Behaviors. + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpUpdateBehaviors' + required: + - success + - errors + - messages + description: Dataset created successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset creation failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update configuration for risk behaviors + tags: + - Zero Trust Risk Scoring + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - behaviours + method: update + /accounts/{account_id}/zt_risk_scoring/integrations: + get: + description: Lists all configured Zero Trust risk score integrations for the account. + operationId: dlp-zt-risk-score-integration-list + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpRiskScoreIntegrationArray' + required: + - success + - errors + - messages + description: List response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: List failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all risk score integrations for the account. + tags: + - Zero Trust Risk Scoring Integrations + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - integrations + method: list + post: + description: Creates a new Zero Trust risk score integration, connecting external risk signals to Cloudflare's risk scoring system. + operationId: dlp-zt-risk-score-integration-create + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpCreateIntegrationBody' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpRiskScoreIntegration' + required: + - success + - errors + - messages + description: Create response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Create failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create new risk score integration. + tags: + - Zero Trust Risk Scoring Integrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - integrations + method: create + /accounts/{account_id}/zt_risk_scoring/integrations/reference_id/{reference_id}: + get: + description: Retrieves a Zero Trust risk score integration using its external reference ID. + operationId: dlp-zt-risk-score-integration-get-by-reference-id + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: reference_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpRiskScoreIntegration' + required: + - success + - errors + - messages + description: Get response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Get failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get risk score integration by reference id. + tags: + - Zero Trust Risk Scoring Integrations + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - integrations + - references + method: get + /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}: + delete: + description: Removes a Zero Trust risk score integration, disconnecting the external risk signal source. + operationId: dlp-zt-risk-score-integration-delete + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: integration_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmpty' + required: + - success + - errors + - messages + description: Delete response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Delete failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a risk score integration. + tags: + - Zero Trust Risk Scoring Integrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - integrations + method: delete + get: + operationId: dlp-zt-risk-score-integration-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: integration_id + schema: + format: uuid + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpRiskScoreIntegration' + required: + - success + - errors + - messages + description: Get response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Get failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get risk score integration by id. + tags: + - Zero Trust Risk Scoring Integrations + x-api-token-group: + - Zero Trust Read + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - integrations + method: get + put: + description: Overwrite the reference_id, tenant_url, and active values with the ones provided. + operationId: dlp-zt-risk-score-integration-update + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: path + name: integration_id + schema: + format: uuid + type: string + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpUpdateIntegrationBody' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpRiskScoreIntegration' + required: + - success + - errors + - messages + description: Update response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Update failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a risk score integration. + tags: + - Zero Trust Risk Scoring Integrations + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - integrations + method: update + /accounts/{account_id}/zt_risk_scoring/summary: + get: + description: Gets an aggregate summary of risk scores across the account, including distribution and trends. + operationId: dlp-risk-score-summary-get + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/dlpRiskSummary' + required: + - success + - errors + - messages + description: Risk score for all users in the account. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to get risk scores. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get risk score info for all users in the account + tags: + - Zero Trust Risk Scoring + x-api-token-group: + - 'Zero Trust: PII Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + - summary + method: get + /accounts/{account_id}/zt_risk_scoring/{user_id}: + get: + description: Retrieves the detailed risk score breakdown for a specific user, including contributing factors. + operationId: dlp-risk-score-summary-get-for-user + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + total_pages: + description: The number of total pages in the entire result set. + type: number + type: object + result: + $ref: '#/components/schemas/dlpRiskEvents' + required: + - success + - errors + - messages + description: Risk events. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Failed to get risk events. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get risk event/score information for a specific user + tags: + - Zero Trust Risk Scoring + x-api-token-group: + - 'Zero Trust: PII Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + method: get + /accounts/{account_id}/zt_risk_scoring/{user_id}/reset: + post: + description: Resets risk scores for specified users, clearing their accumulated risk history. + operationId: dlp-risk-score-reset-post + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - name: user_id + in: path + required: true + description: The user ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/dlpMessages' + messages: + $ref: '#/components/schemas/dlpMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/dlpEmpty' + required: + - success + - errors + - messages + description: Dataset created successfully. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/dlpApiResponseCommonFailure' + description: Dataset creation failed. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Clear the risk score for a particular user + tags: + - Zero Trust Risk Scoring + x-api-token-group: + - Zero Trust Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - risk_scoring + method: reset + /zones/{zone_id}/devices/policy/certificates: + get: + description: Fetches device certificate provisioning. + operationId: devices-get-policy-certificates + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDevicesPolicyCertificatesSingle' + description: Get WARP client provision certificates enabled status response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + enabled: + description: The current status of the device policy certificate provisioning feature for WARP clients. + type: boolean + required: + - enabled + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get WARP client provision certificates enabled status failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get device certificate provisioning status + tags: + - Devices + x-api-token-group: + - SSL and Certificates Write + - SSL and Certificates Read + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - default + - certificates + method: get + patch: + description: Enable Zero Trust Clients to provision a certificate, containing a x509 subject, and referenced by Access device posture policies when the client visits MTLS protected domains. This facilitates device posture without a WARP session. + operationId: devices-update-policy-certificates + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDevicesPolicyCertificates' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/teamsDevicesDevicesPolicyCertificatesSingle' + description: Update a zone to toggle permission for devices to provision certificates response. + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + enabled: + description: The current status of the device policy certificate provisioning feature for WARP clients. + type: boolean + required: + - enabled + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch a zone to toggle permission for devices to provision certificates failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update device certificate provisioning status + tags: + - Devices + x-api-token-group: + - SSL and Certificates Write + x-stackql-sdk: + service: zero_trust + resource_chain: + - devices + - policies + - default + - certificates + method: edit + /accounts/{account_id}/access/apps: + get: + description: Lists all Access applications in an account or zone. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: The name of the app. + type: string + - in: query + name: domain + schema: + description: The domain of the app. + type: string + - in: query + name: aud + schema: + description: The aud of the app. + type: string + - in: query + name: target_attributes + schema: + description: Target Criteria attributes in key=value format. + type: string + - in: query + name: exact + schema: + description: True for only exact string matches against passed name/domain query parameters. + type: boolean + - in: query + name: search + schema: + description: Search for apps by other listed query parameters. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 1000 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppsComponentsSchemasResponseCollection' + description: List Access applications response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access applications response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access applications + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: list + operationId: get_accounts_account_id_access_apps + post: + description: Adds a new application to Access. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppRequest' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/accessAppResponse' + required: + - success + - errors + - messages + description: Add an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Add an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: create + operationId: post_accounts_account_id_access_apps + /zones/{zone_id}/access/apps: + get: + description: Lists all Access applications in an account or zone. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: name + schema: + description: The name of the app. + type: string + - in: query + name: domain + schema: + description: The domain of the app. + type: string + - in: query + name: aud + schema: + description: The aud of the app. + type: string + - in: query + name: target_attributes + schema: + description: Target Criteria attributes in key=value format. + type: string + - in: query + name: exact + schema: + description: True for only exact string matches against passed name/domain query parameters. + type: boolean + - in: query + name: search + schema: + description: Search for apps by other listed query parameters. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 1000 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppsComponentsSchemasResponseCollection' + description: List Access applications response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access applications response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access applications + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: list + operationId: get_zones_zone_id_access_apps + post: + description: Adds a new application to Access. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppRequest' + responses: + '201': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/accessAppResponse' + required: + - success + - errors + - messages + description: Add an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Add an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: create + operationId: post_zones_zone_id_access_apps + /accounts/{account_id}/access/apps/ca: + get: + description: Lists short-lived certificate CAs and their public keys. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 100 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCaComponentsSchemasResponseCollection' + description: List short-lived certificate CAs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List short-lived certificate CAs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List short-lived certificate CAs + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: list + operationId: get_accounts_account_id_access_apps_ca + /zones/{zone_id}/access/apps/ca: + get: + description: Lists short-lived certificate CAs and their public keys. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 100 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCaComponentsSchemasResponseCollection' + description: List short-lived certificate CAs response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List short-lived certificate CAs response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List short-lived certificate CAs + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: list + operationId: get_zones_zone_id_access_apps_ca + /accounts/{account_id}/access/apps/{app_id}: + get: + description: Fetches information about an Access application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppsComponentsSchemasSingleResponse' + description: Get an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: get + operationId: get_accounts_account_id_access_apps_app_id + put: + description: Updates an Access application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/accessAppResponse' + required: + - success + - errors + - messages + description: Update an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: update + operationId: put_accounts_account_id_access_apps_app_id + delete: + description: Deletes an application from Access. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: delete + operationId: delete_accounts_account_id_access_apps_app_id + /zones/{zone_id}/access/apps/{app_id}: + get: + description: Fetches information about an Access application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppsComponentsSchemasSingleResponse' + description: Get an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: get + operationId: get_zones_zone_id_access_apps_app_id + put: + description: Updates an Access application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppRequest' + responses: + '200': + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/accessAppResponse' + required: + - success + - errors + - messages + description: Update an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: update + operationId: put_zones_zone_id_access_apps_app_id + delete: + description: Deletes an application from Access. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete an Access application response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access application response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access application + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: delete + operationId: delete_zones_zone_id_access_apps_app_id + /accounts/{account_id}/access/apps/{app_id}/ca: + get: + description: Fetches a short-lived certificate CA and its public key. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCaComponentsSchemasSingleResponse' + description: Get a short-lived certificate CA response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get a short-lived certificate CA response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a short-lived certificate CA + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: get + operationId: get_accounts_account_id_access_apps_app_id_ca + post: + description: Generates a new short-lived certificate CA and public key. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCaComponentsSchemasSingleResponse' + description: Create a short-lived certificate CA response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create a short-lived certificate CA response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a short-lived certificate CA + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: create + operationId: post_accounts_account_id_access_apps_app_id_ca + delete: + description: Deletes a short-lived certificate CA. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasIdResponse' + description: Delete a short-lived certificate CA response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete a short-lived certificate CA response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a short-lived certificate CA + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: delete + operationId: delete_accounts_account_id_access_apps_app_id_ca + /zones/{zone_id}/access/apps/{app_id}/ca: + get: + description: Fetches a short-lived certificate CA and its public key. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCaComponentsSchemasSingleResponse' + description: Get a short-lived certificate CA response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get a short-lived certificate CA response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a short-lived certificate CA + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: get + operationId: get_zones_zone_id_access_apps_app_id_ca + post: + description: Generates a new short-lived certificate CA and public key. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCaComponentsSchemasSingleResponse' + description: Create a short-lived certificate CA response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create a short-lived certificate CA response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a short-lived certificate CA + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: create + operationId: post_zones_zone_id_access_apps_app_id_ca + delete: + description: Deletes a short-lived certificate CA. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasIdResponse' + description: Delete a short-lived certificate CA response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete a short-lived certificate CA response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a short-lived certificate CA + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - cas + method: delete + operationId: delete_zones_zone_id_access_apps_app_id_ca + /accounts/{account_id}/access/apps/{app_id}/policies: + get: + description: Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 200 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasResponseCollection' + description: List Access application policies response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access application policies response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access application policies + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: list + operationId: get_accounts_account_id_access_apps_app_id_policies + post: + description: Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPolicyRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasSingleResponse' + description: Create an Access application policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create an Access application policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: create + operationId: post_accounts_account_id_access_apps_app_id_policies + /zones/{zone_id}/access/apps/{app_id}/policies: + get: + description: Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 200 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasResponseCollection' + description: List Access application policies response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access application policies response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access application policies + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: list + operationId: get_zones_zone_id_access_apps_app_id_policies + post: + description: Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPolicyRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasSingleResponse' + description: Create an Access application policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create an Access application policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: create + operationId: post_zones_zone_id_access_apps_app_id_policies + /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}: + get: + description: Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasSingleResponse' + description: Get an Access policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access policy response failure. + security: + - api_email: [] + api_key: [] + summary: Get an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: get + operationId: get_accounts_account_id_access_apps_app_id_policies_policy_id + put: + description: Updates an Access policy specific to an application. To update a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasSingleResponse' + description: Update an Access application policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access application policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: update + operationId: put_accounts_account_id_access_apps_app_id_policies_policy_id + delete: + description: Deletes an Access policy specific to an application. To delete a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasIdResponse' + description: Delete an Access application policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access application policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: delete + operationId: delete_accounts_account_id_access_apps_app_id_policies_policy_id + /zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}: + get: + description: Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasSingleResponse' + description: Get an Access policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access policy response failure. + security: + - api_email: [] + api_key: [] + summary: Get an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: get + operationId: get_zones_zone_id_access_apps_app_id_policies_policy_id + put: + description: Updates an Access policy specific to an application. To update a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPolicyRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasSingleResponse' + description: Update an Access application policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access application policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: update + operationId: put_zones_zone_id_access_apps_app_id_policies_policy_id + delete: + description: Deletes an Access policy specific to an application. To delete a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: policy_id + in: path + required: true + description: The Access policy ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppPoliciesComponentsSchemasIdResponse' + description: Delete an Access application policy response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access application policy response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access application policy + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - policies + method: delete + operationId: delete_zones_zone_id_access_apps_app_id_policies_policy_id + /accounts/{account_id}/access/apps/{app_id}/revoke_tokens: + post: + description: Revokes all tokens issued for an application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasEmptyResponse' + description: Revoke application tokens response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Revoke application tokens response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Revoke application tokens + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: revoke_tokens + operationId: post_accounts_account_id_access_apps_app_id_revoke_tokens + /zones/{zone_id}/access/apps/{app_id}/revoke_tokens: + post: + description: Revokes all tokens issued for an application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasEmptyResponse' + description: Revoke application tokens response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Revoke application tokens response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Revoke application tokens + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + method: revoke_tokens + operationId: post_zones_zone_id_access_apps_app_id_revoke_tokens + /accounts/{account_id}/access/apps/{app_id}/settings: + put: + description: Updates Access application settings. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppSettingsRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponseUpdate' + description: Update Access application settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update Access application settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Access application settings + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - settings + method: update + operationId: put_accounts_account_id_access_apps_app_id_settings + patch: + description: Updates Access application settings. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppSettingsRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponseUpdate' + description: Update Access application settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update Access application settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Access application settings + tags: [] + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - settings + method: edit + operationId: patch_accounts_account_id_access_apps_app_id_settings + /zones/{zone_id}/access/apps/{app_id}/settings: + put: + description: Updates Access application settings. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppSettingsRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponseUpdate' + description: Update Access application settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update Access application settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Access application settings + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - settings + method: update + operationId: put_zones_zone_id_access_apps_app_id_settings + patch: + description: Updates Access application settings. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessAppSettingsRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponseUpdate' + description: Update Access application settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update Access application settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update Access application settings + tags: [] + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - settings + method: edit + operationId: patch_zones_zone_id_access_apps_app_id_settings + /accounts/{account_id}/access/apps/{app_id}/user_policy_checks: + get: + description: Tests if a specific user has permission to access an application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyCheckResponse' + description: Test Access policies response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Test Access policies response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Test Access policies + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - user_policy_checks + method: list + operationId: get_accounts_account_id_access_apps_app_id_user_policy_checks + /zones/{zone_id}/access/apps/{app_id}/user_policy_checks: + get: + description: Tests if a specific user has permission to access an application. + parameters: + - name: app_id + in: path + required: true + description: The Access application ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessPolicyCheckResponse' + description: Test Access policies response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Test Access policies response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Test Access policies + tags: [] + x-api-token-group: + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - applications + - user_policy_checks + method: list + operationId: get_zones_zone_id_access_apps_app_id_user_policy_checks + /accounts/{account_id}/access/certificates: + get: + description: Lists all mTLS root certificates. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 50 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasResponseCollection' + description: List mTLS certificates response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List mTLS certificates response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List mTLS certificates + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: list + operationId: get_accounts_account_id_access_certificates + post: + description: Adds a new mTLS root certificate to Access. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + associated_hostnames: + $ref: '#/components/schemas/accessAssociatedHostnames' + certificate: + description: The certificate content. + type: string + name: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasName' + required: + - name + - certificate + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasSingleResponse' + description: Add an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Add an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: create + operationId: post_accounts_account_id_access_certificates + /zones/{zone_id}/access/certificates: + get: + description: Lists all mTLS root certificates. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 50 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasResponseCollection' + description: List mTLS certificates response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List mTLS certificates response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List mTLS certificates + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: list + operationId: get_zones_zone_id_access_certificates + post: + description: Adds a new mTLS root certificate to Access. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + associated_hostnames: + $ref: '#/components/schemas/accessAssociatedHostnames' + certificate: + description: The certificate content. + type: string + name: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasName' + required: + - name + - certificate + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasSingleResponse' + description: Add an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Add an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: create + operationId: post_zones_zone_id_access_certificates + /accounts/{account_id}/access/certificates/settings: + get: + description: List all mTLS hostname settings for this account or zone. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessResponseCollectionHostnames' + description: List mTLS hostname settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List mTLS hostname settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all mTLS hostname settings + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + - settings + method: update + operationId: get_accounts_account_id_access_certificates_settings + put: + description: Updates an mTLS certificate's hostname settings. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + settings: + items: + $ref: '#/components/schemas/accessSettings' + type: array + required: + - settings + type: object + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessResponseCollectionHostnames' + description: Update an mTLS certificates hostname settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an mTLS certificates hostname settings failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an mTLS certificate's hostname settings + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + operationId: put_accounts_account_id_access_certificates_settings + /zones/{zone_id}/access/certificates/settings: + get: + description: List all mTLS hostname settings for this account or zone. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessResponseCollectionHostnames' + description: List mTLS hostname settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List mTLS hostname settings response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List all mTLS hostname settings + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + - settings + method: update + operationId: get_zones_zone_id_access_certificates_settings + put: + description: Updates an mTLS certificate's hostname settings. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + settings: + items: + $ref: '#/components/schemas/accessSettings' + type: array + required: + - settings + type: object + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessResponseCollectionHostnames' + description: Update an mTLS certificates hostname settings response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an mTLS certificates hostname settings failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an mTLS certificate's hostname settings + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + operationId: put_zones_zone_id_access_certificates_settings + /accounts/{account_id}/access/certificates/{certificate_id}: + get: + description: Fetches a single mTLS certificate. + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasSingleResponse' + description: Get an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: get + operationId: get_accounts_account_id_access_certificates_certificate_id + put: + description: Updates a configured mTLS certificate. + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + associated_hostnames: + $ref: '#/components/schemas/accessAssociatedHostnames' + name: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasName' + required: + - associated_hostnames + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasSingleResponse' + description: Update an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: update + operationId: put_accounts_account_id_access_certificates_certificate_id + delete: + description: Deletes an mTLS certificate. + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasIdResponse' + description: Delete an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: delete + operationId: delete_accounts_account_id_access_certificates_certificate_id + /zones/{zone_id}/access/certificates/{certificate_id}: + get: + description: Fetches a single mTLS certificate. + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasSingleResponse' + description: Get an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + - 'Access: Mutual TLS Certificates Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: get + operationId: get_zones_zone_id_access_certificates_certificate_id + put: + description: Updates a configured mTLS certificate. + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + associated_hostnames: + $ref: '#/components/schemas/accessAssociatedHostnames' + name: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasName' + required: + - associated_hostnames + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasSingleResponse' + description: Update an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: update + operationId: put_zones_zone_id_access_certificates_certificate_id + delete: + description: Deletes an mTLS certificate. + parameters: + - name: certificate_id + in: path + required: true + description: The certificate ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasIdResponse' + description: Delete an mTLS certificate response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an mTLS certificate response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an mTLS certificate + tags: [] + x-api-token-group: + - 'Access: Mutual TLS Certificates Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - certificates + method: delete + operationId: delete_zones_zone_id_access_certificates_certificate_id + /accounts/{account_id}/access/groups: + get: + description: Lists all Access groups. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: The name of the group. + type: string + - in: query + name: search + schema: + description: Search for groups by other listed query parameters. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 1000 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasResponseCollection' + description: List Access groups response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access groups response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access groups + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: list + operationId: get_accounts_account_id_access_groups + post: + description: Creates a new Access group. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + exclude: + $ref: '#/components/schemas/accessExclude' + include: + $ref: '#/components/schemas/accessInclude' + is_default: + $ref: '#/components/schemas/accessIsDefault' + name: + $ref: '#/components/schemas/accessGroupsComponentsSchemasName' + require: + $ref: '#/components/schemas/accessRequire' + required: + - name + - include + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGroupsComponentsSchemasSingleResponse' + description: Create an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: create + operationId: post_accounts_account_id_access_groups + /zones/{zone_id}/access/groups: + get: + description: Lists all Access groups. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: name + schema: + description: The name of the group. + type: string + - in: query + name: search + schema: + description: Search for groups by other listed query parameters. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 1000 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasResponseCollection' + description: List Access groups response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access groups response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access groups + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: list + operationId: get_zones_zone_id_access_groups + post: + description: Creates a new Access group. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + exclude: + $ref: '#/components/schemas/accessExclude' + include: + $ref: '#/components/schemas/accessInclude' + is_default: + $ref: '#/components/schemas/accessIsDefault' + name: + $ref: '#/components/schemas/accessGroupsComponentsSchemasName' + require: + $ref: '#/components/schemas/accessRequire' + required: + - name + - include + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGroupsComponentsSchemasSingleResponse' + description: Create an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: create + operationId: post_zones_zone_id_access_groups + /accounts/{account_id}/access/groups/{group_id}: + get: + description: Fetches a single Access group. + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGroupsComponentsSchemasSingleResponse' + description: Get an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: get + operationId: get_accounts_account_id_access_groups_group_id + put: + description: Updates a configured Access group. + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + exclude: + $ref: '#/components/schemas/accessExclude' + include: + $ref: '#/components/schemas/accessInclude' + is_default: + $ref: '#/components/schemas/accessIsDefault' + name: + $ref: '#/components/schemas/accessGroupsComponentsSchemasName' + require: + $ref: '#/components/schemas/accessRequire' + required: + - name + - include + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGroupsComponentsSchemasSingleResponse' + description: Update an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: update + operationId: put_accounts_account_id_access_groups_group_id + delete: + description: Deletes an Access group. + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: delete + operationId: delete_accounts_account_id_access_groups_group_id + /zones/{zone_id}/access/groups/{group_id}: + get: + description: Fetches a single Access group. + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGroupsComponentsSchemasSingleResponse' + description: Get an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: get + operationId: get_zones_zone_id_access_groups_group_id + put: + description: Updates a configured Access group. + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + exclude: + $ref: '#/components/schemas/accessExclude' + include: + $ref: '#/components/schemas/accessInclude' + is_default: + $ref: '#/components/schemas/accessIsDefault' + name: + $ref: '#/components/schemas/accessGroupsComponentsSchemasName' + require: + $ref: '#/components/schemas/accessRequire' + required: + - name + - include + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessGroupsComponentsSchemasSingleResponse' + description: Update an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: update + operationId: put_zones_zone_id_access_groups_group_id + delete: + description: Deletes an Access group. + parameters: + - name: group_id + in: path + required: true + description: The Access group ID. + schema: + type: string + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete an Access group response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access group response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access group + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - groups + method: delete + operationId: delete_zones_zone_id_access_groups_group_id + /accounts/{account_id}/access/identity_providers: + get: + description: Lists all configured identity providers. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: scim_enabled + schema: + description: Indicates to Access to only retrieve identity providers that have the System for Cross-Domain Identity Management (SCIM) enabled. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 200 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessResponseCollection' + description: List Access identity providers response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access identity providers response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access identity providers + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: list + operationId: get_accounts_account_id_access_identity_providers + post: + description: Adds a new identity provider to Access. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdentityProviders' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasSingleResponse' + description: Add an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Add an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: create + operationId: post_accounts_account_id_access_identity_providers + /zones/{zone_id}/access/identity_providers: + get: + description: Lists all configured identity providers. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: scim_enabled + schema: + description: Indicates to Access to only retrieve identity providers that have the System for Cross-Domain Identity Management (SCIM) enabled. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 200 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessResponseCollection' + description: List Access identity providers response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List Access identity providers response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Access identity providers + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: list + operationId: get_zones_zone_id_access_identity_providers + post: + description: Adds a new identity provider to Access. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdentityProviders' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasSingleResponse' + description: Add an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Add an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Add an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: create + operationId: post_zones_zone_id_access_identity_providers + /accounts/{account_id}/access/identity_providers/{identity_provider_id}: + get: + description: Fetches a configured identity provider. + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasSingleResponse' + description: Get an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: get + operationId: get_accounts_account_id_access_identity_providers_identity_provider_id + put: + description: Updates a configured identity provider. + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdentityProviders' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasSingleResponse' + description: Update an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: update + operationId: put_accounts_account_id_access_identity_providers_identity_provider_id + delete: + description: Deletes an identity provider from Access. + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: delete + operationId: delete_accounts_account_id_access_identity_providers_identity_provider_id + /zones/{zone_id}/access/identity_providers/{identity_provider_id}: + get: + description: Fetches a configured identity provider. + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasSingleResponse' + description: Get an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: get + operationId: get_zones_zone_id_access_identity_providers_identity_provider_id + put: + description: Updates a configured identity provider. + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdentityProviders' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasSingleResponse' + description: Update an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: update + operationId: put_zones_zone_id_access_identity_providers_identity_provider_id + delete: + description: Deletes an identity provider from Access. + parameters: + - in: path + name: identity_provider_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/accessIdResponse' + description: Delete an Access identity provider response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete an Access identity provider response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete an Access identity provider + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - identity_providers + method: delete + operationId: delete_zones_zone_id_access_identity_providers_identity_provider_id + /accounts/{account_id}/access/organizations: + get: + description: Returns the configuration for your Zero Trust organization. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponse' + description: Get your Zero Trust organization response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get your Zero Trust organization response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get your Zero Trust organization + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Revoke' + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: list + operationId: get_accounts_account_id_access_organizations + put: + description: Updates the configuration for your Zero Trust organization. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_authenticate_via_warp: + $ref: '#/components/schemas/accessAllowAuthenticateViaWarp' + auth_domain: + $ref: '#/components/schemas/accessAuthDomain' + auto_redirect_to_identity: + $ref: '#/components/schemas/accessAutoRedirectToIdentity' + custom_pages: + $ref: '#/components/schemas/accessCustomPages' + deny_unmatched_requests: + $ref: '#/components/schemas/accessDenyUnmatchedRequests' + deny_unmatched_requests_exempted_zone_names: + $ref: '#/components/schemas/accessDenyUnmatchedRequestsExemptedZoneNames' + is_ui_read_only: + $ref: '#/components/schemas/accessIsUiReadOnly' + login_design: + $ref: '#/components/schemas/accessLoginDesign' + mfa_config: + $ref: '#/components/schemas/accessOrgMfaConfig' + mfa_required_for_all_apps: + $ref: '#/components/schemas/accessMfaRequiredForAllApps' + mfa_ssh_piv_key_requirements: + $ref: '#/components/schemas/accessMfaSshPivKeyRequirements' + name: + $ref: '#/components/schemas/accessName' + session_duration: + $ref: '#/components/schemas/accessSessionDuration' + ui_read_only_toggle_reason: + $ref: '#/components/schemas/accessUiReadOnlyToggleReason' + user_seat_expiration_inactive_time: + $ref: '#/components/schemas/accessUserSeatExpirationInactiveTime' + warp_auth_session_duration: + $ref: '#/components/schemas/accessWarpAuthSessionDuration' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponse' + description: Update your Zero Trust organization response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update your Zero Trust organization response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update your Zero Trust organization + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: update + operationId: put_accounts_account_id_access_organizations + post: + description: Sets up a Zero Trust organization for your account or zone. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_authenticate_via_warp: + $ref: '#/components/schemas/accessAllowAuthenticateViaWarp' + auth_domain: + $ref: '#/components/schemas/accessAuthDomain' + auto_redirect_to_identity: + $ref: '#/components/schemas/accessAutoRedirectToIdentity' + deny_unmatched_requests: + $ref: '#/components/schemas/accessDenyUnmatchedRequests' + deny_unmatched_requests_exempted_zone_names: + $ref: '#/components/schemas/accessDenyUnmatchedRequestsExemptedZoneNames' + is_ui_read_only: + $ref: '#/components/schemas/accessIsUiReadOnly' + login_design: + $ref: '#/components/schemas/accessLoginDesign' + mfa_config: + $ref: '#/components/schemas/accessOrgMfaConfig' + mfa_required_for_all_apps: + $ref: '#/components/schemas/accessMfaRequiredForAllApps' + mfa_ssh_piv_key_requirements: + $ref: '#/components/schemas/accessMfaSshPivKeyRequirements' + name: + $ref: '#/components/schemas/accessName' + session_duration: + $ref: '#/components/schemas/accessSessionDuration' + ui_read_only_toggle_reason: + $ref: '#/components/schemas/accessUiReadOnlyToggleReason' + user_seat_expiration_inactive_time: + $ref: '#/components/schemas/accessUserSeatExpirationInactiveTime' + warp_auth_session_duration: + $ref: '#/components/schemas/accessWarpAuthSessionDuration' + required: + - name + - auth_domain + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponse' + description: Create your Zero Trust organization response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create your Zero Trust organization response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create your Zero Trust organization + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: create + operationId: post_accounts_account_id_access_organizations + /zones/{zone_id}/access/organizations: + get: + description: Returns the configuration for your Zero Trust organization. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponse' + description: Get your Zero Trust organization response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get your Zero Trust organization response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get your Zero Trust organization + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Revoke' + - 'Access: Organizations, Identity Providers, and Groups Write' + - 'Access: Organizations, Identity Providers, and Groups Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: list + operationId: get_zones_zone_id_access_organizations + put: + description: Updates the configuration for your Zero Trust organization. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_authenticate_via_warp: + $ref: '#/components/schemas/accessAllowAuthenticateViaWarp' + auth_domain: + $ref: '#/components/schemas/accessAuthDomain' + auto_redirect_to_identity: + $ref: '#/components/schemas/accessAutoRedirectToIdentity' + custom_pages: + $ref: '#/components/schemas/accessCustomPages' + deny_unmatched_requests: + $ref: '#/components/schemas/accessDenyUnmatchedRequests' + deny_unmatched_requests_exempted_zone_names: + $ref: '#/components/schemas/accessDenyUnmatchedRequestsExemptedZoneNames' + is_ui_read_only: + $ref: '#/components/schemas/accessIsUiReadOnly' + login_design: + $ref: '#/components/schemas/accessLoginDesign' + mfa_config: + $ref: '#/components/schemas/accessOrgMfaConfig' + mfa_required_for_all_apps: + $ref: '#/components/schemas/accessMfaRequiredForAllApps' + mfa_ssh_piv_key_requirements: + $ref: '#/components/schemas/accessMfaSshPivKeyRequirements' + name: + $ref: '#/components/schemas/accessName' + session_duration: + $ref: '#/components/schemas/accessSessionDuration' + ui_read_only_toggle_reason: + $ref: '#/components/schemas/accessUiReadOnlyToggleReason' + user_seat_expiration_inactive_time: + $ref: '#/components/schemas/accessUserSeatExpirationInactiveTime' + warp_auth_session_duration: + $ref: '#/components/schemas/accessWarpAuthSessionDuration' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponse' + description: Update your Zero Trust organization response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update your Zero Trust organization response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update your Zero Trust organization + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: update + operationId: put_zones_zone_id_access_organizations + post: + description: Sets up a Zero Trust organization for your account or zone. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + allow_authenticate_via_warp: + $ref: '#/components/schemas/accessAllowAuthenticateViaWarp' + auth_domain: + $ref: '#/components/schemas/accessAuthDomain' + auto_redirect_to_identity: + $ref: '#/components/schemas/accessAutoRedirectToIdentity' + deny_unmatched_requests: + $ref: '#/components/schemas/accessDenyUnmatchedRequests' + deny_unmatched_requests_exempted_zone_names: + $ref: '#/components/schemas/accessDenyUnmatchedRequestsExemptedZoneNames' + is_ui_read_only: + $ref: '#/components/schemas/accessIsUiReadOnly' + login_design: + $ref: '#/components/schemas/accessLoginDesign' + mfa_config: + $ref: '#/components/schemas/accessOrgMfaConfig' + mfa_required_for_all_apps: + $ref: '#/components/schemas/accessMfaRequiredForAllApps' + mfa_ssh_piv_key_requirements: + $ref: '#/components/schemas/accessMfaSshPivKeyRequirements' + name: + $ref: '#/components/schemas/accessName' + session_duration: + $ref: '#/components/schemas/accessSessionDuration' + ui_read_only_toggle_reason: + $ref: '#/components/schemas/accessUiReadOnlyToggleReason' + user_seat_expiration_inactive_time: + $ref: '#/components/schemas/accessUserSeatExpirationInactiveTime' + warp_auth_session_duration: + $ref: '#/components/schemas/accessWarpAuthSessionDuration' + required: + - name + - auth_domain + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSingleResponse' + description: Create your Zero Trust organization response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create your Zero Trust organization response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create your Zero Trust organization + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: create + operationId: post_zones_zone_id_access_organizations + /accounts/{account_id}/access/organizations/revoke_user: + post: + description: Revokes a user's access across all applications. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - description: When set to `true`, all devices associated with the user will be revoked. + in: query + name: devices + schema: + type: boolean + requestBody: + content: + application/json: + schema: + properties: + devices: + description: When set to `true`, all devices associated with the user will be revoked. + type: boolean + email: + description: The email of the user to revoke. + type: string + user_uid: + description: The uuid of the user to revoke. + type: string + warp_session_reauth: + description: "When set to `true`, the user will be required to re-authenticate to WARP for all Gateway policies that enforce a WARP client session duration. When `false`, the user\u2019s WARP session will remain active" + type: boolean + required: + - email + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessEmptyResponse' + description: Revoke all Access tokens for a user response + 4xx: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Revoke all Access tokens for a user response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Revoke all Access tokens for a user + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: revoke_users + operationId: post_accounts_account_id_access_organizations_revoke_user + /zones/{zone_id}/access/organizations/revoke_user: + post: + description: Revokes a user's access across all applications. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: When set to `true`, all devices associated with the user will be revoked. + in: query + name: devices + schema: + type: boolean + requestBody: + content: + application/json: + schema: + properties: + devices: + description: When set to `true`, all devices associated with the user will be revoked. + type: boolean + email: + description: The email of the user to revoke. + type: string + user_uid: + description: The uuid of the user to revoke. + type: string + warp_session_reauth: + description: "When set to `true`, the user will be required to re-authenticate to WARP for all Gateway policies that enforce a WARP client session duration. When `false`, the user\u2019s WARP session will remain active" + type: boolean + required: + - email + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessEmptyResponse' + description: Revoke all Access tokens for a user response + 4xx: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Revoke all Access tokens for a user response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Revoke all Access tokens for a user + tags: [] + x-api-token-group: + - 'Access: Organizations, Identity Providers, and Groups Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - organizations + method: revoke_users + operationId: post_zones_zone_id_access_organizations_revoke_user + /accounts/{account_id}/access/service_tokens: + get: + description: Lists all service tokens. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + - in: query + name: name + schema: + description: The name of the service token. + type: string + - in: query + name: search + schema: + description: Search for service tokens by other listed query parameters. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 1000 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasResponseCollection' + description: List service tokens response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List service tokens response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List service tokens + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + - 'Access: Service Tokens Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: list + operationId: get_accounts_account_id_access_service_tokens + post: + description: Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token. + parameters: + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + client_secret_version: + $ref: '#/components/schemas/accessClientSecretVersion' + duration: + $ref: '#/components/schemas/accessDuration' + name: + $ref: '#/components/schemas/accessSchemasName' + previous_client_secret_expires_at: + $ref: '#/components/schemas/accessPreviousClientSecretExpiresAt' + required: + - name + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCreateResponse' + description: Create a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: create + operationId: post_accounts_account_id_access_service_tokens + /zones/{zone_id}/access/service_tokens: + get: + description: Lists all service tokens. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: name + schema: + description: The name of the service token. + type: string + - in: query + name: search + schema: + description: Search for service tokens by other listed query parameters. + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of results. + type: integer + - in: query + name: per_page + schema: + default: 1000 + description: Number of results per page. + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessComponentsSchemasResponseCollection' + description: List service tokens response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: List service tokens response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List service tokens + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + - 'Access: Service Tokens Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: list + operationId: get_zones_zone_id_access_service_tokens + post: + description: Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token. + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + client_secret_version: + $ref: '#/components/schemas/accessClientSecretVersion' + duration: + $ref: '#/components/schemas/accessDuration' + name: + $ref: '#/components/schemas/accessSchemasName' + previous_client_secret_expires_at: + $ref: '#/components/schemas/accessPreviousClientSecretExpiresAt' + required: + - name + type: object + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/accessCreateResponse' + description: Create a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Create a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: create + operationId: post_zones_zone_id_access_service_tokens + /accounts/{account_id}/access/service_tokens/{service_token_id}: + get: + description: Fetches a single service token. + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasSingleResponse' + description: Get a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + - 'Access: Service Tokens Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: get + operationId: get_accounts_account_id_access_service_tokens_service_token_id + put: + description: Updates a configured service token. + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + client_secret_version: + $ref: '#/components/schemas/accessClientSecretVersion' + duration: + $ref: '#/components/schemas/accessDuration' + name: + $ref: '#/components/schemas/accessSchemasName' + previous_client_secret_expires_at: + $ref: '#/components/schemas/accessPreviousClientSecretExpiresAt' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasSingleResponse' + description: Update a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: update + operationId: put_accounts_account_id_access_service_tokens_service_token_id + delete: + description: Deletes a service token. + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: account_id + in: path + required: true + description: The Cloudflare account ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasSingleResponse' + description: Delete a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: delete + operationId: delete_accounts_account_id_access_service_tokens_service_token_id + /zones/{zone_id}/access/service_tokens/{service_token_id}: + get: + description: Fetches a single service token. + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasSingleResponse' + description: Get a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Get a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + - 'Access: Service Tokens Read' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: get + operationId: get_zones_zone_id_access_service_tokens_service_token_id + put: + description: Updates a configured service token. + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + client_secret_version: + $ref: '#/components/schemas/accessClientSecretVersion' + duration: + $ref: '#/components/schemas/accessDuration' + name: + $ref: '#/components/schemas/accessSchemasName' + previous_client_secret_expires_at: + $ref: '#/components/schemas/accessPreviousClientSecretExpiresAt' + type: object + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasSingleResponse' + description: Update a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Update a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Update a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: update + operationId: put_zones_zone_id_access_service_tokens_service_token_id + delete: + description: Deletes a service token. + parameters: + - in: path + name: service_token_id + schema: + $ref: '#/components/schemas/accessUuid' + required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/accessSchemasSingleResponse' + description: Delete a service token response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/accessApiResponseCommonFailure' + description: Delete a service token response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete a service token + tags: [] + x-api-token-group: + - 'Access: Service Tokens Write' + x-stackql-sdk: + service: zero_trust + resource_chain: + - access + - service_tokens + method: delete + operationId: delete_zones_zone_id_access_service_tokens_service_token_id +components: + schemas: + accessAaguid: + description: The Authenticator Attestation GUID (AAGUID) uniquely identifying a FIDO2 authenticator model + example: 2fc0579f-8113-47ea-b116-bb5a8db9202a + format: uuid + type: string + accessAccessRequests: + properties: + action: + $ref: '#/components/schemas/accessAction' + allowed: + $ref: '#/components/schemas/accessAllowed' + app_domain: + $ref: '#/components/schemas/accessAppDomain' + app_uid: + $ref: '#/components/schemas/accessAppUid' + connection: + $ref: '#/components/schemas/accessConnection' + created_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + ip_address: + $ref: '#/components/schemas/accessIp' + ray_id: + $ref: '#/components/schemas/accessRayId' + user_email: + $ref: '#/components/schemas/accessComponentsSchemasEmail' + type: object + accessAccessRequestsComponentsSchemasResponseCollection: + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/accessAccessRequests' + type: array + required: + - success + - errors + - messages + type: object + accessAccessSeat: + description: True if the seat is part of Access. + example: false + type: boolean + x-auditable: true + accessAction: + description: The event that occurred, such as a login attempt. + example: login + type: string + accessActiveDeviceCount: + description: The number of active devices registered to the user. + example: 2 + type: number + accessActiveSessionResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + properties: + account_id: + example: '1234567890' + type: string + x-auditable: true + auth_status: + example: NONE + type: string + x-auditable: true + common_name: + example: '' + type: string + devicePosture: + type: object + device_id: + example: '' + type: string + device_sessions: + $ref: '#/components/schemas/accessStringKeyMapDeviceSession' + email: + example: test@cloudflare.com + type: string + geo: + $ref: '#/components/schemas/accessGeo' + iat: + example: 1694791905 + type: number + idp: + properties: + id: + type: string + type: + type: string + type: object + ip: + example: 127.0.0.0 + type: string + is_gateway: + example: false + type: boolean + is_warp: + example: false + type: boolean + mtls_auth: + properties: + auth_status: + type: string + cert_issuer_dn: + type: string + cert_issuer_ski: + type: string + cert_presented: + type: boolean + cert_serial: + type: string + type: object + service_token_id: + example: '' + type: string + service_token_status: + example: false + type: boolean + user_uuid: + example: 57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4 + type: string + version: + example: 2 + type: number + isActive: + example: true + type: boolean + required: + - success + - errors + - messages + accessActiveSessionsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessActiveSessionsResponse_result_item' + type: array + required: + - success + - errors + - messages + accessActiveSessionsResponse_result_item: + properties: + expiration: + example: 1694813506 + type: integer + metadata: + properties: + apps: + type: object + expires: + example: 1694813506 + type: integer + iat: + example: 1694791905 + type: integer + nonce: + example: X1aXj1lFVcqqyoXF + type: string + ttl: + example: 21600 + type: integer + type: object + name: + type: string + type: object + accessAllowAllHeaders: + description: Allows all HTTP request headers. + example: true + type: boolean + accessAllowAllMethods: + description: Allows all HTTP request methods. + type: boolean + accessAllowAllOrigins: + description: Allows all origins. + type: boolean + accessAllowAuthenticateViaWarp: + default: false + description: When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value. + type: boolean + x-auditable: true + accessAllowCredentials: + description: When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests. + type: boolean + accessAllowIframe: + description: Enables loading application content in an iFrame. + example: true + type: boolean + accessAllowed: + default: false + description: The result of the authentication event. + type: boolean + accessAllowedClipboardLocalToRemoteFormats: + description: Clipboard formats allowed when copying from local machine to remote RDP session. + example: + - text + items: + $ref: '#/components/schemas/accessRdpClipboardFormat' + type: array + accessAllowedClipboardRemoteToLocalFormats: + description: Clipboard formats allowed when copying from remote RDP session to local machine. + example: + - text + items: + $ref: '#/components/schemas/accessRdpClipboardFormat' + type: array + accessAllowedHeaders: + description: Allowed HTTP request headers. + items: + type: string + type: array + accessAllowedIdps: + description: The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account. + items: + description: The identity providers selected for application. + example: 699d98642c564d2e855e9661899b7252 + type: string + type: array + accessAllowedMethods: + description: Allowed HTTP request methods. + example: + - GET + items: + enum: + - GET + - POST + - HEAD + - PUT + - DELETE + - CONNECT + - OPTIONS + - TRACE + - PATCH + type: string + type: array + accessAllowedOrigins: + description: Allowed origins. + example: + - https://example.com + items: + type: string + type: array + accessApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/accessMessages' + messages: + example: [] + $ref: '#/components/schemas/accessMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + accessAppCount: + description: Number of access applications currently using this policy. + example: 2 + type: integer + x-auditable: true + accessAppDomain: + description: The URL of the Access application. + example: test.example.com/admin + type: string + accessAppLauncherLogoUrl: + description: The image URL of the logo shown in the App Launcher header. + example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg + type: string + accessAppLauncherVisible: + default: true + description: Displays the application in the App Launcher. + example: true + type: boolean + accessAppPoliciesComponentsSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/accessUuid' + type: object + required: + - success + - errors + - messages + accessAppPoliciesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessAppPolicyResponse' + type: array + required: + - success + - errors + - messages + accessAppPoliciesComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessAppPolicyResponse' + required: + - success + - errors + - messages + accessAppPolicyRequest: + type: object + properties: + precedence: + $ref: '#/components/schemas/accessPrecedence' + approval_groups: + $ref: '#/components/schemas/accessApprovalGroups' + approval_required: + $ref: '#/components/schemas/accessApprovalRequired' + connection_rules: + $ref: '#/components/schemas/accessConnectionRules' + isolation_required: + $ref: '#/components/schemas/accessIsolationRequired' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + purpose_justification_prompt: + $ref: '#/components/schemas/accessPurposeJustificationPrompt' + purpose_justification_required: + $ref: '#/components/schemas/accessPurposeJustificationRequired' + session_duration: + $ref: '#/components/schemas/accessComponentsSchemasSessionDuration' + accessAppPolicyResponse: + type: object + properties: + approval_groups: + $ref: '#/components/schemas/accessApprovalGroups' + approval_required: + $ref: '#/components/schemas/accessApprovalRequired' + connection_rules: + $ref: '#/components/schemas/accessConnectionRules' + isolation_required: + $ref: '#/components/schemas/accessIsolationRequired' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + purpose_justification_prompt: + $ref: '#/components/schemas/accessPurposeJustificationPrompt' + purpose_justification_required: + $ref: '#/components/schemas/accessPurposeJustificationRequired' + session_duration: + $ref: '#/components/schemas/accessComponentsSchemasSessionDuration' + precedence: + $ref: '#/components/schemas/accessPrecedence' + created_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + decision: + $ref: '#/components/schemas/accessDecision' + exclude: + $ref: '#/components/schemas/accessSchemasExclude' + id: + $ref: '#/components/schemas/accessSchemasUuid' + include: + $ref: '#/components/schemas/accessSchemasInclude' + name: + $ref: '#/components/schemas/accessPolicyComponentsSchemasName' + require: + $ref: '#/components/schemas/accessSchemasRequire' + updated_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + accessAppRequest: + type: object + title: Self Hosted Application + properties: + allow_authenticate_via_warp: + $ref: '#/components/schemas/accessSchemasAllowAuthenticateViaWarp' + allow_iframe: + $ref: '#/components/schemas/accessAllowIframe' + allowed_idps: + $ref: '#/components/schemas/accessAllowedIdps' + app_launcher_visible: + $ref: '#/components/schemas/accessAppLauncherVisible' + auto_redirect_to_identity: + $ref: '#/components/schemas/accessSchemasAutoRedirectToIdentity' + cors_headers: + $ref: '#/components/schemas/accessCorsHeaders' + custom_deny_message: + $ref: '#/components/schemas/accessCustomDenyMessage' + custom_deny_url: + $ref: '#/components/schemas/accessCustomDenyUrl' + custom_non_identity_deny_url: + $ref: '#/components/schemas/accessCustomNonIdentityDenyUrl' + custom_pages: + $ref: '#/components/schemas/accessSchemasCustomPages' + destinations: + $ref: '#/components/schemas/accessDestinations' + domain: + $ref: '#/components/schemas/accessDomain' + enable_binding_cookie: + $ref: '#/components/schemas/accessEnableBindingCookie' + http_only_cookie_attribute: + $ref: '#/components/schemas/accessHttpOnlyCookieAttribute' + logo_url: + $ref: '#/components/schemas/accessLogoUrl' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + name: + $ref: '#/components/schemas/accessAppsComponentsSchemasName' + oauth_configuration: + $ref: '#/components/schemas/accessOauthConfiguration' + options_preflight_bypass: + $ref: '#/components/schemas/accessOptionsPreflightBypass' + path_cookie_attribute: + $ref: '#/components/schemas/accessPathCookieAttribute' + read_service_tokens_from_header: + $ref: '#/components/schemas/accessReadServiceTokensFromHeader' + same_site_cookie_attribute: + $ref: '#/components/schemas/accessSameSiteCookieAttribute' + scim_config: + $ref: '#/components/schemas/accessScimConfig' + self_hosted_domains: + $ref: '#/components/schemas/accessSelfHostedDomains' + service_auth_401_redirect: + $ref: '#/components/schemas/accessServiceAuth401Redirect' + session_duration: + $ref: '#/components/schemas/accessSchemasSessionDuration' + skip_interstitial: + $ref: '#/components/schemas/accessSkipInterstitial' + tags: + $ref: '#/components/schemas/accessTags' + type: + $ref: '#/components/schemas/accessType' + example: self_hosted + use_clientless_isolation_app_launcher_url: + $ref: '#/components/schemas/accessUseClientlessIsolationAppLauncherUrl' + policies: + description: The policies that Access applies to the application, in ascending order of precedence. Items can reference existing policies or create new policies exclusive to the application. Reusable and inline policies are mutually exclusive. + items: + type: object + description: A JSON that links a reusable policy to an application. + properties: + id: + $ref: '#/components/schemas/accessSchemasUuid' + precedence: + $ref: '#/components/schemas/accessPrecedence' + approval_groups: + $ref: '#/components/schemas/accessApprovalGroups' + approval_required: + $ref: '#/components/schemas/accessApprovalRequired' + connection_rules: + $ref: '#/components/schemas/accessConnectionRules' + isolation_required: + $ref: '#/components/schemas/accessIsolationRequired' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + purpose_justification_prompt: + $ref: '#/components/schemas/accessPurposeJustificationPrompt' + purpose_justification_required: + $ref: '#/components/schemas/accessPurposeJustificationRequired' + session_duration: + $ref: '#/components/schemas/accessComponentsSchemasSessionDuration' + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + type: array + saas_app: + type: object + title: SAML SaaS App + properties: + auth_type: + description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml" + enum: + - saml + - oidc + example: saml + type: string + consumer_service_url: + description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion. + example: https://example.com + type: string + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + custom_attributes: + items: + properties: + friendly_name: + description: The SAML FriendlyName of the attribute. + example: Last Name + type: string + name: + description: The name of the attribute. + example: family_name + type: string + name_format: + description: A globally unique name for an identity or service provider. + enum: + - urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified + - urn:oasis:names:tc:SAML:2.0:attrname-format:basic + - urn:oasis:names:tc:SAML:2.0:attrname-format:uri + example: urn:oasis:names:tc:SAML:2.0:attrname-format:basic + type: string + source: + properties: + name: + description: The name of the IdP attribute. + example: last_name + type: string + name_by_idp: + description: A mapping from IdP ID to attribute name. + items: + properties: + idp_id: + description: The UID of the IdP. + example: exampleIdPID1 + type: string + source_name: + description: The name of the IdP provided attribute. + example: AttributeName1 + type: string + type: object + type: array + type: object + type: object + type: array + default_relay_state: + description: The URL that the user will be redirected to after a successful login for IDP initiated logins. + example: https://example.com + type: string + idp_entity_id: + description: The unique identifier for your SaaS application. + example: https://example.cloudflareaccess.com + type: string + x-stainless-configurability: computed_optional + name_id_format: + $ref: '#/components/schemas/unnamedSchemaRefC6200e37c458aaa3c42e6e5b999bc419' + name_id_transform_jsonata: + description: A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting. + example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@') + type: string + public_key: + description: The Access public certificate that will be used to verify your identity. + example: example unique name + type: string + x-stainless-configurability: computed_optional + saml_attribute_transform_jsonata: + description: A [JSONata] (https://jsonata.org/) expression that transforms an application's user identities into attribute assertions in the SAML response. The expression can transform id, email, name, and groups values. It can also transform fields listed in the saml_attributes or oidc_fields of the identity provider used to authenticate. The output of this expression must be a JSON object. + example: '$ ~>| groups | {''group_name'': name} |' + type: string + sp_entity_id: + description: A globally unique name for an identity or service provider. + example: example unique name + type: string + sso_endpoint: + description: The endpoint where your SaaS application will send login requests. + example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd + type: string + x-stainless-configurability: computed_optional + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + access_token_lifetime: + description: The lifetime of the OIDC Access Token after creation. Valid units are m,h. Must be greater than or equal to 1m and less than or equal to 24h. + example: 5m + type: string + allow_pkce_without_client_secret: + description: If client secret should be required on the token endpoint when authorization_code_with_pkce grant is used. + example: true + type: boolean + app_launcher_url: + description: The URL where this applications tile redirects users + example: https://example.com/login + type: string + client_id: + description: The application client id + example: oidc client id + type: string + client_secret: + description: The application client secret, only returned on POST request. + example: oidc client secret + type: string + x-sensitive: true + custom_claims: + items: + properties: + name: + description: The name of the claim. + example: family_name + type: string + scope: + description: The scope of the claim. + enum: + - groups + - profile + - email + - openid + example: profile + type: string + source: + properties: + name: + description: The name of the IdP claim. + example: last_name + type: string + name_by_idp: + description: A mapping from IdP ID to claim name. + example: + exampleIdPID1: ClaimName1 + exampleIdPID2: ClaimName2 + type: object + type: object + type: object + type: array + grant_types: + description: The OIDC flows supported by this application + example: + - authorization_code + items: + enum: + - authorization_code + - authorization_code_with_pkce + - refresh_tokens + - hybrid + - implicit + type: string + type: array + group_filter_regex: + description: A regex to filter Cloudflare groups returned in ID token and userinfo endpoint + example: ^GROUP_FILTER-*$ + type: string + hybrid_and_implicit_options: + properties: + return_access_token_from_authorization_endpoint: + description: If an Access Token should be returned from the OIDC Authorization endpoint + type: boolean + return_id_token_from_authorization_endpoint: + description: If an ID Token should be returned from the OIDC Authorization endpoint + type: boolean + type: object + redirect_uris: + description: The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens + example: + - https://example.com + items: + type: string + type: array + refresh_token_options: + properties: + lifetime: + description: How long a refresh token will be valid for after creation. Valid units are m,h,d. Must be longer than 1m. + example: 30d + type: string + type: object + scopes: + description: Define the user information shared with access, "offline_access" scope will be automatically enabled if refresh tokens are enabled + example: + - openid + - groups + - email + - profile + items: + enum: + - openid + - groups + - email + - profile + type: string + type: array + app_launcher_logo_url: + $ref: '#/components/schemas/accessAppLauncherLogoUrl' + bg_color: + $ref: '#/components/schemas/accessBgColor' + footer_links: + $ref: '#/components/schemas/accessFooterLinks' + header_bg_color: + $ref: '#/components/schemas/accessHeaderBgColor' + landing_page_design: + $ref: '#/components/schemas/accessLandingPageDesign' + skip_app_launcher_login_page: + $ref: '#/components/schemas/accessSkipAppLauncherLoginPage' + target_criteria: + items: + $ref: '#/components/schemas/accessTargetCriteriaInfraApp' + type: array + required: + - type + description: Contains the targets secured by the application. + accessAppResponse: + type: object + title: Self Hosted Application + properties: + aud: + $ref: '#/components/schemas/accessSchemasAud' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + id: + $ref: '#/components/schemas/accessUuid' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + allow_authenticate_via_warp: + $ref: '#/components/schemas/accessSchemasAllowAuthenticateViaWarp' + allow_iframe: + $ref: '#/components/schemas/accessAllowIframe' + allowed_idps: + $ref: '#/components/schemas/accessAllowedIdps' + app_launcher_visible: + $ref: '#/components/schemas/accessAppLauncherVisible' + auto_redirect_to_identity: + $ref: '#/components/schemas/accessSchemasAutoRedirectToIdentity' + cors_headers: + $ref: '#/components/schemas/accessCorsHeaders' + custom_deny_message: + $ref: '#/components/schemas/accessCustomDenyMessage' + custom_deny_url: + $ref: '#/components/schemas/accessCustomDenyUrl' + custom_non_identity_deny_url: + $ref: '#/components/schemas/accessCustomNonIdentityDenyUrl' + custom_pages: + $ref: '#/components/schemas/accessSchemasCustomPages' + destinations: + $ref: '#/components/schemas/accessDestinations' + domain: + $ref: '#/components/schemas/accessDomain' + enable_binding_cookie: + $ref: '#/components/schemas/accessEnableBindingCookie' + http_only_cookie_attribute: + $ref: '#/components/schemas/accessHttpOnlyCookieAttribute' + logo_url: + $ref: '#/components/schemas/accessLogoUrl' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + name: + $ref: '#/components/schemas/accessAppsComponentsSchemasName' + oauth_configuration: + $ref: '#/components/schemas/accessOauthConfiguration' + options_preflight_bypass: + $ref: '#/components/schemas/accessOptionsPreflightBypass' + path_cookie_attribute: + $ref: '#/components/schemas/accessPathCookieAttribute' + read_service_tokens_from_header: + $ref: '#/components/schemas/accessReadServiceTokensFromHeader' + same_site_cookie_attribute: + $ref: '#/components/schemas/accessSameSiteCookieAttribute' + scim_config: + $ref: '#/components/schemas/accessScimConfig' + self_hosted_domains: + $ref: '#/components/schemas/accessSelfHostedDomains' + service_auth_401_redirect: + $ref: '#/components/schemas/accessServiceAuth401Redirect' + session_duration: + $ref: '#/components/schemas/accessSchemasSessionDuration' + skip_interstitial: + $ref: '#/components/schemas/accessSkipInterstitial' + tags: + $ref: '#/components/schemas/accessTags' + type: + $ref: '#/components/schemas/accessType' + example: self_hosted + use_clientless_isolation_app_launcher_url: + $ref: '#/components/schemas/accessUseClientlessIsolationAppLauncherUrl' + policies: + items: + $ref: '#/components/schemas/accessAppPolicyResponse' + type: array + saas_app: + type: object + title: SAML SaaS App + properties: + auth_type: + description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml" + enum: + - saml + - oidc + example: saml + type: string + consumer_service_url: + description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion. + example: https://example.com + type: string + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + custom_attributes: + items: + properties: + friendly_name: + description: The SAML FriendlyName of the attribute. + example: Last Name + type: string + name: + description: The name of the attribute. + example: family_name + type: string + name_format: + description: A globally unique name for an identity or service provider. + enum: + - urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified + - urn:oasis:names:tc:SAML:2.0:attrname-format:basic + - urn:oasis:names:tc:SAML:2.0:attrname-format:uri + example: urn:oasis:names:tc:SAML:2.0:attrname-format:basic + type: string + source: + properties: + name: + description: The name of the IdP attribute. + example: last_name + type: string + name_by_idp: + description: A mapping from IdP ID to attribute name. + items: + properties: + idp_id: + description: The UID of the IdP. + example: exampleIdPID1 + type: string + source_name: + description: The name of the IdP provided attribute. + example: AttributeName1 + type: string + type: object + type: array + type: object + type: object + type: array + default_relay_state: + description: The URL that the user will be redirected to after a successful login for IDP initiated logins. + example: https://example.com + type: string + idp_entity_id: + description: The unique identifier for your SaaS application. + example: https://example.cloudflareaccess.com + type: string + x-stainless-configurability: computed_optional + name_id_format: + $ref: '#/components/schemas/unnamedSchemaRefC6200e37c458aaa3c42e6e5b999bc419' + name_id_transform_jsonata: + description: A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting. + example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@') + type: string + public_key: + description: The Access public certificate that will be used to verify your identity. + example: example unique name + type: string + x-stainless-configurability: computed_optional + saml_attribute_transform_jsonata: + description: A [JSONata] (https://jsonata.org/) expression that transforms an application's user identities into attribute assertions in the SAML response. The expression can transform id, email, name, and groups values. It can also transform fields listed in the saml_attributes or oidc_fields of the identity provider used to authenticate. The output of this expression must be a JSON object. + example: '$ ~>| groups | {''group_name'': name} |' + type: string + sp_entity_id: + description: A globally unique name for an identity or service provider. + example: example unique name + type: string + sso_endpoint: + description: The endpoint where your SaaS application will send login requests. + example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd + type: string + x-stainless-configurability: computed_optional + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + access_token_lifetime: + description: The lifetime of the OIDC Access Token after creation. Valid units are m,h. Must be greater than or equal to 1m and less than or equal to 24h. + example: 5m + type: string + allow_pkce_without_client_secret: + description: If client secret should be required on the token endpoint when authorization_code_with_pkce grant is used. + example: true + type: boolean + app_launcher_url: + description: The URL where this applications tile redirects users + example: https://example.com/login + type: string + client_id: + description: The application client id + example: oidc client id + type: string + client_secret: + description: The application client secret, only returned on POST request. + example: oidc client secret + type: string + x-sensitive: true + custom_claims: + items: + properties: + name: + description: The name of the claim. + example: family_name + type: string + scope: + description: The scope of the claim. + enum: + - groups + - profile + - email + - openid + example: profile + type: string + source: + properties: + name: + description: The name of the IdP claim. + example: last_name + type: string + name_by_idp: + description: A mapping from IdP ID to claim name. + example: + exampleIdPID1: ClaimName1 + exampleIdPID2: ClaimName2 + type: object + type: object + type: object + type: array + grant_types: + description: The OIDC flows supported by this application + example: + - authorization_code + items: + enum: + - authorization_code + - authorization_code_with_pkce + - refresh_tokens + - hybrid + - implicit + type: string + type: array + group_filter_regex: + description: A regex to filter Cloudflare groups returned in ID token and userinfo endpoint + example: ^GROUP_FILTER-*$ + type: string + hybrid_and_implicit_options: + properties: + return_access_token_from_authorization_endpoint: + description: If an Access Token should be returned from the OIDC Authorization endpoint + type: boolean + return_id_token_from_authorization_endpoint: + description: If an ID Token should be returned from the OIDC Authorization endpoint + type: boolean + type: object + redirect_uris: + description: The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens + example: + - https://example.com + items: + type: string + type: array + refresh_token_options: + properties: + lifetime: + description: How long a refresh token will be valid for after creation. Valid units are m,h,d. Must be longer than 1m. + example: 30d + type: string + type: object + scopes: + description: Define the user information shared with access, "offline_access" scope will be automatically enabled if refresh tokens are enabled + example: + - openid + - groups + - email + - profile + items: + enum: + - openid + - groups + - email + - profile + type: string + type: array + app_launcher_logo_url: + $ref: '#/components/schemas/accessAppLauncherLogoUrl' + bg_color: + $ref: '#/components/schemas/accessBgColor' + footer_links: + $ref: '#/components/schemas/accessFooterLinks' + header_bg_color: + $ref: '#/components/schemas/accessHeaderBgColor' + landing_page_design: + $ref: '#/components/schemas/accessLandingPageDesign' + skip_app_launcher_login_page: + $ref: '#/components/schemas/accessSkipAppLauncherLoginPage' + target_criteria: + items: + $ref: '#/components/schemas/accessTargetCriteriaInfraApp' + type: array + required: + - type + accessAppSettingsRequest: + properties: + allow_iframe: + $ref: '#/components/schemas/accessAllowIframe' + skip_interstitial: + $ref: '#/components/schemas/accessSkipInterstitial' + type: object + accessAppSettingsResponse: + properties: + allow_iframe: + $ref: '#/components/schemas/accessAllowIframe' + skip_interstitial: + $ref: '#/components/schemas/accessSkipInterstitial' + type: object + accessAppUid: + description: The unique identifier for the Access application. + example: df7e2w5f-02b7-4d9d-af26-8d1988fca630 + type: string + accessApprovalGroup: + description: A group of email addresses that can approve a temporary authentication request. + properties: + approvals_needed: + description: The number of approvals needed to obtain access. + example: 1 + minimum: 0 + type: number + email_addresses: + description: A list of emails that can approve the access request. + example: + - test@cloudflare.com + - test2@cloudflare.com + items: + type: string + type: array + email_list_uuid: + description: The UUID of an re-usable email list. + type: string + required: + - approvals_needed + type: object + accessApprovalGroups: + description: Administrators who can approve a temporary authentication request. + example: + - approvals_needed: 1 + email_addresses: + - test1@cloudflare.com + - test2@cloudflare.com + - approvals_needed: 3 + email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34 + items: + $ref: '#/components/schemas/accessApprovalGroup' + type: array + x-stainless-collection-type: set + accessApprovalRequired: + description: Requires the user to request access from an administrator at the start of each session. + example: true + type: boolean + accessAppsComponentsSchemasName: + description: The name of the application. + example: Admin Site + type: string + accessAppsComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessAppResponse' + type: array + required: + - success + - errors + - messages + accessAppsComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessAppResponse' + required: + - success + - errors + - messages + accessAssociatedHostnames: + description: The hostnames of the applications that will use this certificate. + items: + description: A fully-qualified domain name (FQDN). + example: admin.example.com + type: string + x-auditable: true + type: array + accessAud: + description: The Application Audience (AUD) tag. Identifies the application associated with the CA. + example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893 + maxLength: 64 + readOnly: true + type: string + x-auditable: true + accessAuthDomain: + description: The unique subdomain assigned to your Zero Trust organization. + example: test.cloudflareaccess.com + type: string + x-auditable: true + accessAuthenticatorDeviceAaguid: + description: A FIDO2 authenticator device AAGUID entry + properties: + aaguid: + $ref: '#/components/schemas/accessAaguid' + name: + $ref: '#/components/schemas/accessAuthenticatorDeviceAaguidsComponentsSchemasName' + required: + - aaguid + - name + type: object + accessAuthenticatorDeviceAaguidsComponentsSchemasName: + description: The human-readable name of the FIDO2 authenticator + example: YubiKey 5 NFC + type: string + accessAuthenticatorDeviceAaguidsComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + example: + - aaguid: 2fc0579f-8113-47ea-b116-bb5a8db9202a + name: YubiKey 5 NFC + - aaguid: fcb1bcb4-f370-078c-6993-bc24d0ae3fbe + name: Ledger Nano X FIDO2 Authenticator + items: + $ref: '#/components/schemas/accessAuthenticatorDeviceAaguid' + type: array + required: + - success + - errors + - messages + accessAuthenticatorId: + description: The unique identifier for the MFA device. + example: test-authenticator-id-123 + type: string + accessAutoRedirectToIdentity: + default: false + description: When set to `true`, users skip the identity provider selection step during login. + type: boolean + x-auditable: true + accessBgColor: + description: The background color of the App Launcher page. + example: '#ff0000' + type: string + accessBookmarks: + properties: + app_launcher_visible: + $ref: '#/components/schemas/accessSchemasAppLauncherVisible' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + domain: + $ref: '#/components/schemas/accessSchemasDomain' + id: + description: The unique identifier for the Bookmark application. + type: string + logo_url: + $ref: '#/components/schemas/accessSchemasLogoUrl' + name: + $ref: '#/components/schemas/accessBookmarksComponentsSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + type: object + accessBookmarksComponentsSchemasName: + description: The name of the Bookmark application. + example: My Website + type: string + x-auditable: true + accessBookmarksComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessBookmarks' + type: array + required: + - success + - errors + - messages + accessBookmarksComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessBookmarks' + required: + - success + - errors + - messages + accessButtonColor: + description: The background color of the log in button on the landing page. + example: '#ff0000' + type: string + accessButtonTextColor: + description: The color of the text in the log in button on the landing page. + example: '#ff0000' + type: string + accessCa: + properties: + aud: + $ref: '#/components/schemas/accessAud' + id: + $ref: '#/components/schemas/accessSchemasId' + public_key: + $ref: '#/components/schemas/accessPublicKey' + type: object + accessCaComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessCa' + type: array + required: + - success + - errors + - messages + accessCaComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessCa' + required: + - success + - errors + - messages + accessCertificates: + properties: + associated_hostnames: + $ref: '#/components/schemas/accessAssociatedHostnames' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + expires_on: + $ref: '#/components/schemas/accessTimestamp' + fingerprint: + $ref: '#/components/schemas/accessFingerprint' + id: + description: The ID of the application that will use this certificate. + type: string + x-auditable: true + name: + $ref: '#/components/schemas/accessCertificatesComponentsSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + type: object + accessCertificatesComponentsSchemasName: + description: The name of the certificate. + example: Allow devs + type: string + x-auditable: true + accessCertificatesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessCertificates' + type: array + required: + - success + - errors + - messages + accessCertificatesComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessCertificates' + required: + - success + - errors + - messages + accessCfResourceId: + description: The unique Cloudflare-generated Id of the SCIM Group resource; also known as the "Id". + example: a2abeb50-59c9-4c01-8c5c-963d3bf5700f + type: string + accessClientId: + description: The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header. + example: 88bf3b6d86161464f6509f7219099e57.access.example.com + type: string + accessClientSecret: + description: The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header. + example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5 + type: string + x-sensitive: true + accessClientSecretVersion: + default: 1 + description: A version number identifying the current `client_secret` associated with the service token. Incrementing it triggers a rotation; the previous secret will still be accepted until the time indicated by `previous_client_secret_expires_at`. + type: number + x-auditable: true + accessComponentsSchemasEmail: + description: The email address of the authenticating user. + example: user@example.com + format: email + type: string + accessComponentsSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/accessUuid' + type: object + required: + - success + - errors + - messages + accessComponentsSchemasName: + description: The name of the identity provider, shown to users on the login page. + example: Widget Corps IDP + type: string + accessComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessServiceTokens' + type: array + required: + - success + - errors + - messages + accessComponentsSchemasSessionDuration: + default: 24h + description: "The amount of time that tokens issued for the application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or \xB5s), ms, s, m, h." + example: 24h + type: string + accessComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessIdentityProviders' + required: + - success + - errors + - messages + accessConnection: + description: The IdP used to authenticate. + example: saml + type: string + accessConnectionRules: + description: The rules that define how users may connect to targets secured by your application. + properties: + rdp: + $ref: '#/components/schemas/accessConnectionRulesRdp' + title: Connection Rules + type: object + accessConnectionRulesRdp: + description: The RDP-specific rules that define clipboard behavior for RDP connections. + properties: + allowed_clipboard_local_to_remote_formats: + $ref: '#/components/schemas/accessAllowedClipboardLocalToRemoteFormats' + allowed_clipboard_remote_to_local_formats: + $ref: '#/components/schemas/accessAllowedClipboardRemoteToLocalFormats' + title: RDP Connection Rules + type: object + accessCorsHeaders: + properties: + allow_all_headers: + $ref: '#/components/schemas/accessAllowAllHeaders' + allow_all_methods: + $ref: '#/components/schemas/accessAllowAllMethods' + allow_all_origins: + $ref: '#/components/schemas/accessAllowAllOrigins' + allow_credentials: + $ref: '#/components/schemas/accessAllowCredentials' + allowed_headers: + $ref: '#/components/schemas/accessAllowedHeaders' + allowed_methods: + $ref: '#/components/schemas/accessAllowedMethods' + allowed_origins: + $ref: '#/components/schemas/accessAllowedOrigins' + max_age: + $ref: '#/components/schemas/accessMaxAge' + type: object + accessCreateResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + client_id: + $ref: '#/components/schemas/accessClientId' + client_secret: + $ref: '#/components/schemas/accessClientSecret' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + duration: + $ref: '#/components/schemas/accessDuration' + id: + description: The ID of the service token. + type: string + name: + $ref: '#/components/schemas/accessSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + type: object + required: + - success + - errors + - messages + accessCreatedAt: + x-stainless-skip: true + $ref: '#/components/schemas/accessTimestamp' + accessCustomDenyMessage: + description: The custom error message shown to a user when they are denied access to the application. + type: string + accessCustomDenyUrl: + description: The custom URL a user is redirected to when they are denied access to the application when failing identity-based rules. + type: string + accessCustomNonIdentityDenyUrl: + description: The custom URL a user is redirected to when they are denied access to the application when failing non-identity rules. + type: string + accessCustomPage: + properties: + app_count: + $ref: '#/components/schemas/accessSchemasAppCount' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + custom_html: + description: Custom page HTML. + example:

Access Denied

+ type: string + x-auditable: true + name: + $ref: '#/components/schemas/accessCustomPagesComponentsSchemasName' + type: + $ref: '#/components/schemas/accessSchemasType' + uid: + $ref: '#/components/schemas/accessUuid' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + required: + - name + - custom_html + - type + type: object + accessCustomPageWithoutHtml: + properties: + app_count: + $ref: '#/components/schemas/accessSchemasAppCount' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + name: + $ref: '#/components/schemas/accessCustomPagesComponentsSchemasName' + type: + $ref: '#/components/schemas/accessSchemasType' + uid: + $ref: '#/components/schemas/accessUuid' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + required: + - name + - type + type: object + accessCustomPages: + properties: + forbidden: + description: The uid of the custom page to use when a user is denied access after failing a non-identity rule. + example: 699d98642c564d2e855e9661899b7252 + type: string + identity_denied: + description: The uid of the custom page to use when a user is denied access. + example: 699d98642c564d2e855e9661899b7252 + type: string + type: object + accessCustomPagesComponentsSchemasName: + description: Custom page name. + type: string + x-auditable: true + accessCustomPagesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessCustomPageWithoutHtml' + type: array + required: + - success + - errors + - messages + accessCustomPagesComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessCustomPage' + required: + - success + - errors + - messages + accessDaysUntilNextRotation: + description: The number of days until the next key rotation. + example: 1 + readOnly: true + type: number + x-auditable: true + accessDecision: + description: The action Access will take if a user matches this policy. Infrastructure application policies can only use the Allow action. + enum: + - allow + - deny + - non_identity + - bypass + example: allow + type: string + accessDeleteAuthenticatorResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + type: object + required: + - success + - errors + - messages + accessDeleteUserResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + nullable: true + type: object + required: + - success + - errors + - messages + accessDenyUnmatchedRequests: + description: Determines whether to deny all requests to Cloudflare-protected resources that lack an associated Access application. If enabled, you must explicitly configure an Access application and policy to allow traffic to your Cloudflare-protected resources. For domains you want to be public across all subdomains, add the domain to the `deny_unmatched_requests_exempted_zone_names` array. + type: boolean + x-auditable: true + accessDenyUnmatchedRequestsExemptedZoneNames: + description: Contains zone names to exempt from the `deny_unmatched_requests` feature. Requests to a subdomain in an exempted zone will block unauthenticated traffic by default if there is a configured Access application and policy that matches the request. + example: + - example.com + items: + type: string + type: array + x-auditable: true + accessDestinations: + default: [] + description: List of destinations secured by Access. This supersedes `self_hosted_domains` to allow for more flexibility in defining different types of domains. If `destinations` are provided, then `self_hosted_domains` will be ignored. + example: + - type: public + uri: test.example.com/admin + - type: public + uri: test.anotherexample.com/staff + - cidr: 10.5.0.0/24 + port_range: 80-90 + type: private + - cidr: 10.5.0.3/32 + port_range: '80' + type: private + - hostname: private-sni.example.com + type: private + - mcp_server_id: mcp-server-1 + type: via_mcp_server_portal + items: + type: object + title: Public destination + description: A public hostname that Access will secure. Public destinations support sub-domain and path. Wildcard '*' can be used in the definition. + properties: + type: + enum: + - public + type: string + uri: + description: The URI of the destination. Public destinations' URIs can include a domain and path with [wildcards](https://developers.cloudflare.com/cloudflare-one/policies/access/app-paths/). + type: string + cidr: + description: The CIDR range of the destination. Single IPs will be computed as /32. + type: string + hostname: + description: The hostname of the destination. Matches a valid SNI served by an HTTPS origin. + type: string + l4_protocol: + description: The L4 protocol of the destination. When omitted, both UDP and TCP traffic will match. + enum: + - tcp + - udp + type: string + port_range: + description: The port range of the destination. Can be a single port or a range of ports. When omitted, all ports will match. + type: string + vnet_id: + description: The VNET ID to match the destination. When omitted, all VNETs will match. + type: string + mcp_server_id: + description: The MCP server id configured in ai-controls. + type: string + type: array + accessDirection: + default: desc + description: The chronological order used to sort the logs. + enum: + - desc + - asc + example: desc + type: string + accessDohJwtDuration: + description: "The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or \xB5s), ms, s, m, h. Note that the maximum duration for this setting is the same as the key rotation period on the account. Default expiration is 24h" + example: 800h + type: string + x-auditable: true + accessDomain: + description: The primary hostname and path secured by Access. This domain will be displayed if the app is visible in the App Launcher. + example: test.example.com/admin + type: string + accessDuration: + default: 8760h + description: "The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or \xB5s), ms, s, m, h. The default is 1 year in hours (8760h)." + example: 60m + type: string + x-auditable: true + accessEmail: + description: The email address of the SCIM User resource. + example: john.smith@example.com + type: string + accessEmptyResponse: + type: object + properties: + result: + enum: + - true + - false + example: true + type: boolean + success: + enum: + - true + - false + example: true + type: boolean + accessEnableBindingCookie: + default: false + description: Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks. + type: boolean + accessExclude: + description: Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules. + items: + $ref: '#/components/schemas/accessRule' + type: array + accessExternalId: + description: The IdP-generated Id of the SCIM resource. + example: all_employees + type: string + accessFailedLoginResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessFailedLoginResponse_result_item' + type: array + required: + - success + - errors + - messages + accessFailedLoginResponse_result_item: + properties: + expiration: + type: integer + metadata: + example: + app_name: Test App + aud: 39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04 + datetime: '2022-02-02T21:54:34.914Z' + ray_id: 6d76a8a42ead4133 + user_email: test@cloudflare.com + user_uuid: 57171132-e453-4ee8-b2a5-8cbaad333207 + type: object + type: object + accessFingerprint: + description: The MD5 fingerprint of the certificate. + example: MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91 + type: string + accessFooterLinks: + description: The links in the App Launcher footer. + example: + - name: Cloudflare's Privacy Policy + url: https://www.cloudflare.com/privacypolicy/ + items: + properties: + name: + description: The hypertext in the footer link. + example: Cloudflare's Privacy Policy + type: string + url: + description: the hyperlink in the footer link. + example: https://www.cloudflare.com/privacypolicy/ + type: string + required: + - name + - url + type: object + type: array + accessGatewayCaComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessSchemasCertificates' + type: array + required: + - success + - errors + - messages + accessGatewayCaComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessSchemasCertificates' + required: + - success + - errors + - messages + accessGatewaySeat: + description: True if the seat is part of Gateway. + example: false + type: boolean + x-auditable: true + accessGeo: + $ref: '#/components/schemas/unnamedSchemaRef6a02fe18089d53b52b2cd3949b717919' + accessGroups: + properties: + displayName: + description: The display name of the SCIM Group resource. + example: ALL EMPLOYEES + type: string + externalId: + $ref: '#/components/schemas/accessExternalId' + id: + $ref: '#/components/schemas/accessId' + meta: + $ref: '#/components/schemas/accessMeta' + schemas: + description: The list of URIs which indicate the attributes contained within a SCIM resource. + example: + - urn:ietf:params:scim:schemas:core:2.0:Group + items: + type: string + type: array + type: object + accessGroupsComponentsSchemasName: + description: The name of the Access group. + example: Allow devs + type: string + x-auditable: true + accessGroupsComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessSchemasGroups' + required: + - success + - errors + - messages + accessGroupsName: + description: The display name of the SCIM Group resource. + example: ALL_EMPLOYEES + type: string + accessHeaderBgColor: + description: The background color of the App Launcher header. + example: '#ff0000' + type: string + accessHttpOnlyCookieAttribute: + default: true + description: Enables the HttpOnly cookie attribute, which increases security against XSS attacks. + example: true + type: boolean + accessId: + description: The unique Cloudflare-generated Id of the SCIM resource. + example: bd97ef8d-7986-43e3-9ee0-c25dda33e4b0 + type: string + accessIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/accessUuid' + type: object + required: + - success + - errors + - messages + accessIdentity: + properties: + account_id: + example: '1234567890' + type: string + x-auditable: true + auth_status: + example: NONE + type: string + x-auditable: true + common_name: + example: '' + type: string + devicePosture: + type: object + device_id: + example: '' + type: string + device_sessions: + $ref: '#/components/schemas/accessStringKeyMapDeviceSession' + email: + example: test@cloudflare.com + type: string + geo: + $ref: '#/components/schemas/accessGeo' + iat: + example: 1694791905 + type: number + idp: + properties: + id: + type: string + type: + type: string + type: object + ip: + example: 127.0.0.0 + type: string + is_gateway: + example: false + type: boolean + is_warp: + example: false + type: boolean + mtls_auth: + properties: + auth_status: + type: string + cert_issuer_dn: + type: string + cert_issuer_ski: + type: string + cert_presented: + type: boolean + cert_serial: + type: string + type: object + service_token_id: + example: '' + type: string + service_token_status: + example: false + type: boolean + user_uuid: + example: 57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4 + type: string + version: + example: 2 + type: number + type: object + accessIdentityProviders: + type: object + title: Azure AD + properties: + config: + description: The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). + type: object + properties: + client_id: + description: Your OAuth Client ID + example: + type: string + client_secret: + description: Your OAuth Client Secret + example: + type: string + x-sensitive: true + claims: + description: Custom claims + example: + - email_verified + - preferred_username + - custom_claim_name + items: + type: string + type: array + x-auditable: true + email_claim_name: + description: The claim name for email in the id_token response. + example: custom_claim_name + type: string + x-auditable: true + conditional_access_enabled: + description: Should Cloudflare try to load authentication contexts from your account + type: boolean + x-auditable: true + directory_id: + description: Your Azure directory uuid + example: + type: string + x-auditable: true + prompt: + description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. + enum: + - login + - select_account + - none + type: string + x-auditable: true + support_groups: + description: Should Cloudflare try to load groups from your account + type: boolean + x-auditable: true + id: + $ref: '#/components/schemas/accessUuid' + name: + $ref: '#/components/schemas/accessComponentsSchemasName' + scim_config: + $ref: '#/components/schemas/scimConfig' + type: + $ref: '#/components/schemas/accessIdpType' + required: + - config + - name + - type + accessIdpId: + description: The unique Id of the IdP that has SCIM enabled. + example: + - df7e2w5f-02b7-4d9d-af26-8d1988fca630 + - 0194ae2c-efcf-7cfb-8884-055f1a161fa5 + items: + type: string + type: array + accessIdpResourceId: + description: The IdP-generated Id of the SCIM Group resource; also known as the "external Id". + example: all_employees + type: string + accessIdpType: + description: The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). + enum: + - onetimepin + - azureAD + - saml + - centrify + - facebook + - github + - google-apps + - google + - linkedin + - oidc + - okta + - onelogin + - pingone + - yandex + example: onetimepin + type: string + accessImageUrl: + description: The URL of the image shown on the landing page. + example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg + type: string + accessInclude: + description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules. + items: + $ref: '#/components/schemas/accessRule' + type: array + accessIp: + description: The IP address of the authenticating user. + example: 198.41.129.166 + type: string + accessIsDefault: + description: Whether this is the default group + type: boolean + x-auditable: true + accessIsUiReadOnly: + default: false + description: Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled. + type: boolean + x-auditable: true + accessIsolationRequired: + description: Require this application to be served in an isolated browser for users matching this policy. 'Client Web Isolation' must be on for the account in order to use this feature. + example: false + type: boolean + accessKeyConfig: + properties: + days_until_next_rotation: + $ref: '#/components/schemas/accessDaysUntilNextRotation' + key_rotation_interval_days: + $ref: '#/components/schemas/accessKeyRotationIntervalDays' + last_key_rotation_at: + $ref: '#/components/schemas/accessLastKeyRotationAt' + type: object + accessKeyRotationIntervalDays: + description: The number of days between key rotations. + example: 30 + maximum: 365 + minimum: 21 + type: number + x-auditable: true + accessKeysComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessKeyConfig' + required: + - success + - errors + - messages + accessLandingPageDesign: + description: The design of the App Launcher landing page shown to users when they log in. + properties: + button_color: + $ref: '#/components/schemas/accessButtonColor' + button_text_color: + $ref: '#/components/schemas/accessButtonTextColor' + image_url: + $ref: '#/components/schemas/accessImageUrl' + message: + $ref: '#/components/schemas/accessMessage' + title: + $ref: '#/components/schemas/accessTitle' + type: object + accessLastKeyRotationAt: + description: The timestamp of the previous key rotation. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + accessLastSeenIdentityResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + $ref: '#/components/schemas/accessIdentity' + required: + - success + - errors + - messages + accessLastSuccessfulLogin: + description: The time at which the user last successfully logged in. + example: '2020-07-01T05:20:00Z' + format: date-time + type: string + accessLimit: + default: 20 + description: The maximum number of update logs to retrieve. + example: 10 + type: integer + accessLoginDesign: + properties: + background_color: + description: The background color on your login page. + example: '#c5ed1b' + type: string + footer_text: + description: The text at the bottom of your login page. + example: This is an example description. + type: string + header_text: + description: The text at the top of your login page. + example: This is an example description. + type: string + logo_path: + description: The URL of the logo on your login page. + example: https://example.com/logo.png + type: string + text_color: + description: The text color on your login page. + example: '#c5ed1b' + type: string + type: object + accessLogoUrl: + description: The image URL for the logo shown in the App Launcher dashboard. + example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg + type: string + accessMaxAge: + description: The maximum number of seconds the results of a preflight request can be cached. + example: -1 + maximum: 86400 + minimum: -1 + type: number + accessMessage: + description: The message shown on the landing page. + example: Log in below to reach your applications behind Access. + type: string + accessMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + accessMeta: + description: The metadata of the SCIM resource. + properties: + created: + description: The timestamp of when the SCIM resource was created. + example: '2025-01-01T00:00:00Z' + format: date-time + type: string + lastModified: + description: The timestamp of when the SCIM resource was last modified. + example: '2025-01-02T00:00:00Z' + format: date-time + type: string + type: object + accessMfaConfig: + description: Configures multi-factor authentication (MFA) settings. + properties: + allowed_authenticators: + description: Lists the MFA methods that users can authenticate with. + example: + - totp + - biometrics + - security_key + items: + enum: + - totp + - biometrics + - security_key + type: string + type: array + mfa_disabled: + description: Indicates whether to disable MFA for this resource. This option is available at the application and policy level. + example: false + type: boolean + session_duration: + description: 'Defines the duration of an MFA session. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days). Examples:`5m` or `24h`.' + example: 24h + type: string + type: object + x-auditable: true + accessMfaRequiredForAllApps: + default: false + description: Determines whether global MFA settings apply to applications by default. The organization must have MFA enabled with at least one authentication method and a session duration configured. + example: false + type: boolean + x-auditable: true + accessMfaSshPivKeyRequirements: + description: Configures SSH PIV key requirements for MFA using hardware security keys. + properties: + pin_policy: + description: 'Defines when a PIN is required to use the SSH key. Valid values: `never` (no PIN required), `once` (PIN required once per session), `always` (PIN required for each use).' + enum: + - never + - once + - always + example: always + type: string + require_fips_device: + description: Requires the SSH PIV key to be stored on a FIPS 140-2 Level 1 or higher validated device. + example: true + type: boolean + ssh_key_size: + description: Specifies the allowed SSH key sizes in bits. Valid sizes depend on key type. Ed25519 has a fixed key size and does not accept this parameter. + example: + - 256 + - 2048 + items: + enum: + - 256 + - 384 + - 521 + - 2048 + - 3072 + - 4096 + type: integer + type: array + ssh_key_type: + description: Specifies the allowed SSH key types. Valid values are `ecdsa`, `ed25519`, and `rsa`. + example: + - ecdsa + - rsa + items: + enum: + - ecdsa + - ed25519 + - rsa + type: string + type: array + touch_policy: + description: 'Defines when physical touch is required to use the SSH key. Valid values: `never` (no touch required), `always` (touch required for each use), `cached` (touch cached for 15 seconds).' + enum: + - never + - always + - cached + example: always + type: string + type: object + x-auditable: true + accessName: + description: The name of your Zero Trust organization. + example: Widget Corps Internal Applications + type: string + x-auditable: true + accessNameResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + name: + $ref: '#/components/schemas/accessTagsComponentsSchemasName' + type: object + required: + - success + - errors + - messages + accessNonce: + example: X1aXj1lFVcqqyoXF + type: string + accessOauthConfiguration: + description: '**Beta:** Optional configuration for managing an OAuth authorization flow controlled by Access. When set, Access will act as the OAuth authorization server for this application. Only compatible with OAuth clients that support [RFC 8707](https://datatracker.ietf.org/doc/html/rfc8707) (Resource Indicators for OAuth 2.0). This feature is currently in beta.' + properties: + dynamic_client_registration: + description: Settings for OAuth dynamic client registration. + properties: + allow_any_on_localhost: + description: Allows any client with redirect URIs on localhost. + type: boolean + allow_any_on_loopback: + description: Allows any client with redirect URIs on 127.0.0.1. + type: boolean + allowed_uris: + description: The URIs that are allowed as redirect URIs for dynamically registered clients. Must use the `https` protocol. Paths may end in `/*` to match all sub-paths. + example: + - https://example.com/callback + items: + type: string + type: array + enabled: + description: Whether dynamic client registration is enabled. + type: boolean + type: object + enabled: + default: true + description: Whether the OAuth configuration is enabled for this application. When set to `false`, Access will not handle OAuth for this application. Defaults to `true` if omitted. + type: boolean + grant: + description: Settings for OAuth grant behavior. + properties: + access_token_lifetime: + description: "The lifetime of the access token. Must be in the format `300ms` or `2h45m`. Valid time units are ns, us (or \xB5s), ms, s, m, h." + example: 5m + type: string + session_duration: + description: "The duration of the OAuth session. Must be in the format `300ms` or `2h45m`. Valid time units are ns, us (or \xB5s), ms, s, m, h." + example: 24h + type: string + type: object + type: object + accessOptionsPreflightBypass: + description: Allows options preflight requests to bypass Access authentication and go directly to the origin. Cannot turn on if cors_headers is set. + example: true + type: boolean + accessOrgMfaConfig: + description: Configures multi-factor authentication (MFA) settings for an organization. + properties: + allowed_authenticators: + description: Lists the MFA methods that users can authenticate with. + example: + - totp + - biometrics + - security_key + items: + enum: + - totp + - biometrics + - security_key + - ssh_piv_key + type: string + type: array + amr_matching_session_duration: + description: 'Allows a user to skip MFA via Authentication Method Reference (AMR) matching when the AMR claim provided by the IdP the user used to authenticate contains "mfa". Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days).' + example: 12h + type: string + required_aaguids: + description: Specifies a Cloudflare List of required FIDO2 authenticator device AAGUIDs. + example: 2fc0579f-8113-47ea-b116-bb5a8db9202a + format: uuid + type: string + session_duration: + description: 'Defines the duration of an MFA session. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days). Examples:`5m` or `24h`.' + example: 24h + type: string + type: object + x-auditable: true + accessOrganizations: + properties: + allow_authenticate_via_warp: + $ref: '#/components/schemas/accessAllowAuthenticateViaWarp' + auth_domain: + $ref: '#/components/schemas/accessAuthDomain' + auto_redirect_to_identity: + $ref: '#/components/schemas/accessAutoRedirectToIdentity' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + custom_pages: + $ref: '#/components/schemas/accessCustomPages' + deny_unmatched_requests: + $ref: '#/components/schemas/accessDenyUnmatchedRequests' + deny_unmatched_requests_exempted_zone_names: + $ref: '#/components/schemas/accessDenyUnmatchedRequestsExemptedZoneNames' + is_ui_read_only: + $ref: '#/components/schemas/accessIsUiReadOnly' + login_design: + $ref: '#/components/schemas/accessLoginDesign' + mfa_config: + $ref: '#/components/schemas/accessOrgMfaConfig' + mfa_required_for_all_apps: + $ref: '#/components/schemas/accessMfaRequiredForAllApps' + mfa_ssh_piv_key_requirements: + $ref: '#/components/schemas/accessMfaSshPivKeyRequirements' + name: + $ref: '#/components/schemas/accessName' + session_duration: + $ref: '#/components/schemas/accessSessionDuration' + ui_read_only_toggle_reason: + $ref: '#/components/schemas/accessUiReadOnlyToggleReason' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + user_seat_expiration_inactive_time: + $ref: '#/components/schemas/accessUserSeatExpirationInactiveTime' + warp_auth_session_duration: + $ref: '#/components/schemas/accessWarpAuthSessionDuration' + type: object + accessPathCookieAttribute: + default: false + description: Enables cookie paths to scope an application's JWT to the application path. If disabled, the JWT will scope to the hostname by default + example: true + type: boolean + accessPercentApproved: + description: The percentage of (processed) users approved based on policy evaluation results. + example: 25 + type: integer + x-auditable: true + accessPercentBlocked: + description: The percentage of (processed) users blocked based on policy evaluation results. + example: 25 + type: integer + x-auditable: true + accessPercentErrored: + description: The percentage of (processed) users errored based on policy evaluation results. + example: 25 + type: integer + x-auditable: true + accessPercentUsersProcessed: + description: The percentage of users processed so far (of the entire user base). + example: 50 + type: integer + accessPolicyCheckResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + app_state: + properties: + app_uid: + $ref: '#/components/schemas/accessUuid' + aud: + example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389 + type: string + hostname: + example: test.com + type: string + name: + example: Test App + type: string + policies: + example: + - decision: allow + exclude: [] + include: + - _type: email + email: testuser@gmail.com + precedence: 1 + require: [] + status: Success + items: + type: object + type: array + status: + example: Success + type: string + type: object + user_identity: + properties: + account_id: + example: 41ecfbb341f033e52b46742756aabb8b + type: string + device_sessions: + example: {} + type: object + email: + example: testuser@gmail.com + type: string + geo: + $ref: '#/components/schemas/unnamedSchemaRef6a02fe18089d53b52b2cd3949b717919' + iat: + type: integer + id: + example: '1164449231815010287495' + type: string + is_gateway: + example: false + type: boolean + is_warp: + example: false + type: boolean + name: + example: Test User + type: string + user_uuid: + $ref: '#/components/schemas/accessUuid' + version: + type: integer + type: object + type: object + required: + - success + - errors + - messages + accessPolicyComponentsSchemasName: + description: The name of the Access policy. + example: Allow devs + type: string + accessPolicyInitReq: + properties: + policies: + items: + type: object + properties: + approval_groups: + $ref: '#/components/schemas/accessApprovalGroups' + approval_required: + $ref: '#/components/schemas/accessApprovalRequired' + connection_rules: + $ref: '#/components/schemas/accessConnectionRules' + isolation_required: + $ref: '#/components/schemas/accessIsolationRequired' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + purpose_justification_prompt: + $ref: '#/components/schemas/accessPurposeJustificationPrompt' + purpose_justification_required: + $ref: '#/components/schemas/accessPurposeJustificationRequired' + session_duration: + $ref: '#/components/schemas/accessComponentsSchemasSessionDuration' + decision: + $ref: '#/components/schemas/accessDecision' + exclude: + $ref: '#/components/schemas/accessSchemasExclude' + include: + $ref: '#/components/schemas/accessSchemasInclude' + name: + $ref: '#/components/schemas/accessPolicyComponentsSchemasName' + require: + $ref: '#/components/schemas/accessSchemasRequire' + required: + - name + - include + - decision + description: The UUID of the reusable policy you wish to test + example: f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6 + type: array + type: object + accessPolicyInitResp: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/accessPolicyTestId' + status: + $ref: '#/components/schemas/accessStatus' + type: object + required: + - success + - errors + - messages + accessPolicyReq: + properties: + approval_groups: + $ref: '#/components/schemas/accessApprovalGroups' + approval_required: + $ref: '#/components/schemas/accessApprovalRequired' + connection_rules: + $ref: '#/components/schemas/accessConnectionRules' + isolation_required: + $ref: '#/components/schemas/accessIsolationRequired' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + purpose_justification_prompt: + $ref: '#/components/schemas/accessPurposeJustificationPrompt' + purpose_justification_required: + $ref: '#/components/schemas/accessPurposeJustificationRequired' + session_duration: + $ref: '#/components/schemas/accessComponentsSchemasSessionDuration' + decision: + $ref: '#/components/schemas/accessDecision' + exclude: + $ref: '#/components/schemas/accessSchemasExclude' + include: + $ref: '#/components/schemas/accessSchemasInclude' + name: + $ref: '#/components/schemas/accessPolicyComponentsSchemasName' + require: + $ref: '#/components/schemas/accessSchemasRequire' + type: object + required: + - decision + - include + - name + accessPolicyTestId: + description: The UUID of the policy test. + example: f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6 + maxLength: 64 + type: string + x-auditable: true + accessPolicyUpdateResp: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/accessPolicyTestId' + percent_approved: + $ref: '#/components/schemas/accessPercentApproved' + percent_blocked: + $ref: '#/components/schemas/accessPercentBlocked' + percent_errored: + $ref: '#/components/schemas/accessPercentErrored' + percent_users_processed: + $ref: '#/components/schemas/accessPercentUsersProcessed' + status: + $ref: '#/components/schemas/accessUpdateStatus' + total_users: + $ref: '#/components/schemas/accessTotalUsers' + users_approved: + $ref: '#/components/schemas/accessUsersApproved' + users_blocked: + $ref: '#/components/schemas/accessUsersBlocked' + users_errored: + $ref: '#/components/schemas/accessUsersErrored' + type: object + required: + - success + - errors + - messages + accessPolicyUsers: + properties: + email: + $ref: '#/components/schemas/accessSchemasEmail' + id: + $ref: '#/components/schemas/accessUuid' + name: + $ref: '#/components/schemas/accessUsersComponentsSchemasName' + status: + $ref: '#/components/schemas/accessUserResult' + type: object + accessPolicyUsersResp: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + description: Page of processed users. + items: + $ref: '#/components/schemas/accessPolicyUsers' + type: array + required: + - success + - errors + - messages + accessPort: + description: The port that the targets use for the chosen communication protocol. A port cannot be assigned to multiple protocols. + example: 22 + type: integer + accessPrecedence: + description: The order of execution for this policy. Must be unique for each policy within an app. + type: integer + accessPreviousClientSecretExpiresAt: + description: The expiration of the previous `client_secret`. This can be modified at any point after a rotation. For example, you may extend it further into the future if you need more time to update services with the new secret; or move it into the past to immediately invalidate the previous token in case of compromise. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + accessProtocolInfraApp: + description: The communication protocol your application secures. + enum: + - SSH + example: SSH + type: string + x-auditable: true + accessPublicKey: + description: The public key to add to your SSH server configuration. + example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org + readOnly: true + type: string + accessPurposeJustificationPrompt: + description: A custom message that will appear on the purpose justification screen. + example: Please enter a justification for entering this protected domain. + type: string + accessPurposeJustificationRequired: + description: Require users to enter a justification when they log in to the application. + example: true + type: boolean + accessRayId: + description: The unique identifier for the request to Cloudflare. + example: 187d944c61940c77 + maxLength: 16 + type: string + accessRdpClipboardFormat: + description: Clipboard format for RDP connections. + enum: + - text + type: string + x-auditable: true + accessReadServiceTokensFromHeader: + description: 'Allows matching Access Service Tokens passed HTTP in a single header with this name. This works as an alternative to the (CF-Access-Client-Id, CF-Access-Client-Secret) pair of headers. The header value will be interpreted as a json object similar to: { "cf-access-client-id": "88bf3b6d86161464f6509f7219099e57.access.example.com", "cf-access-client-secret": "bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5" }' + example: Authorization + type: string + accessRequestMethod: + description: The request method of the SCIM request. + example: + - DELETE + - PATCH + items: + enum: + - DELETE + - PATCH + - POST + - PUT + type: string + type: array + accessRequestsCfResourceId: + description: The unique Cloudflare-generated Id of the SCIM resource. + example: bd97ef8d-7986-43e3-9ee0-c25dda33e4b0 + type: string + accessRequestsIdpResourceId: + description: The IdP-generated Id of the SCIM resource. + type: string + accessRequestsStatus: + description: The status of the SCIM request. + example: + - FAILURE + - SUCCESS + items: + enum: + - FAILURE + - SUCCESS + type: string + type: array + accessRequire: + description: Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules. + items: + $ref: '#/components/schemas/accessRule' + type: array + accessResourceGroupName: + description: The display name of the SCIM Group resource. + example: ALL_EMPLOYEES + type: string + accessResourceType: + description: The resource type of the SCIM request. + example: + - USER + - GROUP + items: + enum: + - USER + - GROUP + type: string + type: array + accessResourceUserEmail: + description: The email address of the SCIM User resource. + example: john.smith@example.com + format: email + type: string + accessResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessResponseCollection_result_item' + type: array + required: + - success + - errors + - messages + accessResponseCollectionHostnames: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessSettings' + type: array + required: + - success + - errors + - messages + accessResponseCollection_result_item: + type: object + title: Azure AD + properties: + config: + description: The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). + type: object + properties: + client_id: + description: Your OAuth Client ID + example: + type: string + client_secret: + description: Your OAuth Client Secret + example: + type: string + x-sensitive: true + claims: + description: Custom claims + example: + - email_verified + - preferred_username + - custom_claim_name + items: + type: string + type: array + x-auditable: true + email_claim_name: + description: The claim name for email in the id_token response. + example: custom_claim_name + type: string + x-auditable: true + conditional_access_enabled: + description: Should Cloudflare try to load authentication contexts from your account + type: boolean + x-auditable: true + directory_id: + description: Your Azure directory uuid + example: + type: string + x-auditable: true + prompt: + description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. + enum: + - login + - select_account + - none + type: string + x-auditable: true + support_groups: + description: Should Cloudflare try to load groups from your account + type: boolean + x-auditable: true + id: + $ref: '#/components/schemas/accessUuid' + name: + $ref: '#/components/schemas/accessComponentsSchemasName' + scim_config: + $ref: '#/components/schemas/scimConfig' + type: + $ref: '#/components/schemas/accessIdpType' + required: + - config + - name + - type + accessResponses: + properties: + cf_resource_id: + description: The unique Cloudflare-generated Id of the SCIM resource. + example: bd97ef8d-7986-43e3-9ee0-c25dda33e4b0 + type: string + error_description: + description: The error message which is generated when the status of the SCIM request is 'FAILURE'. + example: Invalid JSON body + type: string + idp_id: + description: The unique Id of the IdP that has SCIM enabled. + example: df7e2w5f-02b7-4d9d-af26-8d1988fca630 + type: string + idp_resource_id: + description: The IdP-generated Id of the SCIM resource. + example: all_employees + type: string + logged_at: + $ref: '#/components/schemas/accessTimestamp' + request_body: + description: The JSON-encoded string body of the SCIM request. + example: '{}}' + type: string + request_method: + description: The request method of the SCIM request. + example: DELETE + type: string + resource_group_name: + description: The display name of the SCIM Group resource if it exists. + example: ALL_EMPLOYEES + type: string + resource_type: + description: The resource type of the SCIM request. + example: GROUP + type: string + resource_user_email: + description: The email address of the SCIM User resource if it exists. + example: john.smith@example.com + format: email + type: string + status: + description: The status of the SCIM request. + example: FAILURE + type: string + type: object + accessReusablePoliciesComponentsSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/accessSchemasUuid' + type: object + required: + - success + - errors + - messages + accessReusablePoliciesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessReusablePolicyResp' + type: array + required: + - success + - errors + - messages + accessReusablePoliciesComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessReusablePolicyResp' + required: + - success + - errors + - messages + accessReusablePolicyResp: + type: object + properties: + approval_groups: + $ref: '#/components/schemas/accessApprovalGroups' + approval_required: + $ref: '#/components/schemas/accessApprovalRequired' + connection_rules: + $ref: '#/components/schemas/accessConnectionRules' + isolation_required: + $ref: '#/components/schemas/accessIsolationRequired' + mfa_config: + $ref: '#/components/schemas/accessMfaConfig' + purpose_justification_prompt: + $ref: '#/components/schemas/accessPurposeJustificationPrompt' + purpose_justification_required: + $ref: '#/components/schemas/accessPurposeJustificationRequired' + session_duration: + $ref: '#/components/schemas/accessComponentsSchemasSessionDuration' + app_count: + $ref: '#/components/schemas/accessAppCount' + reusable: + enum: + - true + type: boolean + created_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + decision: + $ref: '#/components/schemas/accessDecision' + exclude: + $ref: '#/components/schemas/accessSchemasExclude' + id: + $ref: '#/components/schemas/accessSchemasUuid' + include: + $ref: '#/components/schemas/accessSchemasInclude' + name: + $ref: '#/components/schemas/accessPolicyComponentsSchemasName' + require: + $ref: '#/components/schemas/accessSchemasRequire' + updated_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + accessRule: + type: object + title: Access groups + description: Matches an Access group. + properties: + group: + properties: + id: + description: The ID of a previously created Access group. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + required: + - id + type: object + any_valid_service_token: + description: An empty object which matches on all service tokens. + example: {} + type: object + x-stainless-empty-object: true + auth_context: + properties: + ac_id: + description: The ACID of an Authentication context. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + id: + description: The ID of an Authentication context. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + identity_provider_id: + description: The ID of your Azure identity provider. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + required: + - id + - identity_provider_id + - ac_id + type: object + auth_method: + properties: + auth_method: + description: The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176#section-2. + example: mfa + type: string + required: + - auth_method + type: object + azureAD: + properties: + id: + description: The ID of an Azure group. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + identity_provider_id: + description: The ID of your Azure identity provider. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + required: + - id + - identity_provider_id + type: object + certificate: + example: {} + type: object + x-stainless-empty-object: true + common_name: + properties: + common_name: + description: The common name to match. + example: james@example.com + type: string + required: + - common_name + type: object + geo: + properties: + country_code: + description: The country code that should be matched. + example: US + type: string + required: + - country_code + type: object + device_posture: + properties: + integration_uid: + description: The ID of a device posture integration. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + required: + - integration_uid + type: object + email_domain: + properties: + domain: + description: The email domain to match. + example: example.com + type: string + required: + - domain + type: object + email_list: + properties: + id: + description: The ID of a previously created email list. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + required: + - id + type: object + email: + properties: + email: + description: The email of the user. + example: test@example.com + format: email + type: string + required: + - email + type: object + everyone: + description: An empty object which matches on all users. + example: {} + type: object + x-stainless-empty-object: true + external_evaluation: + properties: + evaluate_url: + description: The API endpoint containing your business logic. + example: https://eval.example.com + type: string + keys_url: + description: The API endpoint containing the key that Access uses to verify that the response came from your API. + example: https://eval.example.com/keys + type: string + required: + - evaluate_url + - keys_url + type: object + github-organization: + properties: + identity_provider_id: + description: The ID of your Github identity provider. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + name: + description: The name of the organization. + example: cloudflare + type: string + team: + description: The name of the team + example: api-team + type: string + required: + - name + - identity_provider_id + type: object + gsuite: + properties: + email: + description: The email of the Google Workspace group. + example: devs@cloudflare.com + type: string + identity_provider_id: + description: The ID of your Google Workspace identity provider. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + required: + - email + - identity_provider_id + type: object + login_method: + properties: + id: + description: The ID of an identity provider. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + required: + - id + type: object + ip_list: + properties: + id: + description: The ID of a previously created IP list. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + required: + - id + type: object + ip: + properties: + ip: + description: An IPv4 or IPv6 CIDR block. + example: 2400:cb00:21:10a::/64 + type: string + required: + - ip + type: object + okta: + properties: + identity_provider_id: + description: The ID of your Okta identity provider. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + name: + description: The name of the Okta group. + example: devs + type: string + required: + - name + - identity_provider_id + type: object + saml: + properties: + attribute_name: + description: The name of the SAML attribute. + example: group + type: string + attribute_value: + description: The SAML attribute value to look for. + example: devs@cloudflare.com + type: string + identity_provider_id: + description: The ID of your SAML identity provider. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + required: + - attribute_name + - attribute_value + - identity_provider_id + type: object + oidc: + properties: + claim_name: + description: The name of the OIDC claim. + example: group + type: string + claim_value: + description: The OIDC claim value to look for. + example: devs@cloudflare.com + type: string + identity_provider_id: + description: The ID of your OIDC identity provider. + example: ea85612a-29c8-46c2-bacb-669d65136971 + type: string + required: + - claim_name + - claim_value + - identity_provider_id + type: object + service_token: + properties: + token_id: + description: The ID of a Service Token. + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + required: + - token_id + type: object + linked_app_token: + properties: + app_uid: + description: The ID of an Access OIDC SaaS application + example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f + type: string + required: + - app_uid + type: object + user_risk_score: + properties: + user_risk_score: + description: A list of risk score levels to match. Values can be low, medium, high, or unscored. + example: + - low + - medium + items: + enum: + - low + - medium + - high + - unscored + type: string + minItems: 1 + type: array + required: + - user_risk_score + type: object + required: [] + example: + certificate: {} + accessSameSiteCookieAttribute: + description: Sets the SameSite cookie setting, which provides increased security against CSRF attacks. + example: strict + type: string + accessSchemasAccessSeat: + description: True if the user has authenticated with Cloudflare Access. + example: false + type: boolean + accessSchemasAllowAuthenticateViaWarp: + description: When set to true, users can authenticate to this application using their WARP session. When set to false this application will always require direct IdP authentication. This setting always overrides the organization setting for WARP authentication. + example: true + type: boolean + accessSchemasAppCount: + description: Number of apps the custom page is assigned to. + type: integer + x-auditable: true + x-stainless-skip: true + accessSchemasAppLauncherVisible: + description: Displays the application in the App Launcher. + example: true + type: boolean + x-auditable: true + accessSchemasAud: + description: Audience tag. + example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893 + maxLength: 64 + readOnly: true + type: string + accessSchemasAutoRedirectToIdentity: + default: false + description: When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps. + type: boolean + accessSchemasCertificates: + properties: + id: + description: The key ID of this certificate. + type: string + x-auditable: true + public_key: + description: The public key of this certificate. + type: string + type: object + accessSchemasCustomPages: + description: The custom pages that will be displayed when applicable for this application + items: + description: The custom pages selected for application. + example: 699d98642c564d2e855e9661899b7252 + type: string + type: array + accessSchemasDomain: + description: The domain of the Bookmark application. + example: example.com + type: string + x-auditable: true + accessSchemasEmail: + description: The email of the user. + example: jdoe@example.com + format: email + type: string + accessSchemasEmptyResponse: + type: object + properties: + result: + nullable: true + type: object + success: + enum: + - true + - false + example: true + type: boolean + accessSchemasExclude: + default: [] + description: Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules. + items: + $ref: '#/components/schemas/accessRule' + type: array + x-stainless-collection-type: set + accessSchemasGatewaySeat: + description: True if the user has logged into the WARP client. + example: false + type: boolean + accessSchemasGroups: + properties: + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + exclude: + $ref: '#/components/schemas/accessExclude' + id: + $ref: '#/components/schemas/accessUuid' + include: + $ref: '#/components/schemas/accessInclude' + is_default: + $ref: '#/components/schemas/accessRequire' + name: + $ref: '#/components/schemas/accessGroupsComponentsSchemasName' + require: + $ref: '#/components/schemas/accessRequire' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + type: object + accessSchemasId: + description: The ID of the CA. + example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9 + maxLength: 48 + readOnly: true + type: string + x-auditable: true + accessSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/accessSchemasId' + type: object + required: + - success + - errors + - messages + accessSchemasInclude: + default: [] + description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules. + items: + $ref: '#/components/schemas/accessRule' + type: array + x-stainless-collection-type: set + accessSchemasLogoUrl: + description: The image URL for the logo shown in the App Launcher dashboard. + example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg + type: string + x-auditable: true + accessSchemasName: + description: The name of the service token. + example: CI/CD token + type: string + x-auditable: true + accessSchemasRequire: + default: [] + description: Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules. + items: + $ref: '#/components/schemas/accessRule' + type: array + x-stainless-collection-type: set + accessSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessSchemasGroups' + type: array + required: + - success + - errors + - messages + accessSchemasSeatUid: + description: The unique API identifier for the Zero Trust seat. + type: string + accessSchemasSessionDuration: + default: 24h + description: "The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or \xB5s), ms, s, m, h. Note: unsupported for infrastructure type applications." + example: 24h + type: string + accessSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessServiceTokens' + required: + - success + - errors + - messages + accessSchemasType: + description: Custom page type. + enum: + - identity_denied + - forbidden + type: string + x-auditable: true + accessSchemasUsers: + properties: + access_seat: + $ref: '#/components/schemas/accessSchemasAccessSeat' + active_device_count: + $ref: '#/components/schemas/accessActiveDeviceCount' + created_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + email: + $ref: '#/components/schemas/accessSchemasEmail' + gateway_seat: + $ref: '#/components/schemas/accessSchemasGatewaySeat' + id: + $ref: '#/components/schemas/accessUuid' + last_successful_login: + $ref: '#/components/schemas/accessLastSuccessfulLogin' + name: + $ref: '#/components/schemas/accessUsersComponentsSchemasName' + seat_uid: + $ref: '#/components/schemas/accessSchemasSeatUid' + uid: + $ref: '#/components/schemas/accessUid' + updated_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + type: object + accessSchemasUuid: + description: The UUID of the policy + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + accessScimConfig: + description: Configuration for provisioning to this application via SCIM. This is currently in closed beta. + properties: + authentication: + type: object + title: HTTP Basic + description: Attributes for configuring HTTP Basic authentication scheme for SCIM provisioning to an application. + properties: + password: + description: Password used to authenticate with the remote SCIM service. + type: string + x-sensitive: true + scheme: + description: The authentication scheme to use when making SCIM requests to this application. + enum: + - httpbasic + type: string + user: + description: User name used to authenticate with the remote SCIM service. + type: string + token: + description: Token used to authenticate with the remote SCIM service. + type: string + x-sensitive: true + authorization_url: + description: URL used to generate the auth code used during token generation. + type: string + client_id: + description: Client ID used to authenticate when generating a token for authenticating with the remote SCIM service. + type: string + client_secret: + description: Secret used to authenticate when generating a token for authenticating with the remove SCIM service. + type: string + x-sensitive: true + scopes: + description: The authorization scopes to request when generating the token used to authenticate with the remove SCIM service. + items: + type: string + type: array + token_url: + description: URL used to generate the token used to authenticate with the remote SCIM service. + type: string + required: + - scheme + items: + $ref: '#/components/schemas/accessScimConfigSingleAuthentication' + deactivate_on_delete: + description: 'If false, propagates DELETE requests to the target application for SCIM resources. If true, sets ''active'' to false on the SCIM resource. Note: Some targets do not support DELETE operations.' + type: boolean + enabled: + description: Whether SCIM provisioning is turned on for this application. + type: boolean + idp_uid: + description: The UID of the IdP to use as the source for SCIM resources to provision to this application. + type: string + mappings: + description: A list of mappings to apply to SCIM resources before provisioning them in this application. These can transform or filter the resources to be provisioned. + items: + $ref: '#/components/schemas/accessScimConfigMapping' + type: array + remote_uri: + description: The base URI for the application's SCIM-compatible API. + type: string + required: + - remote_uri + - idp_uid + type: object + accessScimConfigMapping: + description: Transformations and filters applied to resources before they are provisioned in the remote SCIM service. + properties: + enabled: + description: Whether or not this mapping is enabled. + type: boolean + filter: + description: A [SCIM filter expression](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2) that matches resources that should be provisioned to this application. + example: title pr or userType eq "Intern" + type: string + operations: + description: Whether or not this mapping applies to creates, updates, or deletes. + properties: + create: + description: Whether or not this mapping applies to create (POST) operations. + type: boolean + delete: + description: Whether or not this mapping applies to DELETE operations. + type: boolean + update: + description: Whether or not this mapping applies to update (PATCH/PUT) operations. + type: boolean + type: object + schema: + description: Which SCIM resource type this mapping applies to. + example: urn:ietf:params:scim:schemas:core:2.0:User + type: string + strictness: + description: "The level of adherence to outbound resource schemas when provisioning to this mapping. \u2018Strict\u2019 removes unknown values, while \u2018passthrough\u2019 passes unknown values to the target." + enum: + - strict + - passthrough + type: string + transform_jsonata: + description: A [JSONata](https://jsonata.org/) expression that transforms the resource before provisioning it in the application. + example: '$merge([$, {''userName'': $substringBefore($.userName, ''@'') & ''+test@'' & $substringAfter($.userName, ''@'')}])' + type: string + required: + - schema + type: object + accessScimConfigSingleAuthentication: + type: object + title: HTTP Basic + description: Attributes for configuring HTTP Basic authentication scheme for SCIM provisioning to an application. + properties: + password: + description: Password used to authenticate with the remote SCIM service. + type: string + x-sensitive: true + scheme: + description: The authentication scheme to use when making SCIM requests to this application. + enum: + - httpbasic + type: string + user: + description: User name used to authenticate with the remote SCIM service. + type: string + token: + description: Token used to authenticate with the remote SCIM service. + type: string + x-sensitive: true + authorization_url: + description: URL used to generate the auth code used during token generation. + type: string + client_id: + description: Client ID used to authenticate when generating a token for authenticating with the remote SCIM service. + type: string + client_secret: + description: Secret used to authenticate when generating a token for authenticating with the remove SCIM service. + type: string + x-sensitive: true + scopes: + description: The authorization scopes to request when generating the token used to authenticate with the remove SCIM service. + items: + type: string + type: array + token_url: + description: URL used to generate the token used to authenticate with the remote SCIM service. + type: string + required: + - scheme + accessScimGroupsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessGroups' + type: array + required: + - success + - errors + - messages + accessScimUpdateLogsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessResponses' + type: array + required: + - success + - errors + - messages + accessScimUsersResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessUsers' + type: array + required: + - success + - errors + - messages + accessSeat: + properties: + access_seat: + $ref: '#/components/schemas/accessAccessSeat' + gateway_seat: + $ref: '#/components/schemas/accessGatewaySeat' + seat_uid: + $ref: '#/components/schemas/accessSeatUid' + required: + - seat_uid + - gateway_seat + - access_seat + type: object + accessSeatUid: + description: The unique API identifier for the Zero Trust seat. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + accessSeats: + properties: + access_seat: + $ref: '#/components/schemas/accessAccessSeat' + created_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + gateway_seat: + $ref: '#/components/schemas/accessGatewaySeat' + seat_uid: + $ref: '#/components/schemas/accessSeatUid' + updated_at: + $ref: '#/components/schemas/accessTimestamp' + readOnly: true + type: object + accessSeatsComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessSeats' + type: array + required: + - success + - errors + - messages + accessSeatsDefinition: + items: + $ref: '#/components/schemas/accessSeat' + type: array + accessSelfHostedDomains: + default: [] + deprecated: true + description: List of public domains that Access will secure. This field is deprecated in favor of `destinations` and will be supported until **November 21, 2025.** If `destinations` are provided, then `self_hosted_domains` will be ignored. + example: + - test.example.com/admin + - test.anotherexample.com/staff + items: + description: A domain that Access will secure. + type: string + type: array + accessServiceAuth401Redirect: + description: Returns a 401 status code when the request is blocked by a Service Auth policy. + example: true + type: boolean + accessServiceTokens: + properties: + client_id: + $ref: '#/components/schemas/accessClientId' + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + duration: + $ref: '#/components/schemas/accessDuration' + expires_at: + $ref: '#/components/schemas/accessTimestamp' + id: + description: The ID of the service token. + $ref: '#/components/schemas/accessUuid' + last_seen_at: + x-stainless-skip: true + $ref: '#/components/schemas/accessTimestamp' + name: + $ref: '#/components/schemas/accessSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + type: object + accessSessionDuration: + description: "The amount of time that tokens issued for applications will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or \xB5s), ms, s, m, h." + example: 24h + type: string + accessSettings: + properties: + china_network: + description: Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled. + example: false + type: boolean + x-auditable: true + client_certificate_forwarding: + description: Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin. + example: true + type: boolean + x-auditable: true + hostname: + description: The hostname that these settings apply to. + example: admin.example.com + type: string + x-auditable: true + required: + - hostname + - china_network + - client_certificate_forwarding + title: Hostname Settings + type: object + accessSince: + description: the timestamp of the earliest update log. + example: '2025-01-01T00:00:00Z' + format: date-time + type: string + accessSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessOrganizations' + required: + - success + - errors + - messages + accessSingleResponseUpdate: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessAppSettingsResponse' + required: + - success + - errors + - messages + accessSingleResponseWithoutHtml: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessCustomPageWithoutHtml' + required: + - success + - errors + - messages + accessSingleUserResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessSchemasUsers' + required: + - success + - errors + - messages + accessSkipAppLauncherLoginPage: + default: false + description: Determines when to skip the App Launcher landing page. + example: true + type: boolean + accessSkipInterstitial: + description: Enables automatic authentication through cloudflared. + example: true + type: boolean + accessStatus: + description: The status of the policy test request. + enum: + - success + example: success + type: string + x-auditable: true + accessStringKeyMapDeviceSession: + type: object + accessTag: + description: A tag + properties: + app_count: + description: The number of applications that have this tag + example: 1 + type: integer + x-auditable: true + x-stainless-skip: true + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + name: + $ref: '#/components/schemas/accessTagsComponentsSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + required: + - name + type: object + accessTagWithoutAppCount: + description: A tag + properties: + created_at: + $ref: '#/components/schemas/accessCreatedAt' + readOnly: true + name: + $ref: '#/components/schemas/accessTagsComponentsSchemasName' + updated_at: + $ref: '#/components/schemas/accessUpdatedAt' + readOnly: true + required: + - name + type: object + accessTags: + default: [] + description: The tags you want assigned to an application. Tags are used to filter applications in the App Launcher dashboard. + items: + description: The tag associated with an application. + example: engineers + type: string + type: array + x-stainless-collection-type: set + accessTagsComponentsSchemasName: + description: The name of the tag + example: engineers + type: string + accessTagsComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessTag' + type: array + required: + - success + - errors + - messages + accessTagsComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/accessTag' + required: + - success + - errors + - messages + accessTargetAttributes: + description: Contains a map of target attribute keys to target attribute values. + example: + hostname: + - test-server + - production-server + type: object + accessTargetCriteriaInfraApp: + properties: + port: + $ref: '#/components/schemas/accessPort' + target_attributes: + $ref: '#/components/schemas/accessTargetAttributes' + protocol: + $ref: '#/components/schemas/accessProtocolInfraApp' + required: + - target_attributes + - port + - protocol + title: Target Criteria + type: object + accessTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + accessTitle: + default: Welcome! + description: The title shown on the landing page. + example: Welcome back! + type: string + accessTotalUsers: + description: The total number of users in the user base. + example: 20 + type: integer + x-auditable: true + accessType: + description: The application type. + enum: + - self_hosted + - saas + - ssh + - vnc + - app_launcher + - warp + - biso + - bookmark + - dash_sso + - infrastructure + - rdp + - mcp + - mcp_portal + - proxy_endpoint + example: self_hosted + type: string + accessUiReadOnlyToggleReason: + description: A description of the reason why the UI read only field is being toggled. + example: Temporarily turn off the UI read only lock to make a change via the UI + type: string + x-stainless-terraform-configurability: computed_optional + accessUid: + description: The unique API identifier for the user. + type: string + accessUntil: + description: the timestamp of the most-recent update log. + example: '2025-01-02T00:00:00Z' + format: date-time + type: string + accessUpdateStatus: + description: The status of the policy test. + enum: + - blocked + - processing + - exceeded time + - complete + example: complete + type: string + x-auditable: true + accessUpdatedAt: + x-stainless-skip: true + $ref: '#/components/schemas/accessTimestamp' + accessUseClientlessIsolationAppLauncherUrl: + default: false + description: Determines if users can access this application via a clientless browser isolation URL. This allows users to access private domains without connecting to Gateway. The option requires Clientless Browser Isolation to be set up with policies that allow users of this application. + example: false + type: boolean + accessUserId: + description: The UUID of the authenticating user. + example: f757c5c3-c1b2-50f7-9126-150a099b6f7e + format: uuid + type: string + accessUserResult: + description: Policy evaluation result for an individual user. + enum: + - approved + - blocked + - error + example: approved + type: string + x-auditable: true + accessUserSeatExpirationInactiveTime: + description: "The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Minimum value for this setting is 1 month (730h). Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `\xB5s`), `ms`, `s`, `m`, `h`." + example: 730h + type: string + x-auditable: true + accessUsername: + description: The username of the SCIM User resource. + example: John Smith + type: string + accessUsers: + properties: + active: + description: Determines the status of the SCIM User resource. + example: true + type: boolean + displayName: + description: The name of the SCIM User resource. + example: John Smith + type: string + emails: + items: + properties: + primary: + description: Indicates if the email address is the primary email belonging to the SCIM User resource. + example: true + type: boolean + type: + description: Indicates the type of the email address. + example: work + type: string + value: + description: The email address of the SCIM User resource. + example: john.smith@example.com + format: email + type: string + type: object + type: array + externalId: + description: The IdP-generated Id of the SCIM resource. + example: john_smith + type: string + id: + $ref: '#/components/schemas/accessId' + meta: + $ref: '#/components/schemas/accessMeta' + schemas: + description: The list of URIs which indicate the attributes contained within a SCIM resource. + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + type: array + type: object + accessUsersApproved: + description: The number of (processed) users approved based on policy evaluation results. + example: 5 + type: integer + x-auditable: true + accessUsersBlocked: + description: The number of (processed) users blocked based on policy evaluation results. + example: 5 + type: integer + x-auditable: true + accessUsersCfResourceId: + description: The unique Cloudflare-generated Id of the SCIM User resource; also known as the "Id". + example: bd97ef8d-7986-43e3-9ee0-c25dda33e4b0 + type: string + accessUsersComponentsSchemasName: + description: The name of the user. + example: Jane Doe + type: string + accessUsersComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/accessMessages' + messages: + $ref: '#/components/schemas/accessMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 100 + type: number + total_count: + description: Total results available without any search parameters. + example: 1 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/accessSchemasUsers' + type: array + required: + - success + - errors + - messages + accessUsersErrored: + description: The number of (processed) users errored based on policy evaluation results. + example: 5 + type: integer + accessUsersIdpResourceId: + description: The IdP-generated Id of the SCIM User resource; also known as the "external Id". + example: john_smith_01 + type: string + accessUsersName: + description: The name of the SCIM User resource. + example: John Smith + type: string + accessUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + readOnly: true + accessWarpAuthSessionDuration: + description: 'The amount of time that tokens issued for applications will be valid. Must be in the format `30m` or `2h45m`. Valid time units are: m, h.' + example: 24h + type: string + x-auditable: true + alexandriaApplication: + properties: + application_confidence_score: + $ref: '#/components/schemas/alexandriaApplicationConfidenceScore' + application_score_composition: + $ref: '#/components/schemas/alexandriaApplicationScoreComposition' + application_source: + $ref: '#/components/schemas/alexandriaApplicationSource' + application_type: + $ref: '#/components/schemas/alexandriaApplicationType' + application_type_description: + $ref: '#/components/schemas/alexandriaApplicationTypeDescription' + created_at: + $ref: '#/components/schemas/alexandriaApplicationCreatedAt' + readOnly: true + gen_ai_score: + $ref: '#/components/schemas/alexandriaApplicationGenAiScore' + hostnames: + $ref: '#/components/schemas/alexandriaApplicationHostnames' + human_id: + $ref: '#/components/schemas/alexandriaApplicationHumanId' + id: + $ref: '#/components/schemas/alexandriaApplicationId' + intel_id: + $ref: '#/components/schemas/alexandriaApplicationIntelId' + ip_subnets: + $ref: '#/components/schemas/alexandriaApplicationIpSubnets' + name: + $ref: '#/components/schemas/alexandriaApplicationName' + port_protocols: + $ref: '#/components/schemas/alexandriaApplicationPortProtocols' + support_domains: + $ref: '#/components/schemas/alexandriaApplicationSupportDomains' + updated_at: + $ref: '#/components/schemas/alexandriaApplicationUpdatedAt' + readOnly: true + version: + $ref: '#/components/schemas/alexandriaApplicationVersion' + required: + - application_source + - application_type + - application_type_description + - gen_ai_score + - application_confidence_score + - created_at + - hostnames + - human_id + - id + - ip_subnets + - name + - port_protocols + - support_domains + - updated_at + - version + type: object + alexandriaApplicationConfidenceScore: + description: Confidence score for the application. Returns -1 when no score is available. + example: 0.92 + format: float + type: number + alexandriaApplicationCreatedAt: + description: Returns the application creation time. + example: '2025-01-01T00:00:00Z' + type: string + alexandriaApplicationGenAiScore: + description: GenAI score for the application. Returns -1 when no score is available. + example: 1.5 + format: float + type: number + alexandriaApplicationHostnames: + description: Returns the list of hostnames for the application. + example: + - example.com + - foo.com + items: + type: string + type: array + alexandriaApplicationHumanId: + description: Returns the human readable ID. + example: HR + type: string + alexandriaApplicationId: + description: Returns the application ID. + example: 12345678-1234-1234-1234-123456789012 + type: string + alexandriaApplicationIntelId: + description: Returns the Intel API ID for the application. + example: 498 + format: int64 + nullable: true + type: integer + alexandriaApplicationIpSubnets: + description: Returns the list of IP subnets for the application. + example: + - 192.168.1.0/24 + - 10.0.0.0/8 + items: + type: string + type: array + alexandriaApplicationName: + description: Returns the application name. + example: HR + type: string + alexandriaApplicationPortProtocols: + description: Returns the list of port protocols for the application. + example: + - tcp/80 + - tcp/443 + items: + type: string + type: array + alexandriaApplicationScoreComposition: + description: Returns the score composition breakdown for the application. + example: + categories: + - confidence: 0.95 + name: Security + plan: free + nullable: true + type: object + alexandriaApplicationSource: + description: Returns the application source. + example: cloudflare + type: string + alexandriaApplicationSupportDomains: + description: Returns the list of support domains for the application. + example: + - example.com + - foo.com + items: + type: string + type: array + alexandriaApplicationType: + description: Returns the application type. + example: Human Resources + type: string + alexandriaApplicationTypeDescription: + description: Returns the application type description. + example: Applications used to manage employees and workforce tools. + type: string + alexandriaApplicationUpdatedAt: + description: Returns the application update time. + example: '2025-01-01T00:00:00Z' + type: string + alexandriaApplicationVersion: + description: Returns the application version. + example: '2025-01-01T00:00:00Z' + type: string + alexandriaApplications: + description: Returns the list of applications. + items: + $ref: '#/components/schemas/alexandriaApplication' + type: array + alexandriaCategories: + description: Returns the list of categories. + items: + $ref: '#/components/schemas/alexandriaCategory' + type: array + alexandriaCategory: + properties: + created_at: + $ref: '#/components/schemas/alexandriaCategoryCreatedAt' + readOnly: true + description: + $ref: '#/components/schemas/alexandriaCategoryDescription' + id: + $ref: '#/components/schemas/alexandriaCategoryId' + name: + $ref: '#/components/schemas/alexandriaCategoryName' + required: + - created_at + - description + - id + - name + type: object + alexandriaCategoryCreatedAt: + description: Returns the category creation time. + example: '2025-01-01T00:00:00Z' + type: string + alexandriaCategoryDescription: + description: Returns the category description. + example: Category description + type: string + alexandriaCategoryId: + description: Returns the category ID. + example: 12345678-1234-1234-1234-123456789012 + type: string + alexandriaCategoryName: + description: Returns the category name. + example: Category name + type: string + alexandriaGetApplicationResponse: + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/alexandriaApplication' + required: + - success + - errors + - messages + type: object + alexandriaGetApplicationsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Returns the total number of results for the requested service. + example: 1 + type: number + page: + description: Returns the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Returns the number of results per page of results. + example: 20 + type: number + total_count: + description: Returns the total results available without any search parameters. + example: 2000 + type: number + type: object + result: + $ref: '#/components/schemas/alexandriaApplications' + required: + - success + - errors + - messages + alexandriaGetCategoriesResponse: + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/alexandriaCategories' + required: + - success + - errors + - messages + type: object + alexandriaGetCategoryResponse: + properties: + errors: + $ref: '#/components/schemas/alexandriaMessages' + messages: + $ref: '#/components/schemas/alexandriaMessages' + success: + description: Indicates whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/alexandriaCategory' + required: + - success + - errors + - messages + type: object + alexandriaMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + digitalExperienceMonitoringAggregateStat: + properties: + avgMs: + nullable: true + type: integer + deltaPct: + format: float + nullable: true + type: number + timePeriod: + $ref: '#/components/schemas/digitalExperienceMonitoringAggregateTimePeriod' + required: + - timePeriod + type: object + digitalExperienceMonitoringAggregateTimePeriod: + properties: + units: + enum: + - hours + - days + - testRuns + type: string + value: + type: integer + required: + - value + - units + type: object + digitalExperienceMonitoringAggregateTimeSlot: + properties: + avgMs: + type: integer + timestamp: + type: string + required: + - timestamp + - avgMs + type: object + digitalExperienceMonitoringApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + example: [] + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + digitalExperienceMonitoringColo: + description: Cloudflare colo + example: SJC + type: string + digitalExperienceMonitoringColosResponse: + description: array of colos. + items: + properties: + airportCode: + description: Airport code + example: SFO + type: string + city: + description: City + example: San Francisco + type: string + countryCode: + description: Country code + example: US + type: string + required: + - airportCode + - countryCode + - city + type: object + type: array + digitalExperienceMonitoringCommandId: + description: Unique identifier for a command + example: 5758fefe-ae7e-4538-a39b-1fef6abcb909 + type: string + digitalExperienceMonitoringCommandsDevicesResponse: + properties: + devices: + description: List of eligible devices + items: + properties: + deviceId: + description: Device identifier (UUID v4) + type: string + deviceName: + description: Device identifier (human readable) + type: string + eligible: + description: Whether the device is eligible for remote captures + type: boolean + ineligibleReason: + description: If the device is not eligible, the reason why. + type: string + personEmail: + description: User contact email address + type: string + platform: + $ref: '#/components/schemas/digitalExperienceMonitoringPlatform' + registrationId: + description: Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user's registration on the device. + type: string + status: + $ref: '#/components/schemas/digitalExperienceMonitoringStatus' + timestamp: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + version: + $ref: '#/components/schemas/digitalExperienceMonitoringVersion' + type: object + type: array + type: object + digitalExperienceMonitoringCpuPctByApp: + items: + properties: + cpu_pct: + format: float + type: number + name: + type: string + type: object + type: array + digitalExperienceMonitoringCreateRuleBody: + properties: + description: + type: string + x-auditable: true + match: + description: The wirefilter expression to match. + type: string + name: + description: The name of the Rule. + type: string + x-auditable: true + required: + - name + - match + type: object + digitalExperienceMonitoringDevice: + properties: + alwaysOn: + nullable: true + type: boolean + batteryCharging: + nullable: true + type: boolean + batteryCycles: + format: int64 + nullable: true + type: integer + batteryPct: + format: float + nullable: true + type: number + colo: + $ref: '#/components/schemas/digitalExperienceMonitoringColo' + connectionType: + nullable: true + type: string + cpuPct: + format: float + nullable: true + type: number + cpuPctByApp: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringCpuPctByApp' + nullable: true + type: array + deviceId: + description: Device identifier (UUID v4) + type: string + deviceIpv4: + $ref: '#/components/schemas/digitalExperienceMonitoringIpInfo' + deviceIpv6: + $ref: '#/components/schemas/digitalExperienceMonitoringIpInfo' + deviceName: + description: Device identifier (human readable) + type: string + diskReadBps: + format: int64 + nullable: true + type: integer + diskUsagePct: + format: float + nullable: true + type: number + diskWriteBps: + format: int64 + nullable: true + type: integer + dohSubdomain: + nullable: true + type: string + estimatedLossPct: + format: float + nullable: true + type: number + firewallEnabled: + nullable: true + type: boolean + gatewayIpv4: + $ref: '#/components/schemas/digitalExperienceMonitoringIpInfo' + gatewayIpv6: + $ref: '#/components/schemas/digitalExperienceMonitoringIpInfo' + handshakeLatencyMs: + format: int64 + nullable: true + type: number + ispIpv4: + $ref: '#/components/schemas/digitalExperienceMonitoringIpInfo' + ispIpv6: + $ref: '#/components/schemas/digitalExperienceMonitoringIpInfo' + metal: + nullable: true + type: string + mode: + $ref: '#/components/schemas/digitalExperienceMonitoringMode' + networkRcvdBps: + format: int64 + nullable: true + type: integer + networkSentBps: + format: int64 + nullable: true + type: integer + networkSsid: + nullable: true + type: string + personEmail: + $ref: '#/components/schemas/digitalExperienceMonitoringPersonEmail' + platform: + $ref: '#/components/schemas/digitalExperienceMonitoringPlatform' + ramAvailableKb: + format: int64 + nullable: true + type: integer + ramUsedPct: + format: float + nullable: true + type: number + ramUsedPctByApp: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringRamUsedPctByApp' + nullable: true + type: array + registrationId: + description: Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user's registration on the device. + nullable: true + type: string + status: + $ref: '#/components/schemas/digitalExperienceMonitoringStatus' + switchLocked: + nullable: true + type: boolean + timestamp: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + version: + $ref: '#/components/schemas/digitalExperienceMonitoringVersion' + wifiStrengthDbm: + format: int64 + nullable: true + type: integer + required: + - colo + - deviceId + - mode + - platform + - status + - timestamp + - version + type: object + digitalExperienceMonitoringDeviceDexTestSchemasData: + description: The configuration object which contains the details for the WARP client to conduct the test. + example: + host: https://dash.cloudflare.com + kind: http + method: GET + properties: + host: + description: The desired endpoint to test. + example: https://dash.cloudflare.com + type: string + x-auditable: true + kind: + description: The type of test. + enum: + - http + - traceroute + example: http + type: string + x-auditable: true + method: + description: The HTTP request method type. + enum: + - GET + example: GET + type: string + x-auditable: true + required: + - kind + - host + type: object + digitalExperienceMonitoringDeviceDexTestSchemasDescription: + description: Additional details about the test. + example: Checks the dash endpoint every 30 minutes + type: string + digitalExperienceMonitoringDeviceDexTestSchemasEnabled: + description: Determines whether or not the test is active. + example: true + type: boolean + digitalExperienceMonitoringDeviceDexTestSchemasHttp: + properties: + data: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasData' + description: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasDescription' + enabled: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasEnabled' + interval: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasInterval' + name: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasName' + target_policies: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestTargetPolicies' + targeted: + type: boolean + x-stainless-terraform-configurability: computed + test_id: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasTestId' + required: + - name + - interval + - enabled + - data + type: object + digitalExperienceMonitoringDeviceDexTestSchemasInterval: + description: How often the test will run. + example: 30m + type: string + digitalExperienceMonitoringDeviceDexTestSchemasName: + description: The name of the DEX test. Must be unique. + example: HTTP dash health check + type: string + digitalExperienceMonitoringDeviceDexTestTargetPolicies: + description: DEX rules targeted by this test + items: + $ref: '#/components/schemas/digitalExperienceMonitoringDexTargetPolicy' + type: array + digitalExperienceMonitoringDeviceId: + description: Device-specific ID, given as UUID v4 + example: cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7 + type: string + digitalExperienceMonitoringDexDeleteResponseCollection: + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + dex_tests: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasHttp' + type: array + type: object + required: + - success + - errors + - messages + type: object + digitalExperienceMonitoringDexResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasHttp' + nullable: true + type: array + required: + - success + - errors + - messages + digitalExperienceMonitoringDexRule: + properties: + created_at: + example: '2023-07-16 15:00:00+00' + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + readOnly: true + description: + type: string + id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + match: + type: string + name: + type: string + x-auditable: true + targeted_tests: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringDexTargetedTest' + type: array + x-auditable: true + x-stainless-terraform-configurability: computed + updated_at: + example: '2023-07-16 15:00:00+00' + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + readOnly: true + required: + - id + - name + - match + - created_at + type: object + digitalExperienceMonitoringDexSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasHttp' + required: + - success + - errors + - messages + digitalExperienceMonitoringDexTargetPolicy: + properties: + default: + description: Whether the DEX rule is the account default + type: boolean + x-stainless-terraform-configurability: computed + id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + name: + description: The name of the DEX rule + type: string + x-stainless-terraform-configurability: computed + required: + - id + type: object + digitalExperienceMonitoringDexTargetedTest: + properties: + data: + $ref: '#/components/schemas/digitalExperienceMonitoringDeviceDexTestSchemasData' + enabled: + type: boolean + x-auditable: true + name: + type: string + x-auditable: true + test_id: + type: string + x-auditable: true + required: + - test_id + - name + - enabled + - data + type: object + digitalExperienceMonitoringFleetStatusDevicesResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringDevice' + type: array + required: + - success + - errors + - messages + digitalExperienceMonitoringFleetStatusLiveResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + deviceStats: + properties: + byColo: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringLiveStat' + nullable: true + type: array + byMode: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringLiveStat' + nullable: true + type: array + byPlatform: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringLiveStat' + nullable: true + type: array + byStatus: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringLiveStat' + nullable: true + type: array + byVersion: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringLiveStat' + nullable: true + type: array + uniqueDevicesTotal: + $ref: '#/components/schemas/digitalExperienceMonitoringUniqueDevicesTotal' + type: object + type: object + required: + - success + - errors + - messages + digitalExperienceMonitoringFleetStatusOverTimeResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + messages: + $ref: '#/components/schemas/digitalExperienceMonitoringMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: The number of total pages in the entire result set. + example: 100 + type: number + type: object + result: + properties: + deviceStats: + properties: + byMode: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasAggregateStat' + type: array + byStatus: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringSchemasAggregateStat' + type: array + uniqueDevicesTotal: + $ref: '#/components/schemas/digitalExperienceMonitoringUniqueDevicesTotal' + type: object + type: object + required: + - success + - errors + - messages + digitalExperienceMonitoringGetCommandsQuotaResponse: + properties: + quota: + description: The remaining number of commands that can be initiated for an account + type: number + quota_usage: + description: The number of commands that have been initiated for an account + type: number + reset_time: + description: The time when the quota resets + format: date-time + type: string + required: + - quota_usage + - quota + - reset_time + type: object + digitalExperienceMonitoringGetCommandsResponse: + properties: + commands: + items: + properties: + completed_date: + format: date-time + nullable: true + type: string + created_date: + format: date-time + type: string + device_id: + type: string + filename: + nullable: true + type: string + id: + type: string + registration_id: + description: Unique identifier for the device registration + type: string + status: + type: string + type: + type: string + user_email: + type: string + type: object + type: array + type: object + digitalExperienceMonitoringHttpDetailsPercentilesResponse: + properties: + dnsResponseTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringPercentiles' + resourceFetchTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringPercentiles' + serverResponseTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringPercentiles' + type: object + digitalExperienceMonitoringHttpDetailsResponse: + properties: + host: + description: The url of the HTTP synthetic application test + example: http://example.com + type: string + httpStats: + nullable: true + properties: + availabilityPct: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatPctOverTime' + dnsResponseTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + httpStatusCode: + items: + properties: + status200: + type: integer + status300: + type: integer + status400: + type: integer + status500: + type: integer + timestamp: + example: '2023-07-16 15:00:00+00' + type: string + required: + - timestamp + - status200 + - status300 + - status400 + - status500 + type: object + type: array + resourceFetchTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + serverResponseTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + uniqueDevicesTotal: + description: Count of unique devices that have run this test in the given time period + example: 57 + type: integer + required: + - uniqueDevicesTotal + - resourceFetchTimeMs + - serverResponseTimeMs + - dnsResponseTimeMs + - httpStatusCode + - availabilityPct + type: object + httpStatsByColo: + items: + properties: + availabilityPct: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatPctOverTime' + colo: + example: DFW + type: string + dnsResponseTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + httpStatusCode: + items: + properties: + status200: + type: integer + status300: + type: integer + status400: + type: integer + status500: + type: integer + timestamp: + example: '2023-07-16 15:00:00+00' + type: string + required: + - timestamp + - status200 + - status300 + - status400 + - status500 + type: object + type: array + resourceFetchTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + serverResponseTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + uniqueDevicesTotal: + description: Count of unique devices that have run this test in the given time period + example: 57 + type: integer + required: + - colo + - uniqueDevicesTotal + - resourceFetchTimeMs + - serverResponseTimeMs + - dnsResponseTimeMs + - httpStatusCode + - availabilityPct + type: object + type: array + interval: + description: The interval at which the HTTP synthetic application test is set to run. + example: 0h5m0s + type: string + kind: + enum: + - http + type: string + method: + description: The HTTP method to use when running the test + example: GET + type: string + name: + description: The name of the HTTP synthetic application test + example: Atlassian Sign In Page + type: string + target_policies: + items: + $ref: '#/components/schemas/unnamedSchemaRefBf9e2abcf1b78a6cab8e6e29e2228a11' + nullable: true + type: array + targeted: + type: boolean + type: object + digitalExperienceMonitoringIpInfo: + properties: + address: + nullable: true + type: string + asn: + nullable: true + type: integer + aso: + nullable: true + type: string + location: + properties: + city: + nullable: true + type: string + country_iso: + nullable: true + type: string + state_iso: + nullable: true + type: string + zip: + nullable: true + type: string + type: object + netmask: + nullable: true + type: string + version: + nullable: true + type: string + type: object + digitalExperienceMonitoringListRulesResponse: + properties: + rules: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringDexRule' + type: array + type: object + digitalExperienceMonitoringLiveStat: + properties: + uniqueDevicesTotal: + $ref: '#/components/schemas/digitalExperienceMonitoringUniqueDevicesTotal' + value: + type: string + type: object + digitalExperienceMonitoringMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + digitalExperienceMonitoringMode: + description: The mode under which the WARP client is run + example: proxy + type: string + digitalExperienceMonitoringPage: + default: 1 + description: Page number of paginated results + example: 1 + minimum: 1 + type: number + digitalExperienceMonitoringPatchRuleBody: + properties: + description: + type: string + x-auditable: true + match: + description: The wirefilter expression to match. + type: string + name: + description: The name of the Rule. + type: string + x-auditable: true + type: object + digitalExperienceMonitoringPerPage: + description: Number of items per page + example: 10 + maximum: 50 + minimum: 1 + type: number + digitalExperienceMonitoringPercentiles: + properties: + p50: + description: p50 observed in the time period + nullable: true + type: number + p90: + description: p90 observed in the time period + nullable: true + type: number + p95: + description: p95 observed in the time period + nullable: true + type: number + p99: + description: p99 observed in the time period + nullable: true + type: number + type: object + digitalExperienceMonitoringPersonEmail: + description: User contact email address + type: string + digitalExperienceMonitoringPlatform: + description: Operating system + example: windows + type: string + digitalExperienceMonitoringPostCommandsResponse: + properties: + commands: + description: List of created commands + items: + properties: + args: + description: Command arguments + type: object + device_id: + description: Identifier for the device associated with the command + type: string + id: + description: Unique identifier for the command + type: string + registration_id: + description: Unique identifier for the device registration + type: string + status: + description: Current status of the command + enum: + - PENDING_EXEC + - PENDING_UPLOAD + - SUCCESS + - FAILED + type: string + type: + description: Type of the command (e.g., "pcap" or "warp-diag") + type: string + type: object + type: array + type: object + digitalExperienceMonitoringRamUsedPctByApp: + items: + properties: + name: + type: string + ram_used_pct: + format: float + type: number + type: object + type: array + digitalExperienceMonitoringSchemasAggregateStat: + properties: + timestamp: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + uniqueDevicesTotal: + $ref: '#/components/schemas/digitalExperienceMonitoringUniqueDevicesTotal' + value: + type: string + type: object + digitalExperienceMonitoringSchemasTestId: + description: The unique identifier for the test. + example: 372e67954025e0ba6aaa6d586b9e0b59 + maxLength: 32 + readOnly: true + type: string + digitalExperienceMonitoringSinceMinutes: + default: 10 + description: Number of minutes before current time + example: 10 + maximum: 60 + minimum: 1 + type: number + digitalExperienceMonitoringSortBy: + default: timestamp + description: Dimension to sort results by + enum: + - colo + - device_id + - mode + - platform + - status + - timestamp + - version + type: string + digitalExperienceMonitoringSource: + default: last_seen + description: Specifies fleet status details source + enum: + - last_seen + - hourly + - raw + example: last_seen + type: string + digitalExperienceMonitoringStatus: + description: Network status + example: connected + type: string + digitalExperienceMonitoringTestStatOverTime: + properties: + avg: + description: average observed in the time period + nullable: true + type: integer + max: + description: highest observed in the time period + nullable: true + type: integer + min: + description: lowest observed in the time period + nullable: true + type: integer + slots: + items: + properties: + timestamp: + example: '2023-07-16 15:00:00+00' + type: string + value: + type: integer + required: + - timestamp + - value + type: object + type: array + required: + - slots + type: object + digitalExperienceMonitoringTestStatPctOverTime: + properties: + avg: + description: average observed in the time period + format: float + nullable: true + type: number + max: + description: highest observed in the time period + format: float + nullable: true + type: number + min: + description: lowest observed in the time period + format: float + nullable: true + type: number + slots: + items: + properties: + timestamp: + example: '2023-07-16 15:00:00+00' + type: string + value: + format: float + type: number + required: + - timestamp + - value + type: object + type: array + required: + - slots + type: object + digitalExperienceMonitoringTestsResponse: + properties: + overviewMetrics: + properties: + avgHttpAvailabilityPct: + description: percentage availability for all HTTP test results in response + format: float + nullable: true + type: number + avgTracerouteAvailabilityPct: + description: percentage availability for all traceroutes results in response + format: float + nullable: true + type: number + testsTotal: + description: number of tests. + type: integer + required: + - testsTotal + type: object + tests: + description: array of test results objects. + items: + properties: + created: + description: date the test was created. + type: string + description: + description: the test description defined during configuration + type: string + enabled: + description: if true, then the test will run on targeted devices. Else, the test will not run. + type: boolean + host: + type: string + httpResults: + nullable: true + properties: + resourceFetchTime: + $ref: '#/components/schemas/digitalExperienceMonitoringTimingAggregates' + required: + - resourceFetchTime + type: object + httpResultsByColo: + items: + properties: + colo: + description: Cloudflare colo + example: SJC + type: string + resourceFetchTime: + $ref: '#/components/schemas/digitalExperienceMonitoringTimingAggregates' + required: + - colo + - resourceFetchTime + type: object + type: array + id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + interval: + description: The interval at which the synthetic application test is set to run. + type: string + kind: + description: test type, http or traceroute + enum: + - http + - traceroute + type: string + method: + description: for HTTP, the method to use when running the test + type: string + name: + description: name given to this test + type: string + target_policies: + items: + $ref: '#/components/schemas/unnamedSchemaRefBf9e2abcf1b78a6cab8e6e29e2228a11' + nullable: true + type: array + targeted: + type: boolean + tracerouteResults: + nullable: true + properties: + roundTripTime: + $ref: '#/components/schemas/digitalExperienceMonitoringTimingAggregates' + required: + - roundTripTime + type: object + tracerouteResultsByColo: + items: + properties: + colo: + description: Cloudflare colo + example: SJC + type: string + roundTripTime: + $ref: '#/components/schemas/digitalExperienceMonitoringTimingAggregates' + required: + - colo + - roundTripTime + type: object + type: array + updated: + type: string + required: + - id + - name + - kind + - interval + - enabled + - description + - updated + - created + - host + type: object + type: array + required: + - overviewMetrics + - tests + type: object + digitalExperienceMonitoringTimeNow: + description: Current time in ISO format + example: '2023-10-11T00:00:00Z' + type: string + digitalExperienceMonitoringTimestamp: + description: Timestamp in ISO format + example: '2023-10-11T00:00:00Z' + type: string + digitalExperienceMonitoringTimingAggregates: + properties: + avgMs: + nullable: true + type: integer + history: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringAggregateStat' + type: array + overTime: + nullable: true + properties: + timePeriod: + $ref: '#/components/schemas/digitalExperienceMonitoringAggregateTimePeriod' + values: + items: + $ref: '#/components/schemas/digitalExperienceMonitoringAggregateTimeSlot' + type: array + required: + - values + - timePeriod + type: object + required: + - history + type: object + digitalExperienceMonitoringTracerouteDetailsPercentilesResponse: + properties: + hopsCount: + $ref: '#/components/schemas/digitalExperienceMonitoringPercentiles' + packetLossPct: + $ref: '#/components/schemas/digitalExperienceMonitoringPercentiles' + roundTripTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringPercentiles' + type: object + digitalExperienceMonitoringTracerouteDetailsResponse: + properties: + host: + description: The host of the Traceroute synthetic application test + example: 1.1.1.1 + type: string + interval: + description: The interval at which the Traceroute synthetic application test is set to run. + example: 0h5m0s + type: string + kind: + enum: + - traceroute + type: string + name: + description: The name of the Traceroute synthetic application test + example: Atlassian Sign In Page + type: string + target_policies: + items: + $ref: '#/components/schemas/unnamedSchemaRefBf9e2abcf1b78a6cab8e6e29e2228a11' + nullable: true + type: array + targeted: + type: boolean + tracerouteStats: + nullable: true + properties: + availabilityPct: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatPctOverTime' + hopsCount: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + packetLossPct: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatPctOverTime' + roundTripTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + uniqueDevicesTotal: + description: Count of unique devices that have run this test in the given time period + example: 57 + type: integer + required: + - uniqueDevicesTotal + - roundTripTimeMs + - hopsCount + - packetLossPct + - availabilityPct + type: object + tracerouteStatsByColo: + items: + properties: + availabilityPct: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatPctOverTime' + colo: + example: DFW + type: string + hopsCount: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + packetLossPct: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatPctOverTime' + roundTripTimeMs: + $ref: '#/components/schemas/digitalExperienceMonitoringTestStatOverTime' + uniqueDevicesTotal: + description: Count of unique devices that have run this test in the given time period + example: 57 + type: integer + required: + - colo + - uniqueDevicesTotal + - roundTripTimeMs + - hopsCount + - packetLossPct + - availabilityPct + type: object + type: array + required: + - kind + - name + - host + - interval + type: object + digitalExperienceMonitoringTracerouteTestNetworkPathResponse: + properties: + deviceName: + type: string + id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + interval: + description: The interval at which the Traceroute synthetic application test is set to run. + example: 0h5m0s + type: string + kind: + enum: + - traceroute + type: string + name: + type: string + networkPath: + nullable: true + properties: + sampling: + description: Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval. + nullable: true + properties: + unit: + enum: + - hours + type: string + value: + type: integer + required: + - value + - unit + type: object + slots: + items: + properties: + clientToAppRttMs: + description: Round trip time in ms of the client to app mile + nullable: true + type: integer + clientToCfEgressRttMs: + description: Round trip time in ms of the client to Cloudflare egress mile + nullable: true + type: integer + clientToCfIngressRttMs: + description: Round trip time in ms of the client to Cloudflare ingress mile + nullable: true + type: integer + clientToIspRttMs: + description: Round trip time in ms of the client to ISP mile + nullable: true + type: integer + id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + timestamp: + example: '2023-07-16 15:00:00+00' + type: string + required: + - id + - timestamp + - clientToAppRttMs + - clientToCfIngressRttMs + - clientToCfEgressRttMs + type: object + type: array + required: + - slots + type: object + url: + description: The host of the Traceroute synthetic application test + example: 1.1.1.1 + type: string + required: + - id + type: object + digitalExperienceMonitoringTracerouteTestResultNetworkPathResponse: + properties: + deviceName: + description: name of the device associated with this network path response + type: string + hops: + description: an array of the hops taken by the device to reach the end destination + items: + properties: + asn: + nullable: true + type: integer + aso: + nullable: true + type: string + ipAddress: + nullable: true + type: string + location: + nullable: true + properties: + city: + nullable: true + type: string + state: + nullable: true + type: string + zip: + nullable: true + type: string + type: object + mile: + enum: + - client-to-app + - client-to-cf-egress + - client-to-cf-ingress + - client-to-isp + nullable: true + type: string + name: + nullable: true + type: string + packetLossPct: + format: float + nullable: true + type: number + rttMs: + nullable: true + type: integer + ttl: + type: integer + required: + - ttl + type: object + type: array + resultId: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + testId: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + testName: + description: name of the tracroute test + type: string + required: + - resultId + - hops + type: object + digitalExperienceMonitoringUniqueDevicesResponse: + properties: + uniqueDevicesTotal: + description: total number of unique devices + type: integer + required: + - uniqueDevicesTotal + type: object + digitalExperienceMonitoringUniqueDevicesTotal: + description: Number of unique devices + type: number + digitalExperienceMonitoringUuid: + description: API Resource UUID tag. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + digitalExperienceMonitoringVersion: + description: WARP client version + example: 1.0.0 + type: string + digitalExperienceMonitoringWarpConfigDetails: + properties: + account_name: + description: The account name. + type: string + account_tag: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + config_name: + description: The name of the WARP configuration. + type: string + type: object + digitalExperienceMonitoringWarpEventsResponse: + items: + type: object + properties: + account_name: + description: The account name. + type: string + account_tag: + description: The public account identifier. + type: string + device_id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + device_registration: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + hostname: + description: The hostname of the machine the event is from + type: string + registration_id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + serial_number: + description: The serial number of the machine the event is from + type: string + timestamp: + $ref: '#/components/schemas/digitalExperienceMonitoringTimestamp' + toggle: + description: The state of the WARP toggle. + enum: + - 'on' + - 'off' + type: string + user_email: + description: Email tied to the device + type: string + from: + $ref: '#/components/schemas/digitalExperienceMonitoringWarpConfigDetails' + to: + $ref: '#/components/schemas/digitalExperienceMonitoringWarpConfigDetails' + type: array + dlpAddinAccountMapping: + properties: + addin_identifier_token: + format: uuid + type: string + auth_requirements: + $ref: '#/components/schemas/dlpAddinAuth' + required: + - auth_requirements + - addin_identifier_token + type: object + dlpAddinAuth: + type: object + properties: + allowed_microsoft_organizations: + items: + type: string + type: array + type: + enum: + - Org + type: string + required: + - type + dlpApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/dlpMessages' + messages: + example: [] + $ref: '#/components/schemas/dlpMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + dlpBehaviors: + properties: + behaviors: + type: object + required: + - behaviors + type: object + dlpConfidence: + enum: + - low + - medium + - high + - very_high + type: string + dlpContextAwareness: + deprecated: true + description: Scan the context of predefined entries to only return matches surrounded by keywords. + properties: + enabled: + description: If true, scan the context of predefined entries to only return matches surrounded by keywords. + type: boolean + skip: + $ref: '#/components/schemas/dlpSkipConfig' + required: + - enabled + - skip + type: object + dlpCreateEmailRule: + properties: + action: + $ref: '#/components/schemas/dlpEmailRuleAction' + conditions: + description: Triggered if all conditions match. + items: + $ref: '#/components/schemas/dlpEmailRuleCondition' + type: array + description: + nullable: true + type: string + enabled: + type: boolean + name: + type: string + required: + - name + - enabled + - conditions + - action + type: object + dlpCreateIntegrationBody: + properties: + integration_type: + $ref: '#/components/schemas/dlpRiskScoreIntegrationType' + reference_id: + description: A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider + nullable: true + type: string + tenant_url: + description: The base url of the tenant, e.g. "https://tenant.okta.com". + format: uri + type: string + required: + - integration_type + - tenant_url + type: object + dlpCustomEntry: + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + nullable: true + type: string + enabled: + deprecated: true + type: boolean + id: + format: uuid + type: string + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + profile_id: + deprecated: true + format: uuid + nullable: true + type: string + updated_at: + format: date-time + type: string + readOnly: true + required: + - id + - name + - created_at + - updated_at + - pattern + - enabled + type: object + dlpCustomEntryUpdate: + properties: + description: + nullable: true + type: string + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + enabled: + type: boolean + required: + - name + - pattern + - enabled + type: object + dlpCustomProfile: + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + default: 0 + description: Related DLP policies will trigger when the match count exceeds the number set. + example: 5 + format: int32 + maximum: 1000 + minimum: 0 + type: integer + confidence_threshold: + default: low + $ref: '#/components/schemas/dlpConfidence' + context_awareness: + $ref: '#/components/schemas/dlpContextAwareness' + created_at: + description: When the profile was created. + format: date-time + type: string + readOnly: true + data_classes: + description: Data classes associated with this profile. + items: + format: uuid + type: string + type: array + data_tags: + description: Data tags associated with this profile. + items: + format: uuid + type: string + type: array + description: + description: The description of the profile. + nullable: true + type: string + entries: + deprecated: true + items: + $ref: '#/components/schemas/dlpEntry' + type: array + x-stainless-skip: + - terraform + id: + description: The id of the profile (uuid). + format: uuid + type: string + name: + description: The name of the profile. + type: string + x-auditable: true + ocr_enabled: + default: false + type: boolean + sensitivity_levels: + description: Sensitivity levels associated with this profile. + items: + $ref: '#/components/schemas/dlpSensitivityLevelRef' + type: array + shared_entries: + items: + $ref: '#/components/schemas/dlpEntry' + type: array + x-stainless-terraform-configurability: computed + updated_at: + description: When the profile was lasted updated. + format: date-time + type: string + readOnly: true + required: + - id + - name + - created_at + - updated_at + - allowed_match_count + - ocr_enabled + type: object + dlpCustomProfileArray: + items: + $ref: '#/components/schemas/dlpCustomProfile' + type: array + dlpCustomProfileUpdate: + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + format: int32 + nullable: true + type: integer + confidence_threshold: + default: low + nullable: true + type: string + context_awareness: + $ref: '#/components/schemas/dlpContextAwareness' + data_classes: + description: Data class IDs to associate with the profile. If omitted, existing associations are unchanged. + items: + format: uuid + type: string + nullable: true + type: array + data_tags: + description: Data tag IDs to associate with the profile. If omitted, existing associations are unchanged. + items: + format: uuid + type: string + nullable: true + type: array + description: + description: The description of the profile. + nullable: true + type: string + entries: + deprecated: true + description: Custom entries from this profile. If this field is omitted, entries owned by this profile will not be changed. + items: + $ref: '#/components/schemas/dlpProfileEntryUpdate' + nullable: true + type: array + name: + type: string + ocr_enabled: + default: false + type: boolean + sensitivity_levels: + description: Sensitivity levels to associate with the profile. If omitted, existing associations are unchanged. + items: + $ref: '#/components/schemas/dlpSensitivityLevelRef' + nullable: true + type: array + shared_entries: + description: Other entries, e.g. predefined or integration. + items: + $ref: '#/components/schemas/dlpSharedEntryUpdate' + type: array + required: + - name + type: object + dlpDataset: + properties: + case_sensitive: + type: boolean + columns: + items: + $ref: '#/components/schemas/dlpDatasetColumn' + type: array + created_at: + format: date-time + type: string + readOnly: true + description: + description: The description of the dataset. + nullable: true + type: string + encoding_version: + format: int32 + minimum: 0 + type: integer + id: + format: uuid + type: string + name: + type: string + num_cells: + format: int64 + type: integer + secret: + type: boolean + status: + $ref: '#/components/schemas/dlpDatasetUploadStatus' + updated_at: + description: Stores when the dataset was last updated. This includes name or description changes as well as uploads. + format: date-time + type: string + readOnly: true + uploads: + items: + $ref: '#/components/schemas/dlpDatasetUpload' + type: array + required: + - name + - id + - status + - num_cells + - created_at + - updated_at + - uploads + - secret + - encoding_version + - columns + type: object + dlpDatasetArray: + items: + $ref: '#/components/schemas/dlpDataset' + type: array + dlpDatasetColumn: + properties: + entry_id: + format: uuid + type: string + header_name: + type: string + num_cells: + format: int64 + type: integer + upload_status: + $ref: '#/components/schemas/dlpDatasetUploadStatus' + required: + - entry_id + - upload_status + - header_name + - num_cells + type: object + dlpDatasetColumnArray: + items: + $ref: '#/components/schemas/dlpDatasetColumn' + type: array + dlpDatasetCreation: + properties: + dataset: + $ref: '#/components/schemas/dlpDataset' + encoding_version: + description: Encoding version to use for dataset. + format: int32 + minimum: 0 + type: integer + max_cells: + format: int64 + minimum: 0 + type: integer + secret: + description: The secret to use for Exact Data Match datasets. This is not present in Custom Wordlists. + format: password + type: string + version: + description: The version to use when uploading the dataset. + format: int64 + type: integer + required: + - version + - max_cells + - dataset + - encoding_version + type: object + dlpDatasetNewVersion: + properties: + case_sensitive: + type: boolean + columns: + items: + $ref: '#/components/schemas/dlpDatasetColumn' + type: array + encoding_version: + format: int32 + minimum: 0 + type: integer + max_cells: + format: int64 + minimum: 0 + type: integer + secret: + format: password + type: string + version: + format: int64 + type: integer + required: + - version + - max_cells + - encoding_version + type: object + dlpDatasetUpload: + properties: + num_cells: + format: int64 + type: integer + status: + $ref: '#/components/schemas/dlpDatasetUploadStatus' + version: + format: int64 + type: integer + required: + - version + - status + - num_cells + type: object + dlpDatasetUploadStatus: + enum: + - empty + - uploading + - pending + - processing + - failed + - complete + type: string + dlpDlpSettings: + description: DLP account-level settings response. + properties: + ai_context_analysis: + description: Whether AI context analysis is enabled at the account level. + type: boolean + ocr: + description: Whether OCR is enabled at the account level. + type: boolean + payload_logging: + $ref: '#/components/schemas/dlpPayloadLogSetting' + required: + - payload_logging + - ai_context_analysis + - ocr + type: object + dlpDlpSettingsUpdate: + description: 'Request model for updating DLP account-level settings. All fields are optional. Missing fields behave differently for PUT vs PATCH: - PUT: missing fields reset to initial (unconfigured) values. - PATCH: missing fields keep existing values.' + properties: + ai_context_analysis: + default: false + description: Whether AI context analysis is enabled at the account level. + nullable: true + type: boolean + x-stainless-terraform-configurability: computed_optional + ocr: + default: false + description: Whether OCR is enabled at the account level. + nullable: true + type: boolean + x-stainless-terraform-configurability: computed_optional + payload_logging: + x-stainless-terraform-configurability: computed_optional + $ref: '#/components/schemas/dlpPayloadLogSettingUpdate' + type: object + dlpDocumentFingerprint: + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + default: '' + type: string + entry_id: + format: uuid + type: string + file_name: + nullable: true + type: string + id: + format: uuid + type: string + match_percent: + format: int32 + type: integer + name: + type: string + status: + $ref: '#/components/schemas/dlpDatasetUploadStatus' + updated_at: + format: date-time + type: string + readOnly: true + version: + format: int64 + nullable: true + type: integer + required: + - id + - entry_id + - name + - description + - match_percent + - status + - created_at + - updated_at + type: object + dlpDocumentFingerprintArray: + items: + $ref: '#/components/schemas/dlpDocumentFingerprint' + type: array + dlpDocumentFingerprintUpload: + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + type: string + entry_id: + format: uuid + type: string + file_name: + type: string + id: + format: uuid + type: string + match_percent: + format: int32 + type: integer + name: + type: string + status: + $ref: '#/components/schemas/dlpDatasetUploadStatus' + updated_at: + format: date-time + type: string + readOnly: true + version: + format: int64 + type: integer + required: + - id + - entry_id + - name + - description + - match_percent + - version + - file_name + - status + - created_at + - updated_at + type: object + dlpEmailRule: + properties: + action: + $ref: '#/components/schemas/dlpEmailRuleAction' + conditions: + description: Triggered if all conditions match. + items: + $ref: '#/components/schemas/dlpEmailRuleCondition' + type: array + created_at: + format: date-time + type: string + readOnly: true + description: + nullable: true + type: string + enabled: + type: boolean + name: + type: string + priority: + format: int32 + minimum: 0 + type: integer + rule_id: + format: uuid + type: string + updated_at: + format: date-time + type: string + readOnly: true + required: + - rule_id + - name + - priority + - enabled + - conditions + - action + - created_at + - updated_at + type: object + dlpEmailRuleAction: + properties: + action: + enum: + - Block + type: string + message: + nullable: true + type: string + required: + - action + type: object + dlpEmailRuleArray: + items: + $ref: '#/components/schemas/dlpEmailRule' + type: array + dlpEmailRuleCondition: + properties: + operator: + $ref: '#/components/schemas/dlpEmailRuleOperator' + selector: + $ref: '#/components/schemas/dlpEmailRuleSelector' + value: + $ref: '#/components/schemas/dlpEmailRuleValue' + required: + - selector + - operator + - value + type: object + dlpEmailRuleOperator: + enum: + - InList + - NotInList + - MatchRegex + - NotMatchRegex + type: string + dlpEmailRuleSelector: + enum: + - Recipients + - Sender + - DLPProfiles + type: string + dlpEmailRuleValue: + type: array + items: + type: string + dlpEmpty: + nullable: true + type: object + dlpEntry: + type: object + title: Custom Entry + properties: + created_at: + format: date-time + type: string + readOnly: true + description: + nullable: true + type: string + enabled: + deprecated: true + type: boolean + id: + format: uuid + type: string + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + profile_id: + deprecated: true + format: uuid + nullable: true + type: string + updated_at: + format: date-time + type: string + readOnly: true + type: + enum: + - custom + type: string + confidence: + $ref: '#/components/schemas/dlpEntryConfidence' + variant: + $ref: '#/components/schemas/dlpPredefinedEntryVariant' + case_sensitive: + description: Only applies to custom word lists. Determines if the words should be matched in a case-sensitive manner Cannot be set to false if secret is true + type: boolean + secret: + type: boolean + word_list: {} + required: + - enabled + - id + - name + - type + dlpEntryConfidence: + properties: + ai_context_available: + description: Indicates whether this entry has AI remote service validation. + type: boolean + available: + description: Indicates whether this entry has any form of validation that is not an AI remote service. + type: boolean + required: + - available + - ai_context_available + type: object + dlpEntryOfNewProfile: + type: object + properties: + description: + nullable: true + type: string + enabled: + type: boolean + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + words: + items: + type: string + type: array + required: + - enabled + - name + dlpEntryProfile: + description: Computed entry field for a profile that an entry is shared into. + properties: + id: + format: uuid + type: string + name: + type: string + required: + - id + - name + type: object + dlpEntryUpdate: + properties: + enabled: + type: boolean + description: + nullable: true + type: string + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + type: + enum: + - custom + type: string + required: + - type + type: object + dlpEntryWithSharedProfiles: + properties: + upload_status: + x-stainless-terraform-configurability: computed_optional + $ref: '#/components/schemas/dlpDatasetUploadStatus' + profiles: + items: + $ref: '#/components/schemas/dlpEntryProfile' + type: array + x-stainless-terraform-configurability: computed_optional + created_at: + format: date-time + type: string + readOnly: true + description: + nullable: true + type: string + enabled: + deprecated: true + type: boolean + id: + format: uuid + type: string + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + profile_id: + deprecated: true + format: uuid + nullable: true + type: string + updated_at: + format: date-time + type: string + readOnly: true + type: + enum: + - custom + type: string + confidence: + $ref: '#/components/schemas/dlpEntryConfidence' + variant: + $ref: '#/components/schemas/dlpPredefinedEntryVariant' + case_sensitive: + description: Only applies to custom word lists. Determines if the words should be matched in a case-sensitive manner Cannot be set to false if secret is true + type: boolean + secret: + type: boolean + word_list: {} + required: + - enabled + - id + - name + - type + type: object + title: Custom Entry + dlpEntryWithUploadStatus: + properties: + upload_status: + x-stainless-terraform-configurability: computed_optional + $ref: '#/components/schemas/dlpDatasetUploadStatus' + created_at: + format: date-time + type: string + readOnly: true + description: + nullable: true + type: string + enabled: + deprecated: true + type: boolean + id: + format: uuid + type: string + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + profile_id: + deprecated: true + format: uuid + nullable: true + type: string + updated_at: + format: date-time + type: string + readOnly: true + type: + enum: + - custom + type: string + confidence: + $ref: '#/components/schemas/dlpEntryConfidence' + variant: + $ref: '#/components/schemas/dlpPredefinedEntryVariant' + case_sensitive: + description: Only applies to custom word lists. Determines if the words should be matched in a case-sensitive manner Cannot be set to false if secret is true + type: boolean + secret: + type: boolean + word_list: {} + type: object + title: Custom Entry + required: + - enabled + - id + - name + - type + dlpIntegrationEntry: + properties: + created_at: + format: date-time + type: string + readOnly: true + enabled: + type: boolean + id: + format: uuid + type: string + name: + type: string + profile_id: + format: uuid + nullable: true + type: string + x-stainless-terraform-configurability: computed_optional + updated_at: + format: date-time + type: string + readOnly: true + required: + - id + - name + - created_at + - updated_at + - enabled + type: object + dlpLimits: + properties: + max_custom_regex_entries: + description: Maximum number of custom regex entries allowed for the account. + format: int64 + minimum: 0 + type: integer + max_dataset_cells: + description: Maximum number of dataset cells allowed for the account, across all EDM and CWL datasets. + format: int64 + minimum: 0 + type: integer + max_document_fingerprints: + description: Maximum number of document fingerprints allowed for the account. + format: int64 + minimum: 0 + type: integer + used_custom_regex_entries: + description: Number of custom regex entries currently configured for the account. + format: int64 + minimum: 0 + type: integer + used_dataset_cells: + description: Number of dataset cells currently configured for the account, across all EDM and CWL datasets. Document fingerprints do not count towards this limit. + format: int64 + minimum: 0 + type: integer + used_document_fingerprints: + description: Number of document fingerprints currently configured for the account. + format: int64 + minimum: 0 + type: integer + required: + - max_custom_regex_entries + - used_custom_regex_entries + - max_dataset_cells + - used_dataset_cells + - max_document_fingerprints + - used_document_fingerprints + type: object + dlpMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dlpNewCustomProfile: + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + default: 0 + description: Related DLP policies will trigger when the match count exceeds the number set. + example: 5 + format: int32 + maximum: 1000 + minimum: 0 + type: integer + confidence_threshold: + default: low + nullable: true + type: string + context_awareness: + $ref: '#/components/schemas/dlpContextAwareness' + data_classes: + description: Data class IDs to associate with the profile. + items: + format: uuid + type: string + type: array + data_tags: + description: Data tag IDs to associate with the profile. + items: + format: uuid + type: string + type: array + description: + description: The description of the profile. + nullable: true + type: string + entries: + items: + $ref: '#/components/schemas/dlpEntryOfNewProfile' + type: array + x-stainless-skip: + - terraform + name: + type: string + ocr_enabled: + default: false + type: boolean + sensitivity_levels: + description: Sensitivity levels to associate with the profile. + items: + $ref: '#/components/schemas/dlpSensitivityLevelRef' + type: array + shared_entries: + description: Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles). + items: + $ref: '#/components/schemas/dlpNewSharedEntry' + type: array + required: + - name + type: object + dlpNewEntry: + properties: + description: + nullable: true + type: string + enabled: + type: boolean + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + profile_id: + format: uuid + type: string + required: + - name + - pattern + - enabled + type: object + dlpNewPredefinedEntry: + description: Used to create a new predefined or integration entry. Predefined or integration entries can not be updated via the API so these fields will update the entry's settings. + properties: + enabled: + type: boolean + entry_id: + format: uuid + type: string + profile_id: + description: This field is not used as the owning profile. For predefined entries it is already set to a predefined profile. + format: uuid + nullable: true + type: string + required: + - enabled + - entry_id + type: object + dlpNewPredefinedProfile: + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + default: 0 + example: 5 + format: int32 + maximum: 1000 + minimum: 0 + nullable: true + type: integer + confidence_threshold: + default: low + nullable: true + type: string + context_awareness: + $ref: '#/components/schemas/dlpContextAwareness' + entries: + deprecated: true + items: + $ref: '#/components/schemas/dlpPredefinedProfileEntryUpdate' + type: array + ocr_enabled: + default: false + type: boolean + profile_id: + format: uuid + type: string + type: object + required: + - profile_id + dlpNewSharedEntry: + properties: + enabled: + type: boolean + entry_id: + format: uuid + type: string + required: + - entry_id + - enabled + type: object + dlpPattern: + properties: + regex: + type: string + validation: + $ref: '#/components/schemas/dlpValidation' + required: + - regex + type: object + dlpPayloadLogMaskingLevel: + description: 'Masking level for payload logs. - `full`: The entire payload is masked. - `partial`: Only partial payload content is masked. - `clear`: No masking is applied to the payload content. - `default`: DLP uses its default masking behavior.' + enum: + - full + - partial + - clear + - default + type: string + dlpPayloadLogSetting: + properties: + masking_level: + $ref: '#/components/schemas/dlpPayloadLogMaskingLevel' + public_key: + description: Base64-encoded public key for encrypting payload logs. Null when payload logging is disabled. + nullable: true + type: string + updated_at: + format: date-time + type: string + readOnly: true + required: + - updated_at + type: object + dlpPayloadLogSettingUpdate: + description: Request model for payload log settings within the DLP settings endpoint. Unlike the legacy endpoint, null and missing are treated identically here (both mean "not provided" for PATCH, "reset to default" for PUT). + properties: + masking_level: + default: default + $ref: '#/components/schemas/dlpPayloadLogMaskingLevel' + public_key: + description: Base64-encoded public key for encrypting payload logs. - Set to a non-empty base64 string to enable payload logging with the given key. - Set to an empty string to disable payload logging. - Omit or set to null to leave unchanged (PATCH) or reset to disabled (PUT). + nullable: true + type: string + type: object + dlpPayloadLogSettingUpdateLegacy: + description: Request model for the legacy payload log settings endpoint. + properties: + masking_level: + $ref: '#/components/schemas/dlpPayloadLogMaskingLevel' + public_key: + description: 'Base64-encoded public key for encrypting payload logs. - Set to null or empty string to disable payload logging. - Set to a non-empty base64 string to enable payload logging with the given key. For customers with configurable payload masking feature rolled out: - If the field is missing, the existing setting will be kept. Note that this is different from setting to null or empty string. For all other customers: - If the field is missing, the existing setting will be cleared.' + nullable: true + type: string + type: object + dlpPredefinedEntry: + properties: + confidence: + $ref: '#/components/schemas/dlpEntryConfidence' + enabled: + type: boolean + id: + format: uuid + type: string + name: + type: string + profile_id: + deprecated: true + format: uuid + nullable: true + type: string + variant: + $ref: '#/components/schemas/dlpPredefinedEntryVariant' + required: + - id + - name + - enabled + - confidence + type: object + dlpPredefinedEntryUpdate: + properties: + enabled: + type: boolean + required: + - enabled + type: object + dlpPredefinedEntryVariant: + properties: + description: + nullable: true + type: string + topic_type: + $ref: '#/components/schemas/dlpPromptTopicType' + type: + enum: + - PromptTopic + type: string + required: + - topic_type + - type + type: object + dlpPredefinedProfileConfig: + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + format: int32 + type: integer + confidence_threshold: + default: low + nullable: true + type: string + enabled_entries: + description: Entries to enable for this predefined profile. Any entries not provided will be disabled. + items: + format: uuid + type: string + type: array + entries: + deprecated: true + description: This field has been deprecated for `enabled_entries`. + items: + $ref: '#/components/schemas/dlpEntry' + type: array + id: + description: The id of the predefined profile (uuid). + format: uuid + type: string + name: + description: The name of the predefined profile. + type: string + ocr_enabled: + default: false + type: boolean + open_access: + description: Whether this profile can be accessed by anyone. + type: boolean + required: + - id + - name + - entries + - enabled_entries + - allowed_match_count + - confidence_threshold + type: object + dlpPredefinedProfileConfigUpdate: + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + default: 0 + example: 5 + format: int32 + maximum: 1000 + minimum: 0 + nullable: true + type: integer + confidence_threshold: + default: low + nullable: true + type: string + enabled_entries: + items: + format: uuid + type: string + nullable: true + type: array + entries: + deprecated: true + items: + $ref: '#/components/schemas/dlpPredefinedProfileEntryUpdate' + type: array + x-stainless-terraform-configurability: computed_optional + ocr_enabled: + default: false + type: boolean + type: object + dlpPredefinedProfileEntryUpdate: + properties: + enabled: + type: boolean + id: + format: uuid + type: string + required: + - id + - enabled + type: object + dlpPredefinedProfileUpdate: + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + default: 0 + example: 5 + format: int32 + maximum: 1000 + minimum: 0 + nullable: true + type: integer + confidence_threshold: + default: low + nullable: true + type: string + context_awareness: + $ref: '#/components/schemas/dlpContextAwareness' + entries: + deprecated: true + items: + $ref: '#/components/schemas/dlpPredefinedProfileEntryUpdate' + type: array + ocr_enabled: + default: false + type: boolean + type: object + dlpProfile: + type: object + title: Custom Profile + properties: + ai_context_enabled: + default: false + type: boolean + allowed_match_count: + default: 0 + description: Related DLP policies will trigger when the match count exceeds the number set. + example: 5 + format: int32 + maximum: 1000 + minimum: 0 + type: integer + confidence_threshold: + default: low + $ref: '#/components/schemas/dlpConfidence' + context_awareness: + $ref: '#/components/schemas/dlpContextAwareness' + created_at: + description: When the profile was created. + format: date-time + type: string + readOnly: true + data_classes: + description: Data classes associated with this profile. + items: + format: uuid + type: string + type: array + data_tags: + description: Data tags associated with this profile. + items: + format: uuid + type: string + type: array + description: + description: The description of the profile. + nullable: true + type: string + entries: + deprecated: true + items: + $ref: '#/components/schemas/dlpEntry' + type: array + x-stainless-skip: + - terraform + id: + description: The id of the profile (uuid). + format: uuid + type: string + name: + description: The name of the profile. + type: string + x-auditable: true + ocr_enabled: + default: false + type: boolean + sensitivity_levels: + description: Sensitivity levels associated with this profile. + items: + $ref: '#/components/schemas/dlpSensitivityLevelRef' + type: array + shared_entries: + items: + $ref: '#/components/schemas/dlpEntry' + type: array + x-stainless-terraform-configurability: computed + updated_at: + description: When the profile was lasted updated. + format: date-time + type: string + readOnly: true + type: + enum: + - custom + type: string + open_access: + description: Whether this profile can be accessed by anyone. + type: boolean + required: + - id + - name + - type + dlpProfileArray: + items: + $ref: '#/components/schemas/dlpProfile' + type: array + dlpProfileEntryUpdate: + type: object + properties: + description: + nullable: true + type: string + enabled: + type: boolean + name: + type: string + pattern: + $ref: '#/components/schemas/dlpPattern' + entry_id: + format: uuid + type: string + required: + - enabled + - name + - pattern + dlpPromptTopicType: + enum: + - Intent + - Content + type: string + dlpRegexValidationQuery: + properties: + max_match_bytes: + description: Maximum number of bytes that the regular expression can match. If this is `null` then there is no limit on the length. Patterns can use `*` and `+`. Otherwise repeats should use a range `{m,n}` to restrict patterns to the length. If this field is missing, then a default length limit is used. Note that the length is specified in bytes. Since regular expressions use UTF-8 the pattern `.` can match up to 4 bytes. Hence `.{1,256}` has a maximum length of 1024 bytes. + format: int32 + minimum: 0 + nullable: true + type: integer + regex: + type: string + required: + - regex + type: object + dlpRegexValidationResult: + properties: + valid: + type: boolean + required: + - valid + type: object + dlpRiskEvent: + properties: + event_details: {} + id: + type: string + name: + type: string + risk_level: + $ref: '#/components/schemas/dlpRiskLevel' + timestamp: + format: date-time + type: string + required: + - id + - risk_level + - name + - timestamp + type: object + dlpRiskEvents: + properties: + email: + type: string + events: + items: + $ref: '#/components/schemas/dlpRiskEvent' + type: array + last_reset_time: + format: date-time + nullable: true + type: string + name: + type: string + risk_level: + $ref: '#/components/schemas/dlpRiskLevel' + required: + - name + - email + - events + type: object + dlpRiskLevel: + enum: + - low + - medium + - high + type: string + dlpRiskScoreIntegration: + properties: + account_tag: + description: The Cloudflare account tag. + type: string + active: + description: Whether this integration is enabled and should export changes in risk score. + type: boolean + created_at: + description: When the integration was created in RFC3339 format. + format: date-time + type: string + readOnly: true + id: + description: The id of the integration, a UUIDv4. + format: uuid + type: string + integration_type: + $ref: '#/components/schemas/dlpRiskScoreIntegrationType' + reference_id: + description: A reference ID defined by the client. Should be set to the Access-Okta IDP integration ID. Useful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID. + type: string + tenant_url: + description: The base URL for the tenant. E.g. "https://tenant.okta.com". + type: string + well_known_url: + description: The URL for the Shared Signals Framework configuration, e.g. "/.well-known/sse-configuration/{integration_uuid}/". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1. + type: string + required: + - id + - account_tag + - integration_type + - reference_id + - tenant_url + - well_known_url + - active + - created_at + type: object + dlpRiskScoreIntegrationArray: + items: + $ref: '#/components/schemas/dlpRiskScoreIntegration' + type: array + dlpRiskScoreIntegrationType: + enum: + - Okta + type: string + dlpRiskSummary: + properties: + users: + items: + $ref: '#/components/schemas/dlpUserRiskInfo' + type: array + required: + - users + type: object + dlpSensitivityLevelRef: + description: A reference pairing a sensitivity group with a specific level within that group. + properties: + group_id: + format: uuid + type: string + level_id: + format: uuid + type: string + required: + - group_id + - level_id + type: object + dlpSharedEntryUpdate: + properties: + enabled: + type: boolean + entry_id: + format: uuid + type: string + required: + - entry_id + - enabled + type: object + dlpSkipConfig: + description: Content types to exclude from context analysis and return all matches. + properties: + files: + description: If the content type is a file, skip context analysis and return all matches. + type: boolean + required: + - files + type: object + dlpUpdateAddinAccountMapping: + properties: + auth_requirements: + $ref: '#/components/schemas/dlpAddinAuth' + required: + - auth_requirements + type: object + dlpUpdateBehaviors: + properties: + behaviors: + type: object + required: + - behaviors + type: object + dlpUpdateDocumentFingerprint: + properties: + description: + nullable: true + type: string + match_percent: + format: int32 + nullable: true + type: integer + name: + nullable: true + type: string + type: object + dlpUpdateEmailRulePriorities: + description: Used to update multiple email rule priorities as an atomic action, to support patterns such as swapping the priorities of two email rules. + properties: + new_priorities: + type: object + required: + - new_priorities + type: object + dlpUpdateIntegrationBody: + properties: + active: + description: Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party. + type: boolean + reference_id: + description: A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider + nullable: true + type: string + tenant_url: + description: The base url of the tenant, e.g. "https://tenant.okta.com". + format: uri + type: string + required: + - tenant_url + - active + type: object + dlpUserRiskInfo: + properties: + email: + type: string + event_count: + minimum: 0 + type: integer + last_event: + format: date-time + type: string + max_risk_level: + $ref: '#/components/schemas/dlpRiskLevel' + name: + type: string + user_id: + format: uuid + type: string + required: + - user_id + - name + - email + - max_risk_level + - event_count + - last_event + type: object + dlpValidation: + deprecated: true + enum: + - luhn + type: string + infraApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/infraMessages' + messages: + example: [] + $ref: '#/components/schemas/infraMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + infraIPInfo: + description: The IPv4/IPv6 address that identifies where to reach a target + properties: + ipv4: + description: The target's IPv4 address + properties: + ip_addr: + description: IP address of the target + example: 187.26.29.249 + type: string + x-auditable: true + virtual_network_id: + description: (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. + example: c77b744e-acc8-428f-9257-6878c046ed55 + format: uuid + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + ipv6: + description: The target's IPv6 address + properties: + ip_addr: + description: IP address of the target + example: 64c0:64e8:f0b4:8dbf:7104:72b0:ec8f:f5e0 + type: string + x-auditable: true + virtual_network_id: + description: (optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used. + example: c77b744e-acc8-428f-9257-6878c046ed55 + format: uuid + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + type: object + infraMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + infraSortingDirection: + enum: + - asc + - desc + type: string + infraTarget: + properties: + created_at: + description: Date and time at which the target was created + example: '2019-08-24T14:15:22Z' + format: date-time + type: string + readOnly: true + hostname: + description: A non-unique field that refers to a target + example: infra-access-target + type: string + id: + $ref: '#/components/schemas/infraTargetId' + ip: + $ref: '#/components/schemas/infraIPInfo' + modified_at: + description: Date and time at which the target was modified + example: '2019-08-24T14:15:22Z' + format: date-time + type: string + readOnly: true + required: + - id + - hostname + - ip + - created_at + - modified_at + type: object + infraTargetArray: + items: + $ref: '#/components/schemas/infraTarget' + type: array + infraTargetId: + description: Target identifier + format: uuid + maxLength: 36 + title: target_id + type: string + x-auditable: true + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + scimConfig: + description: The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider. + properties: + enabled: + default: false + description: A flag to enable or disable SCIM for the identity provider. + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + identity_update_behavior: + default: no_action + description: Indicates how a SCIM event updates a user identity used for policy evaluation. Use "automatic" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With "reauth" identities will not contain fields from the SCIM user resource. With "no_action" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate. + enum: + - automatic + - reauth + - no_action + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + scim_base_url: + description: The base URL of Cloudflare's SCIM V2.0 API endpoint. + readOnly: true + type: string + x-auditable: true + seat_deprovision: + default: false + description: A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled. + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + secret: + description: A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it at /access/identity_providers/:idpID/refresh_scim_secret. + readOnly: true + type: string + x-sensitive: true + user_deprovision: + default: false + description: A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider. + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + teamsDevicesAccount: + properties: + account_type: + deprecated: true + type: string + id: + deprecated: true + type: string + name: + description: The name of the enrolled account. + example: Company + type: string + x-auditable: true + type: object + teamsDevicesAllowModeSwitch: + default: false + description: Whether to allow the user to switch WARP between modes. + example: true + type: boolean + teamsDevicesAllowUpdates: + default: false + description: Whether to receive update notifications when a new version of the client is available. + example: true + type: boolean + teamsDevicesAllowedToLeave: + default: true + description: Whether to allow devices to leave the organization. + example: true + type: boolean + teamsDevicesApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + example: [] + $ref: '#/components/schemas/teamsDevicesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + teamsDevicesApiResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesAutoConnect: + default: 0 + description: The amount of time in seconds to reconnect after having been disabled. + example: 0 + type: number + teamsDevicesCaptivePortal: + default: 180 + description: Turn on the captive portal after the specified amount of time. + example: 180 + type: number + teamsDevicesCheckDisks: + description: List of volume names to be checked for encryption. + example: + - C + - D + - G + items: + type: string + type: array + teamsDevicesClientVersion: + properties: + package_size: + description: Size of the package in bytes. + example: 123125760 + format: int64 + type: integer + package_url: + description: URL to download the package. + example: https://downloads.cloudflareclient.com/v1/download/windows/version/2024.11.309.0 + type: string + release_date: + description: The release date timestamp. + example: '2024-11-18T21:57:58.478Z' + type: string + release_notes: + description: Release notes for this version. + example: This release contains minor fixes and improvements. + type: string + version: + description: The client version string. + example: 2024.11.309.0 + type: string + required: + - version + - release_date + type: object + teamsDevicesComponentsSchemasName: + description: The name of the device posture integration. + example: My Workspace One Integration + type: string + x-auditable: true + teamsDevicesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworks' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworks' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesComponentsSchemasType: + description: The type of device managed network. + enum: + - tls + example: tls + type: string + x-auditable: true + teamsDevicesComponentsSchemasUuid: + description: UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + readOnly: true + type: string + x-auditable: true + teamsDevicesConfigRequest: + description: The configuration object containing third-party integration information. + example: + api_url: https://as123.awmdm.com/API + auth_url: https://na.uemauth.workspaceone.com/connect/token + client_id: example client id + client_secret: example client secret + type: object + title: Workspace One Config + properties: + api_url: + description: The Workspace One API URL provided in the Workspace One Admin Dashboard. + example: https://as123.awmdm.com/API + type: string + auth_url: + description: The Workspace One Authorization URL depending on your region. + example: https://na.uemauth.workspaceone.com/connect/token + type: string + client_id: + description: The Workspace One client ID provided in the Workspace One Admin Dashboard. + example: example client id + type: string + client_secret: + description: The Workspace One client secret provided in the Workspace One Admin Dashboard. + example: example client secret + type: string + x-sensitive: true + customer_id: + description: The Crowdstrike customer ID. + example: example customer id + type: string + x-auditable: true + client_key: + description: The Uptycs client secret. + example: example client key + type: string + x-sensitive: true + access_client_id: + description: If present, this id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`. + example: 88bf3b6d86161464f6509f7219099e57.access + type: string + access_client_secret: + description: If present, this secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`. + example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5 + type: string + x-sensitive: true + required: [] + teamsDevicesConfigResponse: + description: The configuration object containing third-party integration information. + example: + api_url: https://as123.awmdm.com/API + auth_url: https://na.uemauth.workspaceone.com/connect/token + client_id: example client id + type: object + $ref: '#/components/schemas/teamsDevicesWorkspaceOneConfigResponse' + teamsDevicesCreated: + description: When the device was created. + example: '2017-06-14T00:00:00Z' + format: date-time + type: string + x-auditable: true + teamsDevicesCursorResultInfo: + description: V4 public API Pagination/Cursor info. + example: + count: 1 + cursor: ais86dftf.asdf7ba8 + per_page: 10 + total_count: null + properties: + count: + description: Number of records in the response. + type: integer + cursor: + description: Opaque token to request the next set of records. + type: string + per_page: + description: The limit for the number of records in the response. + type: integer + total_count: + description: Total number of records available. + nullable: true + type: integer + required: + - per_page + - count + - cursor + type: object + teamsDevicesDefault: + description: Whether the policy is the default policy for an account. + example: false + type: boolean + teamsDevicesDefaultDeviceSettingsPolicy: + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + default: + description: Whether the policy will be applied to matching devices. + example: true + type: boolean + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + enabled: + default: true + description: Whether the policy will be applied to matching devices. + example: true + type: boolean + exclude: + $ref: '#/components/schemas/teamsDevicesExclude' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + fallback_domains: + $ref: '#/components/schemas/teamsDevicesFallbackDomains' + gateway_unique_id: + $ref: '#/components/schemas/teamsDevicesGatewayUniqueId' + include: + $ref: '#/components/schemas/teamsDevicesInclude' + policy_id: + $ref: '#/components/schemas/teamsDevicesSchemasUuid' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + type: object + teamsDevicesDefaultDeviceSettingsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesDefaultDeviceSettingsPolicy' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesDeleted: + description: True if the device was deleted. + example: true + type: boolean + teamsDevicesDeploymentGroup: + properties: + created_at: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupCreatedAt' + readOnly: true + id: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupId' + name: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupName' + policy_ids: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupPolicyIds' + updated_at: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupUpdatedAt' + readOnly: true + version_config: + description: Contains version configurations for different target environments. + items: + $ref: '#/components/schemas/teamsDevicesVersionConfig' + type: array + required: + - id + - name + - version_config + - created_at + - updated_at + type: object + teamsDevicesDeploymentGroupCreateRequest: + properties: + name: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupName' + policy_ids: + description: Contains an optional list of policy IDs assigned to a group. + items: + type: string + type: array + version_config: + description: Contains at least one version configuration. + items: + $ref: '#/components/schemas/teamsDevicesVersionConfig' + minItems: 1 + type: array + required: + - name + - version_config + type: object + teamsDevicesDeploymentGroupCreatedAt: + description: The RFC3339Nano timestamp when the deployment group was created. + example: '2026-02-14T13:17:00.123456789Z' + type: string + teamsDevicesDeploymentGroupId: + description: The ID of the deployment group. + example: 550e8400-e29b-41d4-a716-446655440000 + type: string + x-auditable: true + teamsDevicesDeploymentGroupName: + description: A user-friendly name for the deployment group. + example: Engineering Ring 0 + maxLength: 255 + minLength: 1 + type: string + x-auditable: true + teamsDevicesDeploymentGroupPolicyIds: + description: Contains a list of policy IDs assigned to this deployment group. + example: + - policy-uuid-1 + - policy-uuid-2 + items: + type: string + type: array + x-auditable: true + teamsDevicesDeploymentGroupUpdateRequest: + properties: + name: + $ref: '#/components/schemas/teamsDevicesDeploymentGroupName' + policy_ids: + description: Replaces the entire list of policy IDs. + items: + type: string + type: array + version_config: + description: Replaces the entire version_config array. + items: + $ref: '#/components/schemas/teamsDevicesVersionConfig' + type: array + type: object + teamsDevicesDeploymentGroupUpdatedAt: + description: The RFC3339Nano timestamp when the deployment group was last updated. + example: '2026-02-14T13:17:00.123456789Z' + type: string + teamsDevicesDescription: + description: The description of the device posture rule. + example: The rule for admin serial numbers + type: string + x-auditable: true + teamsDevicesDevice: + properties: + account: + $ref: '#/components/schemas/teamsDevicesAccount' + created: + $ref: '#/components/schemas/teamsDevicesCreated' + deleted: + $ref: '#/components/schemas/teamsDevicesDeleted' + device_type: + $ref: '#/components/schemas/teamsDevicesDeviceType' + gateway_device_id: + $ref: '#/components/schemas/teamsDevicesGatewayDeviceId' + id: + $ref: '#/components/schemas/teamsDevicesRegistrationId' + ip: + $ref: '#/components/schemas/teamsDevicesIp' + key: + $ref: '#/components/schemas/teamsDevicesKey' + key_type: + $ref: '#/components/schemas/teamsDevicesKeyType' + last_seen: + $ref: '#/components/schemas/teamsDevicesLastSeen' + mac_address: + $ref: '#/components/schemas/teamsDevicesMacAddress' + model: + $ref: '#/components/schemas/teamsDevicesModel' + name: + $ref: '#/components/schemas/teamsDevicesSchemasName' + os_version: + $ref: '#/components/schemas/teamsDevicesOsVersion' + serial_number: + $ref: '#/components/schemas/teamsDevicesSerialNumber' + tunnel_type: + $ref: '#/components/schemas/teamsDevicesTunnelType' + updated: + $ref: '#/components/schemas/teamsDevicesUpdated' + user: + $ref: '#/components/schemas/teamsDevicesUser' + version: + $ref: '#/components/schemas/teamsDevicesVersion' + type: object + teamsDevicesDeviceManagedNetworks: + properties: + config: + $ref: '#/components/schemas/teamsDevicesSchemasConfigResponse' + name: + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworksComponentsSchemasName' + network_id: + $ref: '#/components/schemas/teamsDevicesUuid' + type: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasType' + type: object + teamsDevicesDeviceManagedNetworksComponentsSchemasName: + description: The name of the device managed network. This name must be unique. + example: managed-network-1 + type: string + x-auditable: true + teamsDevicesDevicePostureIntegrations: + properties: + config: + $ref: '#/components/schemas/teamsDevicesConfigResponse' + id: + $ref: '#/components/schemas/teamsDevicesUuid' + interval: + $ref: '#/components/schemas/teamsDevicesInterval' + name: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasName' + type: + $ref: '#/components/schemas/teamsDevicesSchemasType' + type: object + teamsDevicesDevicePostureRules: + properties: + description: + $ref: '#/components/schemas/teamsDevicesDescription' + expiration: + $ref: '#/components/schemas/teamsDevicesExpiration' + id: + $ref: '#/components/schemas/teamsDevicesUuid' + input: + $ref: '#/components/schemas/teamsDevicesInput' + match: + $ref: '#/components/schemas/teamsDevicesMatch' + name: + $ref: '#/components/schemas/teamsDevicesName' + schedule: + $ref: '#/components/schemas/teamsDevicesSchedule' + type: + $ref: '#/components/schemas/teamsDevicesType' + type: object + teamsDevicesDeviceResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesDevice' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesDeviceSettingsPolicy: + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + default: + $ref: '#/components/schemas/teamsDevicesDefault' + description: + $ref: '#/components/schemas/teamsDevicesSchemasDescription' + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + enabled: + default: true + description: Whether the policy will be applied to matching devices. + example: true + type: boolean + exclude: + $ref: '#/components/schemas/teamsDevicesExclude' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + fallback_domains: + $ref: '#/components/schemas/teamsDevicesFallbackDomains' + gateway_unique_id: + $ref: '#/components/schemas/teamsDevicesGatewayUniqueId' + include: + $ref: '#/components/schemas/teamsDevicesInclude' + lan_allow_minutes: + $ref: '#/components/schemas/teamsDevicesLanAllowMinutes' + lan_allow_subnet_size: + $ref: '#/components/schemas/teamsDevicesLanAllowSubnetSize' + match: + $ref: '#/components/schemas/teamsDevicesSchemasMatch' + name: + description: The name of the device settings profile. + example: Allow Developers + maxLength: 100 + type: string + policy_id: + $ref: '#/components/schemas/teamsDevicesSchemasUuid' + precedence: + $ref: '#/components/schemas/teamsDevicesPrecedence' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + target_tests: + items: + $ref: '#/components/schemas/teamsDevicesTargetDexTest' + type: array + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + type: object + teamsDevicesDeviceSettingsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesDeviceSettingsPolicy' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesDeviceSettingsResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDeviceSettingsPolicy' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesDeviceType: + example: windows + type: string + x-auditable: true + teamsDevicesDevices: + properties: + created: + $ref: '#/components/schemas/teamsDevicesCreated' + deleted: + $ref: '#/components/schemas/teamsDevicesDeleted' + device_type: + $ref: '#/components/schemas/teamsDevicesPlatform' + id: + $ref: '#/components/schemas/teamsDevicesRegistrationId' + ip: + $ref: '#/components/schemas/teamsDevicesIp' + key: + $ref: '#/components/schemas/teamsDevicesKey' + last_seen: + $ref: '#/components/schemas/teamsDevicesLastSeen' + mac_address: + $ref: '#/components/schemas/teamsDevicesMacAddress' + manufacturer: + $ref: '#/components/schemas/teamsDevicesManufacturer' + model: + $ref: '#/components/schemas/teamsDevicesModel' + name: + $ref: '#/components/schemas/teamsDevicesSchemasName' + os_distro_name: + $ref: '#/components/schemas/teamsDevicesOsDistroName' + os_distro_revision: + $ref: '#/components/schemas/teamsDevicesOsDistroRevision' + os_version: + $ref: '#/components/schemas/teamsDevicesOsVersion' + os_version_extra: + $ref: '#/components/schemas/teamsDevicesOsVersionExtra' + revoked_at: + $ref: '#/components/schemas/teamsDevicesRevokedAt' + serial_number: + $ref: '#/components/schemas/teamsDevicesSerialNumber' + updated: + $ref: '#/components/schemas/teamsDevicesUpdated' + user: + $ref: '#/components/schemas/teamsDevicesUser' + version: + $ref: '#/components/schemas/teamsDevicesVersion' + type: object + teamsDevicesDevicesPolicyCertificates: + properties: + enabled: + description: The current status of the device policy certificate provisioning feature for WARP clients. + example: true + type: boolean + required: + - enabled + type: object + teamsDevicesDevicesPolicyCertificatesSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesDevicesPolicyCertificates' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesDevicesResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDevices' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesDisableAutoFallback: + default: false + description: If the `dns_server` field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers unless this policy option is set to `true`. + example: true + type: boolean + x-auditable: true + teamsDevicesDisableForTime: + properties: + '1': + description: Override code that is valid for 1 hour. + example: '9106681' + type: string + x-stainless-naming: + python: + property_name: one + go: + property_name: One + '3': + description: Override code that is valid for 3 hours. + example: '5356247' + type: string + x-stainless-naming: + python: + property_name: three + go: + property_name: Three + '6': + description: Override code that is valid for 6 hours. + example: '9478972' + type: string + x-stainless-naming: + python: + property_name: six + go: + property_name: Six + '12': + description: Override code that is valid for 12 hour2. + example: '3424359' + type: string + x-stainless-naming: + python: + property_name: twelve + go: + property_name: Twelve + '24': + description: Override code that is valid for 24 hour.2. + example: '2887634' + type: string + x-stainless-naming: + python: + property_name: twenty_four + go: + property_name: TwentyFour + type: object + teamsDevicesDisconnect: + description: Disconnects all devices on the account using Global WARP override. + example: false + type: boolean + x-auditable: true + teamsDevicesEmail: + description: The contact email address of the user. + example: user@example.com + maxLength: 90 + type: string + x-auditable: true + teamsDevicesEmptyBody: + nullable: true + type: object + teamsDevicesExclude: + default: + - address: 10.0.0.0/8 + - address: 100.64.0.0/10 + - address: 169.254.0.0/16 + description: DHCP Unspecified + - address: 172.16.0.0/12 + - address: 192.0.0.0/24 + - address: 192.168.0.0/16 + - address: 224.0.0.0/24 + - address: 240.0.0.0/4 + - address: 255.255.255.255/32 + description: DHCP Broadcast + - address: fe80::/10 + description: IPv6 Link Local + - address: fd00::/8 + - address: ff01::/16 + - address: ff02::/16 + - address: ff03::/16 + - address: ff04::/16 + - address: ff05::/16 + description: List of routes excluded in the WARP client's tunnel. + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnel' + type: array + teamsDevicesExcludeOfficeIps: + default: false + description: Whether to add Microsoft IPs to Split Tunnel exclusions. + example: true + type: boolean + teamsDevicesExcludeRequest: + description: List of routes excluded in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request. + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnel' + type: array + x-stainless-terraform-configurability: computed_optional + teamsDevicesExpiration: + description: Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client. + example: 1h + type: string + teamsDevicesExtendedKeyUsageEnum: + enum: + - clientAuth + - emailProtection + type: string + x-auditable: true + teamsDevicesFallbackDomain: + properties: + description: + description: A description of the fallback domain, displayed in the client UI. + example: Domain bypass for local development + maxLength: 100 + type: string + x-auditable: true + dns_server: + description: A list of IP addresses to handle domain resolution. + items: + $ref: '#/components/schemas/teamsDevicesIp' + type: array + suffix: + description: The domain suffix to match when resolving locally. + example: example.com + type: string + x-auditable: true + required: + - suffix + type: object + teamsDevicesFallbackDomainResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesFallbackDomain' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesFallbackDomains: + default: + - suffix: intranet + - suffix: internal + - suffix: private + - suffix: localdomain + - suffix: domain + - suffix: lan + - suffix: home + - suffix: host + - suffix: corp + - suffix: local + - suffix: localhost + - suffix: home.arpa + - suffix: invalid + - suffix: test + items: + $ref: '#/components/schemas/teamsDevicesFallbackDomain' + type: array + teamsDevicesGatewayDeviceId: + deprecated: true + example: PD33E90AXfafe14643cbbbc-4a0ed4fc8415Q + type: string + teamsDevicesGatewayUniqueId: + example: 699d98642c564d2e855e9661899b7252 + type: string + teamsDevicesGlobalWarpOverride: + properties: + disconnect: + $ref: '#/components/schemas/teamsDevicesDisconnect' + timestamp: + $ref: '#/components/schemas/teamsDevicesTimestamp' + type: object + teamsDevicesGlobalWarpOverrideRequest: + properties: + disconnect: + $ref: '#/components/schemas/teamsDevicesDisconnect' + justification: + $ref: '#/components/schemas/teamsDevicesJustification' + required: + - disconnect + title: Global WARP override request + type: object + teamsDevicesGlobalWarpOverrideResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesGlobalWarpOverride' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + properties: + id: + $ref: '#/components/schemas/teamsDevicesUuid' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesInclude: + description: List of routes included in the WARP client's tunnel. + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnelInclude' + type: array + teamsDevicesIncludeRequest: + description: List of routes included in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request. + items: + $ref: '#/components/schemas/teamsDevicesSplitTunnelInclude' + type: array + x-stainless-terraform-configurability: computed_optional + teamsDevicesIncludeSplitTunnelAddress: + description: The address in CIDR format to include in the tunnel. If `address` is present, `host` must not be present. + example: 192.0.2.0/24 + type: string + x-stainless-terraform-configurability: computed_optional + teamsDevicesIncludeSplitTunnelDescription: + description: A description of the Split Tunnel item, displayed in the client UI. + example: Include testing domains in the tunnel + maxLength: 100 + type: string + x-stainless-terraform-configurability: computed_optional + teamsDevicesIncludeSplitTunnelHost: + description: The domain name to include in the tunnel. If `host` is present, `address` must not be present. + example: '*.example.com' + type: string + x-stainless-terraform-configurability: computed_optional + teamsDevicesInput: + description: The value to be checked against. + example: + operating_system: linux + path: /bin/cat + thumbprint: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e + type: object + title: File Check + properties: + exists: + description: Whether or not file exists. + example: true + type: boolean + x-auditable: true + operating_system: + $ref: '#/components/schemas/unnamedSchemaRef41885dd46b9e0294254c49305a273681' + path: + description: File path. + example: /bin/cat + type: string + x-auditable: true + sha256: + description: SHA-256. + example: https://api.us-2.crowdstrike.com + type: string + thumbprint: + description: Signing certificate thumbprint. + example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e + type: string + id: + description: List ID. + example: da3de859-8f6e-47ea-a2b5-b2433858471f + type: string + x-auditable: true + domain: + description: Domain. + example: example.com + type: string + x-auditable: true + operator: + $ref: '#/components/schemas/unnamedSchemaRef34ef0ad73a63c3f76ed170adca181930' + os_distro_name: + description: Operating System Distribution Name (linux only). + example: ubuntu + type: string + x-auditable: true + os_distro_revision: + description: Version of OS Distribution (linux only). + example: 11.3.1 + type: string + x-auditable: true + os_version_extra: + description: Additional operating system version details. For Windows, the UBR (Update Build Revision). For Mac or iOS, the Product Version Extra. For Linux, the distribution name and version. + example: (a) or 6889 or Ubuntu 24.04 + type: string + x-auditable: true + version: + description: Version of OS. + example: 13.3.0 + type: string + x-auditable: true + enabled: + description: Enabled. + example: true + type: boolean + x-auditable: true + checkDisks: + $ref: '#/components/schemas/teamsDevicesCheckDisks' + requireAll: + $ref: '#/components/schemas/teamsDevicesRequireAll' + certificate_id: + description: UUID of Cloudflare managed certificate. + example: b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30 + maxLength: 36 + type: string + cn: + description: Common Name that is protected by the certificate. + example: example.com + type: string + check_private_key: + description: Confirm the certificate was not imported from another device. We recommend keeping this enabled unless the certificate was deployed without a private key. + example: true + type: boolean + extended_key_usage: + description: List of values indicating purposes for which the certificate public key can be used. + example: + - clientAuth + - emailProtection + items: + $ref: '#/components/schemas/teamsDevicesExtendedKeyUsageEnum' + type: array + locations: + properties: + paths: + $ref: '#/components/schemas/teamsDevicesPaths' + trust_stores: + $ref: '#/components/schemas/teamsDevicesTrustStores' + type: object + subject_alternative_names: + description: List of certificate Subject Alternative Names. + example: + - example.com + - sample.com + items: + type: string + type: array + update_window_days: + description: Number of days that the antivirus should be updated within. + example: 7 + type: number + compliance_status: + description: Compliance Status. + enum: + - compliant + - noncompliant + - unknown + example: compliant + type: string + x-auditable: true + connection_id: + description: Posture Integration ID. + example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f + type: string + x-auditable: true + last_seen: + description: For more details on last seen, please refer to the Crowdstrike documentation. + example: 15d3h20m4s + type: string + x-auditable: true + os: + description: Os Version. + example: 13.3.0 + type: string + x-auditable: true + overall: + description: Overall. + example: '90' + type: string + x-auditable: true + sensor_config: + description: SensorConfig. + example: '90' + type: string + x-auditable: true + state: + description: For more details on state, please refer to the Crowdstrike documentation. + enum: + - online + - offline + - unknown + example: online + type: string + x-auditable: true + versionOperator: + description: Version Operator. + enum: + - < + - <= + - '>' + - '>=' + - == + example: '>' + type: string + x-auditable: true + countOperator: + description: Count Operator. + enum: + - < + - <= + - '>' + - '>=' + - == + example: '>' + type: string + x-auditable: true + issue_count: + description: The Number of Issues. + example: '1' + type: string + x-auditable: true + eid_last_seen: + description: For more details on eid last seen, refer to the Tanium documentation. + example: '2023-07-20T23:16:32Z' + type: string + x-auditable: true + risk_level: + description: For more details on risk level, refer to the Tanium documentation. + enum: + - low + - medium + - high + - critical + example: low + type: string + x-auditable: true + scoreOperator: + description: Score Operator. + enum: + - < + - <= + - '>' + - '>=' + - == + example: '>' + type: string + x-auditable: true + total_score: + description: For more details on total score, refer to the Tanium documentation. + example: 1 + type: number + x-auditable: true + active_threats: + description: The Number of active threats. + example: 1 + type: number + infected: + description: Whether device is infected. + example: true + type: boolean + is_active: + description: Whether device is active. + example: true + type: boolean + network_status: + description: Network status of device. + enum: + - connected + - disconnected + - disconnecting + - connecting + example: connected + type: string + operational_state: + description: Agent operational state. + enum: + - na + - partially_disabled + - auto_fully_disabled + - fully_disabled + - auto_partially_disabled + - disabled_error + - db_corruption + type: string + score: + description: A value between 0-100 assigned to devices set by the 3rd party posture provider. + example: 100 + type: number + required: [] + teamsDevicesInterval: + description: The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`). + example: 10m + type: string + x-auditable: true + teamsDevicesIp: + description: IPv4 or IPv6 address. + example: 1.1.1.1 + type: string + x-auditable: true + teamsDevicesIpProfile: + properties: + created_at: + $ref: '#/components/schemas/teamsDevicesIpProfileCreatedAt' + readOnly: true + description: + $ref: '#/components/schemas/teamsDevicesIpProfileDescription' + enabled: + $ref: '#/components/schemas/teamsDevicesIpProfileEnabled' + id: + $ref: '#/components/schemas/teamsDevicesIpProfileId' + match: + $ref: '#/components/schemas/teamsDevicesIpProfileMatch' + name: + $ref: '#/components/schemas/teamsDevicesIpProfileName' + precedence: + $ref: '#/components/schemas/teamsDevicesIpProfilePrecedence' + subnet_id: + $ref: '#/components/schemas/teamsDevicesIpProfileSubnetId' + updated_at: + $ref: '#/components/schemas/teamsDevicesIpProfileUpdatedAt' + readOnly: true + required: + - id + - name + - match + - description + - precedence + - subnet_id + - created_at + - updated_at + - enabled + type: object + teamsDevicesIpProfileCreateRequest: + properties: + description: + description: An optional description of the Device IP profile. + example: example comment + nullable: true + type: string + x-auditable: true + enabled: + default: true + description: Whether the Device IP profile will be applied to matching devices. + example: true + type: boolean + x-auditable: true + match: + $ref: '#/components/schemas/teamsDevicesIpProfileMatch' + name: + $ref: '#/components/schemas/teamsDevicesIpProfileName' + precedence: + $ref: '#/components/schemas/teamsDevicesIpProfilePrecedence' + subnet_id: + $ref: '#/components/schemas/teamsDevicesIpProfileSubnetId' + required: + - name + - subnet_id + - precedence + - match + type: object + teamsDevicesIpProfileCreatedAt: + description: The RFC3339Nano timestamp when the Device IP profile was created. + example: '2025-02-14T13:17:00.123456789Z' + type: string + teamsDevicesIpProfileDescription: + description: An optional description of the Device IP profile. + example: example comment + nullable: true + type: string + x-auditable: true + teamsDevicesIpProfileEnabled: + description: Whether the Device IP profile is enabled. + example: true + type: boolean + x-auditable: true + teamsDevicesIpProfileId: + description: The ID of the Device IP profile. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + type: string + x-auditable: true + teamsDevicesIpProfileMatch: + description: 'The wirefilter expression to match registrations. Available values: "identity.name", "identity.email", "identity.groups.id", "identity.groups.name", "identity.groups.email", "identity.saml_attributes".' + example: identity.email == "test@cloudflare.com" + maxLength: 10000 + type: string + x-auditable: true + teamsDevicesIpProfileName: + description: A user-friendly name for the Device IP profile. + example: IPv4 Cloudflare Source IPs + type: string + x-auditable: true + teamsDevicesIpProfilePrecedence: + description: The precedence of the Device IP profile. Lower values indicate higher precedence. Device IP profile will be evaluated in ascending order of this field. + example: 100 + type: integer + x-auditable: true + teamsDevicesIpProfileSubnetId: + description: The ID of the Subnet. + example: b70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + type: string + x-auditable: true + teamsDevicesIpProfileUpdateRequest: + properties: + description: + description: An optional description of the Device IP profile. + example: example comment + type: string + x-auditable: true + enabled: + $ref: '#/components/schemas/teamsDevicesIpProfileEnabled' + match: + $ref: '#/components/schemas/teamsDevicesIpProfileMatch' + name: + $ref: '#/components/schemas/teamsDevicesIpProfileName' + precedence: + $ref: '#/components/schemas/teamsDevicesIpProfilePrecedence' + subnet_id: + $ref: '#/components/schemas/teamsDevicesIpProfileSubnetId' + type: object + teamsDevicesIpProfileUpdatedAt: + description: The RFC3339Nano timestamp when the Device IP profile was last updated. + example: '2025-02-14T13:17:00.123456789Z' + type: string + teamsDevicesJustification: + description: Reasoning for setting the Global WARP override state. This will be surfaced in the audit log. + example: Turning off WARP for testing purposes. + type: string + x-auditable: true + teamsDevicesKey: + description: The device's public key. + example: yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc= + type: string + teamsDevicesKeyType: + description: Type of the key. + example: curve25519 + type: string + x-auditable: true + teamsDevicesLanAllowMinutes: + description: The amount of time in minutes a user is allowed access to their LAN. A value of 0 will allow LAN access until the next WARP reconnection, such as a reboot or a laptop waking from sleep. Note that this field is omitted from the response if null or unset. + example: 30 + type: number + teamsDevicesLanAllowSubnetSize: + description: The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset. + example: 24 + type: number + teamsDevicesLastSeen: + description: When the device last connected to Cloudflare services. + example: '2017-06-14T00:00:00Z' + format: date-time + type: string + x-auditable: true + teamsDevicesMacAddress: + description: The device mac address. + example: 00-00-5E-00-53-00 + type: string + x-auditable: true + teamsDevicesManufacturer: + description: The device manufacturer name. + example: My phone corp + type: string + teamsDevicesMatch: + description: The conditions that the client must match to run the rule. + items: + $ref: '#/components/schemas/teamsDevicesMatchItem' + type: array + teamsDevicesMatchItem: + properties: + platform: + $ref: '#/components/schemas/teamsDevicesPlatform' + type: object + teamsDevicesMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + teamsDevicesModel: + description: The device model name. + example: MyPhone(pro-X) + type: string + teamsDevicesName: + description: The name of the device posture rule. + example: Admin Serial Numbers + type: string + x-auditable: true + teamsDevicesOsDistroName: + description: The Linux distro name. + example: ubuntu + type: string + x-auditable: true + teamsDevicesOsDistroRevision: + description: The Linux distro revision. + example: 1.0.0 + type: string + x-auditable: true + teamsDevicesOsVersion: + description: The operating system version. + example: 10.0.0 + type: string + teamsDevicesOsVersionExtra: + description: Additional operating system version details. For Windows, the UBR (Update Build Revision). For Mac or iOS, the Product Version Extra. For Linux, the distribution name and version. + example: (a) or 6889 or Ubuntu 24.04 + type: string + teamsDevicesOverrideCodes: + properties: + disable_for_time: + type: object + type: object + teamsDevicesOverrideCodesResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + nullable: true + type: array + properties: + disable_for_time: + $ref: '#/components/schemas/teamsDevicesDisableForTime' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesPaginationInfo: + example: + count: 1 + page: 1 + per_page: 10 + total_count: 10 + total_pages: 1 + properties: + count: + description: Number of records in the response. + type: integer + page: + description: The page size number of the response. + type: integer + per_page: + description: The limit for the number of records in the response. + type: integer + total_count: + description: Total number of records available. + type: integer + total_pages: + description: Total number of pages available. + type: integer + required: + - page + - per_page + - count + - total_count + type: object + teamsDevicesPaths: + description: List of paths to check for client certificate on linux. + example: + - /path1 + - /path2 + items: + type: string + type: array + teamsDevicesPhysicalDevice: + description: A WARP Device. + properties: + active_registrations: + description: The number of active registrations for the device. Active registrations are those which haven't been revoked or deleted. + example: 1 + type: integer + x-auditable: true + client_version: + description: Version of the WARP client. + example: 1.0.0 + nullable: true + type: string + x-auditable: true + created_at: + description: The RFC3339 timestamp when the device was created. + example: '2025-02-14T13:17:00Z' + type: string + x-auditable: true + readOnly: true + deleted_at: + description: The RFC3339 timestamp when the device was deleted. + example: '2025-02-14T13:17:00Z' + nullable: true + type: string + x-auditable: true + readOnly: true + device_type: + description: The device operating system. + example: linux + nullable: true + type: string + x-auditable: true + hardware_id: + description: A string that uniquely identifies the hardware or virtual machine (VM). + nullable: true + type: string + x-auditable: true + id: + description: The unique ID of the device. + example: fc9ab6ab-3b94-4319-9941-459462b3d73e + type: string + x-auditable: true + last_seen_at: + description: The RFC3339 timestamp when the device was last seen. + example: '2025-02-14T13:17:00Z' + nullable: true + type: string + x-auditable: true + last_seen_registration: + description: The last seen registration for the device. + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesRegistrationDetails' + last_seen_user: + description: The last user to use the WARP device. + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesUser' + mac_address: + description: The device MAC address. + example: f5:01:73:cf:12:23 + nullable: true + type: string + x-auditable: true + manufacturer: + description: The device manufacturer. + example: ACME + nullable: true + type: string + x-auditable: true + model: + description: The model name of the device. + example: Mark VII + nullable: true + type: string + x-auditable: true + name: + description: The name of the device. + example: My Device + type: string + x-auditable: true + os_version: + description: The device operating system version number. + nullable: true + type: string + x-auditable: true + os_version_extra: + description: Additional operating system version details. For Windows, the UBR (Update Build Revision). For Mac or iOS, the Product Version Extra. For Linux, the distribution name and version. + nullable: true + type: string + x-auditable: true + public_ip: + deprecated: true + description: '**Deprecated**: IP information is provided by DEX - see https://developers.cloudflare.com/api/resources/zero_trust/subresources/dex/subresources/fleet_status/subresources/devices/methods/list/' + example: 1.1.1.1 + nullable: true + type: string + x-auditable: true + serial_number: + description: The device serial number. + example: ABS765ASD8A + nullable: true + type: string + x-auditable: true + updated_at: + description: The RFC3339 timestamp when the device was last updated. + example: '2025-02-14T13:17:00Z' + type: string + x-auditable: true + readOnly: true + required: + - id + - name + - created_at + - updated_at + - last_seen_at + - active_registrations + type: object + teamsDevicesPlatform: + enum: + - windows + - mac + - linux + - android + - ios + - chromeos + example: windows + type: string + x-auditable: true + teamsDevicesPolicySummary: + description: The device settings profile assigned to this registration. + properties: + default: + description: Whether the device settings profile is the default profile for the account. + type: boolean + deleted: + description: Whether the device settings profile was deleted. + type: boolean + id: + description: The ID of the device settings profile. + example: 11ffb86f-3f0c-4306-b4a2-e62f872b166a + type: string + name: + description: The name of the device settings profile. + type: string + updated_at: + description: The RFC3339 timestamp of when the device settings profile last changed for the registration. + example: '2025-02-14T13:17:00Z' + type: string + readOnly: true + required: + - id + - name + - updated_at + - default + - deleted + type: object + teamsDevicesPrecedence: + description: The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field. + example: 100 + type: number + teamsDevicesRegisterInterfaceIpWithDns: + default: true + description: Determines if the operating system will register WARP's local interface IP with your on-premises DNS server. + example: true + type: boolean + teamsDevicesRegistration: + description: A WARP configuration tied to a single user. Multiple registrations can be created from a single WARP device. + properties: + created_at: + description: The RFC3339 timestamp when the registration was created. + example: '2025-02-14T13:17:00Z' + type: string + x-auditable: true + readOnly: true + deleted_at: + description: The RFC3339 timestamp when the registration was deleted. + example: '2025-02-14T13:17:00Z' + nullable: true + type: string + x-auditable: true + readOnly: true + device: + $ref: '#/components/schemas/teamsDevicesRegistrationDeviceDetails' + id: + description: The ID of the registration. + example: 11ffb86f-3f0c-4306-b4a2-e62f872b166a + type: string + x-auditable: true + key: + description: The public key used to connect to the Cloudflare network. + example: U+QTP50RsWfeLGHF4tlGDnmGeuwtsz46KCHr5OyhWq00Rsdfl45mgnQAuEJ6CO0YrkyTl9FUf5iB0bwYR3g4EEFEHhtu6jFaqfMrBMBSz6itv9HQXkaR9OieKQ== + type: string + x-auditable: true + key_type: + description: The type of encryption key used by the WARP client for the active key. Currently 'curve25519' for WireGuard and 'secp256r1' for MASQUE. + example: secp256r1 + nullable: true + type: string + x-auditable: true + last_seen_at: + description: The RFC3339 timestamp when the registration was last seen. + example: '2025-02-14T13:17:00Z' + type: string + x-auditable: true + policy: + $ref: '#/components/schemas/teamsDevicesPolicySummary' + revoked_at: + description: The RFC3339 timestamp when the registration was revoked. + example: '2025-02-14T13:17:00Z' + nullable: true + type: string + x-auditable: true + tunnel_type: + description: Type of the tunnel - wireguard or masque. + example: masque + nullable: true + type: string + x-auditable: true + updated_at: + description: The RFC3339 timestamp when the registration was last updated. + example: '2025-02-14T13:17:00Z' + type: string + x-auditable: true + readOnly: true + user: + $ref: '#/components/schemas/teamsDevicesUser' + required: + - id + - key + - device + - created_at + - updated_at + - last_seen_at + type: object + teamsDevicesRegistrationDetails: + description: The summary of a registration. + properties: + policy: + description: A summary of the device profile evaluated for the registration. + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesPolicySummary' + type: object + teamsDevicesRegistrationDeviceDetails: + description: Device details embedded inside of a registration. + properties: + client_version: + description: Version of the WARP client. + example: 1.0.0 + type: string + x-auditable: true + id: + description: The ID of the device. + example: 32aa0404-78f1-49a4-99e0-97f575081356 + type: string + x-auditable: true + name: + description: The name of the device. + example: My Device + type: string + x-auditable: true + required: + - id + - name + type: object + teamsDevicesRegistrationId: + description: Registration ID. Equal to Device ID except for accounts which enabled [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/). + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + teamsDevicesRequireAll: + description: Whether to check all disks for encryption. + example: true + type: boolean + x-auditable: true + teamsDevicesResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDevicePostureRules' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + teamsDevicesRevokeDevicesRequest: + description: A list of Registration IDs to revoke. + items: + $ref: '#/components/schemas/teamsDevicesRegistrationId' + maxLength: 200 + type: array + teamsDevicesRevokedAt: + description: When the device was revoked. + example: '2017-06-14T00:00:00Z' + format: date-time + type: string + x-auditable: true + teamsDevicesSccmVpnBoundarySupport: + default: false + description: Determines whether the WARP client indicates to SCCM that it is inside a VPN boundary. (Windows only). + example: false + type: boolean + teamsDevicesSchedule: + description: 'Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.' + example: 1h + type: string + x-auditable: true + teamsDevicesSchemasConfigRequest: + description: The configuration object containing information for the WARP client to detect the managed network. + example: + sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c + tls_sockaddr: foo.bar:1234 + type: object + $ref: '#/components/schemas/teamsDevicesTlsConfigRequest' + teamsDevicesSchemasConfigResponse: + description: The configuration object containing information for the WARP client to detect the managed network. + example: + sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c + tls_sockaddr: foo.bar:1234 + type: object + $ref: '#/components/schemas/teamsDevicesTlsConfigResponse' + teamsDevicesSchemasDescription: + description: A description of the policy. + example: Policy for test teams. + maxLength: 500 + type: string + teamsDevicesSchemasIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesSchemasMatch: + description: 'The wirefilter expression to match devices. Available values: "identity.email", "identity.groups.id", "identity.groups.name", "identity.groups.email", "identity.service_token_uuid", "identity.saml_attributes", "network", "os.name", "os.version".' + example: identity.email == "test@cloudflare.com" + maxLength: 500 + type: string + teamsDevicesSchemasName: + description: The device name. + example: My mobile device + type: string + teamsDevicesSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesDevicePostureIntegrations' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesDevicePostureIntegrations' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesSchemasType: + description: The type of device posture integration. + enum: + - workspace_one + - crowdstrike_s2s + - uptycs + - intune + - kolide + - tanium_s2s + - sentinelone_s2s + - custom_s2s + example: workspace_one + type: string + x-auditable: true + teamsDevicesSchemasUuid: + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + teamsDevicesSerialNumber: + description: The device serial number. + example: EXAMPLEHMD6R + type: string + teamsDevicesServiceModeV2: + properties: + mode: + description: The mode to run the WARP client under. + example: proxy + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + port: + description: The port number when used with proxy mode. + example: 3000 + type: number + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + x-stainless-terraform-configurability: computed_optional + teamsDevicesSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesDevicePostureRules' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + teamsDevicesSplitTunnel: + type: object + properties: + address: + $ref: '#/components/schemas/teamsDevicesSplitTunnelAddress' + description: + $ref: '#/components/schemas/teamsDevicesSplitTunnelDescription' + host: + $ref: '#/components/schemas/teamsDevicesSplitTunnelHost' + required: [] + teamsDevicesSplitTunnelAddress: + description: The address in CIDR format to exclude from the tunnel. If `address` is present, `host` must not be present. + example: 192.0.2.0/24 + type: string + x-stainless-terraform-configurability: computed_optional + teamsDevicesSplitTunnelDescription: + description: A description of the Split Tunnel item, displayed in the client UI. + example: Exclude testing domains from the tunnel + maxLength: 100 + type: string + x-stainless-terraform-configurability: computed_optional + teamsDevicesSplitTunnelHost: + description: The domain name to exclude from the tunnel. If `host` is present, `address` must not be present. + example: '*.example.com' + type: string + x-stainless-terraform-configurability: computed_optional + teamsDevicesSplitTunnelInclude: + type: object + properties: + address: + $ref: '#/components/schemas/teamsDevicesIncludeSplitTunnelAddress' + description: + $ref: '#/components/schemas/teamsDevicesIncludeSplitTunnelDescription' + host: + $ref: '#/components/schemas/teamsDevicesIncludeSplitTunnelHost' + required: [] + teamsDevicesSplitTunnelIncludeResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesSplitTunnelInclude' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesSplitTunnelResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + items: + type: object + $ref: '#/components/schemas/teamsDevicesSplitTunnel' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/teamsDevicesResultInfo' + required: + - success + - errors + - messages + - result + teamsDevicesSupportUrl: + default: '' + description: The URL to launch when the Send Feedback button is clicked. + example: https://1.1.1.1/help + type: string + teamsDevicesSwitchLocked: + default: false + description: Whether to allow the user to turn off the WARP switch and disconnect the client. + example: true + type: boolean + teamsDevicesTargetDexTest: + properties: + id: + description: The id of the DEX test targeting this policy. + type: string + name: + description: The name of the DEX test targeting this policy. + type: string + type: object + teamsDevicesTargetEnvironmentInfo: + properties: + display_name: + description: A human-readable name for the target environment. + example: Windows + type: string + target_environment: + description: The target environment identifier. + example: windows + type: string + required: + - target_environment + - display_name + type: object + teamsDevicesTimestamp: + description: When the Global WARP override state was updated. + example: '1970-01-01T00:00:00.000Z' + format: date-time + type: string + x-auditable: true + teamsDevicesTlsConfigRequest: + properties: + sha256: + description: The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate. + example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c + type: string + tls_sockaddr: + description: A network address of the form "host:port" that the WARP client will use to detect the presence of a TLS host. + example: foobar:1234 + type: string + required: + - tls_sockaddr + type: object + teamsDevicesTlsConfigResponse: + description: The Managed Network TLS Config Response. + properties: + sha256: + description: The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate. + example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c + type: string + tls_sockaddr: + description: A network address of the form "host:port" that the WARP client will use to detect the presence of a TLS host. + example: foobar:1234 + type: string + x-auditable: true + required: + - tls_sockaddr + type: object + teamsDevicesTrustStores: + description: List of trust stores to check for client certificate. + example: + - system + - user + items: + $ref: '#/components/schemas/teamsDevicesTrustStoresEnum' + type: array + teamsDevicesTrustStoresEnum: + enum: + - system + - user + type: string + x-auditable: true + teamsDevicesTunnelProtocol: + default: '' + description: Determines which tunnel protocol to use. + example: wireguard + type: string + teamsDevicesTunnelType: + description: Type of the tunnel connection used. + example: masque + type: string + x-auditable: true + teamsDevicesType: + description: The type of device posture rule. + enum: + - file + - application + - tanium + - gateway + - warp + - disk_encryption + - serial_number + - sentinelone + - carbonblack + - firewall + - os_version + - domain_joined + - client_certificate + - client_certificate_v2 + - antivirus + - unique_client_id + - kolide + - tanium_s2s + - crowdstrike_s2s + - intune + - workspace_one + - sentinelone_s2s + - custom_s2s + example: file + type: string + x-auditable: true + teamsDevicesUnrevokeDevicesRequest: + description: A list of Registration IDs to unrevoke. + items: + $ref: '#/components/schemas/teamsDevicesRegistrationId' + maxLength: 200 + type: array + teamsDevicesUpdated: + description: When the device was updated. + example: '2017-06-14T00:00:00Z' + format: date-time + type: string + x-auditable: true + teamsDevicesUser: + properties: + email: + $ref: '#/components/schemas/teamsDevicesEmail' + id: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasUuid' + name: + description: The enrolled device user's name. + example: John Appleseed + type: string + type: object + teamsDevicesUuid: + description: API UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + teamsDevicesV4ResponseMessage: + description: A message which can be returned in either the 'errors' or 'messages' fields in a v4 API response. + properties: + code: + type: integer + message: + type: string + required: + - code + - message + type: object + teamsDevicesVersion: + description: The WARP client version. + example: 1.0.0 + type: string + teamsDevicesVersionConfig: + properties: + target_environment: + description: The target environment for the client version (e.g., windows, macos). + example: windows + nullable: true + type: string + x-auditable: true + version: + description: The specific client version to deploy. + example: 2026.5.234.0 + type: string + x-auditable: true + required: + - version + - target_environment + type: object + teamsDevicesVirtualNetworks: + description: Virtual network access settings for the device. + nullable: true + properties: + allowed: + description: List of virtual network IDs the device is allowed to access. When virtual_networks is set, at least one entry is required. + example: + - f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + items: + format: uuid + type: string + minItems: 1 + type: array + uniqueItems: true + default: + description: The default virtual network ID. Must be included in the `allowed` list. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + required: + - allowed + - default + type: object + teamsDevicesWorkspaceOneConfigResponse: + description: The Workspace One Config Response. + properties: + api_url: + description: The Workspace One API URL provided in the Workspace One Admin Dashboard. + example: https://as123.awmdm.com/API + type: string + auth_url: + description: The Workspace One Authorization URL depending on your region. + example: https://na.uemauth.workspaceone.com/connect/token + type: string + client_id: + description: The Workspace One client ID provided in the Workspace One Admin Dashboard. + example: example client id + type: string + required: + - api_url + - auth_url + - client_id + type: object + teamsDevicesZeroTrustAccountDeviceSettings: + properties: + disable_for_time: + description: Sets the time limit, in seconds, that a user can use an override code to bypass WARP. + type: number + external_emergency_signal_enabled: + description: Controls whether the external emergency disconnect feature is enabled. + example: true + type: boolean + external_emergency_signal_fingerprint: + description: The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value. + example: abcd1234567890abcd1234567890abcd1234567890abcd1234567890abcd1234 + type: string + external_emergency_signal_interval: + description: The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds. + example: 5m + type: string + external_emergency_signal_url: + description: The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host. + example: https://192.0.2.1/signal + type: string + gateway_proxy_enabled: + description: Enable gateway proxy filtering on TCP. + example: true + type: boolean + gateway_udp_proxy_enabled: + description: Enable gateway proxy filtering on UDP. + example: true + type: boolean + root_certificate_installation_enabled: + description: Enable installation of cloudflare managed root certificate. + example: true + type: boolean + use_zt_virtual_ip: + description: Enable using CGNAT virtual IPv4. + example: true + type: boolean + type: object + teamsDevicesZeroTrustAccountDeviceSettingsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/teamsDevicesMessages' + messages: + $ref: '#/components/schemas/teamsDevicesMessages' + result: + nullable: true + type: object + $ref: '#/components/schemas/teamsDevicesZeroTrustAccountDeviceSettings' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + tunnelAccountId: + description: Cloudflare account ID + example: 699d98642c564d2e855e9661899b7252 + maxLength: 32 + type: string + x-auditable: true + tunnelAddressFamily: + description: IP address family, either `v4` (IPv4) or `v6` (IPv6) + enum: + - v4 + - v6 + example: v4 + type: string + tunnelApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/tunnelMessages' + messages: + example: [] + $ref: '#/components/schemas/tunnelMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelArch: + description: The cloudflared OS architecture used to establish this connection. + example: linux_amd64 + type: string + tunnelCfdTunnel: + description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + remote_config: + $ref: '#/components/schemas/tunnelRemoteConfig' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + tunnelCfdTunnelResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelCfdTunnel' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelCfdTunnelResponseSingle: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelCfdTunnel' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelClientId: + description: UUID of the Cloudflare Tunnel connector. + example: 1bedc50d-42b3-473c-b108-ff3d10c0d925 + format: uuid + maxLength: 36 + readOnly: true + type: string + x-auditable: true + tunnelClientIdInput: + description: UUID of the Cloudflare Tunnel connector. + example: 1bedc50d-42b3-473c-b108-ff3d10c0d925 + format: uuid + maxLength: 36 + type: string + x-auditable: true + tunnelColoName: + description: The Cloudflare data center used for this connection. + example: DFW + type: string + tunnelComponentsSchemasTunnelId: + description: UUID of the tunnel. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + format: uuid + maxLength: 36 + type: string + x-auditable: true + tunnelConfig: + description: The tunnel configuration and ingress rules. + properties: + ingress: + description: List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel. + items: + $ref: '#/components/schemas/tunnelIngressRule' + minItems: 1 + type: array + originRequest: + $ref: '#/components/schemas/tunnelOriginRequest' + warp-routing: + deprecated: true + description: Enable private network access from WARP users to private network routes. This is enabled if the tunnel has an assigned route. + properties: + enabled: + type: boolean + readOnly: true + type: object + x-stainless-deprecation-message: This field is ignored by cloudflared since version 2023.10.0. + x-stainless-skip: true + type: object + tunnelConfigSrc: + default: local + description: Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard. + enum: + - local + - cloudflare + example: cloudflare + type: string + tunnelConfigVersion: + description: The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard. + type: integer + tunnelConfiguration: + description: Cloudflare Tunnel configuration + properties: + account_id: + $ref: '#/components/schemas/tunnelIdentifier' + config: + $ref: '#/components/schemas/tunnelConfig' + created_at: + $ref: '#/components/schemas/tunnelTimestamp' + readOnly: true + source: + $ref: '#/components/schemas/tunnelSchemasConfigSrc' + tunnel_id: + $ref: '#/components/schemas/tunnelSchemasTunnelId' + version: + $ref: '#/components/schemas/tunnelSchemasConfigVersion' + type: object + tunnelConfigurationResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelSchemasMessages' + messages: + $ref: '#/components/schemas/tunnelSchemasMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/tunnelConfiguration' + required: + - success + - errors + - messages + tunnelConnectionId: + description: UUID of the Cloudflare Tunnel connection. + example: 1bedc50d-42b3-473c-b108-ff3d10c0d925 + format: uuid + maxLength: 36 + readOnly: true + type: string + x-auditable: true + tunnelConnections: + description: The Cloudflare Tunnel connections between your origin and Cloudflare's edge. + items: + $ref: '#/components/schemas/tunnelSchemasConnection' + type: array + tunnelConnectionsDeprecated: + deprecated: true + description: The Cloudflare Tunnel connections between your origin and Cloudflare's edge. + items: + $ref: '#/components/schemas/tunnelSchemasConnection' + type: array + x-stainless-deprecation-message: This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint `/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections` + tunnelConnsActiveAt: + description: Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive. + example: '2009-11-10T23:00:00Z' + format: date-time + type: string + tunnelConnsInactiveAt: + description: Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active. + example: '2009-11-10T23:00:00Z' + format: date-time + type: string + tunnelCreatedAt: + description: Timestamp of when the resource was created. + example: '2021-01-25T18:22:34.317854Z' + format: date-time + readOnly: true + type: string + tunnelDeletedAt: + description: Timestamp of when the resource was deleted. If `null`, the resource has not been deleted. + example: '2009-11-10T23:00:00.000000Z' + format: date-time + readOnly: true + type: string + tunnelEmptyResponse: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelExistedAt: + description: If provided, include only resources that were created (and not deleted) before this time. URL encoded. + example: 2019-10-12T07%3A20%3A50.52Z + format: url-encoded-date-time + type: string + tunnelFeatures: + description: Features enabled for the Cloudflare Tunnel. + items: + example: ha-origin + type: string + type: array + tunnelHaStatus: + description: The HA status of a WARP Connector client. + enum: + - offline + - passive + - active + type: string + x-auditable: true + tunnelHostname: + description: The hostname of the route. + example: office-1.local + type: string + x-auditable: true + tunnelHostnameComment: + description: An optional description of the hostname route. + example: example comment + type: string + x-auditable: true + tunnelHostnameQueryComment: + description: If set, only list hostname routes with the given comment. + example: example%20comment + type: string + tunnelHostnameRoute: + properties: + comment: + $ref: '#/components/schemas/tunnelHostnameComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + hostname: + $ref: '#/components/schemas/tunnelHostname' + id: + $ref: '#/components/schemas/tunnelHostnameRouteId' + tunnel_id: + $ref: '#/components/schemas/tunnelComponentsSchemasTunnelId' + tunnel_name: + $ref: '#/components/schemas/tunnelSchemasTunnelName' + type: object + tunnelHostnameRouteId: + description: The hostname route ID. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + tunnelHostnameRouteResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelHostnameRoute' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelHostnameRouteResponseSingle: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelHostnameRoute' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelIcmpProxyEnabled: + description: A flag to enable the ICMP proxy for the account network. + example: true + type: boolean + x-auditable: true + tunnelIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + tunnelIngressRule: + description: Public hostname + properties: + hostname: + description: Public hostname for this service. + example: tunnel.example.com + type: string + originRequest: + $ref: '#/components/schemas/tunnelOriginRequest' + path: + description: Requests with this path route to this public hostname. + example: subpath + type: string + service: + description: 'Protocol and address of destination server. Supported protocols: http://, https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively can return a HTTP status code http_status:[code] e.g. ''http_status:404''.' + example: https://localhost:8001 + type: string + required: + - hostname + - service + type: object + tunnelIp: + example: 10.1.0.137 + type: string + tunnelIpNetwork: + description: The private IPv4 or IPv6 range connected by the route, in CIDR notation. + example: 172.16.0.0/16 + type: string + x-auditable: true + tunnelIpNetworkEncoded: + description: IP/CIDR range in URL-encoded format + example: 172.16.0.0%2F16 + type: string + tunnelIsDefaultNetwork: + description: If `true`, this virtual network is the default for the account. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + tunnelIsDefaultNetworkOptional: + default: false + description: If `true`, this virtual network is the default for the account. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + tunnelIsPendingReconnect: + description: Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic. + example: false + type: boolean + tunnelManagementResources: + description: Management resources the token will have access to. + enum: + - logs + example: logs + type: string + tunnelMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + tunnelMetadata: + description: Metadata associated with the tunnel. + example: {} + type: object + tunnelOfframpWarpEnabled: + description: A flag to enable WARP to WARP traffic. + example: true + type: boolean + x-auditable: true + tunnelOriginRequest: + description: Configuration parameters for the public hostname specific connection settings between cloudflared and origin server. + properties: + access: + description: For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header. + properties: + audTag: + description: Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API. + items: + type: string + type: array + teamName: + example: zero-trust-organization-name + type: string + required: + - audTag + - teamName + type: object + caPool: + description: Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare. + type: string + connectTimeout: + description: Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout. + example: 10 + type: integer + disableChunkedEncoding: + description: Disables chunked transfer encoding. Useful if you are running a WSGI server. + type: boolean + http2Origin: + description: Attempt to connect to origin using HTTP2. Origin must be configured as https. + type: boolean + httpHostHeader: + description: Sets the HTTP Host header on requests sent to the local service. + type: string + keepAliveConnections: + description: Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections. + example: 100 + type: integer + keepAliveTimeout: + description: Timeout after which an idle keepalive connection can be discarded. + example: 90 + type: integer + matchSNItoHost: + description: Auto configure the Hostname on the origin server certificate. + example: false + type: boolean + x-stainless-naming: + python: + name: match_sni_to_host + noHappyEyeballs: + description: "Disable the \u201Chappy eyeballs\u201D algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols." + example: false + type: boolean + noTLSVerify: + description: Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. + example: false + type: boolean + originServerName: + description: Hostname that cloudflared should expect from your origin server certificate. + type: string + proxyType: + description: 'cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.' + type: string + tcpKeepAlive: + description: The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. + example: 30 + type: integer + tlsTimeout: + description: Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. + example: 10 + type: integer + type: object + tunnelPageNumber: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + tunnelPerPage: + description: Number of results to display. + maximum: 1000 + minimum: 1 + type: number + tunnelRemoteConfig: + deprecated: true + description: If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine. + example: true + type: boolean + x-auditable: true + x-stainless-deprecation-message: Use the config_src field instead. + x-stainless-ignore: true + tunnelResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + tunnelRoute: + properties: + comment: + $ref: '#/components/schemas/tunnelRouteComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelRouteId' + network: + $ref: '#/components/schemas/tunnelIpNetwork' + tunnel_id: + $ref: '#/components/schemas/tunnelTunnelId' + virtual_network_id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + type: object + tunnelRouteComment: + default: '' + description: Optional remark describing the route. + example: Example comment for this route. + maxLength: 100 + type: string + x-auditable: true + tunnelRouteId: + description: UUID of the route. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + tunnelRouteResponseSingle: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelRoute' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelRunAt: + description: Timestamp of when the tunnel connection was started. + example: '2009-11-10T23:00:00Z' + format: date-time + type: string + tunnelSchemasApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/tunnelSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/tunnelSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelSchemasConfigSrc: + description: Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel's configuration on the Zero Trust dashboard. + enum: + - local + - cloudflare + example: cloudflare + type: string + x-stainless-terraform-configurability: computed_optional + tunnelSchemasConfigVersion: + description: The version of the Tunnel Configuration. + type: integer + tunnelSchemasConnection: + properties: + client_id: + $ref: '#/components/schemas/tunnelClientId' + client_version: + $ref: '#/components/schemas/tunnelVersion' + colo_name: + $ref: '#/components/schemas/tunnelColoName' + id: + $ref: '#/components/schemas/tunnelConnectionId' + is_pending_reconnect: + $ref: '#/components/schemas/tunnelIsPendingReconnect' + opened_at: + description: Timestamp of when the connection was established. + example: '2021-01-25T18:22:34.317854Z' + format: date-time + type: string + origin_ip: + description: The public IP address of the host running cloudflared. + $ref: '#/components/schemas/tunnelIp' + uuid: + $ref: '#/components/schemas/tunnelConnectionId' + type: object + tunnelSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + tunnelSchemasTunnelId: + description: UUID of the tunnel. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + format: uuid + maxLength: 36 + readOnly: true + type: string + tunnelSchemasTunnelName: + description: A user-friendly name for a tunnel. + example: api-tunnel + type: string + tunnelSchemasWarpConnectorConnection: + properties: + client_id: + $ref: '#/components/schemas/tunnelClientId' + client_version: + $ref: '#/components/schemas/tunnelVersion' + colo_name: + $ref: '#/components/schemas/tunnelColoName' + id: + $ref: '#/components/schemas/tunnelConnectionId' + opened_at: + description: Timestamp of when the connection was established. + example: '2021-01-25T18:22:34.317854Z' + format: date-time + type: string + origin_ip: + description: The public IP address of the host running WARP Connector. + $ref: '#/components/schemas/tunnelIp' + type: object + tunnelStatus: + description: The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). + enum: + - inactive + - degraded + - healthy + - down + example: healthy + type: string + tunnelSubnet: + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelSubnetId' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + subnet_type: + $ref: '#/components/schemas/tunnelSubnetType' + type: object + tunnelSubnetComment: + default: '' + description: An optional description of the subnet. + example: example comment + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + tunnelSubnetId: + description: The UUID of the subnet. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + tunnelSubnetIpNetwork: + description: The private IPv4 or IPv6 range defining the subnet, in CIDR notation. + example: 100.64.0.0/12 + type: string + x-auditable: true + tunnelSubnetIsDefaultNetwork: + default: false + description: If `true`, this is the default subnet for the account. There can only be one default subnet per account. + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + tunnelSubnetName: + description: A user-friendly name for the subnet. + example: IPv4 Cloudflare Source IPs + type: string + x-auditable: true + tunnelSubnetQueryComment: + description: If set, only list subnets with the given comment. + example: example%20comment + type: string + tunnelSubnetQueryName: + description: If set, only list subnets with the given name + example: IPv4%20Cloudflare%20Source%20IPs + type: string + tunnelSubnetResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelSubnet' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelSubnetResponseSingle: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelSubnet' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelSubnetResponseSingleNullable: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + nullable: true + properties: + comment: + $ref: '#/components/schemas/tunnelSubnetComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelSubnetId' + is_default_network: + $ref: '#/components/schemas/tunnelSubnetIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelSubnetName' + network: + $ref: '#/components/schemas/tunnelSubnetIpNetwork' + subnet_type: + $ref: '#/components/schemas/tunnelSubnetType' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelSubnetType: + description: The type of subnet. + enum: + - cloudflare_source + - warp + example: cloudflare_source + type: string + x-auditable: true + tunnelTeamnet: + properties: + comment: + $ref: '#/components/schemas/tunnelRouteComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelRouteId' + network: + $ref: '#/components/schemas/tunnelIpNetwork' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + tunnel_id: + $ref: '#/components/schemas/tunnelTunnelId' + tunnel_name: + $ref: '#/components/schemas/tunnelTunnelName' + virtual_network_id: + $ref: '#/components/schemas/tunnelVirtualNetworkIdComputedOptional' + virtual_network_name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + type: object + tunnelTeamnetResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelTeamnet' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelTeamnetResponseSingle: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelTeamnet' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + x-auditable: true + tunnelTunnelClient: + description: A client (typically cloudflared) that maintains connections to a Cloudflare data center. + properties: + arch: + $ref: '#/components/schemas/tunnelArch' + config_version: + $ref: '#/components/schemas/tunnelConfigVersion' + conns: + $ref: '#/components/schemas/tunnelConnections' + features: + $ref: '#/components/schemas/tunnelFeatures' + id: + $ref: '#/components/schemas/tunnelConnectionId' + run_at: + $ref: '#/components/schemas/tunnelRunAt' + version: + $ref: '#/components/schemas/tunnelVersion' + type: object + tunnelTunnelClientResponse: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelTunnelClient' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelTunnelConnectionsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelTunnelClient' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelTunnelId: + description: UUID of the tunnel. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + format: uuid + maxLength: 36 + type: string + x-auditable: true + tunnelTunnelName: + description: A user-friendly name for a tunnel. + example: blog + type: string + tunnelTunnelResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelTunnelResponseCollection_result_item' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelTunnelResponseCollection_result_item: + type: object + description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + config_src: + $ref: '#/components/schemas/tunnelConfigSrc' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + remote_config: + $ref: '#/components/schemas/tunnelRemoteConfig' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + tunnelTunnelResponseToken: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelTunnelToken' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelTunnelSecret: + description: Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string. + example: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg= + type: string + x-sensitive: true + tunnelTunnelToken: + description: The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel. + example: eyJhIjoiNWFiNGU5Z... + readOnly: true + type: string + x-sensitive: true + tunnelTunnelType: + description: The type of tunnel. + enum: + - cfd_tunnel + - warp_connector + - warp + - magic + - ip_sec + - gre + - cni + example: cfd_tunnel + type: string + x-auditable: true + tunnelTunnelTypes: + description: The types of tunnels to filter by, separated by commas. + items: + $ref: '#/components/schemas/tunnelTunnelType' + type: array + tunnelTunnelWarpConnectorClient: + description: A WARP Connector client that maintains a connection to a Cloudflare data center. + properties: + arch: + $ref: '#/components/schemas/tunnelArch' + conns: + $ref: '#/components/schemas/tunnelWarpConnectorConnections' + features: + $ref: '#/components/schemas/tunnelFeatures' + ha_status: + $ref: '#/components/schemas/tunnelHaStatus' + id: + $ref: '#/components/schemas/tunnelClientId' + run_at: + $ref: '#/components/schemas/tunnelRunAt' + version: + $ref: '#/components/schemas/tunnelVersion' + type: object + tunnelTunnelWarpConnectorClientResponse: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelTunnelWarpConnectorClient' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelTunnelWarpConnectorConnectionsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelTunnelWarpConnectorClient' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelVersion: + description: The cloudflared version used to establish this connection. + example: 2022.7.1 + type: string + tunnelVirtualNetwork: + properties: + comment: + $ref: '#/components/schemas/tunnelVirtualNetworkComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + is_default_network: + $ref: '#/components/schemas/tunnelIsDefaultNetwork' + name: + $ref: '#/components/schemas/tunnelVirtualNetworkName' + required: + - id + - name + - is_default_network + - comment + - created_at + type: object + tunnelVirtualNetworkComment: + default: '' + description: Optional remark describing the virtual network. + example: Staging VPC for data science + maxLength: 256 + type: string + x-auditable: true + tunnelVirtualNetworkId: + description: UUID of the virtual network. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + tunnelVirtualNetworkIdComputedOptional: + description: UUID of the virtual network. + example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 + format: uuid + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + tunnelVirtualNetworkName: + description: A user-friendly name for the virtual network. + example: us-east-1-vpc + maxLength: 256 + type: string + x-auditable: true + tunnelVnetResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelVirtualNetwork' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelVnetResponseSingle: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelVirtualNetwork' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelWarpConnectorConnections: + description: The WARP Connector Tunnel connections between your origin and Cloudflare's edge. + items: + $ref: '#/components/schemas/tunnelSchemasWarpConnectorConnection' + type: array + tunnelWarpConnectorResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + items: + $ref: '#/components/schemas/tunnelWarpConnectorTunnel' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/tunnelResultInfo' + required: + - success + - errors + - messages + - result + tunnelWarpConnectorResponseSingle: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + $ref: '#/components/schemas/tunnelWarpConnectorTunnel' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + tunnelWarpConnectorTunnel: + description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge. + properties: + account_tag: + $ref: '#/components/schemas/tunnelAccountId' + connections: + $ref: '#/components/schemas/tunnelConnectionsDeprecated' + conns_active_at: + $ref: '#/components/schemas/tunnelConnsActiveAt' + conns_inactive_at: + $ref: '#/components/schemas/tunnelConnsInactiveAt' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelTunnelId' + metadata: + $ref: '#/components/schemas/tunnelMetadata' + name: + $ref: '#/components/schemas/tunnelTunnelName' + status: + $ref: '#/components/schemas/tunnelStatus' + tun_type: + $ref: '#/components/schemas/tunnelTunnelType' + type: object + tunnelZeroTrustConnectivitySettingsResponse: + properties: + errors: + $ref: '#/components/schemas/tunnelMessages' + messages: + $ref: '#/components/schemas/tunnelMessages' + result: + properties: + icmp_proxy_enabled: + $ref: '#/components/schemas/tunnelIcmpProxyEnabled' + offramp_warp_enabled: + $ref: '#/components/schemas/tunnelOfframpWarpEnabled' + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + unnamedSchemaRef0462afe1a32ee90b1999d4277af59fa8: + items: + type: object + $ref: '#/components/schemas/teamsDevicesSplitTunnel' + nullable: true + type: array + enum: + - null + unnamedSchemaRef055aaf3918bf29f81c09d394a864182e: + description: Specify account settings. + properties: + activity_log: + $ref: '#/components/schemas/zeroTrustGatewayActivityLogSettings' + antivirus: + $ref: '#/components/schemas/zeroTrustGatewayAntiVirusSettings' + block_page: + $ref: '#/components/schemas/zeroTrustGatewayBlockPageSettings' + body_scanning: + $ref: '#/components/schemas/zeroTrustGatewayBodyScanningSettings' + browser_isolation: + $ref: '#/components/schemas/zeroTrustGatewayBrowserIsolationSettings' + certificate: + $ref: '#/components/schemas/zeroTrustGatewayCertificateSettings' + custom_certificate: + $ref: '#/components/schemas/zeroTrustGatewayCustomCertificateSettings' + extended_email_matching: + $ref: '#/components/schemas/zeroTrustGatewayExtendedEmailMatching' + fips: + $ref: '#/components/schemas/zeroTrustGatewayFipsSettings' + host_selector: + $ref: '#/components/schemas/zeroTrustGatewayHostSelectorSettings' + inspection: + $ref: '#/components/schemas/zeroTrustGatewayInspectionSettings' + protocol_detection: + $ref: '#/components/schemas/zeroTrustGatewayProtocolDetection' + sandbox: + $ref: '#/components/schemas/zeroTrustGatewaySandbox' + tls_decrypt: + $ref: '#/components/schemas/zeroTrustGatewayTlsSettings' + type: object + unnamedSchemaRef1b37523fdb0ae5806cd8e062492aab66: + properties: + client_default: + $ref: '#/components/schemas/zeroTrustGatewayClientDefault' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + dns_destination_ips_id: + $ref: '#/components/schemas/zeroTrustGatewayDnsDestinationIpsIdRead' + dns_destination_ipv6_block_id: + $ref: '#/components/schemas/zeroTrustGatewayDnsDestinationIpv6BlockId' + doh_subdomain: + $ref: '#/components/schemas/zeroTrustGatewaySubdomain' + ecs_support: + $ref: '#/components/schemas/zeroTrustGatewayEcsSupport' + endpoints: + $ref: '#/components/schemas/zeroTrustGatewayEndpoints' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + ip: + $ref: '#/components/schemas/zeroTrustGatewayIp' + ipv4_destination: + description: Show the primary destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only. + example: 172.64.36.1 + readOnly: true + type: string + x-stainless-terraform-configurability: computed + ipv4_destination_backup: + description: Show the backup destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only. + example: 172.64.36.2 + readOnly: true + type: string + x-stainless-terraform-configurability: computed + name: + $ref: '#/components/schemas/zeroTrustGatewaySchemasName' + networks: + $ref: '#/components/schemas/zeroTrustGatewayIpv4Networks' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + enum: + - null + unnamedSchemaRef1fbf91ecd61792c751fead58dc8005e6: + items: + type: object + $ref: '#/components/schemas/teamsDevicesFallbackDomain' + nullable: true + type: array + enum: + - null + unnamedSchemaRef34ef0ad73a63c3f76ed170adca181930: + description: Operator. + enum: + - < + - <= + - '>' + - '>=' + - == + example: '>' + type: string + unnamedSchemaRef41885dd46b9e0294254c49305a273681: + description: Operating system. + enum: + - windows + - linux + - mac + example: mac + type: string + x-auditable: true + unnamedSchemaRef4753ee81779d0e57189420079abab61e: + enum: + - null + type: object + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + ips: + $ref: '#/components/schemas/zeroTrustGatewayIps' + kind: + description: The proxy endpoint kind + enum: + - ip + example: ip + type: string + x-auditable: true + name: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasName' + subdomain: + $ref: '#/components/schemas/zeroTrustGatewaySchemasSubdomain' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + required: + - name + unnamedSchemaRef5e0c6134a624678286f4a424b001870a: + items: + type: object + $ref: '#/components/schemas/teamsDevicesSplitTunnelInclude' + nullable: true + type: array + enum: + - null + unnamedSchemaRef6a02fe18089d53b52b2cd3949b717919: + properties: + country: + example: US + type: string + type: object + unnamedSchemaRef9e35ef84511131488ae286ce78ac4b27: + nullable: true + type: object + properties: + description: + $ref: '#/components/schemas/teamsDevicesDescription' + expiration: + $ref: '#/components/schemas/teamsDevicesExpiration' + id: + $ref: '#/components/schemas/teamsDevicesUuid' + input: + $ref: '#/components/schemas/teamsDevicesInput' + match: + $ref: '#/components/schemas/teamsDevicesMatch' + name: + $ref: '#/components/schemas/teamsDevicesName' + schedule: + $ref: '#/components/schemas/teamsDevicesSchedule' + type: + $ref: '#/components/schemas/teamsDevicesType' + enum: + - null + unnamedSchemaRefB84b377dfc9454d455b646d4bc9ab507: + nullable: true + type: object + properties: + config: + $ref: '#/components/schemas/teamsDevicesConfigResponse' + id: + $ref: '#/components/schemas/teamsDevicesUuid' + interval: + $ref: '#/components/schemas/teamsDevicesInterval' + name: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasName' + type: + $ref: '#/components/schemas/teamsDevicesSchemasType' + enum: + - null + unnamedSchemaRefBf9e2abcf1b78a6cab8e6e29e2228a11: + properties: + default: + description: Whether the policy is the default for the account + type: boolean + id: + $ref: '#/components/schemas/digitalExperienceMonitoringUuid' + name: + type: string + required: + - id + - name + - default + type: object + unnamedSchemaRefC125d35cbb7f93aab989cd19bd764ed6: + properties: + comment: + $ref: '#/components/schemas/tunnelRouteComment' + created_at: + $ref: '#/components/schemas/tunnelCreatedAt' + readOnly: true + deleted_at: + $ref: '#/components/schemas/tunnelDeletedAt' + readOnly: true + id: + $ref: '#/components/schemas/tunnelRouteId' + network: + $ref: '#/components/schemas/tunnelIpNetwork' + tunnel_id: + $ref: '#/components/schemas/tunnelTunnelId' + virtual_network_id: + $ref: '#/components/schemas/tunnelVirtualNetworkId' + type: object + enum: + - null + unnamedSchemaRefC6200e37c458aaa3c42e6e5b999bc419: + description: The format of the name identifier sent to the SaaS application. + enum: + - id + - email + example: id + type: string + unnamedSchemaRefD2b048663faf5e0cd5c90501b71171de: + nullable: true + type: object + properties: + config: + $ref: '#/components/schemas/teamsDevicesSchemasConfigResponse' + name: + $ref: '#/components/schemas/teamsDevicesDeviceManagedNetworksComponentsSchemasName' + network_id: + $ref: '#/components/schemas/teamsDevicesUuid' + type: + $ref: '#/components/schemas/teamsDevicesComponentsSchemasType' + enum: + - null + unnamedSchemaRefE86eeb84b7e922c35cfb0031a6309f7b: + description: Configure logging settings for each rule type. + properties: + dns: + description: Configure logging settings for DNS firewall. + $ref: '#/components/schemas/zeroTrustGatewayAccountLogOptions' + http: + description: Configure logging settings for HTTP/HTTPS firewall. + $ref: '#/components/schemas/zeroTrustGatewayAccountLogOptions' + l4: + description: Configure logging settings for Network firewall. + $ref: '#/components/schemas/zeroTrustGatewayAccountLogOptions' + type: object + unnamedSchemaRefF636ff9f2cb41ff4b715cf8ed8515581: + nullable: true + type: object + properties: + allow_mode_switch: + $ref: '#/components/schemas/teamsDevicesAllowModeSwitch' + allow_updates: + $ref: '#/components/schemas/teamsDevicesAllowUpdates' + allowed_to_leave: + $ref: '#/components/schemas/teamsDevicesAllowedToLeave' + auto_connect: + $ref: '#/components/schemas/teamsDevicesAutoConnect' + captive_portal: + $ref: '#/components/schemas/teamsDevicesCaptivePortal' + default: + $ref: '#/components/schemas/teamsDevicesDefault' + description: + $ref: '#/components/schemas/teamsDevicesSchemasDescription' + disable_auto_fallback: + $ref: '#/components/schemas/teamsDevicesDisableAutoFallback' + enabled: + default: true + description: Whether the policy will be applied to matching devices. + example: true + type: boolean + exclude: + $ref: '#/components/schemas/teamsDevicesExclude' + exclude_office_ips: + $ref: '#/components/schemas/teamsDevicesExcludeOfficeIps' + fallback_domains: + $ref: '#/components/schemas/teamsDevicesFallbackDomains' + gateway_unique_id: + $ref: '#/components/schemas/teamsDevicesGatewayUniqueId' + include: + $ref: '#/components/schemas/teamsDevicesInclude' + lan_allow_minutes: + $ref: '#/components/schemas/teamsDevicesLanAllowMinutes' + lan_allow_subnet_size: + $ref: '#/components/schemas/teamsDevicesLanAllowSubnetSize' + match: + $ref: '#/components/schemas/teamsDevicesSchemasMatch' + name: + description: The name of the device settings profile. + example: Allow Developers + maxLength: 100 + type: string + policy_id: + $ref: '#/components/schemas/teamsDevicesSchemasUuid' + precedence: + $ref: '#/components/schemas/teamsDevicesPrecedence' + register_interface_ip_with_dns: + $ref: '#/components/schemas/teamsDevicesRegisterInterfaceIpWithDns' + sccm_vpn_boundary_support: + $ref: '#/components/schemas/teamsDevicesSccmVpnBoundarySupport' + service_mode_v2: + $ref: '#/components/schemas/teamsDevicesServiceModeV2' + support_url: + $ref: '#/components/schemas/teamsDevicesSupportUrl' + switch_locked: + $ref: '#/components/schemas/teamsDevicesSwitchLocked' + target_tests: + items: + $ref: '#/components/schemas/teamsDevicesTargetDexTest' + type: array + tunnel_protocol: + $ref: '#/components/schemas/teamsDevicesTunnelProtocol' + virtual_networks: + $ref: '#/components/schemas/teamsDevicesVirtualNetworks' + enum: + - null + zeroTrustGatewayAccountLogOptions: + properties: + log_all: + default: false + description: Specify whether to log all requests to this service. + example: false + type: boolean + x-auditable: true + log_blocks: + default: false + description: Specify whether to log only blocking requests to this service. + example: true + type: boolean + x-auditable: true + type: object + zeroTrustGatewayAction: + description: Specify the action to perform when the associated traffic, identity, and device posture expressions either absent or evaluate to `true`. + enum: + - 'on' + - 'off' + - allow + - block + - scan + - noscan + - safesearch + - ytrestricted + - isolate + - noisolate + - override + - l4_override + - egress + - resolve + - quarantine + - redirect + example: allow + type: string + x-auditable: true + zeroTrustGatewayActivityLogSettings: + description: Specify activity log settings. + nullable: true + properties: + enabled: + description: Specify whether to log activity. + example: true + nullable: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayAntiVirusSettings: + description: Specify anti-virus settings. + nullable: true + properties: + enabled_download_phase: + $ref: '#/components/schemas/zeroTrustGatewayEnabledDownloadPhase' + enabled_upload_phase: + $ref: '#/components/schemas/zeroTrustGatewayEnabledUploadPhase' + fail_closed: + $ref: '#/components/schemas/zeroTrustGatewayFailClosed' + notification_settings: + $ref: '#/components/schemas/zeroTrustGatewayNotificationSettings' + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayAppId: + description: Identify this application. Only one application per ID. + type: integer + x-auditable: true + zeroTrustGatewayAppTypeId: + description: Identify the type of this application. Multiple applications can share the same type. Refers to the `id` of a returned application type. + type: integer + x-auditable: true + zeroTrustGatewayAppTypes: + readOnly: true + type: object + properties: + application_type_id: + $ref: '#/components/schemas/zeroTrustGatewayAppTypeId' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/zeroTrustGatewayAppId' + name: + $ref: '#/components/schemas/zeroTrustGatewayAppTypesComponentsSchemasName' + description: + description: Provide a short summary of applications with this type. + example: Applications used to communicate or collaborate in a business setting. + type: string + zeroTrustGatewayAppTypesComponentsSchemasName: + description: Specify the name of the application or application type. + example: Facebook + type: string + x-auditable: true + zeroTrustGatewayAppTypesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayAppTypes' + type: array + required: + - success + - errors + - messages + zeroTrustGatewayApplicationsReviewStatusResponse: + type: object + x-auditable: true + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayApplicationsReviewStatusResponseContent' + required: + - success + - errors + - messages + zeroTrustGatewayApplicationsReviewStatusResponseContent: + properties: + approved_apps: + $ref: '#/components/schemas/zeroTrustGatewayApprovedApps' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + in_review_apps: + $ref: '#/components/schemas/zeroTrustGatewayInReviewApps' + unapproved_apps: + $ref: '#/components/schemas/zeroTrustGatewayUnapprovedApps' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + zeroTrustGatewayApprovedApps: + description: Contains the ids of the approved applications. + items: + type: integer + type: array + x-stainless-collection-type: set + zeroTrustGatewayAuditSshSettingsComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewaySettings' + required: + - success + - errors + - messages + zeroTrustGatewayAuditSshSettingsComponentsSchemasUuid: + description: Identify the seed ID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + zeroTrustGatewayBeta: + description: Indicate whether the category is in beta and subject to change. + example: false + type: boolean + x-auditable: true + zeroTrustGatewayBindingStatus: + description: Indicate the read-only deployment status of the certificate on Cloudflare's edge. Gateway TLS interception can use certificates in the 'available' (previously called 'active') state. + enum: + - pending_deployment + - available + - pending_deletion + - inactive + readOnly: true + type: string + x-auditable: true + zeroTrustGatewayBlockPageSettings: + description: Specify block page layout settings. + nullable: true + properties: + background_color: + description: Specify the block page background color in `#rrggbb` format when the mode is customized_block_page. + type: string + x-auditable: true + enabled: + description: Specify whether to enable the custom block page. + example: true + nullable: true + type: boolean + x-auditable: true + footer_text: + description: Specify the block page footer text when the mode is customized_block_page. + example: --footer-- + type: string + x-auditable: true + header_text: + description: Specify the block page header text when the mode is customized_block_page. + example: --header-- + type: string + x-auditable: true + include_context: + description: Specify whether to append context to target_uri as query parameters. This applies only when the mode is redirect_uri. + type: boolean + x-auditable: true + logo_path: + description: Specify the full URL to the logo file when the mode is customized_block_page. + example: https://logos.com/a.png + type: string + x-auditable: true + mailto_address: + description: Specify the admin email for users to contact when the mode is customized_block_page. + example: admin@example.com + type: string + x-auditable: true + mailto_subject: + description: Specify the subject line for emails created from the block page when the mode is customized_block_page. + example: Blocked User Inquiry + type: string + x-auditable: true + mode: + default: '' + description: Specify whether to redirect users to a Cloudflare-hosted block page or a customer-provided URI. + enum: + - '' + - customized_block_page + - redirect_uri + type: string + x-auditable: true + x-stainless-terraform-configurability: optional + name: + description: Specify the block page title when the mode is customized_block_page. + example: Cloudflare + type: string + x-auditable: true + read_only: + description: Indicate that this setting was shared via the Orgs API and read only for the current account. + nullable: true + readOnly: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed + source_account: + description: Indicate the account tag of the account that shared this setting. + nullable: true + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + suppress_footer: + description: Specify whether to suppress detailed information at the bottom of the block page when the mode is customized_block_page. + example: false + type: boolean + target_uri: + description: Specify the URI to redirect users to when the mode is redirect_uri. + format: uri + type: string + x-auditable: true + version: + description: Indicate the version number of the setting. + example: 1 + nullable: true + readOnly: true + type: integer + x-auditable: true + x-stainless-terraform-configurability: computed + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayBodyScanningSettings: + description: Specify the DLP inspection mode. + nullable: true + properties: + inspection_mode: + description: Specify the inspection mode as either `deep` or `shallow`. + enum: + - deep + - shallow + example: deep + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayBrowserIsolationSettings: + description: Specify Clientless Browser Isolation settings. + nullable: true + properties: + non_identity_enabled: + description: Specify whether to enable non-identity onramp support for Browser Isolation. + example: true + type: boolean + x-auditable: true + url_browser_isolation_enabled: + description: Specify whether to enable Clientless Browser Isolation. + example: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayCategories: + properties: + beta: + $ref: '#/components/schemas/zeroTrustGatewayBeta' + class: + $ref: '#/components/schemas/zeroTrustGatewayClass' + description: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayId' + name: + $ref: '#/components/schemas/zeroTrustGatewayCategoriesComponentsSchemasName' + subcategories: + description: Provide all subcategories for this category. + items: + $ref: '#/components/schemas/zeroTrustGatewaySubcategory' + type: array + readOnly: true + type: object + zeroTrustGatewayCategoriesComponentsSchemasName: + description: Specify the category name. + example: Education + type: string + zeroTrustGatewayCategoriesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayCategories' + type: array + required: + - success + - errors + - messages + zeroTrustGatewayCertificateSettings: + description: Specify certificate settings for Gateway TLS interception. If unset, the Cloudflare Root CA handles interception. + nullable: true + properties: + id: + description: Specify the UUID of the certificate used for interception. Ensure the certificate is available at the edge(previously called 'active'). A nil UUID directs Cloudflare to use the Root CA. + example: d1b364c5-1311-466e-a194-f0e943e0799f + type: string + x-auditable: true + required: + - id + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayCertificates: + properties: + binding_status: + $ref: '#/components/schemas/zeroTrustGatewayBindingStatus' + certificate: + description: Provide the CA certificate (read-only). + example: '-----BEGIN CERTIFICATE-----\nMIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE\n-----END + CERTIFICATE-----\n' + readOnly: true + type: string + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + expires_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + fingerprint: + description: Provide the SHA256 fingerprint of the certificate (read-only). + example: E9:19:49:AA:DD:D8:1E:C1:20:2A:D8:22:BF:A5:F8:FC:1A:F7:10:9F:C7:5B:69:AB:0:31:91:8B:61:B4:BF:1C + readOnly: true + type: string + x-auditable: true + id: + $ref: '#/components/schemas/zeroTrustGatewayUuid' + in_use: + description: Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only). + readOnly: true + type: boolean + x-stainless-terraform-configurability: computed + issuer_org: + description: Indicate the organization that issued the certificate (read-only). + example: Example Inc. + readOnly: true + type: string + x-auditable: true + issuer_raw: + description: Provide the entire issuer field of the certificate (read-only). + example: O=Example Inc.,L=California,ST=San Francisco,C=US + readOnly: true + type: string + x-auditable: true + type: + $ref: '#/components/schemas/zeroTrustGatewayType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + uploaded_on: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + type: object + zeroTrustGatewayCfAccountId: + description: Specify the Cloudflare account ID. + example: 699d98642c564d2e855e9661899b7252 + maxLength: 32 + type: string + zeroTrustGatewayClass: + description: Specify which account types can create policies for this category. `blocked` Blocks unconditionally for all accounts. `removalPending` Allows removal from policies but disables addition. `noBlock` Prevents blocking. + enum: + - free + - premium + - blocked + - removalPending + - noBlock + example: premium + type: string + x-auditable: true + zeroTrustGatewayClientDefault: + default: false + description: Indicate whether this location is the default location. + example: false + type: boolean + x-auditable: true + zeroTrustGatewayComponentsSchemasDescription: + description: Provide a short summary of domains in the category. + example: Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions. + type: string + x-auditable: true + zeroTrustGatewayComponentsSchemasName: + description: Specify the rule name. + example: block bad websites + type: string + x-auditable: true + zeroTrustGatewayComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayLocations' + type: array + required: + - success + - errors + - messages + zeroTrustGatewayComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayRules' + required: + - success + - errors + - messages + zeroTrustGatewayComponentsSchemasUuid: + example: ed35569b41ce4d1facfe683550f54086 + type: string + x-auditable: true + zeroTrustGatewayContents: + description: Actual contents of the PAC file + example: function FindProxyForURL(url, host) { return "DIRECT"; } + type: string + x-auditable: true + zeroTrustGatewayCount: + description: Indicate the number of items in the list. + example: 20 + readOnly: true + type: number + x-stainless-terraform-configurability: computed + zeroTrustGatewayCustomCertificateSettings: + deprecated: true + description: Specify custom certificate settings for BYO-PKI. This field is deprecated; use `certificate` instead. + nullable: true + properties: + binding_status: + description: Indicate the internal certificate status. + example: pending_deployment + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + enabled: + description: Specify whether to enable a custom certificate authority for signing Gateway traffic. + example: true + nullable: true + type: boolean + x-auditable: true + id: + description: Specify the UUID of the certificate (ID from MTLS certificate store). + example: d1b364c5-1311-466e-a194-f0e943e0799f + type: string + x-auditable: true + updated_at: + format: date-time + readOnly: true + type: string + x-stainless-terraform-configurability: computed + required: + - enabled + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayDeletedAt: + description: Indicate the date of deletion, if any. + format: date-time + nullable: true + readOnly: true + type: string + x-stainless-terraform-configurability: computed + zeroTrustGatewayDescription: + description: Provide the list description. + example: The serial numbers for administrators + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayDescriptionItem: + description: Provide the list item description (optional). + example: Austin office IP + minimum: 0 + type: string + zeroTrustGatewayDevicePosture: + default: '' + description: Specify the wirefilter expression used for device posture check. The API automatically formats and sanitizes expressions before storing them. To prevent Terraform state drift, use the formatted expression returned in the API response. + example: any(device_posture.checks.passed[*] in {"1308749e-fcfb-4ebc-b051-fe022b632644"}) + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayDnsDestinationIpsIdRead: + default: 0e4a32c6-6fb8-4858-9296-98f51631e8e6 + description: Indicate the identifier of the pair of IPv4 addresses assigned to this location. + example: 0e4a32c6-6fb8-4858-9296-98f51631e8e6 + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayDnsDestinationIpsIdWrite: + description: Specify the identifier of the pair of IPv4 addresses assigned to this location. When creating a location, if this field is absent or set to null, the pair of shared IPv4 addresses (0e4a32c6-6fb8-4858-9296-98f51631e8e6) is auto-assigned. When updating a location, if this field is absent or set to null, the pre-assigned pair remains unchanged. + example: 0e4a32c6-6fb8-4858-9296-98f51631e8e6 + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayDnsDestinationIpv6BlockId: + description: Specify the UUID of the IPv6 block brought to the gateway so that this location's IPv6 address is allocated from the Bring Your Own IPv6 (BYOIPv6) block rather than the standard Cloudflare IPv6 block. + example: b08f7231-d458-495c-98ef-190604c9ee83 + nullable: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayDnsResolverSettingsV4: + properties: + ip: + description: Specify the IPv4 address of the upstream resolver. + example: 2.2.2.2 + type: string + x-auditable: true + port: + description: Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified. + example: 5053 + type: integer + x-auditable: true + route_through_private_network: + description: Indicate whether to connect to this resolver over a private network. Must set when vnet_id set. + example: true + type: boolean + x-auditable: true + vnet_id: + description: Specify an optional virtual network for this resolver. Uses default virtual network id if omitted. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + type: string + x-auditable: true + required: + - ip + type: object + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayDnsResolverSettingsV6: + properties: + ip: + description: Specify the IPv6 address of the upstream resolver. + example: '2001:DB8::' + type: string + x-auditable: true + port: + description: Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified. + example: 5053 + type: integer + x-auditable: true + route_through_private_network: + description: Indicate whether to connect to this resolver over a private network. Must set when vnet_id set. + example: true + type: boolean + x-auditable: true + vnet_id: + description: Specify an optional virtual network for this resolver. Uses default virtual network id if omitted. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + type: string + x-auditable: true + required: + - ip + type: object + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayDohEndpoint: + properties: + enabled: + description: Indicate whether the DOH endpoint is enabled for this location. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + networks: + $ref: '#/components/schemas/zeroTrustGatewayIpNetworks' + require_token: + description: Specify whether the DOH endpoint requires user identity authentication. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + zeroTrustGatewayDotEndpoint: + properties: + enabled: + description: Indicate whether the DOT endpoint is enabled for this location. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + networks: + $ref: '#/components/schemas/zeroTrustGatewayIpNetworks' + type: object + zeroTrustGatewayEcsSupport: + default: false + description: Indicate whether the location must resolve EDNS queries. + example: false + type: boolean + x-auditable: true + zeroTrustGatewayEmptyResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + required: + - success + - errors + - messages + zeroTrustGatewayEnabled: + default: false + description: Specify whether the rule is enabled. + example: true + type: boolean + x-auditable: true + zeroTrustGatewayEnabledDownloadPhase: + description: Specify whether to enable anti-virus scanning on downloads. + example: false + nullable: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayEnabledUploadPhase: + description: Specify whether to enable anti-virus scanning on uploads. + example: false + nullable: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayEndpoints: + description: Configure the destination endpoints for this location. + nullable: true + properties: + doh: + $ref: '#/components/schemas/zeroTrustGatewayDohEndpoint' + dot: + $ref: '#/components/schemas/zeroTrustGatewayDotEndpoint' + ipv4: + $ref: '#/components/schemas/zeroTrustGatewayIpv4Endpoint' + ipv6: + $ref: '#/components/schemas/zeroTrustGatewayIpv6Endpoint' + required: + - ipv4 + - ipv6 + - doh + - dot + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayExpiration: + description: Defines the expiration time stamp and default duration of a DNS policy. Takes precedence over the policy's `schedule` configuration, if any. This does not apply to HTTP or network policies. Settable only for `dns` rules. + nullable: true + properties: + duration: + description: Defines the default duration a policy active in minutes. Must set in order to use the `reset_expiration` endpoint on this rule. + example: 10 + minimum: 5 + type: integer + x-auditable: true + expired: + description: Indicates whether the policy is expired. + example: false + readOnly: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed + expires_at: + $ref: '#/components/schemas/zeroTrustGatewayTimestamp' + description: Show the timestamp when the policy expires and stops applying. The value must follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets but converts them to the equivalent UTC+00:00 value and returns timestamps with a trailing Z. Expiration policies ignore client timezones and expire globally at the specified expires_at time. + example: '2014-01-01T05:20:20Z' + type: string + x-auditable: true + required: + - expires_at + type: object + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayExtendedEmailMatching: + description: Configures user email settings for firewall policies. When you enable this, the system standardizes email addresses in the identity portion of the rule to match extended email variants in firewall policies. When you disable this setting, the system matches email addresses exactly as you provide them. Enable this setting if your email uses `.` or `+` modifiers. + nullable: true + properties: + enabled: + description: Specify whether to match all variants of user emails (with + or . modifiers) used as criteria in Firewall policies. + example: true + nullable: true + type: boolean + x-auditable: true + read_only: + description: Indicate that this setting was shared via the Orgs API and read only for the current account. + readOnly: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed + source_account: + description: Indicate the account tag of the account that shared this setting. + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + version: + description: Indicate the version number of the setting. + example: 1 + readOnly: true + type: integer + x-auditable: true + x-stainless-terraform-configurability: computed + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayFailClosed: + description: Specify whether to block requests for unscannable files. + example: false + nullable: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayFilters: + description: Specify the protocol or layer to evaluate the traffic, identity, and device posture expressions. Can only contain a single value. + example: + - http + items: + description: Specify the protocol or layer to use. + enum: + - http + - dns + - l4 + - egress + - dns_resolver + example: http + type: string + x-auditable: true + maxItems: 1 + minItems: 1 + type: array + zeroTrustGatewayFipsSettings: + description: Specify FIPS settings. + nullable: true + properties: + tls: + description: Enforce cipher suites and TLS versions compliant with FIPS 140-2. + example: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayGatewayAccount: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + gateway_tag: + $ref: '#/components/schemas/zeroTrustGatewayGatewayTag' + id: + $ref: '#/components/schemas/zeroTrustGatewayCfAccountId' + provider_name: + $ref: '#/components/schemas/zeroTrustGatewayProviderName' + type: object + required: + - success + - errors + - messages + zeroTrustGatewayGatewayAccountConfig: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + type: object + description: Specify account settings. + properties: + settings: + $ref: '#/components/schemas/unnamedSchemaRef055aaf3918bf29f81c09d394a864182e' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + required: + - success + - errors + - messages + zeroTrustGatewayGatewayAccountLoggingSettings: + properties: + redact_pii: + default: false + description: Indicate whether to redact personally identifiable information from activity logging (PII fields include source IP, user email, user ID, device ID, URL, referrer, and user agent). + example: true + type: boolean + x-auditable: true + settings_by_rule_type: + $ref: '#/components/schemas/unnamedSchemaRefE86eeb84b7e922c35cfb0031a6309f7b' + type: object + zeroTrustGatewayGatewayAccountLoggingSettingsResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayGatewayAccountLoggingSettings' + required: + - success + - errors + - messages + zeroTrustGatewayGatewayAccountSettings: + description: Specify account settings. + properties: + settings: + $ref: '#/components/schemas/unnamedSchemaRef055aaf3918bf29f81c09d394a864182e' + type: object + zeroTrustGatewayGatewayTag: + description: Specify the gateway internal ID. + example: f174e90afafe4643bbbc4a0ed4fc8415 + maxLength: 32 + type: string + zeroTrustGatewayGenerateCertRequest: + properties: + validity_period_days: + description: 'Sets the certificate validity period in days (range: 1-10,950 days / ~30 years). Defaults to 1,825 days (5 years). **Important**: This field is only settable during the certificate creation. Certificates becomes immutable after creation - use the `/activate` and `/deactivate` endpoints to manage certificate lifecycle.' + example: 1826 + type: integer + x-auditable: true + type: object + zeroTrustGatewayHostSelectorSettings: + description: Enable host selection in egress policies. + nullable: true + properties: + enabled: + description: Specify whether to enable filtering via hosts for egress policies. + example: false + nullable: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayId: + description: Identify this category. Only one category per ID. + type: integer + x-auditable: true + zeroTrustGatewayIdentity: + default: '' + description: Specify the wirefilter expression used for identity matching. The API automatically formats and sanitizes expressions before storing them. To prevent Terraform state drift, use the formatted expression returned in the API response. + example: any(identity.groups.name[*] in {"finance"}) + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayInReviewApps: + description: Contains the ids of the applications in review. + items: + type: integer + type: array + x-stainless-collection-type: set + zeroTrustGatewayInspectionSettings: + description: Define the proxy inspection mode. + nullable: true + properties: + mode: + description: 'Define the proxy inspection mode. 1. static: Gateway applies static inspection to HTTP on TCP(80). With TLS decryption on, Gateway inspects HTTPS traffic on TCP(443) and UDP(443). 2. dynamic: Gateway applies protocol detection to inspect HTTP and HTTPS traffic on any port. TLS decryption must remain on to inspect HTTPS traffic.' + enum: + - static + - dynamic + example: static + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayIp: + description: Defines the automatically generated IPv6 destination IP assigned to this location. Gateway counts all DNS requests sent to this IP as requests under this location. + example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + zeroTrustGatewayIpNetwork: + properties: + network: + description: Specify the IP address or IP CIDR. + example: 2001:85a3::/64 + type: string + x-auditable: true + required: + - network + type: object + zeroTrustGatewayIpNetworks: + description: Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location. + items: + $ref: '#/components/schemas/zeroTrustGatewayIpNetwork' + nullable: true + type: array + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayIps: + description: Specify the list of CIDRs to restrict ingress connections. + items: + description: Specify an IPv4 or IPv6 CIDR. Limit IPv6 to a maximum of /109 and IPv4 to a maximum of /25. + example: 192.0.2.1/32 + type: string + x-auditable: true + type: array + zeroTrustGatewayIpv4Endpoint: + properties: + enabled: + description: Indicate whether the IPv4 endpoint is enabled for this location. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + type: object + zeroTrustGatewayIpv4Network: + properties: + network: + description: Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24. + example: 192.0.2.1/32 + type: string + x-auditable: true + required: + - network + type: object + zeroTrustGatewayIpv4Networks: + description: Specify the list of network ranges from which requests at this location originate. The list takes effect only if it is non-empty and the IPv4 endpoint is enabled for this location. + items: + $ref: '#/components/schemas/zeroTrustGatewayIpv4Network' + nullable: true + type: array + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayIpv6Endpoint: + properties: + enabled: + description: Indicate whether the IPV6 endpoint is enabled for this location. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + networks: + $ref: '#/components/schemas/zeroTrustGatewayIpv6Networks' + type: object + zeroTrustGatewayIpv6Network: + properties: + network: + description: Specify the IPv6 address or IPv6 CIDR. + example: 2001:85a3::/64 + type: string + x-auditable: true + required: + - network + type: object + zeroTrustGatewayIpv6Networks: + description: Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location. + items: + $ref: '#/components/schemas/zeroTrustGatewayIpv6Network' + nullable: true + type: array + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayItems: + description: Provide the list items. + items: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayDescriptionItem' + value: + $ref: '#/components/schemas/zeroTrustGatewayValue' + type: object + type: array + x-stainless-collection-type: set + zeroTrustGatewayItemsInput: + description: Add items to the list. + items: + properties: + description: + $ref: '#/components/schemas/zeroTrustGatewayDescriptionItem' + value: + $ref: '#/components/schemas/zeroTrustGatewayValue' + type: object + type: array + x-stainless-collection-type: set + zeroTrustGatewayListItemResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Shows the total results returned based on your search parameters. + example: 1 + type: number + page: + description: Show the current page within paginated list of results. + example: 1 + type: number + per_page: + description: Show the number of results per page of results. + example: 20 + type: number + total_count: + description: Show the total results available without any search parameters. + example: 2000 + type: number + type: object + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + type: array + required: + - success + - errors + - messages + zeroTrustGatewayListSingleResponse: + type: object + x-auditable: true + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayLists' + required: + - success + - errors + - messages + zeroTrustGatewayLists: + properties: + count: + $ref: '#/components/schemas/zeroTrustGatewayCount' + x-stainless-naming: + terraform: + property_name: list_count + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + type: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + zeroTrustGatewayLocations: + properties: + client_default: + $ref: '#/components/schemas/zeroTrustGatewayClientDefault' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + dns_destination_ips_id: + $ref: '#/components/schemas/zeroTrustGatewayDnsDestinationIpsIdRead' + dns_destination_ipv6_block_id: + $ref: '#/components/schemas/zeroTrustGatewayDnsDestinationIpv6BlockId' + doh_subdomain: + $ref: '#/components/schemas/zeroTrustGatewaySubdomain' + ecs_support: + $ref: '#/components/schemas/zeroTrustGatewayEcsSupport' + endpoints: + $ref: '#/components/schemas/zeroTrustGatewayEndpoints' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + ip: + $ref: '#/components/schemas/zeroTrustGatewayIp' + ipv4_destination: + description: Show the primary destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only. + example: 172.64.36.1 + readOnly: true + type: string + x-stainless-terraform-configurability: computed + ipv4_destination_backup: + description: Show the backup destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only. + example: 172.64.36.2 + readOnly: true + type: string + x-stainless-terraform-configurability: computed + name: + $ref: '#/components/schemas/zeroTrustGatewaySchemasName' + networks: + $ref: '#/components/schemas/zeroTrustGatewayIpv4Networks' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + zeroTrustGatewayMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + zeroTrustGatewayName: + description: Specify the list name. + example: Admin Serial Numbers + type: string + x-auditable: true + zeroTrustGatewayNotificationSettings: + description: Configure the message the user's device shows during an antivirus scan. + nullable: true + properties: + enabled: + description: Specify whether to enable notifications. + type: boolean + x-auditable: true + include_context: + description: Specify whether to include context information as query parameters. + type: boolean + x-auditable: true + msg: + description: Specify the message to show in the notification. + type: string + x-auditable: true + support_url: + description: Specify a URL that directs users to more information. If unset, the notification opens a block page. + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayPacfile: + properties: + contents: + $ref: '#/components/schemas/zeroTrustGatewayContents' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + slug: + $ref: '#/components/schemas/zeroTrustGatewaySlug' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + url: + $ref: '#/components/schemas/zeroTrustGatewayUrl' + type: object + zeroTrustGatewayPacfilesComponentsSchemasDescription: + description: Detailed description of the PAC file. + example: PAC file for Devops team + type: string + x-auditable: true + zeroTrustGatewayPacfilesComponentsSchemasName: + description: Name of the PAC file. + example: Devops team + type: string + x-auditable: true + zeroTrustGatewayPacfilesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasResponseCollection_result_item' + type: array + required: + - success + - errors + - messages + zeroTrustGatewayPacfilesComponentsSchemasResponseCollection_result_item: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + name: + $ref: '#/components/schemas/zeroTrustGatewayPacfilesComponentsSchemasName' + slug: + $ref: '#/components/schemas/zeroTrustGatewaySlug' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + url: + $ref: '#/components/schemas/zeroTrustGatewayUrl' + type: object + zeroTrustGatewayPacfilesComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayPacfile' + required: + - success + - errors + - messages + zeroTrustGatewayPrecedence: + description: Set the order of your rules. Lower values indicate higher precedence. At each processing phase, evaluate applicable rules in ascending order of this value. Refer to [Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform) to manage precedence via Terraform. + type: integer + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayProtocolDetection: + description: Specify whether to detect protocols from the initial bytes of client traffic. + nullable: true + properties: + enabled: + description: Specify whether to detect protocols from the initial bytes of client traffic. + example: true + nullable: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayProviderName: + description: Specify the provider name (usually Cloudflare). + example: Cloudflare + type: string + zeroTrustGatewayProxyEndpoints: + type: object + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + id: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasUuid' + ips: + $ref: '#/components/schemas/zeroTrustGatewayIps' + kind: + description: The proxy endpoint kind + enum: + - ip + example: ip + type: string + x-auditable: true + name: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpointsComponentsSchemasName' + subdomain: + $ref: '#/components/schemas/zeroTrustGatewaySchemasSubdomain' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + required: + - name + zeroTrustGatewayProxyEndpointsComponentsSchemasName: + description: Specify the name of the proxy endpoint. + example: Devops team + type: string + x-auditable: true + zeroTrustGatewayProxyEndpointsComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpoints' + type: array + required: + - success + - errors + - messages + zeroTrustGatewayProxyEndpointsComponentsSchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayProxyEndpoints' + required: + - success + - errors + - messages + zeroTrustGatewayPublicKey: + description: Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging. + example: 1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA= + type: string + x-auditable: true + zeroTrustGatewayReadOnly: + description: Indicate that this rule is shared via the Orgs API and read only. + readOnly: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed + zeroTrustGatewayReadOnlyTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + zeroTrustGatewayResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayCertificates' + type: array + required: + - success + - errors + - messages + zeroTrustGatewayResultInfo: + properties: + count: + description: Indicate the total number of results for the requested service. + example: 1 + type: number + page: + description: Indicate the current page within a paginated list of results. + example: 1 + type: number + per_page: + description: Indicate the number of results per page. + example: 20 + type: number + total_count: + description: Indicate the total results available without any search parameters. + example: 2000 + type: number + type: object + zeroTrustGatewayRuleSettings: + description: Defines settings for this rule. Settings apply only to specific rule types and must use compatible selectors. If Terraform detects drift, confirm the setting supports your rule type and check whether the API modifies the value. Use API-returned values in your configuration to prevent drift. + properties: + add_headers: + description: Add custom headers to allowed requests as key-value pairs. Use header names as keys that map to arrays of header values. Settable only for `http` rules with the action set to `allow`. + example: + My-Next-Header: + - foo + - bar + X-Custom-Header-Name: + - somecustomvalue + nullable: true + type: object + x-stainless-terraform-configurability: optional + allow_child_bypass: + description: Set to enable MSP children to bypass this rule. Only parent MSP accounts can set this. this rule. Settable for all types of rules. + example: false + nullable: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + audit_ssh: + description: Define the settings for the Audit SSH action. Settable only for `l4` rules with `audit_ssh` action. + nullable: true + properties: + command_logging: + description: Enable SSH command logging. + example: false + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + biso_admin_controls: + description: Configure browser isolation behavior. Settable only for `http` rules with the action set to `isolate`. + properties: + copy: + description: Configure copy behavior. If set to remote_only, users cannot copy isolated content from the remote browser to the local clipboard. If this field is absent, copying remains enabled. Applies only when version == "v2". + enum: + - enabled + - disabled + - remote_only + example: remote_only + type: string + x-auditable: true + dcp: + description: Set to false to enable copy-pasting. Only applies when `version == "v1"`. + type: boolean + x-auditable: true + dd: + description: Set to false to enable downloading. Only applies when `version == "v1"`. + type: boolean + x-auditable: true + dk: + description: Set to false to enable keyboard usage. Only applies when `version == "v1"`. + type: boolean + x-auditable: true + download: + description: Configure download behavior. When set to remote_only, users can view downloads but cannot save them. If this field is absent, downloading remains enabled. Applies only when version == "v2". + enum: + - enabled + - disabled + - remote_only + example: enabled + type: string + x-auditable: true + dp: + description: Set to false to enable printing. Only applies when `version == "v1"`. + example: false + type: boolean + x-auditable: true + du: + description: Set to false to enable uploading. Only applies when `version == "v1"`. + type: boolean + x-auditable: true + keyboard: + description: Configure keyboard usage behavior. If this field is absent, keyboard usage remains enabled. Applies only when version == "v2". + enum: + - enabled + - disabled + example: enabled + type: string + x-auditable: true + paste: + description: Configure paste behavior. If set to remote_only, users cannot paste content from the local clipboard into isolated pages. If this field is absent, pasting remains enabled. Applies only when version == "v2". + enum: + - enabled + - disabled + - remote_only + example: enabled + type: string + x-auditable: true + printing: + description: Configure print behavior. Default, Printing is enabled. Applies only when version == "v2". + enum: + - enabled + - disabled + example: enabled + type: string + x-auditable: true + upload: + description: Configure upload behavior. If this field is absent, uploading remains enabled. Applies only when version == "v2". + enum: + - enabled + - disabled + example: enabled + type: string + x-auditable: true + version: + default: v1 + description: Indicate which version of the browser isolation controls should apply. + enum: + - v1 + - v2 + type: string + x-auditable: true + wm_id: + description: Specify the watermark ID (UUID) to apply to the isolated browser session. When present, enables watermark rendering in the isolated browser. + example: 475345dc-5299-4b6e-8f6a-3d3e4c8e9f1a + format: uuid + maxLength: 36 + minLength: 1 + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + block_page: + description: Configure custom block page settings. If missing or null, use the account settings. Settable only for `http` rules with the action set to `block`. + nullable: true + properties: + include_context: + description: Specify whether to pass the context information as query parameters. + type: boolean + x-auditable: true + target_uri: + description: Specify the URI to which the user is redirected. + format: uri + type: string + x-auditable: true + required: + - target_uri + type: object + x-stainless-terraform-configurability: optional + block_page_enabled: + description: Enable the custom block page. Settable only for `dns` rules with action `block`. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + block_reason: + description: Explain why the rule blocks the request. The custom block page shows this text (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action set to `block`. + example: This website is a security risk + nullable: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + bypass_parent_rule: + description: Set to enable MSP accounts to bypass their parent's rules. Only MSP child accounts can set this. Settable for all types of rules. + example: false + nullable: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: optional + check_session: + description: Configure session check behavior. Settable only for `l4` and `http` rules with the action set to `allow`. + nullable: true + properties: + duration: + description: Sets the required session freshness threshold. The API returns a normalized version of this value. + example: 300s + type: string + x-auditable: true + enforce: + description: Enable session enforcement. + example: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + dns_resolvers: + description: Configure custom resolvers to route queries that match the resolver policy. Unused with 'resolve_dns_through_cloudflare' or 'resolve_dns_internally' settings. DNS queries get routed to the address closest to their origin. Only valid when a rule's action set to 'resolve'. Settable only for `dns_resolver` rules. + nullable: true + properties: + ipv4: + items: + $ref: '#/components/schemas/zeroTrustGatewayDnsResolverSettingsV4' + type: array + ipv6: + items: + $ref: '#/components/schemas/zeroTrustGatewayDnsResolverSettingsV6' + type: array + type: object + x-stainless-terraform-configurability: optional + egress: + description: Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs. Settable only for `egress` rules. + nullable: true + properties: + ipv4: + description: Specify the IPv4 address to use for egress. + example: 192.0.2.2 + type: string + x-auditable: true + ipv4_fallback: + description: Specify the fallback IPv4 address to use for egress when the primary IPv4 fails. Set '0.0.0.0' to indicate local egress via WARP IPs. + example: 192.0.2.3 + type: string + x-auditable: true + ipv6: + description: Specify the IPv6 range to use for egress. + example: 2001:DB8::/64 + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + forensic_copy: + description: Configure whether a copy of the HTTP request will be sent to storage when the rule matches. + nullable: true + properties: + enabled: + description: Enable sending the copy to storage. + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + ignore_cname_category_matches: + description: Ignore category matches at CNAME domains in a response. When off, evaluate categories in this rule against all CNAME domain categories in the response. Settable only for `dns` and `dns_resolver` rules. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + insecure_disable_dnssec_validation: + description: Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE]. Settable only for `dns` rules. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + ip_categories: + description: Enable IPs in DNS resolver category blocks. The system blocks only domain name categories unless you enable this setting. Settable only for `dns` and `dns_resolver` rules. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + ip_indicator_feeds: + description: Indicates whether to include IPs in DNS resolver indicator feed blocks. Default, indicator feeds block only domain names. Settable only for `dns` and `dns_resolver` rules. + example: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + l4override: + description: Send matching traffic to the supplied destination IP address and port. Settable only for `l4` rules with the action set to `l4_override`. + nullable: true + properties: + ip: + description: Defines the IPv4 or IPv6 address. + example: 1.1.1.1 + type: string + x-auditable: true + port: + description: Defines a port number to use for TCP/UDP overrides. + type: integer + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + notification_settings: + description: Configure a notification to display on the user's device when this rule matched. Settable for all types of rules with the action set to `block`. + nullable: true + properties: + enabled: + description: Enable notification. + type: boolean + x-auditable: true + include_context: + description: Indicates whether to pass the context information as query parameters. + type: boolean + x-auditable: true + msg: + description: Customize the message shown in the notification. + type: string + x-auditable: true + support_url: + description: Defines an optional URL to direct users to additional information. If unset, the notification opens a block page. + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + override_host: + description: Defines a hostname for override, for the matching DNS queries. Settable only for `dns` rules with the action set to `override`. + example: example.com + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + override_ips: + description: Defines a an IP or set of IPs for overriding matched DNS queries. Settable only for `dns` rules with the action set to `override`. + example: + - 1.1.1.1 + - 2.2.2.2 + items: + description: Defines the IPv4 or IPv6 address. + example: 1.1.1.1 + type: string + x-auditable: true + nullable: true + type: array + x-stainless-terraform-configurability: computed_optional + payload_log: + description: Configure DLP payload logging. Settable only for `http` rules. + nullable: true + properties: + enabled: + description: Enable DLP payload logging for this rule. + example: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + quarantine: + description: Configure settings that apply to quarantine rules. Settable only for `http` rules. + nullable: true + properties: + file_types: + description: Specify the types of files to sandbox. + items: + enum: + - exe + - pdf + - doc + - docm + - docx + - rtf + - ppt + - pptx + - xls + - xlsm + - xlsx + - zip + - rar + type: string + x-auditable: true + type: array + type: object + x-stainless-terraform-configurability: optional + redirect: + description: Apply settings to redirect rules. Settable only for `http` rules with the action set to `redirect`. + nullable: true + properties: + include_context: + description: Specify whether to pass the context information as query parameters. + type: boolean + x-auditable: true + preserve_path_and_query: + description: Specify whether to append the path and query parameters from the original request to target_uri. + type: boolean + x-auditable: true + target_uri: + description: Specify the URI to which the user is redirected. + format: uri + type: string + x-auditable: true + required: + - target_uri + type: object + x-stainless-terraform-configurability: optional + resolve_dns_internally: + description: Configure to forward the query to the internal DNS service, passing the specified 'view_id' as input. Not used when 'dns_resolvers' is specified or 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dns_resolver` rules. + nullable: true + properties: + fallback: + description: Specify the fallback behavior to apply when the internal DNS response code differs from 'NOERROR' or when the response data contains only CNAME records for 'A' or 'AAAA' queries. + enum: + - none + - public_dns + type: string + x-auditable: true + view_id: + description: Specify the internal DNS view identifier to pass to the internal DNS service. + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + resolve_dns_through_cloudflare: + description: Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot set when 'dns_resolvers' specified or 'resolve_dns_internally' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dns_resolver` rules. + example: true + nullable: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + untrusted_cert: + description: Configure behavior when an upstream certificate is invalid or an SSL error occurs. Settable only for `http` rules with the action set to `allow`. + nullable: true + properties: + action: + description: Defines the action performed when an untrusted certificate seen. The default action an error with HTTP code 526. + enum: + - pass_through + - block + - error + example: error + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + type: object + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayRules: + properties: + action: + $ref: '#/components/schemas/zeroTrustGatewayAction' + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + deleted_at: + $ref: '#/components/schemas/zeroTrustGatewayDeletedAt' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewaySchemasDescription' + device_posture: + $ref: '#/components/schemas/zeroTrustGatewayDevicePosture' + enabled: + $ref: '#/components/schemas/zeroTrustGatewayEnabled' + expiration: + $ref: '#/components/schemas/zeroTrustGatewayExpiration' + filters: + $ref: '#/components/schemas/zeroTrustGatewayFilters' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + identity: + $ref: '#/components/schemas/zeroTrustGatewayIdentity' + name: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasName' + precedence: + $ref: '#/components/schemas/zeroTrustGatewayPrecedence' + read_only: + $ref: '#/components/schemas/zeroTrustGatewayReadOnly' + rule_settings: + $ref: '#/components/schemas/zeroTrustGatewayRuleSettings' + schedule: + $ref: '#/components/schemas/zeroTrustGatewaySchedule' + sharable: + $ref: '#/components/schemas/zeroTrustGatewaySharable' + source_account: + $ref: '#/components/schemas/zeroTrustGatewaySourceAccount' + traffic: + $ref: '#/components/schemas/zeroTrustGatewayTraffic' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + version: + $ref: '#/components/schemas/zeroTrustGatewayVersion' + warning_status: + $ref: '#/components/schemas/zeroTrustGatewayWarningStatus' + required: + - name + - precedence + - enabled + - action + - traffic + - filters + type: object + zeroTrustGatewayRulesComponentsSchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayRules' + type: array + required: + - success + - errors + - messages + zeroTrustGatewaySandbox: + description: Specify whether to enable the sandbox. + nullable: true + properties: + enabled: + description: Specify whether to enable the sandbox. + example: true + nullable: true + type: boolean + x-auditable: true + fallback_action: + description: Specify the action to take when the system cannot scan the file. + enum: + - allow + - block + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewaySchedule: + description: Defines the schedule for activating DNS policies. Settable only for `dns` and `dns_resolver` rules. + nullable: true + properties: + fri: + description: Specify the time intervals when the rule is active on Fridays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Fridays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used. + example: 08:00-12:30,13:30-17:00 + type: string + x-auditable: true + mon: + description: Specify the time intervals when the rule is active on Mondays, in the increasing order from 00:00-24:00(capped at maximum of 6 time splits). If this parameter omitted, the rule is deactivated on Mondays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used. + example: 08:00-12:30,13:30-17:00 + type: string + x-auditable: true + sat: + description: Specify the time intervals when the rule is active on Saturdays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Saturdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used. + example: 08:00-12:30,13:30-17:00 + type: string + x-auditable: true + sun: + description: Specify the time intervals when the rule is active on Sundays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Sundays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used. + example: 08:00-12:30,13:30-17:00 + type: string + x-auditable: true + thu: + description: Specify the time intervals when the rule is active on Thursdays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Thursdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used. + example: 08:00-12:30,13:30-17:00 + type: string + x-auditable: true + time_zone: + description: Specify the time zone for rule evaluation. When a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway always uses the current time for that time zone. When this parameter is omitted, Gateway uses the time zone determined from the user's IP address. Colo time zone is used when the user's IP address does not resolve to a location. + example: America/New York + type: string + x-auditable: true + tue: + description: Specify the time intervals when the rule is active on Tuesdays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Tuesdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used. + example: 08:00-12:30,13:30-17:00 + type: string + x-auditable: true + wed: + description: Specify the time intervals when the rule is active on Wednesdays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Wednesdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used. + example: 08:00-12:30,13:30-17:00 + type: string + x-auditable: true + type: object + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewaySchemasDescription: + description: Specify the rule description. + example: Block bad websites based on their host name. + type: string + x-auditable: true + zeroTrustGatewaySchemasName: + description: Specify the location name. + example: Austin Office Location + type: string + x-auditable: true + zeroTrustGatewaySchemasResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/zeroTrustGatewayResultInfo' + result: + items: + $ref: '#/components/schemas/zeroTrustGatewayLists' + type: array + required: + - success + - errors + - messages + zeroTrustGatewaySchemasSingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayLocations' + required: + - success + - errors + - messages + zeroTrustGatewaySchemasSubdomain: + description: Specify the subdomain to use as the destination in the proxy client. + example: oli3n9zkz5.proxy.cloudflare-gateway.com + readOnly: true + type: string + x-auditable: true + zeroTrustGatewaySchemasType: + description: Specify the list type. + enum: + - SERIAL + - URL + - DOMAIN + - EMAIL + - IP + - CATEGORY + - LOCATION + - DEVICE + - AAGUID + example: SERIAL + type: string + x-auditable: true + zeroTrustGatewaySchemasUuid: + description: Identify the API resource with a UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + zeroTrustGatewaySettings: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + public_key: + $ref: '#/components/schemas/zeroTrustGatewayPublicKey' + seed_id: + $ref: '#/components/schemas/zeroTrustGatewayAuditSshSettingsComponentsSchemasUuid' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + zeroTrustGatewaySharable: + description: Indicate that this rule is sharable via the Orgs API. + readOnly: true + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed + zeroTrustGatewaySingleResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/zeroTrustGatewayCertificates' + required: + - success + - errors + - messages + zeroTrustGatewaySingleResponseWithListItems: + type: object + properties: + errors: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + messages: + $ref: '#/components/schemas/zeroTrustGatewayMessages' + success: + description: Indicate whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + properties: + created_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/zeroTrustGatewayDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewaySchemasUuid' + items: + $ref: '#/components/schemas/zeroTrustGatewayItems' + name: + $ref: '#/components/schemas/zeroTrustGatewayName' + type: + $ref: '#/components/schemas/zeroTrustGatewaySchemasType' + updated_at: + $ref: '#/components/schemas/zeroTrustGatewayReadOnlyTimestamp' + readOnly: true + type: object + required: + - success + - errors + - messages + zeroTrustGatewaySlug: + description: URL-friendly version of the PAC file name. + example: pac_devops + type: string + x-auditable: true + zeroTrustGatewaySourceAccount: + description: Provide the account tag of the account that created the rule. + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + zeroTrustGatewaySubcategory: + properties: + beta: + $ref: '#/components/schemas/zeroTrustGatewayBeta' + class: + $ref: '#/components/schemas/zeroTrustGatewayClass' + description: + $ref: '#/components/schemas/zeroTrustGatewayComponentsSchemasDescription' + id: + $ref: '#/components/schemas/zeroTrustGatewayId' + name: + $ref: '#/components/schemas/zeroTrustGatewayCategoriesComponentsSchemasName' + type: object + zeroTrustGatewaySubdomain: + description: Specify the DNS over HTTPS domain that receives DNS requests. Gateway automatically generates this value. + example: oli3n9zkz5 + readOnly: true + type: string + x-auditable: true + x-stainless-terraform-configurability: computed + zeroTrustGatewayTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + type: string + zeroTrustGatewayTlsSettings: + description: Specify whether to inspect encrypted HTTP traffic. + nullable: true + properties: + enabled: + description: Specify whether to inspect encrypted HTTP traffic. + example: true + type: boolean + x-auditable: true + type: object + x-stainless-terraform-configurability: optional + zeroTrustGatewayTraffic: + default: '' + description: Specify the wirefilter expression used for traffic matching. The API automatically formats and sanitizes expressions before storing them. To prevent Terraform state drift, use the formatted expression returned in the API response. + example: http.request.uri matches ".*a/partial/uri.*" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10 + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + zeroTrustGatewayType: + description: Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed. + enum: + - custom + - gateway_managed + example: gateway_managed + readOnly: true + type: string + x-auditable: true + zeroTrustGatewayUnapprovedApps: + description: Contains the ids of the unapproved applications. + items: + type: integer + type: array + x-stainless-collection-type: set + zeroTrustGatewayUrl: + description: Unique URL to download the PAC file. + example: https://pac.cloudflare-gateway.com/699d98642c564d2e855e9661899b7252/pac_devops + readOnly: true + type: string + x-auditable: true + zeroTrustGatewayUuid: + description: Identify the certificate with a UUID. + example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 + maxLength: 36 + type: string + x-auditable: true + zeroTrustGatewayValue: + description: Specify the item value. + example: 8GE8721REF + type: string + x-auditable: true + zeroTrustGatewayVersion: + description: Indicate the version number of the rule(read-only). + example: 1 + readOnly: true + type: integer + x-auditable: true + x-stainless-terraform-configurability: computed + zeroTrustGatewayWarningStatus: + description: Indicate a warning for a misconfigured rule, if any. + nullable: true + readOnly: true + type: string + x-stainless-terraform-configurability: computed + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + portals: + id: cloudflare.zero_trust.portals + name: portals + title: Portals + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1portals/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1portals/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1portals~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1portals~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1portals~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/portals/methods/get' + - $ref: '#/components/x-stackQL-resources/portals/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/portals/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/portals/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/portals/methods/update' + servers: + id: cloudflare.zero_trust.servers + name: servers + title: Servers + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1servers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1servers/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1servers~1{id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1servers~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1servers~1{id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sync: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1ai-controls~1mcp~1servers~1{id}~1sync/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/servers/methods/get' + - $ref: '#/components/x-stackQL-resources/servers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/servers/methods/sync' + - $ref: '#/components/x-stackQL-resources/servers/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/servers/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/servers/methods/update' + access: + id: cloudflare.zero_trust.access + name: access + title: Access + methods: + update_make_reusable: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1policies~1{policy_id}~1make_reusable/put' + response: + mediaType: application/json + openAPIDocKey: '200' + update_seats: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1seats/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + authenticator_device_aaguids: + id: cloudflare.zero_trust.authenticator_device_aaguids + name: authenticator_device_aaguids + title: Authenticator Device Aaguids + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1authenticator_device_aaguids/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/authenticator_device_aaguids/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bookmarks: + id: cloudflare.zero_trust.bookmarks + name: bookmarks + title: Bookmarks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1bookmarks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1bookmarks~1{bookmark_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1bookmarks~1{bookmark_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1bookmarks~1{bookmark_id}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1bookmarks~1{bookmark_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bookmarks/methods/get' + - $ref: '#/components/x-stackQL-resources/bookmarks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/bookmarks/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/bookmarks/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/bookmarks/methods/update' + custom_pages: + id: cloudflare.zero_trust.custom_pages + name: custom_pages + title: Custom Pages + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1custom_pages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1custom_pages/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1custom_pages~1{custom_page_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1custom_pages~1{custom_page_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1custom_pages~1{custom_page_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_pages/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_pages/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_pages/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/custom_pages/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/custom_pages/methods/update' + gateway_ca: + id: cloudflare.zero_trust.gateway_ca + name: gateway_ca + title: Gateway Ca + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1gateway_ca/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1gateway_ca/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1gateway_ca~1{certificate_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gateway_ca/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/gateway_ca/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/gateway_ca/methods/delete' + replace: [] + scim_groups: + id: cloudflare.zero_trust.scim_groups + name: scim_groups + title: Scim Groups + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1identity_providers~1{identity_provider_id}~1scim~1groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scim_groups/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + scim_users: + id: cloudflare.zero_trust.scim_users + name: scim_users + title: Scim Users + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1identity_providers~1{identity_provider_id}~1scim~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scim_users/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + keys: + id: cloudflare.zero_trust.keys + name: keys + title: Keys + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1keys/put' + response: + mediaType: application/json + openAPIDocKey: '200' + rotate: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1keys~1rotate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/keys/methods/update' + access_requests: + id: cloudflare.zero_trust.access_requests + name: access_requests + title: Access Requests + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1logs~1access_requests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/access_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + updates: + id: cloudflare.zero_trust.updates + name: updates + title: Updates + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1logs~1scim~1updates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/updates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + doh: + id: cloudflare.zero_trust.doh + name: doh + title: Doh + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1organizations~1doh/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1organizations~1doh/put' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/doh/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/doh/methods/update' + access_policies: + id: cloudflare.zero_trust.access_policies + name: access_policies + title: Access Policies + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policies/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policies~1{policy_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policies~1{policy_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policies~1{policy_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/access_policies/methods/list_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/create_by_account' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete_by_account' + replace: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/update_by_account' + policy_tests: + id: cloudflare.zero_trust.policy_tests + name: policy_tests + title: Policy Tests + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policy-tests/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policy-tests~1{policy_test_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policy_tests/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/policy_tests/methods/create' + update: [] + delete: [] + replace: [] + policy_tests_users: + id: cloudflare.zero_trust.policy_tests_users + name: policy_tests_users + title: Policy Tests Users + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1policy-tests~1{policy_test_id}~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policy_tests_users/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + service_tokens: + id: cloudflare.zero_trust.service_tokens + name: service_tokens + title: Service Tokens + methods: + refresh: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1service_tokens~1{service_token_id}~1refresh/post' + response: + mediaType: application/json + openAPIDocKey: '200' + rotate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1service_tokens~1{service_token_id}~1rotate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1service_tokens/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1service_tokens/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1service_tokens/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1service_tokens/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1service_tokens~1{service_token_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1service_tokens~1{service_token_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1service_tokens~1{service_token_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1service_tokens~1{service_token_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1service_tokens~1{service_token_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1service_tokens~1{service_token_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/list_by_zone' + insert: + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/service_tokens/methods/update_by_zone' + tags: + id: cloudflare.zero_trust.tags + name: tags + title: Tags + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1tags/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1tags~1{tag_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1tags~1{tag_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1tags~1{tag_name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/get' + - $ref: '#/components/x-stackQL-resources/tags/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/tags/methods/update' + access_users: + id: cloudflare.zero_trust.access_users + name: access_users + title: Access Users + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/access_users/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + users: + id: cloudflare.zero_trust.users + name: users + title: Users + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_mfa_authenticators: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}~1mfa_authenticators~1{authenticator_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/users/methods/update' + active_sessions: + id: cloudflare.zero_trust.active_sessions + name: active_sessions + title: Active Sessions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}~1active_sessions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}~1active_sessions~1{nonce}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/active_sessions/methods/get' + - $ref: '#/components/x-stackQL-resources/active_sessions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + failed_logins: + id: cloudflare.zero_trust.failed_logins + name: failed_logins + title: Failed Logins + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}~1failed_logins/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/failed_logins/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + last_seen_identity: + id: cloudflare.zero_trust.last_seen_identity + name: last_seen_identity + title: Last Seen Identity + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1users~1{user_id}~1last_seen_identity/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/last_seen_identity/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cloudflared: + id: cloudflare.zero_trust.cloudflared + name: cloudflared + title: Cloudflared + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloudflared/methods/get' + - $ref: '#/components/x-stackQL-resources/cloudflared/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cloudflared/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cloudflared/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/cloudflared/methods/delete' + replace: [] + cfd_tunnel_configurations: + id: cloudflare.zero_trust.cfd_tunnel_configurations + name: cfd_tunnel_configurations + title: Cfd Tunnel Configurations + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}~1configurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}~1configurations/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cfd_tunnel_configurations/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/cfd_tunnel_configurations/methods/update_by_account' + cfd_tunnel: + id: cloudflare.zero_trust.cfd_tunnel + name: cfd_tunnel + title: Cfd Tunnel + methods: + delete_connections: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}~1connections/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + create_management: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}~1management/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + cfd_tunnel_connections: + id: cloudflare.zero_trust.cfd_tunnel_connections + name: cfd_tunnel_connections + title: Cfd Tunnel Connections + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}~1connections/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cfd_tunnel_connections/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cfd_tunnel_connectors: + id: cloudflare.zero_trust.cfd_tunnel_connectors + name: cfd_tunnel_connectors + title: Cfd Tunnel Connectors + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}~1connectors~1{connector_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cfd_tunnel_connectors/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + cfd_tunnel_token: + id: cloudflare.zero_trust.cfd_tunnel_token + name: cfd_tunnel_token + title: Cfd Tunnel Token + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1cfd_tunnel~1{tunnel_id}~1token/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cfd_tunnel_token/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + accounts_devices: + id: cloudflare.zero_trust.accounts_devices + name: accounts_devices + title: Accounts Devices + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1{device_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts_devices/methods/get' + - $ref: '#/components/x-stackQL-resources/accounts_devices/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + client_versions: + id: cloudflare.zero_trust.client_versions + name: client_versions + title: Client Versions + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1client-versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/client_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + target_environments: + id: cloudflare.zero_trust.target_environments + name: target_environments + title: Target Environments + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1client-versions~1target-environments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/target_environments/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + deployment_groups: + id: cloudflare.zero_trust.deployment_groups + name: deployment_groups + title: Deployment Groups + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1deployment-groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1deployment-groups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1deployment-groups~1{group_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1deployment-groups~1{group_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1deployment-groups~1{group_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/deployment_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/deployment_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/deployment_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/deployment_groups/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/deployment_groups/methods/delete' + replace: [] + ip_profiles: + id: cloudflare.zero_trust.ip_profiles + name: ip_profiles + title: Ip Profiles + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1ip-profiles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1ip-profiles/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1ip-profiles~1{profile_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1ip-profiles~1{profile_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1ip-profiles~1{profile_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_profiles/methods/get' + - $ref: '#/components/x-stackQL-resources/ip_profiles/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ip_profiles/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ip_profiles/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/ip_profiles/methods/delete' + replace: [] + networks: + id: cloudflare.zero_trust.networks + name: networks + title: Networks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1networks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + device_managed_networks_delete_device_managed_network: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1networks~1{network_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1networks~1{network_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1networks~1{network_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes~1network~1{ip_network_encoded}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes~1network~1{ip_network_encoded}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/networks/methods/get' + - $ref: '#/components/x-stackQL-resources/networks/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/networks/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/networks/methods/device_managed_networks_delete_device_managed_network' + - $ref: '#/components/x-stackQL-resources/networks/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/networks/methods/update' + devices: + id: cloudflare.zero_trust.devices + name: devices + title: Devices + methods: + create_networks: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1networks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1physical-devices~1{device_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_policy: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update_policy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + unrevoke: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1unrevoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/devices/methods/delete' + replace: [] + devices_physical_devices: + id: cloudflare.zero_trust.devices_physical_devices + name: devices_physical_devices + title: Devices Physical Devices + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1physical-devices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1physical-devices~1{device_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/devices_physical_devices/methods/get' + - $ref: '#/components/x-stackQL-resources/devices_physical_devices/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + physical_devices_revoke: + id: cloudflare.zero_trust.physical_devices_revoke + name: physical_devices_revoke + title: Physical Devices Revoke + methods: + revoke_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1physical-devices~1{device_id}~1revoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + devices_policies: + id: cloudflare.zero_trust.devices_policies + name: devices_policies + title: Devices Policies + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/devices_policies/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + default: + id: cloudflare.zero_trust.default + name: default + title: Default + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/default/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/default/methods/edit' + delete: [] + replace: [] + devices_policy: + id: cloudflare.zero_trust.devices_policy + name: devices_policy + title: Devices Policy + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/devices_policy/methods/get_by_account' + insert: + - $ref: '#/components/x-stackQL-resources/devices_policy/methods/create' + update: [] + delete: [] + replace: [] + excludes_9e6eed: + id: cloudflare.zero_trust.excludes_9e6eed + name: excludes_9e6eed + title: Excludes 9e6eed + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1exclude/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/excludes_9e6eed/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + exclude: + id: cloudflare.zero_trust.exclude + name: exclude + title: Exclude + methods: + devices_set_split_tunnel_exclude_list: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1exclude/put' + response: + mediaType: application/json + openAPIDocKey: '200' + devices_set_split_tunnel_exclude_list_for_a_device_settings_policy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1exclude/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/exclude/methods/devices_set_split_tunnel_exclude_list_for_a_device_settings_policy' + - $ref: '#/components/x-stackQL-resources/exclude/methods/devices_set_split_tunnel_exclude_list' + fallback_domains_f560de: + id: cloudflare.zero_trust.fallback_domains_f560de + name: fallback_domains_f560de + title: Fallback Domains F560de + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1fallback_domains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fallback_domains_f560de/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + fallback_domains: + id: cloudflare.zero_trust.fallback_domains + name: fallback_domains + title: Fallback Domains + methods: + devices_set_local_domain_fallback_list: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1fallback_domains/put' + response: + mediaType: application/json + openAPIDocKey: '200' + devices_set_local_domain_fallback_list_for_a_device_settings_policy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1fallback_domains/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/devices_set_local_domain_fallback_list_for_a_device_settings_policy' + - $ref: '#/components/x-stackQL-resources/fallback_domains/methods/devices_set_local_domain_fallback_list' + includes_73882e: + id: cloudflare.zero_trust.includes_73882e + name: includes_73882e + title: Includes 73882e + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1include/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/includes_73882e/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + include: + id: cloudflare.zero_trust.include + name: include + title: Include + methods: + devices_set_split_tunnel_include_list: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1include/put' + response: + mediaType: application/json + openAPIDocKey: '200' + devices_set_split_tunnel_include_list_for_a_device_settings_policy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1include/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/include/methods/devices_set_split_tunnel_include_list_for_a_device_settings_policy' + - $ref: '#/components/x-stackQL-resources/include/methods/devices_set_split_tunnel_include_list' + excludes_26edfa: + id: cloudflare.zero_trust.excludes_26edfa + name: excludes_26edfa + title: Excludes 26edfa + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1exclude/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/excludes_26edfa/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + fallback_domains_97f458: + id: cloudflare.zero_trust.fallback_domains_97f458 + name: fallback_domains_97f458 + title: Fallback Domains 97f458 + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1fallback_domains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fallback_domains_97f458/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + includes_11848d: + id: cloudflare.zero_trust.includes_11848d + name: includes_11848d + title: Includes 11848d + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1policy~1{policy_id}~1include/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/includes_11848d/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + posture: + id: cloudflare.zero_trust.posture + name: posture + title: Posture + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1{rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/posture/methods/get' + - $ref: '#/components/x-stackQL-resources/posture/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/posture/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/posture/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/posture/methods/update' + posture_integration: + id: cloudflare.zero_trust.posture_integration + name: posture_integration + title: Posture Integration + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1integration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1integration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1integration~1{integration_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1integration~1{integration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/posture_integration/methods/get' + - $ref: '#/components/x-stackQL-resources/posture_integration/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/posture_integration/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/posture_integration/methods/delete' + replace: [] + integrations: + id: cloudflare.zero_trust.integrations + name: integrations + title: Integrations + methods: + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1posture~1integration~1{integration_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1integrations~1{integration_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/integrations/methods/edit' + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/integrations/methods/update' + registrations: + id: cloudflare.zero_trust.registrations + name: registrations + title: Registrations + methods: + bulk_delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1registrations/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1registrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + revoke: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1registrations~1revoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' + unrevoke: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1registrations~1unrevoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1registrations~1{registration_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1registrations~1{registration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/registrations/methods/get' + - $ref: '#/components/x-stackQL-resources/registrations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/registrations/methods/unrevoke' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/registrations/methods/delete' + - $ref: '#/components/x-stackQL-resources/registrations/methods/bulk_delete' + replace: [] + registrations_override_codes: + id: cloudflare.zero_trust.registrations_override_codes + name: registrations_override_codes + title: Registrations Override Codes + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1registrations~1{registration_id}~1override_codes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/registrations_override_codes/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + global_warp_override: + id: cloudflare.zero_trust.global_warp_override + name: global_warp_override + title: Global Warp Override + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1resilience~1disconnect/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1resilience~1disconnect/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/global_warp_override/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/global_warp_override/methods/create' + update: [] + delete: [] + replace: [] + devices_revoke: + id: cloudflare.zero_trust.devices_revoke + name: devices_revoke + title: Devices Revoke + methods: + revoke_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1revoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + devices_settings: + id: cloudflare.zero_trust.devices_settings + name: devices_settings + title: Devices Settings + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1settings/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/devices_settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/devices_settings/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/devices_settings/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/devices_settings/methods/update' + devices_override_codes: + id: cloudflare.zero_trust.devices_override_codes + name: devices_override_codes + title: Devices Override Codes + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1devices~1{device_id}~1override_codes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/devices_override_codes/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + colos: + id: cloudflare.zero_trust.colos + name: colos + title: Colos + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1colos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/colos/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + commands: + id: cloudflare.zero_trust.commands + name: commands + title: Commands + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1commands/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.commands + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1commands/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_downloads: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1commands~1{command_id}~1downloads~1{filename}/get' + response: + mediaType: application/zip + openAPIDocKey: '200' + overrideMediaType: application/json + transform: + body: '[{"contents": {{ toJson . }}}]' + type: golang_template_text_v0.3.0 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commands/methods/get_downloads' + - $ref: '#/components/x-stackQL-resources/commands/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/commands/methods/create' + update: [] + delete: [] + replace: [] + commands_devices: + id: cloudflare.zero_trust.commands_devices + name: commands_devices + title: Commands Devices + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1commands~1devices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.devices + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commands_devices/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + quota: + id: cloudflare.zero_trust.quota + name: quota + title: Quota + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1commands~1quota/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quota/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dex_tests: + id: cloudflare.zero_trust.dex_tests + name: dex_tests + title: Dex Tests + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1devices~1dex_tests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1devices~1dex_tests/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1devices~1dex_tests~1{dex_test_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1devices~1dex_tests~1{dex_test_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1devices~1dex_tests~1{dex_test_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dex_tests/methods/get' + - $ref: '#/components/x-stackQL-resources/dex_tests/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dex_tests/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/dex_tests/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/dex_tests/methods/update' + fleet_status: + id: cloudflare.zero_trust.fleet_status + name: fleet_status + title: Fleet Status + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1devices~1{device_id}~1fleet-status~1live/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fleet_status/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + fleet_status_devices: + id: cloudflare.zero_trust.fleet_status_devices + name: fleet_status_devices + title: Fleet Status Devices + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1fleet-status~1devices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fleet_status_devices/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + fleet_status_live: + id: cloudflare.zero_trust.fleet_status_live + name: fleet_status_live + title: Fleet Status Live + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1fleet-status~1live/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fleet_status_live/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + fleet_status_over_time: + id: cloudflare.zero_trust.fleet_status_over_time + name: fleet_status_over_time + title: Fleet Status Over Time + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1fleet-status~1over-time/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fleet_status_over_time/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + http_tests: + id: cloudflare.zero_trust.http_tests + name: http_tests + title: Http Tests + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1http-tests~1{test_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/http_tests/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + percentiles: + id: cloudflare.zero_trust.percentiles + name: percentiles + title: Percentiles + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1http-tests~1{test_id}~1percentiles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/percentiles/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dex_rules: + id: cloudflare.zero_trust.dex_rules + name: dex_rules + title: Dex Rules + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.rules + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1rules~1{rule_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dex_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/dex_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dex_rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dex_rules/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/dex_rules/methods/delete' + replace: [] + tests: + id: cloudflare.zero_trust.tests + name: tests + title: Tests + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1tests~1overview/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + unique_devices: + id: cloudflare.zero_trust.unique_devices + name: unique_devices + title: Unique Devices + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1tests~1unique-devices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/unique_devices/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + network_path: + id: cloudflare.zero_trust.network_path + name: network_path + title: Network Path + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1traceroute-test-results~1{test_result_id}~1network-path/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_path/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + traceroute_tests: + id: cloudflare.zero_trust.traceroute_tests + name: traceroute_tests + title: Traceroute Tests + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1traceroute-tests~1{test_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/traceroute_tests/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + traceroute_tests_network_path: + id: cloudflare.zero_trust.traceroute_tests_network_path + name: traceroute_tests_network_path + title: Traceroute Tests Network Path + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1traceroute-tests~1{test_id}~1network-path/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/traceroute_tests_network_path/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + traceroute_tests_percentiles: + id: cloudflare.zero_trust.traceroute_tests_percentiles + name: traceroute_tests_percentiles + title: Traceroute Tests Percentiles + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1traceroute-tests~1{test_id}~1percentiles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/traceroute_tests_percentiles/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + warp_change_events: + id: cloudflare.zero_trust.warp_change_events + name: warp_change_events + title: Warp Change Events + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dex~1warp-change-events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warp_change_events/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + datasets: + id: cloudflare.zero_trust.datasets + name: datasets + title: Datasets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + dlp_datasets_define_columns: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1versions~1{version}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/datasets/methods/get' + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/datasets/methods/update' + upload: + id: cloudflare.zero_trust.upload + name: upload + title: Upload + methods: + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1upload/post' + response: + mediaType: application/json + openAPIDocKey: '200' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1upload~1{version}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/upload/methods/edit' + - $ref: '#/components/x-stackQL-resources/upload/methods/create' + update: [] + delete: [] + replace: [] + entries: + id: cloudflare.zero_trust.entries + name: entries + title: Entries + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1datasets~1{dataset_id}~1versions~1{version}~1entries~1{entry_id}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update_custom: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1custom~1{entry_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1{entry_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/entries/methods/create' + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/entries/methods/update' + document_fingerprints: + id: cloudflare.zero_trust.document_fingerprints + name: document_fingerprints + title: Document Fingerprints + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1document_fingerprints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + dlp_document_fingerprints_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1document_fingerprints/post' + response: + mediaType: application/json + openAPIDocKey: '200' + dlp_document_fingerprints_delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1document_fingerprints~1{document_fingerprint_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1document_fingerprints~1{document_fingerprint_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + dlp_document_fingerprints_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1document_fingerprints~1{document_fingerprint_id}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + dlp_document_fingerprints_upload: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1document_fingerprints~1{document_fingerprint_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/document_fingerprints/methods/get' + - $ref: '#/components/x-stackQL-resources/document_fingerprints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/document_fingerprints/methods/dlp_document_fingerprints_update' + - $ref: '#/components/x-stackQL-resources/document_fingerprints/methods/dlp_document_fingerprints_create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/document_fingerprints/methods/dlp_document_fingerprints_delete' + replace: + - $ref: '#/components/x-stackQL-resources/document_fingerprints/methods/dlp_document_fingerprints_upload' + account_mapping: + id: cloudflare.zero_trust.account_mapping + name: account_mapping + title: Account Mapping + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1account_mapping/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1account_mapping/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/account_mapping/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/account_mapping/methods/create' + update: [] + delete: [] + replace: [] + email_rules: + id: cloudflare.zero_trust.email_rules + name: email_rules + title: Email Rules + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1rules~1{rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/email_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/email_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/email_rules/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/email_rules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/email_rules/methods/update' + rules: + id: cloudflare.zero_trust.rules + name: rules + title: Rules + methods: + bulk_edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1email~1rules/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + reset_expiration: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1rules~1{rule_id}~1reset_expiration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/bulk_edit' + delete: [] + replace: [] + dlp_entries: + id: cloudflare.zero_trust.dlp_entries + name: dlp_entries + title: Dlp Entries + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1{entry_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1{entry_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dlp_entries/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/dlp_entries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dlp_entries/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/dlp_entries/methods/delete_by_account' + replace: [] + integration: + id: cloudflare.zero_trust.integration + name: integration + title: Integration + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration~1{entry_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1integration~1{entry_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/integration/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/integration/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/integration/methods/update' + entries_predefined: + id: cloudflare.zero_trust.entries_predefined + name: entries_predefined + title: Entries Predefined + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1predefined/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1predefined~1{entry_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1entries~1predefined~1{entry_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/entries_predefined/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/entries_predefined/methods/delete_by_account' + replace: + - $ref: '#/components/x-stackQL-resources/entries_predefined/methods/update_by_account' + limits: + id: cloudflare.zero_trust.limits + name: limits + title: Limits + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/limits/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dlp: + id: cloudflare.zero_trust.dlp + name: dlp + title: Dlp + methods: + validate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1patterns~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + payload_logs: + id: cloudflare.zero_trust.payload_logs + name: payload_logs + title: Payload Logs + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1payload_log/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1payload_log/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/payload_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/payload_logs/methods/update' + profiles: + id: cloudflare.zero_trust.profiles + name: profiles + title: Profiles + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_predefined: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1predefined~1{profile_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_config: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1predefined~1{profile_id}~1config/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1{profile_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/profiles/methods/get' + - $ref: '#/components/x-stackQL-resources/profiles/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + profiles_custom: + id: cloudflare.zero_trust.profiles_custom + name: profiles_custom + title: Profiles Custom + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1custom/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1custom/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1custom~1{profile_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1custom~1{profile_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1custom~1{profile_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/profiles_custom/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/profiles_custom/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/profiles_custom/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/profiles_custom/methods/delete_by_account' + replace: + - $ref: '#/components/x-stackQL-resources/profiles_custom/methods/update_by_account' + profiles_predefined: + id: cloudflare.zero_trust.profiles_predefined + name: profiles_predefined + title: Profiles Predefined + methods: + dlp_profiles_create_predefined_profile: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1predefined/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1predefined~1{profile_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1predefined~1{profile_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/profiles_predefined/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/profiles_predefined/methods/dlp_profiles_create_predefined_profile' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/profiles_predefined/methods/delete_by_account' + replace: [] + predefined_config: + id: cloudflare.zero_trust.predefined_config + name: predefined_config + title: Predefined Config + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1predefined~1{profile_id}~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1profiles~1predefined~1{profile_id}~1config/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/predefined_config/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/predefined_config/methods/update_by_account' + dlp_settings: + id: cloudflare.zero_trust.dlp_settings + name: dlp_settings + title: Dlp Settings + methods: + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1settings/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1dlp~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dlp_settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/dlp_settings/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/dlp_settings/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/dlp_settings/methods/update' + gateway: + id: cloudflare.zero_trust.gateway + name: gateway + title: Gateway + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1configuration/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gateway/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/gateway/methods/create' + update: [] + delete: [] + replace: [] + app_types: + id: cloudflare.zero_trust.app_types + name: app_types + title: App Types + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1app_types/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/app_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + review_status: + id: cloudflare.zero_trust.review_status + name: review_status + title: Review Status + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1apps~1review_status/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + zero_trust_applications_review_status_update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1apps~1review_status/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/review_status/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/review_status/methods/zero_trust_applications_review_status_update' + audit_ssh_settings: + id: cloudflare.zero_trust.audit_ssh_settings + name: audit_ssh_settings + title: Audit Ssh Settings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1audit_ssh_settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1audit_ssh_settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + rotate_seed: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1audit_ssh_settings~1rotate_seed/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/audit_ssh_settings/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/audit_ssh_settings/methods/update' + gateway_categories: + id: cloudflare.zero_trust.gateway_categories + name: gateway_categories + title: Gateway Categories + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1categories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gateway_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + accounts_gateway_certificates: + id: cloudflare.zero_trust.accounts_gateway_certificates + name: accounts_gateway_certificates + title: Accounts Gateway Certificates + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts_gateway_certificates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + gateway_certificates: + id: cloudflare.zero_trust.gateway_certificates + name: gateway_certificates + title: Gateway Certificates + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1certificates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1certificates~1{certificate_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1certificates~1{certificate_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gateway_certificates/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/gateway_certificates/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/gateway_certificates/methods/delete' + replace: [] + certificates: + id: cloudflare.zero_trust.certificates + name: certificates + title: Certificates + methods: + activate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1certificates~1{certificate_id}~1activate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + deactivate: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1certificates~1{certificate_id}~1deactivate/post' + response: + mediaType: application/json + openAPIDocKey: '201' + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1devices~1policy~1certificates/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1certificates/post' + response: + mediaType: application/json + openAPIDocKey: '201' + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1certificates~1{certificate_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1certificates~1{certificate_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1certificates~1{certificate_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1certificates~1{certificate_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/certificates/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/certificates/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_by_zone' + gateway_configuration: + id: cloudflare.zero_trust.gateway_configuration + name: gateway_configuration + title: Gateway Configuration + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1configuration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1configuration/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gateway_configuration/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/gateway_configuration/methods/update_by_account' + custom_certificate: + id: cloudflare.zero_trust.custom_certificate + name: custom_certificate + title: Custom Certificate + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1configuration~1custom_certificate/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_certificate/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + lists: + id: cloudflare.zero_trust.lists + name: lists + title: Lists + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1lists/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1lists/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1lists~1{list_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1lists~1{list_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1lists~1{list_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1lists~1{list_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/lists/methods/get' + - $ref: '#/components/x-stackQL-resources/lists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/lists/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/lists/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/lists/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/lists/methods/update' + items: + id: cloudflare.zero_trust.items + name: items + title: Items + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1lists~1{list_id}~1items/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/items/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + locations: + id: cloudflare.zero_trust.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1locations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1locations~1{location_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1locations~1{location_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1locations~1{location_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/locations/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/locations/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/locations/methods/update' + logging: + id: cloudflare.zero_trust.logging + name: logging + title: Logging + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1logging/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1logging/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logging/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/logging/methods/update' + pacfiles: + id: cloudflare.zero_trust.pacfiles + name: pacfiles + title: Pacfiles + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1pacfiles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1pacfiles/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1pacfiles~1{pacfile_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1pacfiles~1{pacfile_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1pacfiles~1{pacfile_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pacfiles/methods/get' + - $ref: '#/components/x-stackQL-resources/pacfiles/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pacfiles/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/pacfiles/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/pacfiles/methods/update' + proxy_endpoints: + id: cloudflare.zero_trust.proxy_endpoints + name: proxy_endpoints + title: Proxy Endpoints + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1proxy_endpoints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1proxy_endpoints/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1proxy_endpoints~1{proxy_endpoint_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1proxy_endpoints~1{proxy_endpoint_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1proxy_endpoints~1{proxy_endpoint_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/proxy_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/proxy_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/proxy_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/proxy_endpoints/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/proxy_endpoints/methods/delete' + replace: [] + gateway_rules: + id: cloudflare.zero_trust.gateway_rules + name: gateway_rules + title: Gateway Rules + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1rules~1{rule_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1rules~1{rule_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1rules~1{rule_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gateway_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/gateway_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/gateway_rules/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/gateway_rules/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/gateway_rules/methods/update' + rules_tenant: + id: cloudflare.zero_trust.rules_tenant + name: rules_tenant + title: Rules Tenant + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1gateway~1rules~1tenant/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules_tenant/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + targets: + id: cloudflare.zero_trust.targets + name: targets + title: Targets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + bulk_delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets~1batch/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + batch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets~1batch/put' + response: + mediaType: application/json + openAPIDocKey: '200' + batch_delete: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets~1batch_delete/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets~1{target_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets~1{target_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets~1{target_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/targets/methods/get' + - $ref: '#/components/x-stackQL-resources/targets/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/targets/methods/delete' + - $ref: '#/components/x-stackQL-resources/targets/methods/bulk_delete' + replace: + - $ref: '#/components/x-stackQL-resources/targets/methods/update' + infrastructure: + id: cloudflare.zero_trust.infrastructure + name: infrastructure + title: Infrastructure + methods: + create_targets: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1infrastructure~1targets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + resource_library_applications: + id: cloudflare.zero_trust.resource_library_applications + name: resource_library_applications + title: Resource Library Applications + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1resource-library~1applications/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1resource-library~1applications~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_library_applications/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/resource_library_applications/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + resource_library_categories: + id: cloudflare.zero_trust.resource_library_categories + name: resource_library_categories + title: Resource Library Categories + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1resource-library~1categories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_library_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + categories: + id: cloudflare.zero_trust.categories + name: categories + title: Categories + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1resource-library~1categories~1{id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/categories/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + routes: + id: cloudflare.zero_trust.routes + name: routes + title: Routes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes~1network~1{ip_network_encoded}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes~1{route_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes~1{route_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes~1{route_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routes/methods/get' + - $ref: '#/components/x-stackQL-resources/routes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/routes/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete' + replace: [] + ips: + id: cloudflare.zero_trust.ips + name: ips + title: Ips + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1routes~1ip~1{ip}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ips/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + virtual_networks: + id: cloudflare.zero_trust.virtual_networks + name: virtual_networks + title: Virtual Networks + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1virtual_networks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1virtual_networks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1virtual_networks~1{virtual_network_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1virtual_networks~1{virtual_network_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1teamnet~1virtual_networks~1{virtual_network_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/virtual_networks/methods/get' + - $ref: '#/components/x-stackQL-resources/virtual_networks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/virtual_networks/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/virtual_networks/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/virtual_networks/methods/delete' + replace: [] + tunnels: + id: cloudflare.zero_trust.tunnels + name: tunnels + title: Tunnels + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1tunnels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tunnels/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + warp_connector: + id: cloudflare.zero_trust.warp_connector + name: warp_connector + title: Warp Connector + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector~1{tunnel_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector~1{tunnel_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector~1{tunnel_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update_failover: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector~1{tunnel_id}~1failover/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warp_connector/methods/get' + - $ref: '#/components/x-stackQL-resources/warp_connector/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/warp_connector/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/warp_connector/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/warp_connector/methods/delete' + replace: [] + warp_connector_connections: + id: cloudflare.zero_trust.warp_connector_connections + name: warp_connector_connections + title: Warp Connector Connections + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector~1{tunnel_id}~1connections/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warp_connector_connections/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + warp_connector_connectors: + id: cloudflare.zero_trust.warp_connector_connectors + name: warp_connector_connectors + title: Warp Connector Connectors + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector~1{tunnel_id}~1connectors~1{connector_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warp_connector_connectors/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + warp_connector_token: + id: cloudflare.zero_trust.warp_connector_token + name: warp_connector_token + title: Warp Connector Token + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1warp_connector~1{tunnel_id}~1token/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warp_connector_token/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + connectivity_settings: + id: cloudflare.zero_trust.connectivity_settings + name: connectivity_settings + title: Connectivity Settings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1connectivity_settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1connectivity_settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connectivity_settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/connectivity_settings/methods/edit' + delete: [] + replace: [] + hostname_routes: + id: cloudflare.zero_trust.hostname_routes + name: hostname_routes + title: Hostname Routes + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1routes~1hostname/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1routes~1hostname/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1routes~1hostname~1{hostname_route_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1routes~1hostname~1{hostname_route_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1routes~1hostname~1{hostname_route_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hostname_routes/methods/get' + - $ref: '#/components/x-stackQL-resources/hostname_routes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/hostname_routes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/hostname_routes/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/hostname_routes/methods/delete' + replace: [] + subnets: + id: cloudflare.zero_trust.subnets + name: subnets + title: Subnets + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1subnets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_cloudflare_source: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1subnets~1cloudflare_source~1{address_family}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subnets/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + warp: + id: cloudflare.zero_trust.warp + name: warp + title: Warp + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1subnets~1warp/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1subnets~1warp~1{subnet_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1subnets~1warp~1{subnet_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zerotrust~1subnets~1warp~1{subnet_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warp/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/warp/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/warp/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/warp/methods/delete' + replace: [] + behaviours: + id: cloudflare.zero_trust.behaviours + name: behaviours + title: Behaviours + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1behaviors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1behaviors/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/behaviours/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/behaviours/methods/update' + zt_risk_scoring_integrations: + id: cloudflare.zero_trust.zt_risk_scoring_integrations + name: zt_risk_scoring_integrations + title: Zt Risk Scoring Integrations + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1integrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1integrations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1integrations~1{integration_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1integrations~1{integration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zt_risk_scoring_integrations/methods/get' + - $ref: '#/components/x-stackQL-resources/zt_risk_scoring_integrations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/zt_risk_scoring_integrations/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/zt_risk_scoring_integrations/methods/delete' + replace: [] + references: + id: cloudflare.zero_trust.references + name: references + title: References + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1integrations~1reference_id~1{reference_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/references/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + summary: + id: cloudflare.zero_trust.summary + name: summary + title: Summary + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.users + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/summary/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + risk_scoring: + id: cloudflare.zero_trust.risk_scoring + name: risk_scoring + title: Risk Scoring + methods: + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1{user_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + reset: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1zt_risk_scoring~1{user_id}~1reset/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/risk_scoring/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + devices_policy_certificates: + id: cloudflare.zero_trust.devices_policy_certificates + name: devices_policy_certificates + title: Devices Policy Certificates + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1devices~1policy~1certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/devices_policy_certificates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + access_apps: + id: cloudflare.zero_trust.access_apps + name: access_apps + title: Access Apps + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/access_apps/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/access_apps/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/access_apps/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + applications: + id: cloudflare.zero_trust.applications + name: applications + title: Applications + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps/post' + response: + mediaType: application/json + openAPIDocKey: '201' + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + revoke_tokens_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1revoke_tokens/post' + response: + mediaType: application/json + openAPIDocKey: '202' + revoke_tokens_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1revoke_tokens/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/applications/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/applications/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_by_zone' + cas_f84f2f: + id: cloudflare.zero_trust.cas_f84f2f + name: cas_f84f2f + title: Cas F84f2f + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1ca/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cas_f84f2f/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + cas_c5c46c: + id: cloudflare.zero_trust.cas_c5c46c + name: cas_c5c46c + title: Cas C5c46c + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1ca/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cas_c5c46c/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + cas_e335ab: + id: cloudflare.zero_trust.cas_e335ab + name: cas_e335ab + title: Cas E335ab + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1ca/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cas_e335ab/methods/list_by_account' + insert: [] + update: [] + delete: [] + replace: [] + cas: + id: cloudflare.zero_trust.cas + name: cas + title: Cas + methods: + create_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1ca/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1ca/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + create_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1ca/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1ca/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/cas/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/cas/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/cas/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/cas/methods/delete_by_zone' + replace: [] + cas_0145fa: + id: cloudflare.zero_trust.cas_0145fa + name: cas_0145fa + title: Cas 0145fa + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1ca/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cas_0145fa/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + apps_policies: + id: cloudflare.zero_trust.apps_policies + name: apps_policies + title: Apps Policies + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1policies/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1policies/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1policies~1{policy_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1policies~1{policy_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1policies~1{policy_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1policies~1{policy_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1policies~1{policy_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1policies~1{policy_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/list_by_zone' + insert: + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/apps_policies/methods/update_by_zone' + settings: + id: cloudflare.zero_trust.settings + name: settings + title: Settings + methods: + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '202' + edit_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '202' + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '202' + edit_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '202' + put_accounts_account_id_access_certificates_settings: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1certificates~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '202' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1certificates~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + put_zones_zone_id_access_certificates_settings: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1certificates~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/edit_by_account' + - $ref: '#/components/x-stackQL-resources/settings/methods/edit_by_zone' + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/settings/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/settings/methods/update_by_zone' + - $ref: '#/components/x-stackQL-resources/settings/methods/put_accounts_account_id_access_certificates_settings' + - $ref: '#/components/x-stackQL-resources/settings/methods/put_zones_zone_id_access_certificates_settings' + user_policy_checks: + id: cloudflare.zero_trust.user_policy_checks + name: user_policy_checks + title: User Policy Checks + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1apps~1{app_id}~1user_policy_checks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1apps~1{app_id}~1user_policy_checks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_policy_checks/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/user_policy_checks/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + accounts_access_certificates: + id: cloudflare.zero_trust.accounts_access_certificates + name: accounts_access_certificates + title: Accounts Access Certificates + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts_access_certificates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + access_certificates: + id: cloudflare.zero_trust.access_certificates + name: access_certificates + title: Access Certificates + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1certificates/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1certificates~1{certificate_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + delete: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1certificates~1{certificate_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/access_certificates/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/access_certificates/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/access_certificates/methods/delete' + replace: [] + zones_access_certificates: + id: cloudflare.zero_trust.zones_access_certificates + name: zones_access_certificates + title: Zones Access Certificates + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zones_access_certificates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + certificates_settings: + id: cloudflare.zero_trust.certificates_settings + name: certificates_settings + title: Certificates Settings + methods: + list: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1certificates~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/certificates_settings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + access_groups: + id: cloudflare.zero_trust.access_groups + name: access_groups + title: Access Groups + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/access_groups/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/access_groups/methods/list_by_zone' + insert: [] + update: [] + delete: [] + replace: [] + groups: + id: cloudflare.zero_trust.groups + name: groups + title: Groups + methods: + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1groups/post' + response: + mediaType: application/json + openAPIDocKey: '201' + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1groups/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1groups~1{group_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1groups~1{group_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1groups~1{group_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1groups~1{group_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1groups~1{group_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1groups~1{group_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/groups/methods/get_by_zone' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/groups/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/groups/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/groups/methods/update_by_zone' + identity_providers: + id: cloudflare.zero_trust.identity_providers + name: identity_providers + title: Identity Providers + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1identity_providers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1identity_providers/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1identity_providers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1identity_providers/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1identity_providers~1{identity_provider_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1identity_providers~1{identity_provider_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1identity_providers~1{identity_provider_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + get_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1identity_providers~1{identity_provider_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1identity_providers~1{identity_provider_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1identity_providers~1{identity_provider_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/get_by_account' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/get_by_zone' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/list_by_zone' + insert: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/create_by_zone' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/delete_by_account' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/delete_by_zone' + replace: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/update_by_zone' + organizations: + id: cloudflare.zero_trust.organizations + name: organizations + title: Organizations + methods: + list_by_account: + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1organizations/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1organizations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + update_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1organizations/put' + response: + mediaType: application/json + openAPIDocKey: '200' + create_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1organizations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + revoke_users_by_account: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1accounts~1{account_id}~1access~1organizations~1revoke_user/post' + response: + mediaType: application/json + openAPIDocKey: '200' + revoke_users_by_zone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1access~1organizations~1revoke_user/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/organizations/methods/list_by_account' + - $ref: '#/components/x-stackQL-resources/organizations/methods/list_by_zone' + insert: + - $ref: '#/components/x-stackQL-resources/organizations/methods/create_by_account' + - $ref: '#/components/x-stackQL-resources/organizations/methods/create_by_zone' + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/organizations/methods/update_by_account' + - $ref: '#/components/x-stackQL-resources/organizations/methods/update_by_zone' diff --git a/providers/src/cloudflare/v00.00.00000/services/zones.yaml b/providers/src/cloudflare/v00.00.00000/services/zones.yaml index 3fbd4dc4..4b85365b 100644 --- a/providers/src/cloudflare/v00.00.00000/services/zones.yaml +++ b/providers/src/cloudflare/v00.00.00000/services/zones.yaml @@ -1,12406 +1,2269 @@ openapi: 3.0.3 -servers: - - description: Client API - url: 'https://api.cloudflare.com/client/v4' info: - description: Filters - license: - name: BSD-3-Clause - url: 'https://opensource.org/licenses/BSD-3-Clause' - title: Cloudflare API - zones + title: zones API + description: >- + Welcome to Cloudflare's API documentation site. We are experimenting with an + updated version of our API documentation - check out + [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) + to test out the new experience. To get started using Cloudflare's products + and services via the API, refer to [how to interact with + Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), + which covers using tools like + [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) + and the [official + SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to + maintain your Cloudflare resources. Using the Cloudflare API requires + authentication so that Cloudflare knows who is making requests and what + permissions you have. Create an API token to grant access to the API to + perform actions. You can also authenticate with [API + keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), + but these keys have [several + limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) + that make them less secure than API tokens. Whenever possible, use API + tokens to interact with the Cloudflare API. To create an API token, from the + Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. + For more information on how to create and troubleshoot API tokens, refer to + our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/). + For information regarding rate limits, refer to our [API Rate + Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits). + Totally new to Cloudflare? [Start + here](https://developers.cloudflare.com/fundamentals/get-started/). version: 4.0.0 -components: - schemas: - common_components-schemas-identifier: - description: Identifier - example: 023e105f4ecef8ad9ca31a8372d0c353 - maxLength: 32 - readOnly: true - type: string - filters_components-schemas-id: - description: The unique identifier of the filter. - example: 372e67954025e0ba6aaa6d586b9e0b61 - maxLength: 32 - minLength: 32 - readOnly: true - type: string - filter-delete-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - allOf: - - $ref: '#/components/schemas/filter' - - required: - - id - type: object - type: array - type: object - api-response-common-failure: - properties: - errors: - allOf: - - $ref: '#/components/schemas/messages' - example: - - code: 7003 - message: No route for the URI - minLength: 1 - messages: - allOf: - - $ref: '#/components/schemas/messages' - example: [] - result: - enum: - - null - nullable: true - success: - description: Whether the API call was successful - enum: - - false - example: false - type: boolean - required: - - success - - errors - - messages - - result - type: object - api-response-collection: - anyOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - items: {} - nullable: true - type: array - result_info: - $ref: '#/components/schemas/result_info' - type: object - filter: - additionalProperties: false - properties: - description: - $ref: '#/components/schemas/filters_components-schemas-description' - expression: - $ref: '#/components/schemas/expression' - id: - $ref: '#/components/schemas/filters_components-schemas-id' - paused: - $ref: '#/components/schemas/filters_components-schemas-paused' - ref: - $ref: '#/components/schemas/schemas-ref' - type: object - messages: - example: [] - items: - properties: - code: - minimum: 1000 - type: integer - message: + contact: + name: Cloudflare + url: https://www.cloudflare.com +servers: + - url: https://api.cloudflare.com/client/v4 +security: + - api_token: [] +paths: + /zones: + get: + description: >- + Lists, searches, sorts, and filters your zones. Listing zones across + more than 500 accounts is currently not allowed. + operationId: zones-get + parameters: + - in: query + name: name + schema: + description: >- + A domain name. Optional filter operators can be provided to extend + refine the search: * `equal` (default) * `not_equal` * + `starts_with` * `ends_with` * `contains` * + `starts_with_case_sensitive` * `ends_with_case_sensitive` * + `contains_case_sensitive` + maxLength: 253 type: string - required: - - code - - message - type: object - uniqueItems: true - type: array - api-response-common: - properties: - errors: - $ref: '#/components/schemas/messages' - messages: - $ref: '#/components/schemas/messages' - result: - anyOf: - - type: object - - items: {} - type: array - - type: string - success: - description: Whether the API call was successful - enum: - - true - example: true - type: boolean - required: - - success - - errors - - messages - - result - type: object - result_info: - properties: - count: - description: Total number of results for the requested service - example: 1 - type: number - page: - description: Current page within paginated list of results - example: 1 - type: number - per_page: - description: Number of results per page of results - example: 20 - type: number - total_count: - description: Total results available without any search parameters - example: 2000 - type: number - type: object - filters_components-schemas-description: - description: An informative summary of the filter. - example: Restrict access from these browsers on this address range. - maxLength: 500 - type: string - expression: - description: 'The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).' - example: (http.request.uri.path ~ ".*wp-login.php" or http.request.uri.path ~ ".*xmlrpc.php") and ip.addr ne 172.16.22.155 - type: string - filters_components-schemas-paused: - description: 'When true, indicates that the filter is currently paused.' - example: false - type: boolean - schemas-ref: - description: A short reference tag. Allows you to select related filters. - example: FIL-100 - maxLength: 50 - type: string - schemas-filter-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - allOf: - - $ref: '#/components/schemas/filter' - - required: - - id - - expression - - paused - type: object - type: array - type: object - filter-delete-response-single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - $ref: '#/components/schemas/filter' - - required: - - id + - in: query + name: status + schema: + description: Specify a zone status to filter by. + enum: + - initializing + - pending + - active + - moved + type: string + - in: query + name: account.id + schema: + description: Filter by an account ID. + type: string + - in: query + name: account.name + schema: + description: >- + An account Name. Optional filter operators can be provided to + extend refine the search: * `equal` (default) * `not_equal` * + `starts_with` * `ends_with` * `contains` * + `starts_with_case_sensitive` * `ends_with_case_sensitive` * + `contains_case_sensitive` + maxLength: 253 + type: string + - in: query + name: page + schema: + default: 1 + description: Page number of paginated results. + minimum: 1 + type: number + - in: query + name: per_page + schema: + default: 20 + description: Number of zones per page. + maximum: 50 + minimum: 5 + type: number + - in: query + name: order + schema: + description: Field to order zones by. + enum: + - name + - status + - account.id + - account.name + - plan.id + type: string + - in: query + name: direction + schema: + description: Direction to order zones. + enum: + - asc + - desc + type: string + - in: query + name: match + schema: + default: all + description: Whether to match all search requirements or at least one (any). + enum: + - any + - all + type: string + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful. + type: boolean + result_info: + $ref: '#/components/schemas/zonesResultInfo' + result: + items: + $ref: '#/components/schemas/zonesZone' + type: array + required: + - success + - errors + - messages + type: object + description: List Zones response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesApiResponseCommonFailure' + description: List Zones response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: List Zones + tags: + - Zone + x-api-token-group: + - Zone Zone Read + x-stackql-sdk: + service: zones + resource_chain: [] + method: list + post: + operationId: zones-post + requestBody: + content: + application/json: + schema: + properties: + account: + properties: + id: + $ref: '#/components/schemas/zonesIdentifier' type: object - required: - - result - type: object - api-response-single: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - anyOf: - - type: object - - type: string - nullable: true - schemas-filter-response-single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - oneOf: - - allOf: - - $ref: '#/components/schemas/filter' - - required: - - id - - expression - - paused + name: + $ref: '#/components/schemas/zonesName' + type: + $ref: '#/components/schemas/zonesType' + required: + - name + - account + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful. + type: boolean + result: + $ref: '#/components/schemas/zonesZone' + required: + - success + - errors + - messages + type: object + description: Create Zone response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesApiResponseCommonFailure' + description: Create Zone response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Create Zone + tags: + - Zone + x-api-token-group: + - Zone Zone Edit + - Zone DNS Edit + x-stackql-sdk: + service: zones + resource_chain: [] + method: create + /zones/{zone_identifier}/analytics/colos: + get: + deprecated: true + description: >- + This view provides a breakdown of analytics data by datacenter. Note: + This is available to Enterprise customers only. + operationId: zone-analytics-(-deprecated)-get-analytics-by-co-locations + parameters: + - in: path + name: zone_identifier + schema: + $ref: '#/components/schemas/zoneAnalyticsApiIdentifier' + required: true + - in: query + name: until + schema: + $ref: '#/components/schemas/zoneAnalyticsApiUntil' + - in: query + name: since + schema: + default: -10080 + description: >- + The (inclusive) beginning of the requested time frame. This value + can be a negative integer representing the number of minutes in + the past relative to time the request is made, or can be an + absolute timestamp that conforms to RFC 3339. At this point in + time, it cannot exceed a time in the past greater than one year. + Ranges that the Cloudflare web application provides will provide + the following period length for each point: - Last 60 minutes + (from -59 to -1): 1 minute resolution - Last 7 hours (from -419 to + -60): 15 minutes resolution - Last 15 hours (from -899 to -420): + 30 minutes resolution - Last 72 hours (from -4320 to -900): 1 hour + resolution - Older than 3 days (-525600 to -4320): 1 day + resolution. + type: string + - in: query + name: continuous + schema: + default: true + description: >- + When set to true, the API will move the requested time window + backward, until it finds a region with completely aggregated data. + The API response _may not represent the requested time window_. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zoneAnalyticsApiColoResponse' + description: Get analytics by Co-locations response + 4XX: + content: + application/json: + schema: + type: object + properties: + errors: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + messages: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + result: + description: >- + A breakdown of all dashboard analytics data by + co-locations. This is limited to Enterprise zones only. + items: + properties: + colo_id: + description: The airport code identifer for the co-location. + type: string + timeseries: + $ref: >- + #/components/schemas/zoneAnalyticsApiTimeseriesByColo + totals: + $ref: '#/components/schemas/zoneAnalyticsApiTotalsByColo' type: object - - nullable: true - required: - - result - type: object - firewall-rules_components-schemas-id: - description: The unique identifier of the firewall rule. - example: 372e67954025e0ba6aaa6d586b9e0b60 - maxLength: 32 - readOnly: true - type: string - filter-rules-response-collection-delete: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - allOf: - - $ref: '#/components/schemas/filter-rule-response' - - required: - - id - type: object - type: array - required: - - result - type: object - filter-rule-response: - allOf: - - $ref: '#/components/schemas/filter-rule-base' - - properties: - filter: - oneOf: - - $ref: '#/components/schemas/filter' - - $ref: '#/components/schemas/deleted-filter' - filter-rule-base: - properties: - action: - $ref: '#/components/schemas/firewall-rules_components-schemas-action' - description: - $ref: '#/components/schemas/firewall-rules_components-schemas-description' - id: - $ref: '#/components/schemas/firewall-rules_components-schemas-id' - paused: - $ref: '#/components/schemas/firewall-rules_components-schemas-paused' - priority: - $ref: '#/components/schemas/firewall-rules_components-schemas-priority' - products: - $ref: '#/components/schemas/products' - ref: - $ref: '#/components/schemas/ref' - type: object - deleted-filter: - additionalProperties: false - properties: - deleted: - $ref: '#/components/schemas/deleted' - id: - $ref: '#/components/schemas/filters_components-schemas-id' - required: - - id - - deleted - firewall-rules_components-schemas-action: - description: The action to apply to a matched request. The `log` action is only available on an Enterprise plan. - enum: - - block - - challenge - - js_challenge - - managed_challenge - - allow - - log - - bypass - example: block - type: string - firewall-rules_components-schemas-description: - description: An informative summary of the firewall rule. - example: Blocks traffic identified during investigation for MIR-31 - maxLength: 500 - type: string - firewall-rules_components-schemas-paused: - description: 'When true, indicates that the firewall rule is currently paused.' - example: false - type: boolean - firewall-rules_components-schemas-priority: - description: 'The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.' - example: 50 - maximum: 2147483647 - minimum: 0 - type: number - products: - items: - description: A list of products to bypass for a request when using the `bypass` action. + title: Analytics data by datacenter + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + query: + $ref: '#/components/schemas/zoneAnalyticsApiQueryResponse' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get analytics by Co-locations response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get analytics by Co-locations + tags: + - Zone Analytics (Deprecated) + x-api-token-group: + - Analytics Read + x-cfDeprecation: + description: >- + Please use the new GraphQL Analytics API instead: + https://developers.cloudflare.com/analytics/graphql-api/. It provides + equivalent data and more features, including the ability to select + only the metrics you need. Migration guide: + https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/. + display: true + eol: '2021-03-01' + id: zone_analytics_deprecation + x-cfPermissionsRequired: enum: - - zoneLockdown - - uaBlock - - bic - - hot - - securityLevel - - rateLimit - - waf - example: waf - type: string - type: array - ref: - description: A short reference tag. Allows you to select related firewall rules. - example: MIR-31 - maxLength: 50 - type: string - deleted: - description: 'When true, indicates that the firewall rule was deleted.' - example: true - type: boolean - filter-rules-response-collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - allOf: - - $ref: '#/components/schemas/filter-rule-response' - - required: - - id - - filter - - action - - paused - type: object - type: array - required: - - result - type: object - delete_filter_if_unused: - description: 'When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter.' - type: boolean - filter-rules-single-response-delete: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - $ref: '#/components/schemas/filter-rule-response' - - required: - - id - type: object - required: - - result - type: object - filter-rules-single-response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - allOf: - - $ref: '#/components/schemas/filter-rule-response' - - required: - - id - - filter - - action - - paused - type: object - required: - - result - type: object - healthchecks_components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/healthchecks' - type: array - healthchecks: - properties: - address: - $ref: '#/components/schemas/schemas-address' - check_regions: - $ref: '#/components/schemas/schemas-check_regions' - consecutive_fails: - $ref: '#/components/schemas/consecutive_fails' - consecutive_successes: - $ref: '#/components/schemas/consecutive_successes' - created_on: - $ref: '#/components/schemas/timestamp' - description: - $ref: '#/components/schemas/healthchecks_components-schemas-description' - failure_reason: - $ref: '#/components/schemas/failure_reason' - http_config: - $ref: '#/components/schemas/http_config' - id: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - interval: - $ref: '#/components/schemas/components-schemas-interval' - modified_on: - $ref: '#/components/schemas/timestamp' - name: - $ref: '#/components/schemas/healthchecks_components-schemas-name' - retries: - $ref: '#/components/schemas/retries' - status: - $ref: '#/components/schemas/healthchecks_components-schemas-status' - suspended: - $ref: '#/components/schemas/suspended' - tcp_config: - $ref: '#/components/schemas/tcp_config' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/healthchecks_components-schemas-type' - type: object - schemas-address: - description: The hostname or IP address of the origin server to run health checks on. - example: www.example.com - type: string - schemas-check_regions: - description: A list of regions from which to run health checks. Null means Cloudflare will pick a default region. - example: - - WEU - - ENAM - items: - description: 'WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).' - enum: - - WNAM - - ENAM - - WEU - - EEU - - NSAM - - SSAM - - OC - - ME - - NAF - - SAF - - IN - - SEAS - - NEAS - - ALL_REGIONS - type: string - nullable: true - type: array - consecutive_fails: - default: 1 - description: The number of consecutive fails required from a health check before changing the health to unhealthy. - type: integer - consecutive_successes: - default: 1 - description: The number of consecutive successes required from a health check before changing the health to healthy. - type: integer - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - healthchecks_components-schemas-description: - description: A human-readable description of the health check. - example: Health check for www.example.com - type: string - failure_reason: - description: The current failure reason if status is unhealthy. - example: '' - readOnly: true - type: string - http_config: - description: Parameters specific to an HTTP or HTTPS health check. - nullable: true - properties: - allow_insecure: - default: false - description: Do not validate the certificate when the health check uses HTTPS. - type: boolean - expected_body: - description: 'A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.' - example: success - type: string - expected_codes: - default: '200' - description: The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check. - example: - - 2xx - - '302' - items: - type: string - nullable: true - type: array - follow_redirects: - default: false - description: Follow redirects if the origin returns a 3xx status code. - type: boolean - header: - description: The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. - example: - Host: - - example.com - X-App-ID: - - abc123 - nullable: true - type: object - method: - default: GET - description: The HTTP method to use for the health check. - enum: - - GET - - HEAD - type: string - path: - default: / - description: The endpoint path to health check against. - example: /health - type: string - port: - default: 80 - description: Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS. - type: integer - type: object - healthchecks_components-schemas-identifier: - example: 699d98642c564d2e855e9661899b7252 - components-schemas-interval: - default: 60 - description: 'The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.' - type: integer - healthchecks_components-schemas-name: - description: 'A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.' - example: server-1 - type: string - retries: - default: 2 - description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. - type: integer - healthchecks_components-schemas-status: - description: The current status of the origin server according to the health check. - enum: - - unknown - - healthy - - unhealthy - - suspended - example: healthy - readOnly: true - type: string - suspended: - default: false - description: 'If suspended, no health checks are sent to the origin.' - type: boolean - tcp_config: - description: Parameters specific to TCP health check. - nullable: true - properties: - method: - default: connection_established - description: The TCP connection method to use for the health check. - enum: - - connection_established - type: string - port: - default: 80 - description: Port number to connect to for the health check. Defaults to 80. - type: integer - type: object - schemas-timeout: - default: 5 - description: The timeout (in seconds) before marking the health check as failed. - type: integer - healthchecks_components-schemas-type: - default: HTTP - description: 'The protocol to use for the health check. Currently supported protocols are ''HTTP'', ''HTTPS'' and ''TCP''.' - example: HTTPS - type: string - query_healthcheck: - properties: - address: - $ref: '#/components/schemas/schemas-address' - check_regions: - $ref: '#/components/schemas/schemas-check_regions' - consecutive_fails: - $ref: '#/components/schemas/consecutive_fails' - consecutive_successes: - $ref: '#/components/schemas/consecutive_successes' - description: - $ref: '#/components/schemas/healthchecks_components-schemas-description' - http_config: - $ref: '#/components/schemas/http_config' - interval: - $ref: '#/components/schemas/components-schemas-interval' - name: - $ref: '#/components/schemas/healthchecks_components-schemas-name' - retries: - $ref: '#/components/schemas/retries' - suspended: - $ref: '#/components/schemas/suspended' - tcp_config: - $ref: '#/components/schemas/tcp_config' - timeout: - $ref: '#/components/schemas/schemas-timeout' - type: - $ref: '#/components/schemas/healthchecks_components-schemas-type' - required: - - name - - address - type: object - healthchecks_components-schemas-single_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/healthchecks' - healthchecks_components-schemas-id_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - type: object - request_list: - items: - $ref: '#/components/schemas/request_model' - type: array - request_model: - properties: - enabled: - $ref: '#/components/schemas/managed_headers_components-schemas-enabled' - id: - $ref: '#/components/schemas/managed_headers_components-schemas-id' - type: object - managed_headers_components-schemas-enabled: - description: 'When true, the Managed Transform is enabled.' - example: true - type: boolean - managed_headers_components-schemas-id: - description: Human-readable identifier of the Managed Transform. - example: add_cf-bot-score_header - type: string - response_list: - items: - $ref: '#/components/schemas/response_model' - type: array - response_model: - properties: - available: - $ref: '#/components/schemas/available' - enabled: - $ref: '#/components/schemas/managed_headers_components-schemas-enabled' - id: - $ref: '#/components/schemas/managed_headers_components-schemas-id' - type: object - available: - description: 'When true, the Managed Transform is available in the current Cloudflare plan.' - example: true - type: boolean - ratelimit_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/rate-limits' - type: array - type: object - rate-limits: - allOf: - - $ref: '#/components/schemas/components-schemas-ratelimit' - components-schemas-ratelimit: - properties: - action: - $ref: '#/components/schemas/components-schemas-action' - bypass: - $ref: '#/components/schemas/bypass' - description: - $ref: '#/components/schemas/components-schemas-description' - disabled: - $ref: '#/components/schemas/disabled' - id: - $ref: '#/components/schemas/rate-limits_components-schemas-id' - match: - $ref: '#/components/schemas/match' - period: - $ref: '#/components/schemas/period' - threshold: - $ref: '#/components/schemas/threshold' - components-schemas-action: - anyOf: - - properties: - mode: - $ref: '#/components/schemas/mode' - response: - $ref: '#/components/schemas/custom_response' - timeout: - $ref: '#/components/schemas/timeout' - type: object - description: The action to perform when the threshold of matched traffic within the configured period is exceeded. - type: object - bypass: - description: Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs. - items: - properties: - name: - enum: - - url - example: url - type: string - value: - description: The URL to bypass. - example: api.example.com/* + - '#analytics:read' + x-cfPlanAvailability: + business: false + enterprise: true + free: false + pro: false + /zones/{zone_identifier}/analytics/dashboard: + get: + deprecated: true + description: >- + The dashboard view provides both totals and timeseries data for the + given zone and time period across the entire Cloudflare network. + operationId: zone-analytics-(-deprecated)-get-dashboard + parameters: + - in: path + name: zone_identifier + schema: + $ref: '#/components/schemas/zoneAnalyticsApiIdentifier' + required: true + - in: query + name: until + schema: + $ref: '#/components/schemas/zoneAnalyticsApiUntil' + - in: query + name: since + schema: + default: -10080 + description: >- + The (inclusive) beginning of the requested time frame. This value + can be a negative integer representing the number of minutes in + the past relative to time the request is made, or can be an + absolute timestamp that conforms to RFC 3339. At this point in + time, it cannot exceed a time in the past greater than one year. + Ranges that the Cloudflare web application provides will provide + the following period length for each point: - Last 60 minutes + (from -59 to -1): 1 minute resolution - Last 7 hours (from -419 to + -60): 15 minutes resolution - Last 15 hours (from -899 to -420): + 30 minutes resolution - Last 72 hours (from -4320 to -900): 1 hour + resolution - Older than 3 days (-525600 to -4320): 1 day + resolution. type: string - type: object - type: array - components-schemas-description: - description: An informative summary of the rate limit. This value is sanitized and any tags will be removed. - example: Prevent multiple login failures to mitigate brute force attacks - maxLength: 1024 - type: string - disabled: - description: 'When true, indicates that the rate limit is currently disabled.' - example: false - type: boolean - rate-limits_components-schemas-id: - description: The unique identifier of the rate limit. - example: 372e67954025e0ba6aaa6d586b9e0b59 - maxLength: 32 - readOnly: true - type: string - match: - description: Determines which traffic the rate limit counts towards the threshold. - oneOf: - - properties: - headers: - items: - properties: - name: - $ref: '#/components/schemas/header_name' - op: - $ref: '#/components/schemas/header_op' - value: - $ref: '#/components/schemas/header_value' + - in: query + name: continuous + schema: + default: true + description: >- + When set to true, the API will move the requested time window + backward, until it finds a region with completely aggregated data. + The API response _may not represent the requested time window_. + type: boolean + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zoneAnalyticsApiDashboardResponse' + description: Get dashboard response + 4XX: + content: + application/json: + schema: type: object - type: array - request: - properties: - methods: - $ref: '#/components/schemas/methods' - schemes: - $ref: '#/components/schemas/schemes' - url: - $ref: '#/components/schemas/schemas-url' - type: object - response: - properties: - origin_traffic: - $ref: '#/components/schemas/origin_traffic' - type: object - type: object - type: object - period: - description: 'The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.' - example: 900 - maximum: 86400 - minimum: 10 - type: number - threshold: - description: The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period. - example: 60 - minimum: 1 - type: number - mode: - description: The action to perform. - enum: - - simulate - - ban - - challenge - - js_challenge - - managed_challenge - example: challenge - type: string - custom_response: - anyOf: - - properties: - body: - $ref: '#/components/schemas/body' - content_type: - $ref: '#/components/schemas/content_type' - type: object - description: |- - A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional. - Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object. - type: object - timeout: - description: |- - The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. - Notes: If "mode" is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value. - example: 86400 - maximum: 86400 - minimum: 1 - type: number - header_name: - description: The name of the response header to match. - example: Cf-Cache-Status - type: string - header_op: - description: 'The operator used when matching: `eq` means "equal" and `ne` means "not equal".' - enum: - - eq - - ne - example: ne - type: string - header_value: - description: 'The value of the response header, which must match exactly.' - example: HIT - type: string - methods: - description: 'The HTTP methods to match. You can specify a subset (for example, `[''POST'',''PUT'']`) or all methods (`[''_ALL_'']`). This field is optional when creating a rate limit.' - example: - - GET - - POST - items: - description: An HTTP method or `_ALL_` to indicate all methods. + properties: + errors: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + messages: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + result: + description: Totals and timeseries data. + properties: + timeseries: + $ref: '#/components/schemas/zoneAnalyticsApiTimeseries' + totals: + $ref: '#/components/schemas/zoneAnalyticsApiTotals' + title: Dashboard response + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + query: + $ref: '#/components/schemas/zoneAnalyticsApiQueryResponse' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get dashboard response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get dashboard + tags: + - Zone Analytics (Deprecated) + x-api-token-group: + - Analytics Read + x-cfDeprecation: + description: >- + Please use the new GraphQL Analytics API instead: + https://developers.cloudflare.com/analytics/graphql-api/. It provides + equivalent data and more features, including the ability to select + only the metrics you need. Migration guide: + https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/. + display: true + eol: '2021-03-01' + id: zone_analytics_deprecation + x-cfPermissionsRequired: enum: - - GET - - POST - - PUT - - DELETE - - PATCH - - HEAD - - _ALL_ - example: GET - type: string - type: array - schemes: - description: 'The HTTP schemes to match. You can specify one scheme (`[''HTTPS'']`), both schemes (`[''HTTP'',''HTTPS'']`), or all schemes (`[''_ALL_'']`). This field is optional.' - example: - - HTTP - - HTTPS - items: - description: An HTTP scheme or `_ALL_` to indicate all schemes. - example: HTTPS - type: string - type: array - schemas-url: - description: 'The URL pattern to match, composed of a host and a path such as `example.org/path*`. Normalization is applied before the pattern is matched. `*` wildcards are expanded to match applicable traffic. Query strings are not matched. Set the value to `*` to match all traffic to your zone.' - example: '*.example.org/path*' - maxLength: 1024 - type: string - origin_traffic: - description: |- - When true, only the uncached traffic served from your origin servers will count towards rate limiting. In this case, any cached traffic served by Cloudflare will not count towards rate limiting. This field is optional. - Notes: This field is deprecated. Instead, use response headers and set "origin_traffic" to "false" to avoid legacy behaviour interacting with the "response_headers" property. - type: boolean - body: - description: The response body to return. The value must conform to the configured content type. - example: This request has been rate-limited. - maxLength: 10240 - type: string - content_type: - description: 'The content type of the body. Must be one of the following: `text/plain`, `text/xml`, or `application/json`.' - example: text/xml - maxLength: 50 - type: string - ratelimit_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - schemas-phase: - description: The phase where the ruleset is executed. - enum: - - http_request_transform - - http_request_late_transform - - http_response_headers_transform - type: string - schemas-ruleset: - properties: - description: - example: '' - id: - example: 2f2feab2026849078ba485f918791bdc - kind: - example: zone - name: - example: default - phase: - example: http_request_transform - rules: - description: The rules in the ruleset. - items: - $ref: '#/components/schemas/transform-rules_components-schemas-rule' - type: array - transform-rules_components-schemas-rule: - properties: - action: - example: rewrite - action_parameters: - $ref: '#/components/schemas/schemas-action_parameters' - description: - example: change request based on ip location - expression: - example: ip.geoip.country eq "AL" - id: - example: 3a03d665bac047339bb530ecb439a90d - version: - example: '1' - schemas-action_parameters: - description: The parameters configuring the action. - oneOf: - - $ref: '#/components/schemas/action_parameters_rewrite' - type: object - action_parameters_rewrite: - description: The configuration parameters for the rewrite action. - properties: - uri: - description: 'The URI rewrite configuration to rewrite the URI path, the query string, or both.' - properties: - path: - description: The new URI path sent to the origin. - query: - description: The new query string sent to the origin. - type: object - update_ruleset: - description: A ruleset object. - properties: - description: - $ref: '#/components/schemas/rulesets_components-schemas-description' - rules: - $ref: '#/components/schemas/create_update_rules' - required: - - rules - type: object - rulesets_components-schemas-description: - default: '' - description: An informative description of the ruleset. - example: My ruleset to execute managed rulesets - type: string - create_update_rules: - description: The list of rules in the ruleset. - items: - anyOf: - - $ref: '#/components/schemas/create_update_rule' - - description: The unique ID of a rule. - type: array - create_update_rule: - description: A rule object. - properties: - action: - $ref: '#/components/schemas/rules_components-schemas-action' - action_parameters: - $ref: '#/components/schemas/action_parameters' - description: - $ref: '#/components/schemas/rules_components-schemas-description' - enabled: - $ref: '#/components/schemas/rules_components-schemas-enabled-2' - expression: - $ref: '#/components/schemas/schemas-expression' - logging: - $ref: '#/components/schemas/logging' - ref: - $ref: '#/components/schemas/components-schemas-ref' - required: - - expression - - action - type: object - rules_components-schemas-action: - description: The action to perform when the rule matches. - example: execute - pattern: '^[a-z_]+$' - type: string - action_parameters: - description: The parameters configuring the rule action. - example: - id: 4814384a9e5d4991b9815dcfc25d2f1f - type: object - rules_components-schemas-description: - default: '' - description: An informative description of the rule. - example: Execute the OWASP ruleset when the IP address is not 1.1.1.1 - type: string - rules_components-schemas-enabled-2: - default: 'true' - description: Whether the rule should be executed. - example: true - type: boolean - schemas-expression: - description: The expression defining which traffic will match the rule. - example: ip.src ne 1.1.1.1 - type: string - logging: - description: An object configuring the rule's logging behavior. - example: - enabled: true - properties: - enabled: - description: Whether to generate a log when the rule matches. - example: true - type: boolean - type: object - components-schemas-ref: - description: The reference of the rule (the rule ID by default). - example: my_ref - type: string - schemas-response_model: - properties: - scope: - $ref: '#/components/schemas/scope' - type: - $ref: '#/components/schemas/url_normalization_components-schemas-type' - type: object - scope: - description: The scope of the URL normalization. - example: incoming - type: string - url_normalization_components-schemas-type: - description: The type of URL normalization performed by Cloudflare. - example: cloudflare - type: string - schemas-request_model: - properties: - scope: - $ref: '#/components/schemas/scope' - type: - $ref: '#/components/schemas/url_normalization_components-schemas-type' - type: object - components-schemas-response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/zone_components-schemas-zone' - type: array - zone_components-schemas-zone: - allOf: - - $ref: '#/components/schemas/components-schemas-zone' - components-schemas-zone: - properties: - activated_on: - description: |- - The last time proof of ownership was detected and the zone was made - active - example: '2014-01-02T00:01:00.12345Z' - format: date-time - nullable: true - readOnly: true - type: string - created_on: - description: When the zone was created - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - development_mode: - description: |- - The interval (in seconds) from when development mode expires - (positive integer) or last expired (negative integer) for the - domain. If development mode has never been enabled, this value is 0. - example: 7200 - readOnly: true - type: number - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - modified_on: - description: When the zone was last modified - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - name: - description: The domain name - example: example.com - maxLength: 253 - pattern: '^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$' - readOnly: true - type: string - original_dnshost: - description: DNS host at the time of switching to Cloudflare - example: NameCheap - maxLength: 50 - nullable: true - readOnly: true - type: string - original_name_servers: - description: |- - Original name servers before moving to Cloudflare - Notes: Is this only available for full zones? - example: - - ns1.originaldnshost.com - - ns2.originaldnshost.com - items: - format: hostname - type: string - nullable: true - readOnly: true - type: array - original_registrar: - description: Registrar for the domain at the time of switching to Cloudflare - example: GoDaddy - nullable: true - readOnly: true - type: string - required: - - id - - name - - development_mode - - owner - - account - - meta - - original_name_servers - - original_registrar - - original_dnshost - - created_on - - modified_on - - activated_on - type: object - schemas-create: - properties: - account: - description: Account in which the zone was created. - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: object - name: - $ref: '#/components/schemas/properties-name' - type: - $ref: '#/components/schemas/components-schemas-type' - required: - - name - - account - type: object - components-schemas-response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - properties-name: - description: The domain name - example: example.com - maxLength: 253 - pattern: '^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$' - readOnly: true - type: string - components-schemas-type: - description: A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. - enum: - - full - - partial - example: full - type: string - schemas-identifier: {} - api-response-single-id: - allOf: - - $ref: '#/components/schemas/api-response-common' - - properties: - result: - nullable: true - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - required: - - id - type: object - schemas-patch: - example: - paused: true - properties: - paused: - $ref: '#/components/schemas/paused' - plan: - description: 'The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans.' - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - type: object - type: - description: A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone. - enum: - - full - - partial - example: full - type: string - vanity_name_servers: - $ref: '#/components/schemas/vanity_name_servers' - type: object - paused: - default: false - description: Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits. - readOnly: true - type: boolean - vanity_name_servers: - description: |- - An array of domains used for custom name servers. This is only - available for Business and Enterprise plans. - example: - - ns1.example.com - - ns2.example.com - items: - format: hostname - maxLength: 253 - type: string - type: array - purge_by_cache_tags_or_hosts_or_prefixes: - properties: - hosts: - description: Any assets at URLs with a host that matches one of the provided values will be purged from the Cloudflare cache. - example: - - www.example.com - - images.example.com - items: + - '#analytics:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + /zones/{zone_id}: + delete: + description: Deletes an existing zone. + operationId: zones-0-delete + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - maxLength: 30 - type: array - prefixes: - description: 'Any assets at URLs that match the prefix will be purged from the Cloudflare cache. For example, a.com/b will purge a.com/b/c/d.png but not a.com/bc.png. The prefixes a.com/b and a.com/b/c are redundant.' - example: - - www.example.com/foo - - images.example.com/bar/baz - items: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/zonesApiResponseSingleId' + description: Delete Zone response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesApiResponseCommonFailure' + description: Delete Zone response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Delete Zone + tags: + - Zone + x-api-token-group: + - Zone Write + x-cfPermissionsRequired: + enum: + - '#zone:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zones + resource_chain: [] + method: delete + get: + operationId: zones-0-get + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - maxLength: 30 - type: array - tags: - description: Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the Cloudflare cache. - example: - - some-tag - - another-tag - items: + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful. + type: boolean + result: + $ref: '#/components/schemas/zonesZone' + required: + - success + - errors + - messages + type: object + description: Zone Details response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesApiResponseCommonFailure' + description: Zone Details response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Zone Details + tags: + - Zone + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - 'Zero Trust: PII Read' + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + - 'Access: Apps and Policies Revoke' + - 'Access: Mutual TLS Certificates Write' + - 'Access: Organizations, Identity Providers, and Groups Write' + - Zone Settings Write + - Zone Settings Read + - Zone Read + - DNS Read + - Workers Scripts Write + - Workers Scripts Read + - Zone Write + - Workers Routes Write + - Workers Routes Read + - Stream Write + - Stream Read + - SSL and Certificates Write + - SSL and Certificates Read + - Logs Write + - Logs Read + - Cache Purge + - Page Rules Write + - Page Rules Read + - Load Balancers Write + - Load Balancers Read + - Firewall Services Write + - Firewall Services Read + - DNS Write + - Apps Write + - Analytics Read + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-cfPermissionsRequired: + enum: + - '#zone:read' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zones + resource_chain: [] + method: get + patch: + description: Edits a zone. Only one zone property can be changed at a time. + operationId: zones-0-patch + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - maxLength: 30 - type: array - colo_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - query: - $ref: '#/components/schemas/query_response' - result: - $ref: '#/components/schemas/datacenters' - analytics: - properties: - id: - default: 1 - type: integer - origins: - example: - - address: 198.51.100.4 - changed: true - enabled: true - failure_reason: No failures - healthy: true - ip: 198.51.100.4 - name: some-origin - items: {} - type: array - pool: - example: - changed: true - healthy: true - id: 74bc6a8b9b0dda3d651707a2928bad0c - minimum_origins: 1 - name: some-pool - type: object - timestamp: - example: '2014-01-01T05:20:00.12345Z' - format: date-time - type: string - type: object - query_response: - description: The exact parameters/timestamps the analytics service used to return data. - properties: - since: - $ref: '#/components/schemas/since' - time_delta: - description: The amount of time (in minutes) that each data point in the timeseries represents. The granularity of the time-series returned (e.g. each bucket in the time series representing 1-minute vs 1-day) is calculated by the API based on the time-range provided to the API. - type: integer - until: - $ref: '#/components/schemas/until' - readOnly: true - type: object - datacenters: - description: A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only. - items: - properties: - colo_id: - description: The airport code identifer for the co-location. - example: SFO + requestBody: + content: + application/json: + schema: + properties: + paused: + $ref: '#/components/schemas/zonesPaused' + type: + description: >- + A full zone implies that DNS is hosted with Cloudflare. A + partial zone is typically a partner-hosted zone or a CNAME + setup. This parameter is only available to Enterprise + customers or if it has been explicitly enabled on a zone. + enum: + - full + - partial + - secondary + - internal + type: string + vanity_name_servers: + $ref: '#/components/schemas/zonesVanityNameServers' + type: object + responses: + '200': + content: + application/json: + schema: + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful. + type: boolean + result: + $ref: '#/components/schemas/zonesZone' + required: + - success + - errors + - messages + type: object + description: Edit Zone response. + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesApiResponseCommonFailure' + description: Edit Zone response failure. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Edit Zone + tags: + - Zone + x-api-token-group: + - Zone Write + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zones + resource_chain: [] + method: edit + /zones/{zone_id}/activation_check: + put: + description: >- + Triggeres a new activation check for a PENDING Zone. This can be + triggered every 5 min for paygo/ent customers, every hour for FREE + Zones. + operationId: put-zones-zone_id-activation_check + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: type: string - timeseries: - $ref: '#/components/schemas/timeseries_by_colo' - totals: - $ref: '#/components/schemas/totals_by_colo' - type: object - title: Analytics data by datacenter - type: array - since: - anyOf: - - type: string - - type: integer - default: -10080 - description: |- - The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year. - - Ranges that the Cloudflare web application provides will provide the following period length for each point: - - Last 60 minutes (from -59 to -1): 1 minute resolution - - Last 7 hours (from -419 to -60): 15 minutes resolution - - Last 15 hours (from -899 to -420): 30 minutes resolution - - Last 72 hours (from -4320 to -900): 1 hour resolution - - Older than 3 days (-525600 to -4320): 1 day resolution. - example: '2015-01-01T12:23:00Z' - until: - anyOf: - - type: string - - type: integer - default: 0 - description: 'The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.' - example: '2015-01-02T12:23:00Z' - timeseries_by_colo: - description: Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters. - items: - properties: - bandwidth: - $ref: '#/components/schemas/bandwidth_by_colo' - requests: - $ref: '#/components/schemas/requests_by_colo' - since: - $ref: '#/components/schemas/since' - threats: - $ref: '#/components/schemas/threats' - until: - $ref: '#/components/schemas/until' - type: object - type: array - totals_by_colo: - description: Breakdown of totals by data type. - properties: - bandwidth: - $ref: '#/components/schemas/bandwidth_by_colo' - requests: - $ref: '#/components/schemas/requests_by_colo' - since: - $ref: '#/components/schemas/since' - threats: - $ref: '#/components/schemas/threats' - until: - $ref: '#/components/schemas/until' - type: object - bandwidth_by_colo: - description: Breakdown of totals for bandwidth in the form of bytes. - properties: - all: - description: The total number of bytes served within the time frame. - type: integer - cached: - description: The number of bytes that were cached (and served) by Cloudflare. - type: integer - uncached: - description: The number of bytes that were fetched and served from the origin server. - type: integer - type: object - requests_by_colo: - description: Breakdown of totals for requests. - properties: - all: - description: Total number of requests served. - type: integer - cached: - description: Total number of cached requests served. - type: integer - country: - additionalProperties: true - description: Key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country. - example: - AG: 37298 - GI: 293846 - US: 4181364 - type: object - http_status: - description: A variable list of key/value pairs where the key is a HTTP status code and the value is the number of requests with that code served. - example: - '200': 13496983 - '301': 283 - '400': 187936 - '402': 1828 - '404': 1293 - type: object - uncached: - description: Total number of requests served from the origin. - type: integer - type: object - threats: - description: Breakdown of totals for threats. - properties: - all: - description: The total number of identifiable threats received over the time frame. - type: integer - country: - description: A list of key/value pairs where the key is a two-digit country code and the value is the number of malicious requests received from that country. - example: - AU: 91 - CN: 523423 - US: 123 - type: object - type: - description: The list of key/value pairs where the key is a threat category and the value is the number of requests. - example: - hot.ban.unknown: 5324 - macro.chl.captchaErr: 1341 - macro.chl.jschlErr: 5323 - user.ban.ip: 123 - type: object - type: object - dashboard_response: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - query: - $ref: '#/components/schemas/query_response' - result: - $ref: '#/components/schemas/dashboard' - dashboard: - description: Totals and timeseries data. - properties: - timeseries: - $ref: '#/components/schemas/timeseries' - totals: - $ref: '#/components/schemas/totals' - title: Dashboard response - type: object - timeseries: - description: Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters. - items: - properties: - bandwidth: - $ref: '#/components/schemas/bandwidth' - pageviews: - $ref: '#/components/schemas/pageviews' - requests: - $ref: '#/components/schemas/schemas-requests' - since: - $ref: '#/components/schemas/since' - threats: - $ref: '#/components/schemas/threats' - uniques: - $ref: '#/components/schemas/uniques' - until: - $ref: '#/components/schemas/until' - type: object - type: array - totals: - description: Breakdown of totals by data type. - properties: - bandwidth: - $ref: '#/components/schemas/bandwidth' - pageviews: - $ref: '#/components/schemas/pageviews' - requests: - $ref: '#/components/schemas/schemas-requests' - since: - $ref: '#/components/schemas/since' - threats: - $ref: '#/components/schemas/threats' - uniques: - $ref: '#/components/schemas/uniques' - until: - $ref: '#/components/schemas/until' - type: object - bandwidth: - description: Breakdown of totals for bandwidth in the form of bytes. - properties: - all: - description: The total number of bytes served within the time frame. - type: integer - cached: - description: The number of bytes that were cached (and served) by Cloudflare. - type: integer - content_type: - description: 'A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served.' - example: - css: 237421 - gif: 1234242 - html: 1231290 - javascript: 123245 - jpeg: 784278 - type: object - country: - description: A variable list of key/value pairs where the key is a two-digit country code and the value is the number of bytes served to that country. - example: - AG: 2342483 - GI: 984753 - US: 123145433 - type: object - ssl: - description: A break down of bytes served over HTTPS. - properties: - encrypted: - description: The number of bytes served over HTTPS. - type: integer - unencrypted: - description: The number of bytes served over HTTP. - type: integer - type: object - ssl_protocols: - description: A breakdown of requests by their SSL protocol. - properties: - TLSv1: - description: The number of requests served over TLS v1.0. - type: integer - TLSv1.1: - description: The number of requests served over TLS v1.1. - type: integer - TLSv1.2: - description: The number of requests served over TLS v1.2. - type: integer - TLSv1.3: - description: The number of requests served over TLS v1.3. - type: integer - none: - description: The number of requests served over HTTP. - type: integer - type: object - uncached: - description: The number of bytes that were fetched and served from the origin server. - type: integer - type: object - pageviews: - description: Breakdown of totals for pageviews. - properties: - all: - description: The total number of pageviews served within the time range. - type: integer - search_engine: - description: A variable list of key/value pairs representing the search engine and number of hits. - example: - baidubot: 1345 - bingbot: 5372 - googlebot: 35272 - pingdom: 13435 - type: object - type: object - schemas-requests: - description: Breakdown of totals for requests. - properties: - all: - description: Total number of requests served. - type: integer - cached: - description: Total number of cached requests served. - type: integer - content_type: - description: 'A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests.' - example: - css: 15343 - gif: 23178 - html: 1234213 - javascript: 318236 - jpeg: 1982048 - type: object - country: - description: A variable list of key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country. - example: - AG: 37298 - GI: 293846 - US: 4181364 - type: object - http_status: - additionalProperties: true - description: Key/value pairs where the key is a HTTP status code and the value is the number of requests served with that code. - example: - '200': 13496983 - '301': 283 - '400': 187936 - '402': 1828 - '404': 1293 - type: object - ssl: - description: A break down of requests served over HTTPS. - properties: - encrypted: - description: The number of requests served over HTTPS. - type: integer - unencrypted: - description: The number of requests served over HTTP. - type: integer - type: object - ssl_protocols: - description: A breakdown of requests by their SSL protocol. - properties: - TLSv1: - description: The number of requests served over TLS v1.0. - type: integer - TLSv1.1: - description: The number of requests served over TLS v1.1. - type: integer - TLSv1.2: - description: The number of requests served over TLS v1.2. - type: integer - TLSv1.3: - description: The number of requests served over TLS v1.3. - type: integer - none: - description: The number of requests served over HTTP. - type: integer - type: object - uncached: - description: Total number of requests served from the origin. - type: integer - type: object - uniques: - properties: - all: - description: Total number of unique IP addresses within the time range. - type: integer - type: object - zone_cache_settings_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - cache_reserve_response_value: - properties: - result: - allOf: - - $ref: '#/components/schemas/cache_reserve' - - properties: - value: - $ref: '#/components/schemas/cache_reserve_value' - required: - - value - cache_reserve: - allOf: - - $ref: '#/components/schemas/components-schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - cache_reserve - example: cache_reserve - description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.' - title: Cache Reserve - cache_reserve_value: - default: 'off' - description: Value of the Cache Reserve zone setting. - enum: - - 'on' - - 'off' - type: string - components-schemas-base: - properties: - id: - description: Identifier of the zone setting. - example: development_mode - type: string - modified_on: - description: last time this setting was modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - nullable: true - readOnly: true - type: string - required: - - id - - modified_on - variants: - allOf: - - $ref: '#/components/schemas/components-schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - variants - example: variants - description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' - title: Variants Caching - variants_response_value: - properties: - result: - allOf: - - $ref: '#/components/schemas/variants' - - properties: - value: - $ref: '#/components/schemas/variants_value' - required: - - value - variants_value: - description: Value of the zone setting. - properties: - avif: - description: List of strings with the MIME types of all the variants that should be served for avif. - example: - - image/webp - - image/jpeg - items: {} - type: array - uniqueItems: true - bmp: - description: List of strings with the MIME types of all the variants that should be served for bmp. - example: - - image/webp - - image/jpeg - items: {} - type: array - uniqueItems: true - gif: - description: List of strings with the MIME types of all the variants that should be served for gif. - example: - - image/webp - - image/jpeg - items: {} - type: array - uniqueItems: true - jp2: - description: List of strings with the MIME types of all the variants that should be served for jp2. - example: - - image/webp - - image/avif - items: {} - type: array - uniqueItems: true - jpeg: - description: List of strings with the MIME types of all the variants that should be served for jpeg. - example: - - image/webp - - image/avif - items: {} - type: array - uniqueItems: true - jpg: - description: List of strings with the MIME types of all the variants that should be served for jpg. - example: - - image/webp - - image/avif - items: {} - type: array - uniqueItems: true - jpg2: - description: List of strings with the MIME types of all the variants that should be served for jpg2. - example: - - image/webp - - image/avif - items: {} - type: array - uniqueItems: true - png: - description: List of strings with the MIME types of all the variants that should be served for png. - example: - - image/webp - - image/avif - items: {} - type: array - uniqueItems: true - tif: - description: List of strings with the MIME types of all the variants that should be served for tif. - example: - - image/webp - - image/avif - items: {} - type: array - uniqueItems: true - tiff: - description: List of strings with the MIME types of all the variants that should be served for tiff. - example: - - image/webp - - image/avif - items: {} - type: array - uniqueItems: true - webp: - description: List of strings with the MIME types of all the variants that should be served for webp. - example: - - image/jpeg - - image/avif - items: {} - type: array - uniqueItems: true - type: object - zonelockdown_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/zonelockdown' - type: array - required: - - result - type: object - zonelockdown: - additionalProperties: false - properties: - configurations: - $ref: '#/components/schemas/configurations' - created_on: - $ref: '#/components/schemas/schemas-created_on' - description: - $ref: '#/components/schemas/lockdowns_components-schemas-description' - id: - $ref: '#/components/schemas/lockdowns_components-schemas-id' - modified_on: - $ref: '#/components/schemas/lockdowns_components-schemas-modified_on' - paused: - $ref: '#/components/schemas/components-schemas-paused' - urls: - $ref: '#/components/schemas/schemas-urls' - required: - - id - - created_on - - modified_on - - paused - - description - - urls - - configurations - configurations: - anyOf: - - $ref: '#/components/schemas/schemas-ip_configuration' - - $ref: '#/components/schemas/schemas-cidr_configuration' - description: A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations. - items: - anyOf: - - $ref: '#/components/schemas/schemas-ip_configuration' - - $ref: '#/components/schemas/schemas-cidr_configuration' - type: array - schemas-created_on: - description: The timestamp of when the rule was created. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - lockdowns_components-schemas-description: - description: An informative summary of the rule. - example: Restrict access to these endpoints to requests from a known IP address - maxLength: 1024 - type: string - lockdowns_components-schemas-id: - description: The unique identifier of the Zone Lockdown rule. - example: 372e67954025e0ba6aaa6d586b9e0b59 - maxLength: 32 - readOnly: true - type: string - lockdowns_components-schemas-modified_on: - description: The timestamp of when the rule was last modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - readOnly: true - type: string - components-schemas-paused: - description: 'When true, indicates that the rule is currently paused.' - example: false - type: boolean - schemas-urls: - description: 'The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.' - items: - example: api.mysite.com/some/endpoint* - type: string - type: array - schemas-ip_configuration: - properties: - target: - description: The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule. - enum: - - ip - example: ip - value: - description: The IP address to match. This address will be compared to the IP address of incoming requests. - example: 198.51.100.4 - type: string - title: An IP address configuration. - schemas-cidr_configuration: - properties: - target: - description: The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule. - enum: - - ip_range - example: ip_range - value: - description: The IP address range to match. You can only use prefix lengths `/16` and `/24`. - example: 198.51.100.4/16 - type: string - title: An IP address range configuration. - zonelockdown_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/zonelockdown' - required: - - result - type: object - available-rate-plan: - properties: - can_subscribe: - $ref: '#/components/schemas/can_subscribe' - currency: - $ref: '#/components/schemas/currency' - externally_managed: - $ref: '#/components/schemas/externally_managed' - frequency: - $ref: '#/components/schemas/schemas-frequency' - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - is_subscribed: - $ref: '#/components/schemas/is_subscribed' - legacy_discount: - $ref: '#/components/schemas/legacy_discount' - legacy_id: - $ref: '#/components/schemas/legacy_id' - name: - $ref: '#/components/schemas/rate-plan_components-schemas-name' - price: - $ref: '#/components/schemas/schemas-price' - type: object - can_subscribe: - default: false - description: Indicates whether you can subscribe to this plan. - example: true - type: boolean - currency: - description: The monetary unit in which pricing information is displayed. - example: USD - readOnly: true - type: string - externally_managed: - default: false - description: Indicates whether this plan is managed externally. - example: false - type: boolean - schemas-frequency: - description: The frequency at which you will be billed for this plan. - enum: - - weekly - - monthly - - quarterly - - yearly - example: monthly - readOnly: true - type: string - is_subscribed: - default: false - description: Indicates whether you are currently subscribed to this plan. - example: false - type: boolean - legacy_discount: - default: false - description: Indicates whether this plan has a legacy discount applied. - example: false - type: boolean - legacy_id: - description: 'The legacy identifier for this rate plan, if any.' - example: free - readOnly: true - type: string - rate-plan_components-schemas-name: - description: The plan name. - example: Free Plan - maxLength: 80 - readOnly: true - type: string - schemas-price: - description: The amount you will be billed for this plan. - example: 0 - type: number - plan_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/schemas-rate-plan' - type: array - type: object - schemas-rate-plan: - allOf: - - $ref: '#/components/schemas/rate-plan' - rate-plan: - properties: - components: - $ref: '#/components/schemas/schemas-component_values' - currency: - $ref: '#/components/schemas/currency' - duration: - $ref: '#/components/schemas/duration' - frequency: - $ref: '#/components/schemas/schemas-frequency' - id: - $ref: '#/components/schemas/rate-plan_components-schemas-identifier' - name: - $ref: '#/components/schemas/rate-plan_components-schemas-name' - type: object - schemas-component_values: - description: Array of available components values for the plan. - items: - $ref: '#/components/schemas/component-value' - type: array - duration: - description: The duration of the plan subscription. - example: 1 - type: number - rate-plan_components-schemas-identifier: - description: Plan identifier tag. - example: free - readOnly: true - type: string - component-value: - properties: - default: - $ref: '#/components/schemas/default' - name: - $ref: '#/components/schemas/component-value_components-schemas-name' - unit_price: - $ref: '#/components/schemas/unit_price' - type: object - default: - description: The default amount allocated. - example: 5 - type: number - component-value_components-schemas-name: - description: The unique component. - enum: - - zones - - page_rules - - dedicated_certificates - - dedicated_certificates_custom - example: page_rules - unit_price: - description: The unit price of the addon. - example: 1 - readOnly: true - type: number - zone_settings_response_collection: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - anyOf: - - items: {} - type: array - - type: object - items: - $ref: '#/components/schemas/setting' - setting: - oneOf: - - $ref: '#/components/schemas/always_online' - - $ref: '#/components/schemas/advanced_ddos' - - $ref: '#/components/schemas/brotli' - - $ref: '#/components/schemas/browser_cache_ttl' - - $ref: '#/components/schemas/browser_check' - - $ref: '#/components/schemas/cname_flattening' - - $ref: '#/components/schemas/cache_level' - - $ref: '#/components/schemas/challenge_ttl' - - $ref: '#/components/schemas/development_mode' - - $ref: '#/components/schemas/early_hints' - - $ref: '#/components/schemas/edge_cache_ttl' - - $ref: '#/components/schemas/origin_error_page_pass_thru' - - $ref: '#/components/schemas/sort_query_string_for_cache' - - $ref: '#/components/schemas/email_obfuscation' - - $ref: '#/components/schemas/hotlink_protection' - - $ref: '#/components/schemas/ip_geolocation' - - $ref: '#/components/schemas/ipv6' - - $ref: '#/components/schemas/websockets' - - $ref: '#/components/schemas/sha1_support' - - $ref: '#/components/schemas/tls_1_2_only' - - $ref: '#/components/schemas/minify' - - $ref: '#/components/schemas/max_upload' - - $ref: '#/components/schemas/mobile_redirect' - - $ref: '#/components/schemas/mirage' - - $ref: '#/components/schemas/nel' - - $ref: '#/components/schemas/polish' - - $ref: '#/components/schemas/webp' - - $ref: '#/components/schemas/prefetch_preload' - - $ref: '#/components/schemas/privacy_pass' - - $ref: '#/components/schemas/response_buffering' - - $ref: '#/components/schemas/rocket_loader' - - $ref: '#/components/schemas/security_header' - - $ref: '#/components/schemas/security_level' - - $ref: '#/components/schemas/server_side_exclude' - - $ref: '#/components/schemas/ssl' - - $ref: '#/components/schemas/ssl_recommender' - - $ref: '#/components/schemas/tls_client_auth' - - $ref: '#/components/schemas/true_client_ip_header' - - $ref: '#/components/schemas/proxy_read_timeout' - - $ref: '#/components/schemas/waf' - - $ref: '#/components/schemas/min_tls_version' - - $ref: '#/components/schemas/ciphers' - - $ref: '#/components/schemas/tls_1_3' - - $ref: '#/components/schemas/opportunistic_encryption' - - $ref: '#/components/schemas/automatic_https_rewrites' - - $ref: '#/components/schemas/http2' - - $ref: '#/components/schemas/http3' - - $ref: '#/components/schemas/origin_max_http_version' - - $ref: '#/components/schemas/0rtt' - - $ref: '#/components/schemas/pseudo_ipv4' - - $ref: '#/components/schemas/always_use_https' - - $ref: '#/components/schemas/opportunistic_onion' - - $ref: '#/components/schemas/orange_to_orange' - - $ref: '#/components/schemas/image_resizing' - - $ref: '#/components/schemas/h2_prioritization' - - $ref: '#/components/schemas/schemas-automatic_platform_optimization' - type: object - always_online: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - always_online - example: always_online - value: - $ref: '#/components/schemas/always_online_value' - description: 'When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive''s Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.' - title: Always Online Mode - advanced_ddos: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - advanced_ddos - example: advanced_ddos - value: - $ref: '#/components/schemas/advanced_ddos_value' - description: Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. - title: Advanced DDoS Protection - brotli: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - brotli - example: brotli - value: - $ref: '#/components/schemas/brotli_value' - description: 'When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.' - title: Brotli Compression - browser_cache_ttl: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - browser_cache_ttl - example: browser_cache_ttl - value: - $ref: '#/components/schemas/browser_cache_ttl_value' - description: 'Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors'' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).' - title: Browser Cache TTL - browser_check: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - browser_check - example: browser_check - value: - $ref: '#/components/schemas/browser_check_value' - description: 'Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).' - title: Browser Check - cname_flattening: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: How to flatten the cname destination. - enum: - - cname_flattening - example: flatten_at_root - value: - $ref: '#/components/schemas/cname_flattening_value' - description: Whether or not cname flattening is on. - title: Cloudflare CNAME Flattening - cache_level: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - cache_level - example: cache_level - value: - $ref: '#/components/schemas/cache_level_value' - description: 'Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).' - title: Cloudflare Cache Level - challenge_ttl: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - challenge_ttl - example: challenge_ttl - value: - $ref: '#/components/schemas/challenge_ttl_value' - description: 'Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).' - title: Challenge Page TTL - development_mode: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - development_mode - example: development_mode - time_remaining: - description: |- - Value of the zone setting. - Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false. - example: 3600 - readOnly: true - type: number - value: - $ref: '#/components/schemas/development_mode_value' - description: 'Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare''s accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.' - title: Development Mode - early_hints: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - early_hints - example: early_hints - value: - $ref: '#/components/schemas/early_hints_value' - description: 'When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.' - title: Early Hints - edge_cache_ttl: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - edge_cache_ttl - example: edge_cache_ttl - value: - $ref: '#/components/schemas/edge_cache_ttl_value' - description: Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers. - title: Edge Cache TTL - origin_error_page_pass_thru: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - origin_error_page_pass_thru - example: origin_error_page_pass_thru - value: - $ref: '#/components/schemas/origin_error_page_pass_thru_value' - default: 'off' - description: 'Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.' - title: Error Pages On - sort_query_string_for_cache: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - sort_query_string_for_cache - example: sort_query_string_for_cache - value: - $ref: '#/components/schemas/sort_query_string_for_cache_value' - default: 'off' - description: 'Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.' - title: Get String Sort - email_obfuscation: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - email_obfuscation - example: email_obfuscation - value: - $ref: '#/components/schemas/email_obfuscation_value' - description: 'Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).' - title: Email Obfuscation - hotlink_protection: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - hotlink_protection - example: hotlink_protection - value: - $ref: '#/components/schemas/hotlink_protection_value' - description: 'When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it''s not another site requesting them. People will still be able to download and view images from your page, but other sites won''t be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).' - title: Hotlink Protection - ip_geolocation: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - ip_geolocation - example: ip_geolocation - value: - $ref: '#/components/schemas/ip_geolocation_value' - description: 'Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).' - title: IP Geolocation - ipv6: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - ipv6 - example: ipv6 - value: - $ref: '#/components/schemas/ipv6_value' - description: 'Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).' - title: IPv6 - websockets: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - websockets - example: websockets - value: - $ref: '#/components/schemas/websockets_value' - description: 'WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).' - title: WebSockets - sha1_support: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: Zone setting identifier. - enum: - - sha1_support - example: sha1_support - value: - $ref: '#/components/schemas/sha1_support_value' - description: Allow SHA1 support. - title: Toggle SHA1 support - tls_1_2_only: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: Zone setting identifier. - enum: - - tls_1_2_only - example: tls_1_2_only - value: - $ref: '#/components/schemas/tls_1_2_only_value' - description: Only allows TLS1.2. - title: TLS1.2 only - minify: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: Zone setting identifier. - enum: - - minify - example: minify - value: - $ref: '#/components/schemas/minify_value' - description: 'Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.' - title: Auto-Minify Assets - max_upload: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: identifier of the zone setting. - enum: - - max_upload - example: max_upload - value: - $ref: '#/components/schemas/max_upload_value' - description: Maximum size of an allowable upload. - title: Max Upload - mobile_redirect: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: Identifier of the zone setting. - enum: - - mobile_redirect - example: mobile_redirect - value: - $ref: '#/components/schemas/mobile_redirect_value' - description: 'Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.' - title: Mobile Redirect - mirage: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - mirage - example: mirage - value: - $ref: '#/components/schemas/mirage_value' - description: 'Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.' - title: Mirage Image Optimization - nel: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: Zone setting identifier. - enum: - - nel - example: nel - value: - $ref: '#/components/schemas/nel_value' - description: 'Enable Network Error Logging reporting on your zone. (Beta) ' - title: Network Error Logging - polish: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - polish - example: polish - value: - $ref: '#/components/schemas/polish_value' - description: 'Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.' - title: Polish Image Optimization - webp: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - webp - example: webp - value: - $ref: '#/components/schemas/webp_value' - description: 'When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.' - title: Polish WebP Conversion - prefetch_preload: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - prefetch_preload - example: prefetch_preload - value: - $ref: '#/components/schemas/prefetch_preload_value' - default: 'off' - description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - title: Prefetch preload - privacy_pass: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - privacy_pass - example: privacy_pass - value: - $ref: '#/components/schemas/privacy_pass_value' - description: 'Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).' - title: Privacy Pass - response_buffering: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - response_buffering - example: response_buffering - value: - $ref: '#/components/schemas/response_buffering_value' - default: 'off' - description: 'Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.' - title: Response Buffering - rocket_loader: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - rocket_loader - example: rocket_loader - value: - $ref: '#/components/schemas/rocket_loader_value' - description: 'Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site''s Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page''s rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.' - title: Rocket Loader - security_header: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone's security header. - enum: - - security_header - example: security_header - value: - $ref: '#/components/schemas/security_header_value' - description: Cloudflare security header for a zone. - title: Security Header - security_level: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - security_level - example: security_level - value: - $ref: '#/components/schemas/security_level_value' - description: 'Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).' - title: Security Level - server_side_exclude: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - server_side_exclude - example: server_side_exclude - value: - $ref: '#/components/schemas/server_side_exclude_value' - description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won''t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).' - title: Server Side Exclude - ssl: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - ssl - example: ssl - value: - $ref: '#/components/schemas/ssl_value' - description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).' - title: SSL - ssl_recommender: - allOf: - - properties: - enabled: - $ref: '#/components/schemas/ssl_recommender_enabled' - id: - description: Enrollment value for SSL/TLS Recommender. - enum: - - ssl_recommender - example: ssl_recommender - - properties: - editable: - $ref: '#/components/schemas/editable' - modified_on: - $ref: '#/components/schemas/properties-modified_on' - description: Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - title: SSL/TLS Recommender - tls_client_auth: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - tls_client_auth - example: tls_client_auth - value: - $ref: '#/components/schemas/tls_client_auth_value' - description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - title: TLS Client Authentication - true_client_ip_header: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - true_client_ip_header - example: true_client_ip_header - value: - $ref: '#/components/schemas/true_client_ip_header_value' - default: 'off' - description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. - title: True Client IP Header - proxy_read_timeout: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - proxy_read_timeout - example: proxy_read_timeout - value: - $ref: '#/components/schemas/proxy_read_timeout_value' - description: Maximum time between two read operations from origin. - title: Proxy Read Timeout - waf: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - waf - example: waf - value: - $ref: '#/components/schemas/waf_value' - description: 'The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will ''challenge'' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare''s WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).' - title: Web Application Firewall - min_tls_version: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - min_tls_version - example: min_tls_version - value: - $ref: '#/components/schemas/min_tls_version_value' - default: '1.0' - description: 'Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.' - title: Zone Minimum TLS Version value - ciphers: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - ciphers - example: ciphers - value: - $ref: '#/components/schemas/ciphers_value' - default: [] - description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. - title: Zone ciphers allowed for TLS termination - tls_1_3: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - tls_1_3 - example: tls_1_3 - value: - $ref: '#/components/schemas/tls_1_3_value' - default: 'off' - description: Enables Crypto TLS 1.3 feature for a zone. - title: Enable TLS 1.3 value for a zone - opportunistic_encryption: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - opportunistic_encryption - example: opportunistic_encryption - value: - $ref: '#/components/schemas/opportunistic_encryption_value' - description: Enables the Opportunistic Encryption feature for a zone. - title: Enable Opportunistic Encryption for a zone - automatic_https_rewrites: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - automatic_https_rewrites - example: automatic_https_rewrites - value: - $ref: '#/components/schemas/automatic_https_rewrites_value' - default: 'off' - description: Enable the Automatic HTTPS Rewrites feature for this zone. - title: Zone Enable Automatic HTTPS Rewrites - http2: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - http2 - example: http2 - value: - $ref: '#/components/schemas/http2_value' - description: HTTP2 enabled for this zone. - title: HTTP2 Value - http3: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - http3 - example: http3 - value: - $ref: '#/components/schemas/http3_value' - description: HTTP3 enabled for this zone. - title: HTTP3 Value - origin_max_http_version: - allOf: - - properties: - id: - description: Identifier of the zone setting. - enum: - - origin_max_http_version - example: origin_max_http_version - modified_on: - description: last time this setting was modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - nullable: true - readOnly: true - type: string - required: - - id - description: 'The highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.).' - title: Origin Max HTTP version - 0rtt: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - 0rtt - example: 0rtt - value: - $ref: '#/components/schemas/0rtt_value' - description: 0-RTT session resumption enabled for this zone. - title: 0-RTT Value - pseudo_ipv4: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - default: pseudo_ipv4 - description: Value of the Pseudo IPv4 setting. - enum: - - pseudo_ipv4 - value: - $ref: '#/components/schemas/pseudo_ipv4_value' - description: The value set for the Pseudo IPv4 setting. - title: Pseudo IPv4 Value - always_use_https: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - always_use_https - example: always_use_https - value: - $ref: '#/components/schemas/always_use_https_value' - default: 'off' - description: 'Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.' - title: Zone Enable Always Use HTTPS - opportunistic_onion: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - opportunistic_onion - example: opportunistic_onion - value: - $ref: '#/components/schemas/opportunistic_onion_value' - default: 'off' - description: 'Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.' - title: Zone Enable Onion Routing - orange_to_orange: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - orange_to_orange - example: orange_to_orange - value: - $ref: '#/components/schemas/orange_to_orange_value' - description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - title: Orange to Orange - image_resizing: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - image_resizing - example: image_resizing - value: - $ref: '#/components/schemas/image_resizing_value' - description: 'Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare''s network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.' - title: Image Resizing - h2_prioritization: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - h2_prioritization - example: h2_prioritization - value: - $ref: '#/components/schemas/h2_prioritization_value' - description: HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. - title: HTTP/2 Edge Prioritization - schemas-automatic_platform_optimization: - allOf: - - $ref: '#/components/schemas/schemas-base' - - properties: - id: - description: ID of the zone setting. - enum: - - automatic_platform_optimization - example: automatic_platform_optimization - value: - $ref: '#/components/schemas/automatic_platform_optimization' - description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare''s edge network and caches third-party fonts.' - title: Automatic Platform Optimization for WordPress - schemas-base: - properties: - editable: - default: true - description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - enum: - - true - - false - readOnly: true - type: boolean - id: - description: Identifier of the zone setting. - example: development_mode - type: string - modified_on: - description: last time this setting was modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - nullable: true - readOnly: true - type: string - value: - anyOf: - - type: string - - type: number - - type: object - - items: {} - type: array - description: Current value of the zone setting. - example: 'on' - required: - - id - - value - always_online_value: - default: 'on' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - advanced_ddos_value: - default: 'off' - description: |- - Value of the zone setting. - Notes: Defaults to on for Business+ plans - enum: - - 'on' - - 'off' - type: string - brotli_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'off' - - 'on' - type: string - browser_cache_ttl_value: - default: 14400 - description: |- - Value of the zone setting. - Notes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers` - enum: - - 0 - - 30 - - 60 - - 120 - - 300 - - 1200 - - 1800 - - 3600 - - 7200 - - 10800 - - 14400 - - 18000 - - 28800 - - 43200 - - 57600 - - 72000 - - 86400 - - 172800 - - 259200 - - 345600 - - 432000 - - 691200 - - 1382400 - - 2073600 - - 2678400 - - 5356800 - - 16070400 - - 31536000 - type: number - browser_check_value: - default: 'on' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - cname_flattening_value: - default: flatten_at_root - description: Value of the cname flattening setting. - enum: - - flatten_at_root - - flatten_all - type: string - cache_level_value: - default: aggressive - description: Value of the zone setting. - enum: - - aggressive - - basic - - simplified - type: string - challenge_ttl_value: - default: 1800 - description: Value of the zone setting. - enum: - - 300 - - 900 - - 1800 - - 2700 - - 3600 - - 7200 - - 10800 - - 14400 - - 28800 - - 57600 - - 86400 - - 604800 - - 2592000 - - 31536000 - type: number - development_mode_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - early_hints_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - edge_cache_ttl_value: - default: 7200 - description: |- - Value of the zone setting. - Notes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200) - enum: - - 30 - - 60 - - 300 - - 1200 - - 1800 - - 3600 - - 7200 - - 10800 - - 14400 - - 18000 - - 28800 - - 43200 - - 57600 - - 72000 - - 86400 - - 172800 - - 259200 - - 345600 - - 432000 - - 518400 - - 604800 - type: number - origin_error_page_pass_thru_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - sort_query_string_for_cache_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - email_obfuscation_value: - default: 'on' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - hotlink_protection_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - ip_geolocation_value: - default: 'on' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - ipv6_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'off' - - 'on' - type: string - websockets_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'off' - - 'on' - type: string - sha1_support_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'off' - - 'on' - type: string - tls_1_2_only_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'off' - - 'on' - type: string - minify_value: - description: Value of the zone setting. - properties: - css: - default: 'off' - description: Automatically minify all CSS files for your website. - enum: - - 'on' - - 'off' - html: - default: 'off' - description: Automatically minify all HTML files for your website. - enum: - - 'on' - - 'off' - js: - default: 'off' - description: Automatically minify all JavaScript files for your website. - enum: - - 'on' - - 'off' - type: object - max_upload_value: - default: 100 - description: |- - Value of the zone setting. - Notes: The size depends on the plan level of the zone. (Enterprise = 500, Business = 200, Pro = 100, Free = 100) - enum: - - 100 - - 200 - - 500 - type: number - mobile_redirect_value: - description: Value of the zone setting. - properties: - mobile_subdomain: - description: Which subdomain prefix you wish to redirect visitors on mobile devices to (subdomain must already exist). - example: m - minLength: 1 - nullable: true - type: string - status: - default: 'off' - description: Whether or not mobile redirect is enabled. - enum: - - 'on' - - 'off' - strip_uri: - default: false - description: 'Whether to drop the current page path and redirect to the mobile subdomain URL root, or keep the path and redirect to the same page on the mobile subdomain.' - example: false - type: boolean - type: object - mirage_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - nel_value: - description: Value of the zone setting. - properties: - enabled: - default: false - example: false - type: boolean - type: object - polish_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'off' - - lossless - - lossy - type: string - webp_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'off' - - 'on' - type: string - prefetch_preload_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - privacy_pass_value: - default: 'on' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - response_buffering_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - rocket_loader_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - security_header_value: - properties: - strict_transport_security: - description: Strict Transport Security. - properties: - enabled: - description: Whether or not strict transport security is enabled. - example: true - type: boolean - include_subdomains: - description: Include all subdomains for strict transport security. - example: true - type: boolean - max_age: - description: Max age in seconds of the strict transport security. - example: 86400 - type: number - nosniff: - description: 'Whether or not to include ''X-Content-Type-Options: nosniff'' header.' - example: true - type: boolean - type: object - type: object - security_level_value: - default: medium - description: Value of the zone setting. - enum: - - 'off' - - essentially_off - - low - - medium - - high - - under_attack - type: string - server_side_exclude_value: - default: 'on' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - ssl_value: - default: 'off' - description: |- - Value of the zone setting. - Notes: Depends on the zone's plan level - enum: - - 'off' - - flexible - - full - - strict - type: string - ssl_recommender_enabled: - default: false - description: ssl-recommender enrollment setting. - type: boolean - editable: - default: true - description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). - enum: - - true - - false - readOnly: true - type: boolean - properties-modified_on: - description: last time this setting was modified. - example: '2014-01-01T05:20:00.12345Z' - format: date-time - nullable: true - readOnly: true - type: string - tls_client_auth_value: - default: 'on' - description: value of the zone setting. - enum: - - 'on' - - 'off' - type: string - true_client_ip_header_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - proxy_read_timeout_value: - default: 100 - description: |- - Value of the zone setting. - Notes: Value must be between 1 and 6000 - type: number - waf_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - min_tls_version_value: - default: '1.0' - description: Value of the zone setting. - enum: - - '1.0' - - '1.1' - - '1.2' - - '1.3' - type: string - ciphers_value: - default: [] - description: Value of the zone setting. - example: - - ECDHE-RSA-AES128-GCM-SHA256 - - AES128-SHA - items: - type: string - type: array - uniqueItems: true - tls_1_3_value: - default: 'off' - description: |- - Value of the zone setting. - Notes: Default value depends on the zone's plan level. - enum: - - 'on' - - 'off' - - zrt - type: string - opportunistic_encryption_value: - default: 'on' - description: |- - Value of the zone setting. - Notes: Default value depends on the zone's plan level. - enum: - - 'on' - - 'off' - type: string - automatic_https_rewrites_value: - default: 'on' - description: |- - Value of the zone setting. - Notes: Default value depends on the zone's plan level. - enum: - - 'on' - - 'off' - type: string - http2_value: - default: 'off' - description: Value of the HTTP2 setting. - enum: - - 'on' - - 'off' - type: string - http3_value: - default: 'off' - description: Value of the HTTP3 setting. - enum: - - 'on' - - 'off' - type: string - 0rtt_value: - default: 'off' - description: Value of the 0-RTT setting. - enum: - - 'on' - - 'off' - type: string - pseudo_ipv4_value: - default: 'off' - description: Value of the Pseudo IPv4 setting. - enum: - - 'off' - - add_header - - overwrite_header - type: string - always_use_https_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - opportunistic_onion_value: - default: 'off' - description: |- - Value of the zone setting. - Notes: Default value depends on the zone's plan level. - enum: - - 'on' - - 'off' - type: string - orange_to_orange_value: - default: 'on' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - type: string - image_resizing_value: - default: 'off' - description: 'Whether the feature is enabled, disabled, or enabled in `open proxy` mode.' - enum: - - 'on' - - 'off' - - open - type: string - h2_prioritization_value: - default: 'off' - description: Value of the zone setting. - enum: - - 'on' - - 'off' - - custom - type: string - automatic_platform_optimization: - properties: - cache_by_device_type: - description: 'Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.' - example: false - type: boolean - cf: - default: false - description: Indicates whether or not Cloudflare proxy is enabled. - example: true - type: boolean - enabled: - default: false - description: Indicates whether or not Automatic Platform Optimization is enabled. - example: true - type: boolean - hostnames: - description: An array of hostnames where Automatic Platform Optimization for WordPress is activated. - example: - - www.example.com - - example.com - - shop.example.com - items: - format: hostname - type: string - type: array - wordpress: - default: false - description: Indicates whether or not site is powered by WordPress. - example: true - type: boolean - wp_plugin: - default: false - description: 'Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.' - example: true - type: boolean - required: - - enabled - - cf - - wordpress - - wp_plugin - - hostnames - - cache_by_device_type - type: object - zone_settings_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - origin_max_http_version_response_value: - properties: - result: - allOf: - - $ref: '#/components/schemas/origin_max_http_version' - - properties: - value: - $ref: '#/components/schemas/origin_max_http_version_value' - required: - - value - origin_max_http_version_value: - default: '2' - description: Value of the Origin Max HTTP version setting (Note that the default value for Enterprise is "1"). - enum: - - '1' - - '2' - type: string - subscription-v2_components-schemas-identifier: - description: Subscription identifier tag. - example: 506e3185e9c882d175a2d0cb0093d9f2 - maxLength: 32 - readOnly: true - type: string - zone_subscription_response_single: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - type: object - type: object - subscription-v2: - properties: - app: - properties: - install_id: - $ref: '#/components/schemas/install_id' - component_values: - $ref: '#/components/schemas/component_values' - currency: - $ref: '#/components/schemas/currency' - current_period_end: - $ref: '#/components/schemas/current_period_end' - current_period_start: - $ref: '#/components/schemas/current_period_start' - frequency: - $ref: '#/components/schemas/frequency' - id: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' - price: - $ref: '#/components/schemas/price' - rate_plan: - $ref: '#/components/schemas/rate_plan' - state: - $ref: '#/components/schemas/state' - zone: - $ref: '#/components/schemas/zone' - type: object - install_id: - description: app install id. - type: string - component_values: - description: The list of add-ons subscribed to. - items: - $ref: '#/components/schemas/component_value' - type: array - current_period_end: - description: The end of the current period and also when the next billing is due. - example: '2014-03-31T12:20:00Z' - format: date-time - readOnly: true - type: string - current_period_start: - description: When the current billing period started. May match initial_period_start if this is the first period. - example: '2014-05-11T12:20:00Z' - format: date-time - readOnly: true - type: string - frequency: - description: How often the subscription is renewed automatically. - enum: - - weekly - - monthly - - quarterly - - yearly - example: monthly - type: string - price: - description: 'The price of the subscription that will be billed, in US dollars.' - example: 20 - readOnly: true - type: number - rate_plan: - description: The rate plan applied to the subscription. - properties: - currency: - description: The currency applied to the rate plan subscription. - example: USD - type: string - externally_managed: - description: Whether this rate plan is managed externally from Cloudflare. - example: false - type: boolean - id: - description: The ID of the rate plan. - example: free - is_contract: - description: Whether a rate plan is enterprise-based (or newly adopted term contract). - example: false - type: boolean - public_name: - description: The full name of the rate plan. - example: Business Plan - type: string - scope: - description: The scope that this rate plan applies to. - example: zone - type: string - sets: - description: The list of sets this rate plan applies to. - items: - type: string - type: array - type: object - state: - description: The state that the subscription is in. - enum: - - Trial - - Provisioned - - Paid - - AwaitingPayment - - Cancelled - - Failed - - Expired - example: Paid - readOnly: true - type: string - zone: - description: A simple zone object. May have null properties if not a zone subscription. - properties: - id: - $ref: '#/components/schemas/common_components-schemas-identifier' - name: - $ref: '#/components/schemas/properties-name' - type: object - component_value: - description: A component value for a subscription. - properties: - default: - description: The default amount assigned. - example: 5 - type: number - name: - description: The name of the component value. - example: page_rules - type: string - price: - description: The unit price for the component value. - example: 5 - type: number - value: - description: The amount of the component value assigned. - example: 20 - type: number - type: object - responses: {} - securitySchemes: - api_email: - in: header - name: X-Auth-Email - type: apiKey - api_key: - in: header - name: X-Auth-Key - type: apiKey - api_token: - scheme: bearer - type: http - user_service_key: - in: header - name: X-Auth-User-Service-Key - type: apiKey - x-stackQL-resources: - filters: - id: cloudflare.zones.filters - name: filters - title: Filters - methods: - delete_filters: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - list_filters: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _list_filters: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create_filters: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters/post' - response: - mediaType: application/json - openAPIDocKey: '200' - update_filters: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters/put' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_a_filter: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get_a_filter: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_a_filter: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_a_filter: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1filters~1{id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/filters/methods/list_filters' - - $ref: '#/components/x-stackQL-resources/filters/methods/get_a_filter' - insert: - - $ref: '#/components/x-stackQL-resources/filters/methods/create_filters' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/filters/methods/delete_filters' - - $ref: '#/components/x-stackQL-resources/filters/methods/delete_a_filter' - firewall_rules: - id: cloudflare.zones.firewall_rules - name: firewall_rules - title: Firewall Rules - methods: - delete_firewall_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - list_firewall_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _list_firewall_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_priority_of_firewall_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - create_firewall_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules/post' - response: - mediaType: application/json - openAPIDocKey: '200' - update_firewall_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules/put' - response: - mediaType: application/json - openAPIDocKey: '200' - delete_a_firewall_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get_a_firewall_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _get_a_firewall_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_priority_of_a_firewall_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules~1{id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - update_a_firewall_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1rules~1{id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/firewall_rules/methods/list_firewall_rules' - insert: - - $ref: '#/components/x-stackQL-resources/firewall_rules/methods/create_firewall_rules' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/firewall_rules/methods/delete_firewall_rules' - - $ref: '#/components/x-stackQL-resources/firewall_rules/methods/delete_a_firewall_rule' - healthchecks: - id: cloudflare.zones.healthchecks - name: healthchecks - title: Healthchecks - methods: - health_checks_list_health_checks: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _health_checks_list_health_checks: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - health_checks_create_health_check: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks/post' - response: - mediaType: application/json - openAPIDocKey: '200' - health_checks_delete_health_check: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - health_checks_health_check_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _health_checks_health_check_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - health_checks_patch_health_check: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - health_checks_update_health_check: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1{identifier}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/healthchecks/methods/health_checks_list_health_checks' - - $ref: '#/components/x-stackQL-resources/healthchecks/methods/health_checks_health_check_details' - insert: - - $ref: '#/components/x-stackQL-resources/healthchecks/methods/health_checks_create_health_check' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/healthchecks/methods/health_checks_delete_health_check' - healthchecks_preview: - id: cloudflare.zones.healthchecks_preview - name: healthchecks_preview - title: Healthchecks Preview - methods: - health_checks_create_preview_health_check: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1preview/post' - response: - mediaType: application/json - openAPIDocKey: '200' - health_checks_delete_preview_health_check: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1preview~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - health_checks_health_check_preview_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1preview~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _health_checks_health_check_preview_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1healthchecks~1preview~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/healthchecks_preview/methods/health_checks_health_check_preview_details' - insert: - - $ref: '#/components/x-stackQL-resources/healthchecks_preview/methods/health_checks_create_preview_health_check' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/healthchecks_preview/methods/health_checks_delete_preview_health_check' - managed_headers: - id: cloudflare.zones.managed_headers - name: managed_headers - title: Managed Headers - methods: - managed_transforms_list_managed_transforms: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1managed_headers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _managed_transforms_list_managed_transforms: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1managed_headers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - managed_transforms_update_status_of_managed_transforms: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1managed_headers/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/managed_headers/methods/managed_transforms_list_managed_transforms' - insert: [] - update: [] - delete: [] - rate_limits: - id: cloudflare.zones.rate_limits - name: rate_limits - title: Rate Limits - methods: - for_a_zone_list_rate_limits: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1rate_limits/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _for_a_zone_list_rate_limits: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1rate_limits/get' - response: - mediaType: application/json - openAPIDocKey: '200' - for_a_zone_create_a_rate_limit: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1rate_limits/post' - response: - mediaType: application/json - openAPIDocKey: '200' - for_a_zone_delete_a_rate_limit: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1rate_limits~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - for_a_zone_get_a_rate_limit: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1rate_limits~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _for_a_zone_get_a_rate_limit: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1rate_limits~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - for_a_zone_update_a_rate_limit: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1rate_limits~1{id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/rate_limits/methods/for_a_zone_list_rate_limits' - - $ref: '#/components/x-stackQL-resources/rate_limits/methods/for_a_zone_get_a_rate_limit' - insert: - - $ref: '#/components/x-stackQL-resources/rate_limits/methods/for_a_zone_create_a_rate_limit' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/rate_limits/methods/for_a_zone_delete_a_rate_limit' - rulesets_phases_entrypoint: - id: cloudflare.zones.rulesets_phases_entrypoint - name: rulesets_phases_entrypoint - title: Rulesets Phases Entrypoint - methods: - transform_rules_list_transform_rules: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{phase}~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _transform_rules_list_transform_rules: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{phase}~1entrypoint/get' - response: - mediaType: application/json - openAPIDocKey: '200' - transform_rules_update_transform_rules: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1rulesets~1phases~1{phase}~1entrypoint/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - url_normalization: - id: cloudflare.zones.url_normalization - name: url_normalization - title: Url Normalization - methods: - get_url_normalization_settings: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1url_normalization/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _get_url_normalization_settings: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1url_normalization/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_url_normalization_settings: - operation: - $ref: '#/paths/~1zones~1{zone_id}~1url_normalization/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/url_normalization/methods/get_url_normalization_settings' - insert: [] - update: [] - delete: [] - zones: - id: cloudflare.zones.zones - name: zones - title: Zones - methods: - zone_list_zones: - operation: - $ref: '#/paths/~1zones/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_list_zones: - operation: - $ref: '#/paths/~1zones/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_create_zone: - operation: - $ref: '#/paths/~1zones/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_delete_zone: - operation: - $ref: '#/paths/~1zones~1{identifier}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_zone_details: - operation: - $ref: '#/paths/~1zones~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_zone_details: - operation: - $ref: '#/paths/~1zones~1{identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_edit_zone: - operation: - $ref: '#/paths/~1zones~1{identifier}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/zones/methods/zone_list_zones' - - $ref: '#/components/x-stackQL-resources/zones/methods/zone_zone_details' - insert: - - $ref: '#/components/x-stackQL-resources/zones/methods/zone_create_zone' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/zones/methods/zone_delete_zone' - activation_check: - id: cloudflare.zones.activation_check - name: activation_check - title: Activation Check - methods: - zone_zone_activation_check: - operation: - $ref: '#/paths/~1zones~1{identifier}~1activation_check/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - purge_cache: - id: cloudflare.zones.purge_cache - name: purge_cache - title: Purge Cache - methods: - 'zone_purge_files_by_cache_tags,_host,_or_prefix': - operation: - $ref: '#/paths/~1zones~1{identifier}~1purge_cache/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - analytics_colos: - id: cloudflare.zones.analytics_colos - name: analytics_colos - title: Analytics Colos - methods: - zone_analytics___deprecated__get_analytics_by_co_locations: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1colos/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_analytics___deprecated__get_analytics_by_co_locations: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1colos/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/analytics_colos/methods/zone_analytics___deprecated__get_analytics_by_co_locations' - insert: [] - update: [] - delete: [] - analytics_dashboard: - id: cloudflare.zones.analytics_dashboard - name: analytics_dashboard - title: Analytics Dashboard - methods: - zone_analytics___deprecated__get_dashboard: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1dashboard/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_analytics___deprecated__get_dashboard: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1dashboard/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/analytics_dashboard/methods/zone_analytics___deprecated__get_dashboard' - insert: [] - update: [] - delete: [] - cache_reserve: - id: cloudflare.zones.cache_reserve - name: cache_reserve - title: Cache Reserve - methods: - zone_cache_settings_get_cache_reserve_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1cache~1cache_reserve/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_cache_settings_get_cache_reserve_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1cache~1cache_reserve/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_cache_settings_change_cache_reserve_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1cache~1cache_reserve/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cache_reserve/methods/zone_cache_settings_get_cache_reserve_setting' - insert: [] - update: [] - delete: [] - cache_variants: - id: cloudflare.zones.cache_variants - name: cache_variants - title: Cache Variants - methods: - zone_cache_settings_delete_variants_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1cache~1variants/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_cache_settings_get_variants_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1cache~1variants/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result.value - _zone_cache_settings_get_variants_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1cache~1variants/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_cache_settings_change_variants_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1cache~1variants/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cache_variants/methods/zone_cache_settings_get_variants_setting' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/cache_variants/methods/zone_cache_settings_delete_variants_setting' - firewall_lockdown_rules: - id: cloudflare.zones.firewall_lockdown_rules - name: firewall_lockdown_rules - title: Firewall Lockdown Rules - methods: - zone_lockdown_list_zone_lockdown_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1lockdowns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_lockdown_list_zone_lockdown_rules: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1lockdowns/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_lockdown_create_a_zone_lockdown_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1lockdowns/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_lockdown_delete_a_zone_lockdown_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1lockdowns~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_lockdown_get_a_zone_lockdown_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1lockdowns~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_lockdown_get_a_zone_lockdown_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1lockdowns~1{id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_lockdown_update_a_zone_lockdown_rule: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1firewall~1lockdowns~1{id}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/firewall_lockdown_rules/methods/zone_lockdown_list_zone_lockdown_rules' - insert: - - $ref: '#/components/x-stackQL-resources/firewall_lockdown_rules/methods/zone_lockdown_create_a_zone_lockdown_rule' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/firewall_lockdown_rules/methods/zone_lockdown_delete_a_zone_lockdown_rule' - available_plans: - id: cloudflare.zones.available_plans - name: available_plans - title: Available Plans - methods: - zone_rate_plan_list_available_plans: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1available_plans/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_rate_plan_list_available_plans: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1available_plans/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_rate_plan_available_plan_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1available_plans~1{plan_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_rate_plan_available_plan_details: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1available_plans~1{plan_identifier}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/available_plans/methods/zone_rate_plan_list_available_plans' - - $ref: '#/components/x-stackQL-resources/available_plans/methods/zone_rate_plan_available_plan_details' - insert: [] - update: [] - delete: [] - available_rate_plans: - id: cloudflare.zones.available_rate_plans - name: available_rate_plans - title: Available Rate Plans - methods: - zone_rate_plan_list_available_rate_plans: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1available_rate_plans/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_rate_plan_list_available_rate_plans: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1available_rate_plans/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/available_rate_plans/methods/zone_rate_plan_list_available_rate_plans' - insert: [] - update: [] - delete: [] - settings: - id: cloudflare.zones.settings - name: settings - title: Settings - methods: - zone_settings_get_all_zone_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_settings_get_all_zone_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_edit_zone_settings_info: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_get_0_rtt_session_resumption_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~10rtt/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_0_rtt_session_resumption_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~10rtt/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_0_rtt_session_resumption_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~10rtt/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_get_i_pv6_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ipv6/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_i_pv6_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ipv6/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_i_pv6_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ipv6/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_get_pseudo_i_pv4_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1pseudo_ipv4/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_pseudo_i_pv4_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1pseudo_ipv4/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_pseudo_i_pv4_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1pseudo_ipv4/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings/methods/zone_settings_get_all_zone_settings' - insert: [] - update: [] - delete: [] - settings_advanced_ddos: - id: cloudflare.zones.settings_advanced_ddos - name: settings_advanced_ddos - title: Settings Advanced Ddos - methods: - zone_settings_get_advanced_ddos_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1advanced_ddos/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_advanced_ddos_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1advanced_ddos/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_advanced_ddos/methods/zone_settings_get_advanced_ddos_setting' - insert: [] - update: [] - delete: [] - settings_always_online: - id: cloudflare.zones.settings_always_online - name: settings_always_online - title: Settings Always Online - methods: - zone_settings_get_always_online_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1always_online/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_always_online_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1always_online/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_always_online_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1always_online/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_always_online/methods/zone_settings_get_always_online_setting' - insert: [] - update: [] - delete: [] - settings_always_use_https: - id: cloudflare.zones.settings_always_use_https - name: settings_always_use_https - title: Settings Always Use Https - methods: - zone_settings_get_always_use_https_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1always_use_https/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_always_use_https_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1always_use_https/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_always_use_https_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1always_use_https/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_always_use_https/methods/zone_settings_get_always_use_https_setting' - insert: [] - update: [] - delete: [] - settings_automatic_https_rewrites: - id: cloudflare.zones.settings_automatic_https_rewrites - name: settings_automatic_https_rewrites - title: Settings Automatic Https Rewrites - methods: - zone_settings_get_automatic_https_rewrites_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1automatic_https_rewrites/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_automatic_https_rewrites_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1automatic_https_rewrites/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_automatic_https_rewrites_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1automatic_https_rewrites/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_automatic_https_rewrites/methods/zone_settings_get_automatic_https_rewrites_setting' - insert: [] - update: [] - delete: [] - settings_automatic_platform_optimization: - id: cloudflare.zones.settings_automatic_platform_optimization - name: settings_automatic_platform_optimization - title: Settings Automatic Platform Optimization - methods: - zone_settings_get_automatic_platform_optimization_for_word_press_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1automatic_platform_optimization/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_automatic_platform_optimization_for_word_press_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1automatic_platform_optimization/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_automatic_platform_optimization_for_word_press_settings: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1automatic_platform_optimization/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_automatic_platform_optimization/methods/zone_settings_get_automatic_platform_optimization_for_word_press_settings' - insert: [] - update: [] - delete: [] - settings_brotli: - id: cloudflare.zones.settings_brotli - name: settings_brotli - title: Settings Brotli - methods: - zone_settings_get_brotli_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1brotli/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_brotli_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1brotli/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_brotli_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1brotli/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_brotli/methods/zone_settings_get_brotli_setting' - insert: [] - update: [] - delete: [] - settings_browser_cache_ttl: - id: cloudflare.zones.settings_browser_cache_ttl - name: settings_browser_cache_ttl - title: Settings Browser Cache Ttl - methods: - zone_settings_get_browser_cache_ttl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1browser_cache_ttl/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_browser_cache_ttl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1browser_cache_ttl/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_browser_cache_ttl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1browser_cache_ttl/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_browser_cache_ttl/methods/zone_settings_get_browser_cache_ttl_setting' - insert: [] - update: [] - delete: [] - settings_browser_check: - id: cloudflare.zones.settings_browser_check - name: settings_browser_check - title: Settings Browser Check - methods: - zone_settings_get_browser_check_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1browser_check/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_browser_check_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1browser_check/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_browser_check_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1browser_check/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_browser_check/methods/zone_settings_get_browser_check_setting' - insert: [] - update: [] - delete: [] - settings_cache_level: - id: cloudflare.zones.settings_cache_level - name: settings_cache_level - title: Settings Cache Level - methods: - zone_settings_get_cache_level_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1cache_level/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_cache_level_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1cache_level/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_cache_level_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1cache_level/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_cache_level/methods/zone_settings_get_cache_level_setting' - insert: [] - update: [] - delete: [] - settings_challenge_ttl: - id: cloudflare.zones.settings_challenge_ttl - name: settings_challenge_ttl - title: Settings Challenge Ttl - methods: - zone_settings_get_challenge_ttl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1challenge_ttl/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_challenge_ttl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1challenge_ttl/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_challenge_ttl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1challenge_ttl/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_challenge_ttl/methods/zone_settings_get_challenge_ttl_setting' - insert: [] - update: [] - delete: [] - settings_ciphers: - id: cloudflare.zones.settings_ciphers - name: settings_ciphers - title: Settings Ciphers - methods: - zone_settings_get_ciphers_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ciphers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_ciphers_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ciphers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_ciphers_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ciphers/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_ciphers/methods/zone_settings_get_ciphers_setting' - insert: [] - update: [] - delete: [] - settings_development_mode: - id: cloudflare.zones.settings_development_mode - name: settings_development_mode - title: Settings Development Mode - methods: - zone_settings_get_development_mode_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1development_mode/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_development_mode_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1development_mode/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_development_mode_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1development_mode/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_development_mode/methods/zone_settings_get_development_mode_setting' - insert: [] - update: [] - delete: [] - settings_early_hints: - id: cloudflare.zones.settings_early_hints - name: settings_early_hints - title: Settings Early Hints - methods: - zone_settings_get_early_hints_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1early_hints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_early_hints_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1early_hints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_early_hints_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1early_hints/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_early_hints/methods/zone_settings_get_early_hints_setting' - insert: [] - update: [] - delete: [] - settings_email_obfuscation: - id: cloudflare.zones.settings_email_obfuscation - name: settings_email_obfuscation - title: Settings Email Obfuscation - methods: - zone_settings_get_email_obfuscation_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1email_obfuscation/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_email_obfuscation_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1email_obfuscation/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_email_obfuscation_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1email_obfuscation/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_email_obfuscation/methods/zone_settings_get_email_obfuscation_setting' - insert: [] - update: [] - delete: [] - settings_h2_prioritization: - id: cloudflare.zones.settings_h2_prioritization - name: settings_h2_prioritization - title: Settings H2 Prioritization - methods: - zone_settings_get_http__2_edge_prioritization_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1h2_prioritization/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_http__2_edge_prioritization_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1h2_prioritization/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_http__2_edge_prioritization_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1h2_prioritization/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_h2_prioritization/methods/zone_settings_get_http__2_edge_prioritization_setting' - insert: [] - update: [] - delete: [] - settings_hotlink_protection: - id: cloudflare.zones.settings_hotlink_protection - name: settings_hotlink_protection - title: Settings Hotlink Protection - methods: - zone_settings_get_hotlink_protection_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1hotlink_protection/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_hotlink_protection_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1hotlink_protection/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_hotlink_protection_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1hotlink_protection/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_hotlink_protection/methods/zone_settings_get_hotlink_protection_setting' - insert: [] - update: [] - delete: [] - settings_http2: - id: cloudflare.zones.settings_http2 - name: settings_http2 - title: Settings Http2 - methods: - zone_settings_get_h_t_t_p_2_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1http2/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_h_t_t_p_2_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1http2/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_h_t_t_p_2_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1http2/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_http2/methods/zone_settings_get_h_t_t_p_2_setting' - insert: [] - update: [] - delete: [] - settings_http3: - id: cloudflare.zones.settings_http3 - name: settings_http3 - title: Settings Http3 - methods: - zone_settings_get_h_t_t_p_3_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1http3/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_h_t_t_p_3_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1http3/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_h_t_t_p_3_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1http3/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_http3/methods/zone_settings_get_h_t_t_p_3_setting' - insert: [] - update: [] - delete: [] - settings_image_resizing: - id: cloudflare.zones.settings_image_resizing - name: settings_image_resizing - title: Settings Image Resizing - methods: - zone_settings_get_image_resizing_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1image_resizing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_image_resizing_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1image_resizing/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_image_resizing_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1image_resizing/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_image_resizing/methods/zone_settings_get_image_resizing_setting' - insert: [] - update: [] - delete: [] - settings_ip_geolocation: - id: cloudflare.zones.settings_ip_geolocation - name: settings_ip_geolocation - title: Settings Ip Geolocation - methods: - zone_settings_get_ip_geolocation_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ip_geolocation/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_ip_geolocation_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ip_geolocation/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_ip_geolocation_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ip_geolocation/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_ip_geolocation/methods/zone_settings_get_ip_geolocation_setting' - insert: [] - update: [] - delete: [] - settings_min_tls_version: - id: cloudflare.zones.settings_min_tls_version - name: settings_min_tls_version - title: Settings Min Tls Version - methods: - zone_settings_get_minimum_tls_version_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1min_tls_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_minimum_tls_version_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1min_tls_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_minimum_tls_version_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1min_tls_version/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_min_tls_version/methods/zone_settings_get_minimum_tls_version_setting' - insert: [] - update: [] - delete: [] - settings_minify: - id: cloudflare.zones.settings_minify - name: settings_minify - title: Settings Minify - methods: - zone_settings_get_minify_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1minify/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_minify_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1minify/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_minify_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1minify/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_minify/methods/zone_settings_get_minify_setting' - insert: [] - update: [] - delete: [] - settings_mirage: - id: cloudflare.zones.settings_mirage - name: settings_mirage - title: Settings Mirage - methods: - zone_settings_get_mirage_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1mirage/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_mirage_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1mirage/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_mirage_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1mirage/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_mirage/methods/zone_settings_get_mirage_setting' - insert: [] - update: [] - delete: [] - settings_mobile_redirect: - id: cloudflare.zones.settings_mobile_redirect - name: settings_mobile_redirect - title: Settings Mobile Redirect - methods: - zone_settings_get_mobile_redirect_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1mobile_redirect/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_mobile_redirect_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1mobile_redirect/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_mobile_redirect_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1mobile_redirect/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_mobile_redirect/methods/zone_settings_get_mobile_redirect_setting' - insert: [] - update: [] - delete: [] - settings_nel: - id: cloudflare.zones.settings_nel - name: settings_nel - title: Settings Nel - methods: - zone_settings_get_network_error_logging_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1nel/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_network_error_logging_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1nel/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_network_error_logging_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1nel/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_nel/methods/zone_settings_get_network_error_logging_setting' - insert: [] - update: [] - delete: [] - settings_opportunistic_encryption: - id: cloudflare.zones.settings_opportunistic_encryption - name: settings_opportunistic_encryption - title: Settings Opportunistic Encryption - methods: - zone_settings_get_opportunistic_encryption_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1opportunistic_encryption/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_opportunistic_encryption_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1opportunistic_encryption/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_opportunistic_encryption_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1opportunistic_encryption/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_opportunistic_encryption/methods/zone_settings_get_opportunistic_encryption_setting' - insert: [] - update: [] - delete: [] - settings_opportunistic_onion: - id: cloudflare.zones.settings_opportunistic_onion - name: settings_opportunistic_onion - title: Settings Opportunistic Onion - methods: - zone_settings_get_opportunistic_onion_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1opportunistic_onion/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_opportunistic_onion_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1opportunistic_onion/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_opportunistic_onion_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1opportunistic_onion/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_opportunistic_onion/methods/zone_settings_get_opportunistic_onion_setting' - insert: [] - update: [] - delete: [] - settings_orange_to_orange: - id: cloudflare.zones.settings_orange_to_orange - name: settings_orange_to_orange - title: Settings Orange To Orange - methods: - zone_settings_get_orange_to_orange___o_2_o_: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1orange_to_orange/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_orange_to_orange___o_2_o_: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1orange_to_orange/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_orange_to_orange___o_2_o_: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1orange_to_orange/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_orange_to_orange/methods/zone_settings_get_orange_to_orange___o_2_o_' - insert: [] - update: [] - delete: [] - settings_origin_error_page_pass_thru: - id: cloudflare.zones.settings_origin_error_page_pass_thru - name: settings_origin_error_page_pass_thru - title: Settings Origin Error Page Pass Thru - methods: - zone_settings_get_enable_error_pages_on_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1origin_error_page_pass_thru/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_enable_error_pages_on_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1origin_error_page_pass_thru/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_enable_error_pages_on_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1origin_error_page_pass_thru/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_origin_error_page_pass_thru/methods/zone_settings_get_enable_error_pages_on_setting' - insert: [] - update: [] - delete: [] - settings_origin_max_http_version: - id: cloudflare.zones.settings_origin_max_http_version - name: settings_origin_max_http_version - title: Settings Origin Max Http Version - methods: - zone_settings_get_origin_max_http_version_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1origin_max_http_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_origin_max_http_version_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1origin_max_http_version/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_origin_max_http_version_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1origin_max_http_version/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_origin_max_http_version/methods/zone_settings_get_origin_max_http_version_setting' - insert: [] - update: [] - delete: [] - settings_polish: - id: cloudflare.zones.settings_polish - name: settings_polish - title: Settings Polish - methods: - zone_settings_get_polish_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1polish/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_polish_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1polish/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_polish_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1polish/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_polish/methods/zone_settings_get_polish_setting' - insert: [] - update: [] - delete: [] - settings_prefetch_preload: - id: cloudflare.zones.settings_prefetch_preload - name: settings_prefetch_preload - title: Settings Prefetch Preload - methods: - zone_settings_get_prefetch_preload_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1prefetch_preload/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_prefetch_preload_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1prefetch_preload/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_prefetch_preload_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1prefetch_preload/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_prefetch_preload/methods/zone_settings_get_prefetch_preload_setting' - insert: [] - update: [] - delete: [] - settings_privacy_pass: - id: cloudflare.zones.settings_privacy_pass - name: settings_privacy_pass - title: Settings Privacy Pass - methods: - zone_settings_get_privacy_pass_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1privacy_pass/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_privacy_pass_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1privacy_pass/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_privacy_pass_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1privacy_pass/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_privacy_pass/methods/zone_settings_get_privacy_pass_setting' - insert: [] - update: [] - delete: [] - settings_proxy_read_timeout: - id: cloudflare.zones.settings_proxy_read_timeout - name: settings_proxy_read_timeout - title: Settings Proxy Read Timeout - methods: - zone_settings_get_proxy_read_timeout_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1proxy_read_timeout/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_proxy_read_timeout_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1proxy_read_timeout/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_proxy_read_timeout_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1proxy_read_timeout/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_proxy_read_timeout/methods/zone_settings_get_proxy_read_timeout_setting' - insert: [] - update: [] - delete: [] - settings_response_buffering: - id: cloudflare.zones.settings_response_buffering - name: settings_response_buffering - title: Settings Response Buffering - methods: - zone_settings_get_response_buffering_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1response_buffering/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_response_buffering_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1response_buffering/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_response_buffering_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1response_buffering/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_response_buffering/methods/zone_settings_get_response_buffering_setting' - insert: [] - update: [] - delete: [] - settings_rocket_loader: - id: cloudflare.zones.settings_rocket_loader - name: settings_rocket_loader - title: Settings Rocket Loader - methods: - zone_settings_get_rocket_loader_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1rocket_loader/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_rocket_loader_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1rocket_loader/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_rocket_loader_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1rocket_loader/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_rocket_loader/methods/zone_settings_get_rocket_loader_setting' - insert: [] - update: [] - delete: [] - settings_security_header: - id: cloudflare.zones.settings_security_header - name: settings_security_header - title: Settings Security Header - methods: - zone_settings_get_security_header___hsts__setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1security_header/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_security_header___hsts__setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1security_header/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_security_header___hsts__setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1security_header/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_security_header/methods/zone_settings_get_security_header___hsts__setting' - insert: [] - update: [] - delete: [] - settings_security_level: - id: cloudflare.zones.settings_security_level - name: settings_security_level - title: Settings Security Level - methods: - zone_settings_get_security_level_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1security_level/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_security_level_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1security_level/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_security_level_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1security_level/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_security_level/methods/zone_settings_get_security_level_setting' - insert: [] - update: [] - delete: [] - settings_server_side_exclude: - id: cloudflare.zones.settings_server_side_exclude - name: settings_server_side_exclude - title: Settings Server Side Exclude - methods: - zone_settings_get_server_side_exclude_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1server_side_exclude/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_server_side_exclude_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1server_side_exclude/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_server_side_exclude_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1server_side_exclude/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_server_side_exclude/methods/zone_settings_get_server_side_exclude_setting' - insert: [] - update: [] - delete: [] - settings_sort_query_string_for_cache: - id: cloudflare.zones.settings_sort_query_string_for_cache - name: settings_sort_query_string_for_cache - title: Settings Sort Query String For Cache - methods: - zone_settings_get_enable_query_string_sort_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1sort_query_string_for_cache/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_enable_query_string_sort_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1sort_query_string_for_cache/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_enable_query_string_sort_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1sort_query_string_for_cache/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_sort_query_string_for_cache/methods/zone_settings_get_enable_query_string_sort_setting' - insert: [] - update: [] - delete: [] - settings_ssl: - id: cloudflare.zones.settings_ssl - name: settings_ssl - title: Settings Ssl - methods: - zone_settings_get_ssl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ssl/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_ssl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ssl/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_ssl_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ssl/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_ssl/methods/zone_settings_get_ssl_setting' - insert: [] - update: [] - delete: [] - settings_ssl_recommender: - id: cloudflare.zones.settings_ssl_recommender - name: settings_ssl_recommender - title: Settings Ssl Recommender - methods: - zone_settings_get_ssl__tls_recommender_enrollment: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ssl_recommender/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_ssl__tls_recommender_enrollment: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ssl_recommender/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_ssl__tls_recommender_enrollment: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1ssl_recommender/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_ssl_recommender/methods/zone_settings_get_ssl__tls_recommender_enrollment' - insert: [] - update: [] - delete: [] - settings_tls_1_3: - id: cloudflare.zones.settings_tls_1_3 - name: settings_tls_1_3 - title: Settings Tls 1 3 - methods: - zone_settings_get_tls_1__3_setting_enabled_for_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1tls_1_3/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_tls_1__3_setting_enabled_for_a_zone: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1tls_1_3/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_tls_1__3_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1tls_1_3/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_tls_1_3/methods/zone_settings_get_tls_1__3_setting_enabled_for_a_zone' - insert: [] - update: [] - delete: [] - settings_tls_client_auth: - id: cloudflare.zones.settings_tls_client_auth - name: settings_tls_client_auth - title: Settings Tls Client Auth - methods: - zone_settings_get_tls_client_auth_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1tls_client_auth/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_tls_client_auth_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1tls_client_auth/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_tls_client_auth_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1tls_client_auth/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_tls_client_auth/methods/zone_settings_get_tls_client_auth_setting' - insert: [] - update: [] - delete: [] - settings_true_client_ip_header: - id: cloudflare.zones.settings_true_client_ip_header - name: settings_true_client_ip_header - title: Settings True Client Ip Header - methods: - zone_settings_get_true_client_ip_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1true_client_ip_header/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_true_client_ip_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1true_client_ip_header/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_true_client_ip_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1true_client_ip_header/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_true_client_ip_header/methods/zone_settings_get_true_client_ip_setting' - insert: [] - update: [] - delete: [] - settings_waf: - id: cloudflare.zones.settings_waf - name: settings_waf - title: Settings Waf - methods: - zone_settings_get_web_application_firewall___waf__setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1waf/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_web_application_firewall___waf__setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1waf/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_web_application_firewall___waf__setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1waf/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_waf/methods/zone_settings_get_web_application_firewall___waf__setting' - insert: [] - update: [] - delete: [] - settings_webp: - id: cloudflare.zones.settings_webp - name: settings_webp - title: Settings Webp - methods: - zone_settings_get_web_p_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1webp/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_web_p_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1webp/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_web_p_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1webp/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_webp/methods/zone_settings_get_web_p_setting' - insert: [] - update: [] - delete: [] - settings_websockets: - id: cloudflare.zones.settings_websockets - name: settings_websockets - title: Settings Websockets - methods: - zone_settings_get_web_sockets_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1websockets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.result - _zone_settings_get_web_sockets_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1websockets/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_settings_change_web_sockets_setting: - operation: - $ref: '#/paths/~1zones~1{zone_identifier}~1settings~1websockets/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings_websockets/methods/zone_settings_get_web_sockets_setting' - insert: [] - update: [] - delete: [] - subscription: - id: cloudflare.zones.subscription - name: subscription - title: Subscription - methods: - zone_subscription_zone_subscription_details: - operation: - $ref: '#/paths/~1zones~1{identifier}~1subscription/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _zone_subscription_zone_subscription_details: - operation: - $ref: '#/paths/~1zones~1{identifier}~1subscription/get' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_subscription_create_zone_subscription: - operation: - $ref: '#/paths/~1zones~1{identifier}~1subscription/post' - response: - mediaType: application/json - openAPIDocKey: '200' - zone_subscription_update_zone_subscription: - operation: - $ref: '#/paths/~1zones~1{identifier}~1subscription/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/subscription/methods/zone_subscription_zone_subscription_details' - insert: - - $ref: '#/components/x-stackQL-resources/subscription/methods/zone_subscription_create_zone_subscription' - update: [] - delete: [] -paths: - '/zones/{zone_identifier}/filters': - delete: - description: Deletes one or more existing filters. - operationId: filters-delete-filters - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - id: - $ref: '#/components/schemas/filters_components-schemas-id' - required: - - id - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-delete-response-collection' - description: Delete filters response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-delete-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete filters response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete filters - tags: - - Filters - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches filters in a zone. You can filter the results using several optional parameters. - operationId: filters-list-filters - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-filter-response-collection' - description: List filters response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-filter-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List filters response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List filters - tags: - - Filters - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Creates one or more filters. - operationId: filters-create-filters - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - expression - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-filter-response-collection' - description: Create filters response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-filter-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create filters response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create filters - tags: - - Filters - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates one or more existing filters. - operationId: filters-update-filters - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-filter-response-collection' - description: Update filters response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-filter-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update filters response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update filters - tags: - - Filters - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/filters/{id}': - delete: - description: Deletes an existing filter. - operationId: filters-delete-a-filter - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/filters_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-delete-response-single' - description: Delete a filter response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-delete-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a filter response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a filter - tags: - - Filters - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the details of a filter. - operationId: filters-get-a-filter - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/filters_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-filter-response-single' - description: Get a filter response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-filter-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a filter response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a filter - tags: - - Filters - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates an existing filter. - operationId: filters-update-a-filter - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/filters_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-filter-response-single' - description: Update a filter response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-filter-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a filter response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a filter - tags: - - Filters - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/firewall/rules': - delete: - description: Deletes existing firewall rules. - operationId: firewall-rules-delete-firewall-rules - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - id: - $ref: '#/components/schemas/firewall-rules_components-schemas-id' - required: - - id - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-response-collection-delete' - description: Delete firewall rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-response-collection-delete' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete firewall rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete firewall rules - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches firewall rules in a zone. You can filter the results using several optional parameters. - operationId: firewall-rules-list-firewall-rules - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-response-collection' - description: List firewall rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List firewall rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List firewall rules - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Updates the priority of existing firewall rules. - operationId: firewall-rules-update-priority-of-firewall-rules - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-response-collection' - description: Update priority of firewall rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update priority of firewall rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update priority of firewall rules - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Create one or more firewall rules. - operationId: firewall-rules-create-firewall-rules - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - filter - - action - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-response-collection' - description: Create firewall rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create firewall rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create firewall rules - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates one or more existing firewall rules. - operationId: firewall-rules-update-firewall-rules - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-response-collection' - description: Update firewall rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update firewall rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update firewall rules - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/firewall/rules/{id}': - delete: - description: Deletes an existing firewall rule. - operationId: firewall-rules-delete-a-firewall-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/firewall-rules_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - delete_filter_if_unused: - $ref: '#/components/schemas/delete_filter_if_unused' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-single-response-delete' - description: Delete a firewall rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-single-response-delete' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a firewall rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a firewall rule - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the details of a firewall rule. - operationId: firewall-rules-get-a-firewall-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/firewall-rules_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-single-response' - description: Get a firewall rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-single-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a firewall rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a firewall rule - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Updates the priority of an existing firewall rule. - operationId: firewall-rules-update-priority-of-a-firewall-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/firewall-rules_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-response-collection' - description: Update priority of a firewall rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-response-collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update priority of a firewall rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update priority of a firewall rule - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates an existing firewall rule. - operationId: firewall-rules-update-a-firewall-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/firewall-rules_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - - filter - - action - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/filter-rules-single-response' - description: Update a firewall rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/filter-rules-single-response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a firewall rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a firewall rule - tags: - - Firewall rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/healthchecks': - get: - description: List configured health checks. - operationId: health-checks-list-health-checks - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-response_collection' - description: List Health Checks response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Health Checks response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Health Checks - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - post: - description: Create a new health check. - operationId: health-checks-create-health-check - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/query_healthcheck' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - description: Create Health Check response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Health Check response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Health Check - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/healthchecks/preview': - post: - description: Create a new preview health check. - operationId: health-checks-create-preview-health-check - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/query_healthcheck' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - description: Create Preview Health Check response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Preview Health Check response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Preview Health Check - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/healthchecks/preview/{identifier}': - delete: - description: Delete a health check. - operationId: health-checks-delete-preview-health-check - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-id_response' - description: Delete Preview Health Check response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Preview Health Check response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Preview Health Check - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - get: - description: Fetch a single configured health check preview. - operationId: health-checks-health-check-preview-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - description: Health Check Preview Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Health Check Preview Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Health Check Preview Details - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/healthchecks/{identifier}': - delete: - description: Delete a health check. - operationId: health-checks-delete-health-check - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-id_response' - description: Delete Health Check response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-id_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Health Check response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Health Check - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - get: - description: Fetch a single configured health check. - operationId: health-checks-health-check-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - description: Health Check Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Health Check Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Health Check Details - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - patch: - description: Patch a configured health check. - operationId: health-checks-patch-health-check - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/query_healthcheck' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - description: Patch Health Check response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Patch Health Check response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Patch Health Check - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - put: - description: Update a configured health check. - operationId: health-checks-update-health-check - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/query_healthcheck' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - description: Update Health Check response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/healthchecks_components-schemas-single_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Health Check response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Health Check - tags: - - Health Checks - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_id}/managed_headers': - get: - description: Fetches a list of all Managed Transforms. - operationId: managed-transforms-list-managed-transforms - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - properties: - managed_request_headers: - $ref: '#/components/schemas/request_list' - managed_response_headers: - $ref: '#/components/schemas/request_list' - type: object - description: List Managed Transforms response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - managed_request_headers: - $ref: '#/components/schemas/request_list' - managed_response_headers: - $ref: '#/components/schemas/request_list' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: List Managed Transforms response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Managed Transforms - tags: - - Managed Transforms - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Updates the status of one or more Managed Transforms. - operationId: managed-transforms-update-status-of-managed-transforms - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - managed_request_headers: - $ref: '#/components/schemas/request_list' - managed_response_headers: - $ref: '#/components/schemas/request_list' - required: - - managed_request_headers - - managed_response_headers - type: object - required: true - responses: - '200': - content: - application/json: - schema: - properties: - managed_request_headers: - $ref: '#/components/schemas/response_list' - managed_response_headers: - $ref: '#/components/schemas/response_list' - type: object - description: Update status of Managed Transforms response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - managed_request_headers: - $ref: '#/components/schemas/response_list' - managed_response_headers: - $ref: '#/components/schemas/response_list' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Update status of Managed Transforms response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update status of Managed Transforms - tags: - - Managed Transforms - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/rate_limits': - get: - description: Fetches the rate limits for a zone. - operationId: rate-limits-for-a-zone-list-rate-limits - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ratelimit_response_collection' - description: List rate limits response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ratelimit_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List rate limits response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List rate limits - tags: - - Rate limits for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - description: Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes. - operationId: rate-limits-for-a-zone-create-a-rate-limit - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - match - - threshold - - period - - action - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ratelimit_response_single' - description: Create a rate limit response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ratelimit_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a rate limit response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a rate limit - tags: - - Rate limits for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/rate_limits/{id}': - delete: - description: Deletes an existing rate limit. - operationId: rate-limits-for-a-zone-delete-a-rate-limit - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/rate-limits_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ratelimit_response_single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/rate-limits_components-schemas-id' - type: object - description: Delete a rate limit response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/ratelimit_response_single' - - properties: - result: - properties: - id: - $ref: '#/components/schemas/rate-limits_components-schemas-id' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a rate limit response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a rate limit - tags: - - Rate limits for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - description: Fetches the details of a rate limit. - operationId: rate-limits-for-a-zone-get-a-rate-limit - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/rate-limits_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ratelimit_response_single' - description: Get a rate limit response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ratelimit_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a rate limit response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a rate limit - tags: - - Rate limits for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates an existing rate limit. - operationId: rate-limits-for-a-zone-update-a-rate-limit - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/rate-limits_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - id - - match - - threshold - - period - - action - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ratelimit_response_single' - description: Update a rate limit response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ratelimit_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a rate limit response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a rate limit - tags: - - Rate limits for a zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_id}/rulesets/phases/{phase}/entrypoint': - get: - description: Fetches all Transform Rules in a zone. - operationId: transform-rules-list-transform-rules - parameters: - - in: path - name: phase - required: true - schema: - $ref: '#/components/schemas/schemas-phase' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-ruleset' - description: List Transform Rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-ruleset' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Transform Rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Transform Rules - tags: - - Transform Rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates the Transform Rules of a zone. - operationId: transform-rules-update-transform-rules - parameters: - - in: path - name: phase - required: true - schema: - $ref: '#/components/schemas/schemas-phase' - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/update_ruleset' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single' - description: Update Transform Rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update Transform Rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update Transform Rules - tags: - - Transform Rules - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_id}/url_normalization': - get: - description: Fetches the current URL normalization settings. - operationId: url-normalization-get-url-normalization-settings - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_model' - description: Get URL normalization settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_model' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get URL normalization settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get URL normalization settings - tags: - - URL Normalization - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - put: - description: Updates the URL normalization settings. - operationId: url-normalization-update-url-normalization-settings - parameters: - - in: path - name: zone_id - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-request_model' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-response_model' - description: Update URL normalization settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/schemas-response_model' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update URL normalization settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update URL normalization settings - tags: - - URL Normalization - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - /zones: - get: - description: 'Lists, searches, sorts, and filters your zones.' - operationId: zone-list-zones - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-response_collection' - description: List Zones response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Zones response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Zones - tags: - - Zone - x-cfPermissionsRequired: - enum: - - '#zone:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - post: - operationId: zone-create-zone - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-create' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-response_single' - description: Create Zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create Zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create Zone - tags: - - Zone - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{identifier}': - delete: - description: Deletes an existing zone. - operationId: zone-delete-zone - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Delete Zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete Zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete Zone - tags: - - Zone - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - get: - operationId: zone-zone-details - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-response_single' - description: Zone Details response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Zone Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Zone Details - tags: - - Zone - x-cfPermissionsRequired: - enum: - - '#zone:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Editz a zone. Only one zone property can be changed at a time. - operationId: zone-edit-zone - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/schemas-patch' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/components-schemas-response_single' - description: Edit Zone response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/components-schemas-response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit Zone response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit Zone - tags: - - Zone - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{identifier}/activation_check': - put: - description: Initiates another zone activation check. - operationId: zone-zone-activation-check - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: Zone Activation Check response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: Zone Activation Check response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Zone Activation Check - tags: - - Zone - x-cfPermissionsRequired: - enum: - - '#zone:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{identifier}/purge_cache': - post: - description: |- - Granularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix. - - **NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume. - operationId: 'zone-purge-files-by-cache-tags,-host,-or-prefix' - parameters: - - in: path - name: identifier - required: true - schema: - $ref: '#/components/schemas/schemas-identifier' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/purge_by_cache_tags_or_hosts_or_prefixes' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/api-response-single-id' - description: 'Purge Files by Cache-Tags, Host, or Prefix response' - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single-id' - - $ref: '#/components/schemas/api-response-common-failure' - description: 'Purge Files by Cache-Tags, Host, or Prefix response failure' - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: 'Purge Files by Cache-Tags, Host, or Prefix' - tags: - - Zone - x-cfPermissionsRequired: - enum: - - '#cache_purge:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/analytics/colos': - get: - deprecated: true - description: 'This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.' - operationId: zone-analytics-(-deprecated)-get-analytics-by-co-locations - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/colo_response' - description: Get analytics by Co-locations response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/colo_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get analytics by Co-locations response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get analytics by Co-locations - tags: - - Zone Analytics (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/analytics/x-cfDeprecations/zone_analytics_deprecation' - x-cfPermissionsRequired: - enum: - - '#analytics:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/analytics/dashboard': - get: - deprecated: true - description: The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network. - operationId: zone-analytics-(-deprecated)-get-dashboard - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/dashboard_response' - description: Get dashboard response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/dashboard_response' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get dashboard response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get dashboard - tags: - - Zone Analytics (Deprecated) - x-cfDeprecation: - $ref: '#/components/schemas/analytics/x-cfDeprecations/zone_analytics_deprecation' - x-cfPermissionsRequired: - enum: - - '#analytics:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/cache/cache_reserve': - get: - description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.' - operationId: zone-cache-settings-get-cache-reserve-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/cache_reserve_response_value' - description: Get Cache Reserve setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/cache_reserve_response_value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Cache Reserve setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Cache Reserve setting - tags: - - Zone Cache Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.' - operationId: zone-cache-settings-change-cache-reserve-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/cache_reserve_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/cache_reserve_response_value' - description: Change Cache Reserve setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/cache_reserve_response_value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Cache Reserve setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Cache Reserve setting - tags: - - Zone Cache Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/cache/variants': - delete: - description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' - operationId: zone-cache-settings-delete-variants-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/variants' - description: Delete variants setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/variants' - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete variants setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete variants setting - tags: - - Zone Cache Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - get: - description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' - operationId: zone-cache-settings-get-variants-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/variants_response_value' - description: Get variants setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/variants_response_value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get variants setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get variants setting - tags: - - Zone Cache Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - patch: - description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' - operationId: zone-cache-settings-change-variants-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/variants_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/variants_response_value' - description: Change variants setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_cache_settings_response_single' - - $ref: '#/components/schemas/variants_response_value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change variants setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change variants setting - tags: - - Zone Cache Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/firewall/lockdowns': - get: - description: Fetches Zone Lockdown rules. You can filter the results using several optional parameters. - operationId: zone-lockdown-list-zone-lockdown-rules - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/zonelockdown_response_collection' - description: List Zone Lockdown rules response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zonelockdown_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Zone Lockdown rules response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Zone Lockdown rules - tags: - - Zone Lockdown - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - post: - description: Creates a new Zone Lockdown rule. - operationId: zone-lockdown-create-a-zone-lockdown-rule - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - urls - - configurations - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/zonelockdown_response_single' - description: Create a Zone Lockdown rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zonelockdown_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Create a Zone Lockdown rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Create a Zone Lockdown rule - tags: - - Zone Lockdown - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/firewall/lockdowns/{id}': - delete: - description: Deletes an existing Zone Lockdown rule. - operationId: zone-lockdown-delete-a-zone-lockdown-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/lockdowns_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: {} - required: true - responses: - '200': - content: - application/json: - schema: - properties: - result: - properties: - id: - $ref: '#/components/schemas/lockdowns_components-schemas-id' - type: object - type: object - description: Delete a Zone Lockdown rule response - 4xx: - content: - application/json: - schema: - allOf: - - properties: - result: - properties: - id: - $ref: '#/components/schemas/lockdowns_components-schemas-id' - type: object - - $ref: '#/components/schemas/api-response-common-failure' - description: Delete a Zone Lockdown rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Delete a Zone Lockdown rule - tags: - - Zone Lockdown - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - get: - description: Fetches the details of a Zone Lockdown rule. - operationId: zone-lockdown-get-a-zone-lockdown-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/lockdowns_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/zonelockdown_response_single' - description: Get a Zone Lockdown rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zonelockdown_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get a Zone Lockdown rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get a Zone Lockdown rule - tags: - - Zone Lockdown - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - put: - description: Updates an existing Zone Lockdown rule. - operationId: zone-lockdown-update-a-zone-lockdown-rule - parameters: - - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/lockdowns_components-schemas-id' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - required: - - urls - - configurations - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/zonelockdown_response_single' - description: Update a Zone Lockdown rule response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zonelockdown_response_single' - - $ref: '#/components/schemas/api-response-common-failure' - description: Update a Zone Lockdown rule response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Update a Zone Lockdown rule - tags: - - Zone Lockdown - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/available_plans': - get: - description: Lists available plans the zone can subscribe to. - operationId: zone-rate-plan-list-available-plans - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/available-rate-plan' - type: array - description: List Available Plans response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-collection' - - properties: - result: - items: - $ref: '#/components/schemas/available-rate-plan' - type: array - - $ref: '#/components/schemas/api-response-common-failure' - description: List Available Plans response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Available Plans - tags: - - Zone Rate Plan - x-cfPermissionsRequired: - enum: - - '#billing:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/available_plans/{plan_identifier}': - get: - description: Details of the available plan that the zone can subscribe to. - operationId: zone-rate-plan-available-plan-details - parameters: - - in: path - name: plan_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/available-rate-plan' - description: Available Plan Details response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/api-response-single' - - properties: - result: - $ref: '#/components/schemas/available-rate-plan' - - $ref: '#/components/schemas/api-response-common-failure' - description: Available Plan Details response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Available Plan Details - tags: - - Zone Rate Plan - x-cfPermissionsRequired: - enum: - - '#billing:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/available_rate_plans': - get: - description: Lists all rate plans the zone can subscribe to. - operationId: zone-rate-plan-list-available-rate-plans - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/plan_response_collection' - description: List Available Rate Plans response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/plan_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: List Available Rate Plans response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: List Available Rate Plans - tags: - - Zone Rate Plan - x-cfPermissionsRequired: - enum: - - '#billing:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings': - get: - description: Available settings for your user in relation to a zone. - operationId: zone-settings-get-all-zone-settings - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/zone_settings_response_collection' - description: Get all Zone settings response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get all Zone settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get all Zone settings - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Edit settings for a zone. - operationId: zone-settings-edit-zone-settings-info - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - items: - description: One or more zone setting objects. Must contain an ID and a value. - example: - - id: always_online - value: 'on' - - id: browser_cache_ttl - value: 18000 - - id: ip_geolocation - value: 'off' - items: - $ref: '#/components/schemas/setting' - minItems: 1 - type: array - required: - - items - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/zone_settings_response_collection' - description: Edit zone settings info response - 4xx: - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_collection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Edit zone settings info response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Edit zone settings info - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/0rtt': - get: - description: Gets 0-RTT session resumption setting. - operationId: zone-settings-get-0-rtt-session-resumption-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/0rtt' - description: Get 0-RTT session resumption setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/0rtt' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get 0-RTT session resumption setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get 0-RTT session resumption setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Changes the 0-RTT session resumption setting. - operationId: zone-settings-change-0-rtt-session-resumption-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/0rtt_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/0rtt' - description: Change 0-RTT session resumption setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/0rtt' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change 0-RTT session resumption setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change 0-RTT session resumption setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/settings/advanced_ddos': - get: - description: Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. - operationId: zone-settings-get-advanced-ddos-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/advanced_ddos' - description: Get Advanced DDOS setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/advanced_ddos' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Advanced DDOS setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Advanced DDOS setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/always_online': - get: - description: 'When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive''s Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.' - operationId: zone-settings-get-always-online-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_online' - description: Get Always Online setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_online' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Always Online setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Always Online setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive''s Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.' - operationId: zone-settings-change-always-online-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/always_online_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_online' - description: Change Always Online setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_online' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Always Online setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Always Online setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/always_use_https': - get: - description: 'Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.' - operationId: zone-settings-get-always-use-https-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_use_https' - description: Get Always Use HTTPS setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_use_https' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Always Use HTTPS setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Always Use HTTPS setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.' - operationId: zone-settings-change-always-use-https-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/always_use_https_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_use_https' - description: Change Always Use HTTPS setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/always_use_https' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Always Use HTTPS setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Always Use HTTPS setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/automatic_https_rewrites': - get: - description: Enable the Automatic HTTPS Rewrites feature for this zone. - operationId: zone-settings-get-automatic-https-rewrites-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_https_rewrites' - description: Get Automatic HTTPS Rewrites setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_https_rewrites' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Automatic HTTPS Rewrites setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Automatic HTTPS Rewrites setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Enable the Automatic HTTPS Rewrites feature for this zone. - operationId: zone-settings-change-automatic-https-rewrites-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/automatic_https_rewrites_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_https_rewrites' - description: Change Automatic HTTPS Rewrites setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_https_rewrites' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Automatic HTTPS Rewrites setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Automatic HTTPS Rewrites setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/automatic_platform_optimization': - get: - description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare''s edge network and caches third-party fonts.' - operationId: zone-settings-get-automatic-platform-optimization-for-word-press-settings - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_platform_optimization' - description: Get Automatic Platform Optimization for WordPress settings response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_platform_optimization' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Automatic Platform Optimization for WordPress settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Automatic Platform Optimization for WordPress settings - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare''s edge network and caches third-party fonts.' - operationId: zone-settings-change-automatic-platform-optimization-for-word-press-settings - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/automatic_platform_optimization' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_platform_optimization' - description: Change Automatic Platform Optimization for WordPress settings response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/automatic_platform_optimization' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Automatic Platform Optimization for WordPress settings response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Automatic Platform Optimization for WordPress settings - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/brotli': - get: - description: 'When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.' - operationId: zone-settings-get-brotli-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/brotli' - description: Get Brotli setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/brotli' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Brotli setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Brotli setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.' - operationId: zone-settings-change-brotli-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/brotli_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/brotli' - description: Change Brotli setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/brotli' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Brotli setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Brotli setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/browser_cache_ttl': - get: - description: 'Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors'' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).' - operationId: zone-settings-get-browser-cache-ttl-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_cache_ttl' - description: Get Browser Cache TTL setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_cache_ttl' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Browser Cache TTL setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Browser Cache TTL setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors'' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).' - operationId: zone-settings-change-browser-cache-ttl-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/browser_cache_ttl_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_cache_ttl' - description: Change Browser Cache TTL setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_cache_ttl' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Browser Cache TTL setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Browser Cache TTL setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/browser_check': - get: - description: 'Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).' - operationId: zone-settings-get-browser-check-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_check' - description: Get Browser Check setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_check' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Browser Check setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Browser Check setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).' - operationId: zone-settings-change-browser-check-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/browser_check_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_check' - description: Change Browser Check setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/browser_check' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Browser Check setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Browser Check setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/cache_level': - get: - description: 'Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).' - operationId: zone-settings-get-cache-level-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/cache_level' - description: Get Cache Level setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/cache_level' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Cache Level setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Cache Level setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).' - operationId: zone-settings-change-cache-level-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/cache_level_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/cache_level' - description: Change Cache Level setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/cache_level' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Cache Level setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Cache Level setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/challenge_ttl': - get: - description: 'Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).' - operationId: zone-settings-get-challenge-ttl-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/challenge_ttl' - description: Get Challenge TTL setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/challenge_ttl' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Challenge TTL setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Challenge TTL setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).' - operationId: zone-settings-change-challenge-ttl-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/challenge_ttl_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/challenge_ttl' - description: Change Challenge TTL setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/challenge_ttl' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Challenge TTL setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Challenge TTL setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/ciphers': - get: - description: Gets ciphers setting. - operationId: zone-settings-get-ciphers-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ciphers' - description: Get ciphers setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ciphers' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get ciphers setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get ciphers setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Changes ciphers setting. - operationId: zone-settings-change-ciphers-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/ciphers_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ciphers' - description: Change ciphers setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ciphers' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change ciphers setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change ciphers setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/development_mode': - get: - description: 'Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare''s accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.' - operationId: zone-settings-get-development-mode-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/development_mode' - description: Get Development Mode setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/development_mode' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Development Mode setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Development Mode setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare''s accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.' - operationId: zone-settings-change-development-mode-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/development_mode_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/development_mode' - description: Change Development Mode setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/development_mode' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Development Mode setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Development Mode setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/early_hints': - get: - description: 'When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.' - operationId: zone-settings-get-early-hints-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/early_hints' - description: Get Early Hints setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/early_hints' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Early Hints setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Early Hints setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.' - operationId: zone-settings-change-early-hints-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/early_hints_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/early_hints' - description: Change Early Hints setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/early_hints' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Early Hints setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Early Hints setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/email_obfuscation': - get: - description: 'Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).' - operationId: zone-settings-get-email-obfuscation-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/email_obfuscation' - description: Get Email Obfuscation setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/email_obfuscation' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Email Obfuscation setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Email Obfuscation setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).' - operationId: zone-settings-change-email-obfuscation-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/email_obfuscation_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/email_obfuscation' - description: Change Email Obfuscation setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/email_obfuscation' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Email Obfuscation setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Email Obfuscation setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/h2_prioritization': - get: - description: Gets HTTP/2 Edge Prioritization setting. - operationId: zone-settings-get-http/-2-edge-prioritization-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/h2_prioritization' - description: Get HTTP/2 Edge Prioritization setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/h2_prioritization' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get HTTP/2 Edge Prioritization setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get HTTP/2 Edge Prioritization setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - patch: - description: Changes HTTP/2 Edge Prioritization setting. - operationId: zone-settings-change-http/-2-edge-prioritization-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/h2_prioritization_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/h2_prioritization' - description: Change HTTP/2 Edge Prioritization setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/h2_prioritization' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change HTTP/2 Edge Prioritization setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change HTTP/2 Edge Prioritization setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/settings/hotlink_protection': - get: - description: 'When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it''s not another site requesting them. People will still be able to download and view images from your page, but other sites won''t be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).' - operationId: zone-settings-get-hotlink-protection-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/hotlink_protection' - description: Get Hotlink Protection setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/hotlink_protection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Hotlink Protection setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Hotlink Protection setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it''s not another site requesting them. People will still be able to download and view images from your page, but other sites won''t be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).' - operationId: zone-settings-change-hotlink-protection-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/hotlink_protection_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/hotlink_protection' - description: Change Hotlink Protection setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/hotlink_protection' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Hotlink Protection setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Hotlink Protection setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/http2': - get: - description: Value of the HTTP2 setting. - operationId: zone-settings-get-h-t-t-p-2-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http2' - description: Get HTTP2 setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get HTTP2 setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get HTTP2 setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Value of the HTTP2 setting. - operationId: zone-settings-change-h-t-t-p-2-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/http2_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http2' - description: Change HTTP2 setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http2' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change HTTP2 setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change HTTP2 setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/settings/http3': - get: - description: Value of the HTTP3 setting. - operationId: zone-settings-get-h-t-t-p-3-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http3' - description: Get HTTP3 setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http3' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get HTTP3 setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get HTTP3 setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Value of the HTTP3 setting. - operationId: zone-settings-change-h-t-t-p-3-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/http3_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http3' - description: Change HTTP3 setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/http3' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change HTTP3 setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change HTTP3 setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/settings/image_resizing': - get: - description: 'Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare''s network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.' - operationId: zone-settings-get-image-resizing-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/image_resizing' - description: Get Image Resizing setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/image_resizing' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Image Resizing setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Image Resizing setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - patch: - description: 'Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare''s network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.' - operationId: zone-settings-change-image-resizing-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/image_resizing_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/image_resizing' - description: Change Image Resizing setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/image_resizing' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Image Resizing setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Image Resizing setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/ip_geolocation': - get: - description: 'Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).' - operationId: zone-settings-get-ip-geolocation-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ip_geolocation' - description: Get IP Geolocation setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ip_geolocation' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get IP Geolocation setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get IP Geolocation setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).' - operationId: zone-settings-change-ip-geolocation-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/ip_geolocation_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ip_geolocation' - description: Change IP Geolocation setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ip_geolocation' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change IP Geolocation setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change IP Geolocation setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/ipv6': - get: - description: 'Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).' - operationId: zone-settings-get-i-pv6-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ipv6' - description: Get IPv6 setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ipv6' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get IPv6 setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get IPv6 setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).' - operationId: zone-settings-change-i-pv6-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/ipv6_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ipv6' - description: Change IPv6 setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ipv6' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change IPv6 setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change IPv6 setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/settings/min_tls_version': - get: - description: Gets Minimum TLS Version setting. - operationId: zone-settings-get-minimum-tls-version-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/min_tls_version' - description: Get Minimum TLS Version setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/min_tls_version' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Minimum TLS Version setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Minimum TLS Version setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: Changes Minimum TLS Version setting. - operationId: zone-settings-change-minimum-tls-version-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/min_tls_version_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/min_tls_version' - description: Change Minimum TLS Version setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/min_tls_version' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Minimum TLS Version setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Minimum TLS Version setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/minify': - get: - description: 'Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.' - operationId: zone-settings-get-minify-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/minify' - description: Get Minify setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/minify' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Minify setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Minify setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.' - operationId: zone-settings-change-minify-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/minify_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/minify' - description: Change Minify setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/minify' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Minify setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Minify setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/mirage': - get: - description: 'Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.' - operationId: zone-settings-get-mirage-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mirage' - description: Get Mirage setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mirage' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Mirage setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Mirage setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.' - operationId: zone-settings-change-mirage-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/mirage_value' - required: - - value - required: true - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mirage' - description: Change Mirage setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mirage' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Mirage setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Mirage setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/settings/mobile_redirect': - get: - description: 'Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.' - operationId: zone-settings-get-mobile-redirect-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mobile_redirect' - description: Get Mobile Redirect setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/zoneActivationMessages' + messages: + $ref: '#/components/schemas/zoneActivationMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + id: + $ref: '#/components/schemas/zoneActivationIdentifier' + type: object + required: + - success + - errors + - messages + description: Successful Response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mobile_redirect' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Mobile Redirect setting response failure + $ref: '#/components/schemas/zoneActivationApiResponseCommonFailure' + description: Client Error security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Mobile Redirect setting + summary: Rerun the Activation Check tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.' - operationId: zone-settings-change-mobile-redirect-setting + - Zone + x-api-token-group: + - Zone Write + x-stackql-sdk: + service: zones + resource_chain: + - activation_check + method: trigger + /zones/{zone_id}/analytics/latency: + get: + description: >- + Retrieves aggregate Argo Smart Routing analytics for a zone, including + latency improvements, bandwidth savings, and routing statistics. + operationId: argo-analytics-for-zone-argo-analytics-for-a-zone parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/mobile_redirect_value' - required: - - value - required: true + type: string + - in: query + name: bins + schema: + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mobile_redirect' - description: Change Mobile Redirect setting response - 4xx: + $ref: '#/components/schemas/argoAnalyticsResponseSingle' + description: Argo Analytics for a zone response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/mobile_redirect' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Mobile Redirect setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Mobile Redirect setting - tags: - - Zone Settings + type: object + properties: + errors: + $ref: '#/components/schemas/argoAnalyticsMessages' + messages: + $ref: '#/components/schemas/argoAnalyticsMessages' + result: + type: object + enum: + - null + nullable: true + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Argo Analytics for a zone response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Argo Analytics for a zone + tags: + - Argo Analytics for Zone + x-api-token-group: + - Analytics Read x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#analytics:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/nel': + /zones/{zone_id}/analytics/latency/colos: get: - description: 'Enable Network Error Logging reporting on your zone. (Beta) ' - operationId: zone-settings-get-network-error-logging-setting + description: >- + Retrieves Argo Smart Routing analytics broken down by geographic points + of presence (PoPs). Shows latency improvements and routing efficiency + per location. + operationId: >- + argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/nel' - description: Get Network Error Logging setting response - 4xx: + $ref: '#/components/schemas/argoAnalyticsResponseSingle' + description: Argo Analytics for a zone at different PoPs response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/nel' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Network Error Logging setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/argoAnalyticsMessages' + messages: + $ref: '#/components/schemas/argoAnalyticsMessages' + result: + type: object + enum: + - null + nullable: true + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Argo Analytics for a zone at different PoPs response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Network Error Logging setting + summary: Argo Analytics for a zone at different PoPs tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' + - Argo Analytics for Geolocation + x-api-token-group: + - Analytics Read x-cfPlanAvailability: - business: false + business: true enterprise: true free: true pro: true - patch: - description: 'Enable Network Error Logging reporting on your zone. (Beta) ' - operationId: zone-settings-change-network-error-logging-setting + /zones/{zone_id}/available_plans: + get: + description: Lists available plans the zone can subscribe to. + operationId: zone-rate-plan-list-available-plans parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/nel_value' - required: - - value - required: true + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/nel' - description: Change Network Error Logging setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiAvailableRatePlan' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + description: List Available Plans response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/nel' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Network Error Logging setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiAvailableRatePlan' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Available Plans response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Network Error Logging setting + summary: List Available Plans tags: - - Zone Settings + - Zone Rate Plan + x-api-token-group: + - Billing Write + - Billing Read x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#billing:read' x-cfPlanAvailability: - business: false + business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/opportunistic_encryption': + x-stackql-sdk: + service: zones + resource_chain: + - plans + method: list + /zones/{zone_id}/available_plans/{plan_identifier}: get: - description: Gets Opportunistic Encryption setting. - operationId: zone-settings-get-opportunistic-encryption-setting + description: Details of the available plan that the zone can subscribe to. + operationId: zone-rate-plan-available-plan-details parameters: - in: path - name: zone_identifier + name: plan_identifier + schema: + $ref: '#/components/schemas/billSubsApiIdentifier' required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_encryption' - description: Get Opportunistic Encryption setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + $ref: '#/components/schemas/billSubsApiAvailableRatePlan' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Available Plan Details response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_encryption' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Opportunistic Encryption setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + properties: + can_subscribe: + $ref: '#/components/schemas/billSubsApiCanSubscribe' + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + externally_managed: + $ref: '#/components/schemas/billSubsApiExternallyManaged' + frequency: + $ref: '#/components/schemas/billSubsApiSchemasFrequency' + id: + $ref: '#/components/schemas/billSubsApiIdentifier' + is_subscribed: + $ref: '#/components/schemas/billSubsApiIsSubscribed' + legacy_discount: + $ref: '#/components/schemas/billSubsApiLegacyDiscount' + legacy_id: + $ref: '#/components/schemas/billSubsApiLegacyId' + name: + $ref: '#/components/schemas/billSubsApiSchemasName' + price: + $ref: '#/components/schemas/billSubsApiSchemasPrice' + type: object + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Available Plan Details response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Opportunistic Encryption setting + summary: Available Plan Details tags: - - Zone Settings + - Zone Rate Plan + x-api-token-group: + - Billing Write + - Billing Read x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#billing:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true - patch: - description: Changes Opportunistic Encryption setting. - operationId: zone-settings-change-opportunistic-encryption-setting + x-stackql-sdk: + service: zones + resource_chain: + - plans + method: get + /zones/{zone_id}/available_rate_plans: + get: + description: Lists all rate plans the zone can subscribe to. + operationId: zone-rate-plan-list-available-rate-plans parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/opportunistic_encryption_value' - required: - - value - required: true + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_encryption' - description: Change Opportunistic Encryption setting response - 4xx: + $ref: '#/components/schemas/billSubsApiPlanResponseCollection' + description: List Available Rate Plans response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_encryption' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Opportunistic Encryption setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiSchemasRatePlan' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Available Rate Plans response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Opportunistic Encryption setting + summary: List Available Rate Plans tags: - - Zone Settings + - Zone Rate Plan + x-api-token-group: + - Billing Write + - Billing Read x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#billing:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/opportunistic_onion': + x-stackql-sdk: + service: zones + resource_chain: + - rate_plans + method: get + /zones/{zone_id}/custom_ns: get: - description: 'Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.' - operationId: zone-settings-get-opportunistic-onion-setting + deprecated: true + description: >- + Get metadata for account-level custom nameservers on a zone. Deprecated + in favor of [Show DNS + Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-list-dns-settings). + operationId: >- + account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_onion' - description: Get Opportunistic Onion setting response - 4xx: + $ref: '#/components/schemas/dnsCustomNameserversGetResponse' + description: Get Account Custom Nameserver Related Zone Metadata response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_onion' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Opportunistic Onion setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Opportunistic Onion setting - tags: - - Zone Settings + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + enabled: + description: Whether zone uses account-level custom nameservers. + type: boolean + x-auditable: true + ns_set: + default: 1 + description: The number of the name server set to assign to the zone. + maximum: 5 + minimum: 1 + type: number + x-auditable: true + result: + enum: + - null + nullable: true + type: object + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Get Account Custom Nameserver Related Zone Metadata response failure + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Account Custom Nameserver Related Zone Metadata + tags: + - Account-Level Custom Nameservers Usage for a Zone + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - 'Zero Trust: PII Read' + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + - 'Access: Apps and Policies Revoke' + - 'Access: Mutual TLS Certificates Write' + - 'Access: Organizations, Identity Providers, and Groups Write' + - Zone Settings Write + - Zone Settings Read + - Zone Read + - DNS Read + - Workers Scripts Write + - Workers Scripts Read + - Zone Write + - Workers Routes Write + - Workers Routes Read + - Stream Write + - Stream Read + - SSL and Certificates Write + - SSL and Certificates Read + - Logs Write + - Logs Read + - Cache Purge + - Page Rules Write + - Page Rules Read + - Load Balancers Write + - Load Balancers Read + - Firewall Services Write + - Firewall Services Read + - DNS Write + - Apps Write + - Analytics Read + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' x-cfPermissionsRequired: enum: - - '#zone_settings:read' + - '#zone:read' x-cfPlanAvailability: business: true enterprise: true - free: true - pro: true - patch: - description: 'Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.' - operationId: zone-settings-change-opportunistic-onion-setting + free: false + pro: false + x-stackql-sdk: + service: zones + resource_chain: + - custom_nameservers + method: update + put: + deprecated: true + description: >- + Set metadata for account-level custom nameservers on a zone. If you + would like new zones in the account to use account custom nameservers by + default, use PUT /accounts/:identifier to set the account setting + use_account_custom_ns_by_default to true. Deprecated in favor of [Update + DNS + Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-update-dns-settings). + operationId: >- + account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/opportunistic_onion_value' - required: - - value - required: true + $ref: '#/components/schemas/dnsCustomNameserversZoneMetadata' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_onion' - description: Change Opportunistic Onion setting response - 4xx: + $ref: '#/components/schemas/dnsCustomNameserversSchemasEmptyResponse' + description: Set Account Custom Nameserver Related Zone Metadata response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/opportunistic_onion' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Opportunistic Onion setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + type: number + page: + description: Current page within paginated list of results. + type: number + per_page: + description: Number of results per page of results. + type: number + total_count: + description: Total results available without any search parameters. + type: number + type: object + result: + $ref: >- + #/components/schemas/unnamedSchemaRef619309774d07ec6904f1e354560d6028 + required: + - success + - errors + - messages + - success + - errors + - messages + - result + description: Set Account Custom Nameserver Related Zone Metadata response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Opportunistic Onion setting + summary: Set Account Custom Nameserver Related Zone Metadata tags: - - Zone Settings + - Account-Level Custom Nameservers Usage for a Zone + x-api-token-group: + - Zone Write x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#zone:edit' x-cfPlanAvailability: business: true enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/orange_to_orange': + free: false + pro: false + /zones/{zone_id}/environments: get: - description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - operationId: zone-settings-get-orange-to-orange-(-o-2-o) - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + operationId: zonesEnvironmentsList responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/orange_to_orange' - description: Get Orange to Orange (O2O) response - 4xx: + $ref: '#/components/schemas/kaminoEnvironmentsResponse' + description: Successfully listed zone environments. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/orange_to_orange' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Orange to Orange (O2O) response failure + $ref: '#/components/schemas/kaminoErrorResponse' + description: Client error response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Orange to Orange (O2O) + summary: List zone environments tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. - operationId: zone-settings-change-orange-to-orange-(-o-2-o) + - Zone Environments + x-api-token-group: + - Zone Versioning Write + - Zone Versioning Read parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + x-stackql-sdk: + service: zones + resource_chain: + - environments + method: list + patch: + operationId: zonesEnvironmentsEdit requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/orange_to_orange_value' - required: - - value - required: true + $ref: '#/components/schemas/kaminoEnvironmentsRequest' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/orange_to_orange' - description: Change Orange to Orange (O2O) response - 4xx: + $ref: '#/components/schemas/kaminoEnvironmentsResponse' + description: Successfully updated zone environments. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/orange_to_orange' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Orange to Orange (O2O) response failure + $ref: '#/components/schemas/kaminoErrorResponse' + description: Client error response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Orange to Orange (O2O) + summary: Partially update zone environments tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/origin_error_page_pass_thru': - get: - description: 'Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.' - operationId: zone-settings-get-enable-error-pages-on-setting + - Zone Environments + x-api-token-group: + - Zone Versioning Write parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + x-stackql-sdk: + service: zones + resource_chain: + - environments + method: edit + post: + operationId: zonesEnvironmentsCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/kaminoEnvironmentsRequest' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/origin_error_page_pass_thru' - description: Get Enable Error Pages On setting response - 4xx: + $ref: '#/components/schemas/kaminoEnvironmentsResponse' + description: Successfully created zone environments. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/origin_error_page_pass_thru' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Enable Error Pages On setting response failure + $ref: '#/components/schemas/kaminoErrorResponse' + description: Client error response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Enable Error Pages On setting + summary: Create zone environments tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: 'Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.' - operationId: zone-settings-change-enable-error-pages-on-setting + - Zone Environments + x-api-token-group: + - Zone Versioning Write parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + x-stackql-sdk: + service: zones + resource_chain: + - environments + method: create + put: + operationId: zonesEnvironmentsUpdate requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/origin_error_page_pass_thru_value' - required: - - value - required: true + $ref: '#/components/schemas/kaminoEnvironmentsRequest' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/origin_error_page_pass_thru' - description: Change Enable Error Pages On setting response - 4xx: + $ref: '#/components/schemas/kaminoEnvironmentsResponse' + description: Successfully upserted zone environments. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/origin_error_page_pass_thru' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Enable Error Pages On setting response failure + $ref: '#/components/schemas/kaminoErrorResponse' + description: Client error response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Enable Error Pages On setting + summary: Upsert zone environments tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/origin_max_http_version': - get: - description: Value of the Origin Max HTTP version setting (Note that the default value for Enterprise is "1"). - operationId: zone-settings-get-origin-max-http-version-setting + - Zone Environments + x-api-token-group: + - Zone Versioning Write parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + x-stackql-sdk: + service: zones + resource_chain: + - environments + method: update + /zones/{zone_id}/environments/{environment_id}: + delete: + operationId: zonesEnvironmentsDelete responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - $ref: '#/components/schemas/origin_max_http_version_response_value' - description: Get Origin Max HTTP version setting response - 4xx: + $ref: '#/components/schemas/kaminoEnvironmentsResponse' + description: Successfully deleted zone environment. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - $ref: '#/components/schemas/origin_max_http_version_response_value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Origin Max HTTP version setting response failure + $ref: '#/components/schemas/kaminoErrorResponse' + description: Client error response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Origin Max HTTP version setting + summary: Delete zone environment tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'The highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.).' - operationId: zone-settings-change-origin-max-http-version-setting + - Zone Environments + x-api-token-group: + - Zone Versioning Write parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/origin_max_http_version_value' - required: - - value - required: true + type: string + - description: Reference identifier for the environment. + in: path + name: environment_id + schema: + type: string + required: true + x-stackql-sdk: + service: zones + resource_chain: + - environments + method: delete + /zones/{zone_id}/environments/{environment_id}/rollback: + post: + operationId: zonesEnvironmentsRollback responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - $ref: '#/components/schemas/origin_max_http_version_response_value' - description: Change Origin Max HTTP version setting response - 4xx: + $ref: '#/components/schemas/kaminoEnvironmentsResponse' + description: Successfully rolled back zone environment. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - $ref: '#/components/schemas/origin_max_http_version_response_value' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Origin Max HTTP version setting response failure + $ref: '#/components/schemas/kaminoErrorResponse' + description: Client error response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Origin Max HTTP version setting + summary: Roll back zone environment tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/polish': + - Zone Environments + x-api-token-group: + - Zone Versioning Write + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: Reference identifier for the environment. + in: path + name: environment_id + schema: + type: string + required: true + x-stackql-sdk: + service: zones + resource_chain: + - environments + method: rollback + /zones/{zone_id}/firewall-for-ai/custom-topics: get: - description: 'Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.' - operationId: zone-settings-get-polish-setting + description: Get the Firewall for AI custom topic categories for a zone. + operationId: firewall-for-ai-custom-topics-get parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/polish' - description: Get Polish setting response - 4xx: + $ref: '#/components/schemas/wafProductApiBundleResponseCustomTopics' + description: Get Firewall for AI custom topics response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/polish' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Polish setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Polish setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.' - operationId: zone-settings-change-polish-setting + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + properties: + topics: + description: >- + Custom topic categories for Firewall for AI content + detection. + items: + $ref: '#/components/schemas/wafProductApiBundleCustomTopic' + maxItems: 20 + type: array + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Firewall for AI custom topics failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Firewall for AI Custom Topics + tags: + - Firewall for AI + put: + description: >- + Set the Firewall for AI custom topic categories for a zone. A maximum of + 20 custom topics can be configured per zone. Each topic label must be + 2–20 characters using only lowercase letters (a–z), digits (0–9), and + hyphens. Each topic description must be 2–50 printable ASCII characters. + Changes can take up to a minute to propagate to the zone. + operationId: firewall-for-ai-custom-topics-put parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/polish_value' - required: - - value - required: true + $ref: '#/components/schemas/wafProductApiBundleCustomTopics' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/polish' - description: Change Polish setting response - 4xx: + $ref: '#/components/schemas/wafProductApiBundleResponseCustomTopics' + description: Set Firewall for AI custom topics response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/polish' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Polish setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Polish setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: false - pro: true - '/zones/{zone_identifier}/settings/prefetch_preload': + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + properties: + topics: + description: >- + Custom topic categories for Firewall for AI content + detection. + items: + $ref: '#/components/schemas/wafProductApiBundleCustomTopic' + maxItems: 20 + type: array + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set Firewall for AI custom topics failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set Firewall for AI Custom Topics + tags: + - Firewall for AI + /zones/{zone_id}/firewall-for-ai/settings: get: - description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - operationId: zone-settings-get-prefetch-preload-setting + description: Get whether Firewall for AI is enabled or disabled for a zone. + operationId: firewall-for-ai-settings-get parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/prefetch_preload' - description: Get prefetch preload setting response - 4xx: + $ref: '#/components/schemas/wafProductApiBundleResponseSettings' + description: Get Firewall for AI status response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/prefetch_preload' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get prefetch preload setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get prefetch preload setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. - operationId: zone-settings-change-prefetch-preload-setting + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + description: Firewall for AI enablement status for a zone. + properties: + enabled: + description: Whether Firewall for AI is enabled on the zone. + type: boolean + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Get Firewall for AI status failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Firewall for AI Status + tags: + - Firewall for AI + x-api-token-group: + - Firewall for AI Write + - Firewall for AI Read + put: + description: >- + Enable or disable Firewall for AI for a zone. Changes can take up to a + minute to propagate to the zone. + operationId: firewall-for-ai-settings-put parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/prefetch_preload_value' - required: - - value - required: true + $ref: '#/components/schemas/wafProductApiBundleSettings' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/prefetch_preload' - description: Change prefetch preload setting response - 4xx: + $ref: '#/components/schemas/wafProductApiBundleResponseSettings' + description: Set Firewall for AI status response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/prefetch_preload' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change prefetch preload setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change prefetch preload setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/privacy_pass': - get: - description: 'Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).' - operationId: zone-settings-get-privacy-pass-setting + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + description: Firewall for AI enablement status for a zone. + properties: + enabled: + description: Whether Firewall for AI is enabled on the zone. + type: boolean + type: object + enum: + - null + success: + description: Defines whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Set Firewall for AI status failure response. + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Set Firewall for AI Status + tags: + - Firewall for AI + x-api-token-group: + - Firewall for AI Write + /zones/{zone_id}/hold: + delete: + description: >- + Stop enforcement of a zone hold on the zone, permanently or temporarily, + allowing the creation and activation of zones with this zone's hostname. + operationId: zones-0-hold-delete parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. + schema: + type: string + - description: >- + If `hold_after` is provided, the hold will be temporarily disabled, + then automatically re-enabled by the system at the time specified in + this RFC3339-formatted timestamp. Otherwise, the hold will be + disabled indefinitely. + in: query + name: hold_after schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/privacy_pass' - description: Get Privacy Pass setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + result: + $ref: '#/components/schemas/zoneHold' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Successful Response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/privacy_pass' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Privacy Pass setting response failure + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Client Error security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Privacy Pass setting + summary: Remove Zone Hold tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - patch: - description: 'Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).' - operationId: zone-settings-change-privacy-pass-setting + - Zone Holds + x-api-token-group: + - Zone Write + x-stackql-sdk: + service: zones + resource_chain: + - holds + method: delete + get: + description: >- + Retrieve whether the zone is subject to a zone hold, and metadata about + the hold. + operationId: zones-0-hold-get parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/privacy_pass_value' - required: - - value - required: true + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/privacy_pass' - description: Change Privacy Pass setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/privacy_pass' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Privacy Pass setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Change Privacy Pass setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/proxy_read_timeout': - get: - description: Maximum time between two read operations from origin. - operationId: zone-settings-get-proxy-read-timeout-setting + type: object + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + result: + $ref: '#/components/schemas/zoneHold' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Successful Response + 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Client Error + security: + - api_token: [] + - api_email: [] + api_key: [] + summary: Get Zone Hold + tags: + - Zone Holds + x-api-token-group: + - Trust and Safety Write + - Trust and Safety Read + - 'Zero Trust: PII Read' + - Zaraz Edit + - Zaraz Read + - Zaraz Admin + - 'Access: Apps and Policies Revoke' + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + - 'Access: Apps and Policies Revoke' + - 'Access: Mutual TLS Certificates Write' + - 'Access: Organizations, Identity Providers, and Groups Write' + - Zone Settings Write + - Zone Settings Read + - Zone Read + - DNS Read + - Workers Scripts Write + - Workers Scripts Read + - Zone Write + - Workers Routes Write + - Workers Routes Read + - Stream Write + - Stream Read + - SSL and Certificates Write + - SSL and Certificates Read + - Logs Write + - Logs Read + - Cache Purge + - Page Rules Write + - Page Rules Read + - Load Balancers Write + - Load Balancers Read + - Firewall Services Write + - Firewall Services Read + - DNS Write + - Apps Write + - Analytics Read + - 'Access: Apps and Policies Write' + - 'Access: Apps and Policies Read' + x-stackql-sdk: + service: zones + resource_chain: + - holds + method: get + patch: + description: >- + Update the `hold_after` and/or `include_subdomains` values on an + existing zone hold. The hold is enabled if the `hold_after` date-time + value is in the past. + operationId: zones-0-hold-patch parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + properties: + hold_after: + default: '' + description: >- + If `hold_after` is provided and future-dated, the hold will + be temporarily disabled, then automatically re-enabled by + the system at the time specified in this RFC3339-formatted + timestamp. A past-dated `hold_after` value will have no + effect on an existing, enabled hold. Providing an empty + string will set its value to the current time. + type: string + include_subdomains: + default: false + description: >- + If `true`, the zone hold will extend to block any subdomain + of the given zone, as well as SSL4SaaS Custom Hostnames. For + example, a zone hold on a zone with the hostname + 'example.com' and include_subdomains=true will block + 'example.com', 'staging.example.com', + 'api.staging.example.com', etc. + type: boolean + type: object responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/proxy_read_timeout' - description: Get Proxy Read Timeout setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + result: + $ref: '#/components/schemas/zoneHold' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Successful Response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/proxy_read_timeout' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Proxy Read Timeout setting response failure + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Client Error security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Proxy Read Timeout setting + summary: Update Zone Hold tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: Maximum time between two read operations from origin. - operationId: zone-settings-change-proxy-read-timeout-setting + - Zone Holds + x-api-token-group: + - Zone Write + x-stackql-sdk: + service: zones + resource_chain: + - holds + method: edit + post: + description: >- + Enforce a zone hold on the zone, blocking the creation and activation of + zones with this zone's hostname. + operationId: zones-0-hold-post parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/proxy_read_timeout_value' - required: - - value - required: true + type: string + - description: >- + If provided, the zone hold will extend to block any subdomain of the + given zone, as well as SSL4SaaS Custom Hostnames. For example, a + zone hold on a zone with the hostname 'example.com' and + include_subdomains=true will block 'example.com', + 'staging.example.com', 'api.staging.example.com', etc. + in: query + name: include_subdomains + schema: + type: boolean responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/proxy_read_timeout' - description: Change Proxy Read Timeout setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + result: + $ref: '#/components/schemas/zoneHold' + success: + description: Whether the API call was successful + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Successful Response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/proxy_read_timeout' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Proxy Read Timeout setting response failure + $ref: '#/components/schemas/zonesSchemasApiResponseCommonFailure' + description: Client Error security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Proxy Read Timeout setting + summary: Create Zone Hold tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/pseudo_ipv4': + - Zone Holds + x-api-token-group: + - Zone Write + x-stackql-sdk: + service: zones + resource_chain: + - holds + method: create + /zones/{zone_id}/settings: get: - description: Value of the Pseudo IPv4 setting. - operationId: zone-settings-get-pseudo-i-pv4-setting + deprecated: true + description: Available settings for your user in relation to a zone. + operationId: zone-settings-get-all-zone-settings parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/pseudo_ipv4' - description: Get Pseudo IPv4 setting response - 4xx: + $ref: '#/components/schemas/zonesZoneSettingsResponseCollection' + description: Get all Zone settings response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/pseudo_ipv4' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Pseudo IPv4 setting response failure + $ref: >- + #/components/schemas/zonesComponentsSchemasApiResponseCommonFailure + description: Get all Zone settings response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Pseudo IPv4 setting + summary: Get all zone settings tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' @@ -12409,160 +2272,264 @@ paths: enterprise: true free: true pro: true + x-stainless-deprecation-message: >- + This endpoint is deprecated. Zone settings should instead be managed + individually. patch: - description: Value of the Pseudo IPv4 setting. - operationId: zone-settings-change-pseudo-i-pv4-setting + deprecated: true + description: Edit settings for a zone. + operationId: zone-settings-edit-zone-settings-info parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/pseudo_ipv4_value' - required: - - value - required: true + $ref: '#/components/schemas/zonesMultipleSettings' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/pseudo_ipv4' - description: Change Pseudo IPv4 setting response - 4xx: + $ref: '#/components/schemas/zonesZoneSettingsResponseCollection' + description: Edit zone settings info response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/pseudo_ipv4' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Pseudo IPv4 setting response failure + $ref: >- + #/components/schemas/zonesComponentsSchemasApiResponseCommonFailure + description: Edit zone settings info response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Pseudo IPv4 setting + summary: Edit multiple zone settings tags: - Zone Settings + x-api-token-group: + - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true - free: false + free: true pro: true - '/zones/{zone_identifier}/settings/response_buffering': + x-stainless-deprecation-message: >- + This endpoint is deprecated. Zone settings should instead be managed + individually. + /zones/{zone_id}/settings/aegis: get: - description: 'Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.' - operationId: zone-settings-get-response-buffering-setting + description: >- + Aegis provides dedicated egress IPs (from Cloudflare to your origin) for + your layer 7 WAF and CDN services. The egress IPs are reserved + exclusively for your account so that you can increase your origin + security by only allowing traffic from a small list of IP addresses. + operationId: zone-cache-settings-get-aegis-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/response_buffering' - description: Get Response Buffering setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + editable: + $ref: '#/components/schemas/cacheRulesEditable' + id: + description: The identifier of the caching setting. + type: string + x-auditable: true + enum: + - aegis + modified_on: + $ref: '#/components/schemas/cacheRulesModifiedOn' + description: Last time this setting was modified. + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: Value of the zone setting. + type: object + x-auditable: true + properties: + enabled: + description: Whether the feature is enabled or not. + type: boolean + x-auditable: true + pool_id: + description: >- + Egress pool id which refers to a grouping of + dedicated egress IPs through which Cloudflare will + connect to origin. + type: string + x-auditable: true + required: + - id + - value + - editable + - id + type: object + title: Aegis + required: + - success + - errors + - messages + description: Get aegis setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/response_buffering' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Response Buffering setting response failure + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Get aegis setting response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Response Buffering setting + summary: Get aegis setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - Zone Read + - Zone Write x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#zone_settings:read' x-cfPlanAvailability: business: false enterprise: true free: false pro: false patch: - description: 'Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.' - operationId: zone-settings-change-response-buffering-setting + description: >- + Aegis provides dedicated egress IPs (from Cloudflare to your origin) for + your layer 7 WAF and CDN services. The egress IPs are reserved + exclusively for your account so that you can increase your origin + security by only allowing traffic from a small list of IP addresses. + operationId: zone-cache-settings-change-aegis-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: value: - $ref: '#/components/schemas/response_buffering_value' + $ref: '#/components/schemas/cacheRulesAegisValue' required: - value - required: true + type: object responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/response_buffering' - description: Change Response Buffering setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + properties: + editable: + $ref: '#/components/schemas/cacheRulesEditable' + id: + description: The identifier of the caching setting. + type: string + x-auditable: true + enum: + - aegis + modified_on: + $ref: '#/components/schemas/cacheRulesModifiedOn' + description: Last time this setting was modified. + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: Value of the zone setting. + type: object + x-auditable: true + properties: + enabled: + description: Whether the feature is enabled or not. + type: boolean + x-auditable: true + pool_id: + description: >- + Egress pool id which refers to a grouping of + dedicated egress IPs through which Cloudflare will + connect to origin. + type: string + x-auditable: true + required: + - id + - value + - editable + - id + type: object + title: Aegis + required: + - success + - errors + - messages + description: Change aegis setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/response_buffering' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Response Buffering setting response failure + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Change aegis setting response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Response Buffering setting + summary: Change aegis setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' @@ -12571,46 +2538,59 @@ paths: enterprise: true free: false pro: false - '/zones/{zone_identifier}/settings/rocket_loader': + /zones/{zone_id}/settings/fonts: get: - description: 'Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site''s Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page''s rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.' - operationId: zone-settings-get-rocket-loader-setting + description: >- + Enhance your website's font delivery with Cloudflare Fonts. Deliver + Google Hosted fonts from your own domain, boost performance, and enhance + user privacy. Refer to the Cloudflare Fonts documentation for more + information. + operationId: zone-settings-get-fonts-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/rocket_loader' - description: Get Rocket Loader setting response - 4xx: + properties: + errors: + $ref: '#/components/schemas/speedMessages' + messages: + $ref: '#/components/schemas/speedMessages' + success: + description: Whether the API call was successful. + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/speedCloudflareFonts' + required: + - success + - errors + - messages + type: object + description: Get Cloudflare Fonts setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/rocket_loader' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Rocket Loader setting response failure + $ref: '#/components/schemas/speedApiResponseCommonFailure' + description: Get Cloudflare Fonts setting response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Rocket Loader setting + summary: Get Cloudflare Fonts setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' @@ -12620,54 +2600,66 @@ paths: free: true pro: true patch: - description: 'Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site''s Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page''s rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.' - operationId: zone-settings-change-rocket-loader-setting + description: >- + Enhance your website's font delivery with Cloudflare Fonts. Deliver + Google Hosted fonts from your own domain, boost performance, and enhance + user privacy. Refer to the Cloudflare Fonts documentation for more + information. + operationId: zone-settings-change-fonts-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: value: - $ref: '#/components/schemas/rocket_loader_value' + $ref: '#/components/schemas/speedCloudflareFontsValue' required: - value - required: true + type: object responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/rocket_loader' - description: Change Rocket Loader setting response - 4xx: + properties: + errors: + $ref: '#/components/schemas/speedMessages' + messages: + $ref: '#/components/schemas/speedMessages' + success: + description: Whether the API call was successful. + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/speedCloudflareFonts' + required: + - success + - errors + - messages + type: object + description: Change Cloudflare Fonts setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/rocket_loader' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Rocket Loader setting response failure + $ref: '#/components/schemas/speedApiResponseCommonFailure' + description: Change Cloudflare Fonts setting response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Rocket Loader setting + summary: Change Cloudflare Fonts setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' @@ -12676,46 +2668,49 @@ paths: enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/security_header': + /zones/{zone_id}/settings/origin_h2_max_streams: get: - description: Cloudflare security header for a zone. - operationId: zone-settings-get-security-header-(-hsts)-setting + description: >- + Origin H2 Max Streams configures the max number of concurrent requests + that Cloudflare will send within the same connection when communicating + with the origin server, if the origin supports it. Note that if your + origin does not support H2 multiplexing, 5xx errors may be observed, + particularly 520s. Also note that the default value is `100` for all + plan types except Enterprise where it is `1`. `1` means that H2 + multiplexing is disabled. + operationId: zone-cache-settings-get-origin-h2-max-streams-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_header' - description: Get Security Header (HSTS) setting response - 4xx: + $ref: '#/components/schemas/cacheRulesOriginH2MaxStreamsResponseValue' + description: Get Origin H2 Max Streams setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_header' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Security Header (HSTS) setting response failure + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Get Origin H2 Max Streams setting response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Security Header (HSTS) setting + summary: Get Origin H2 Max Streams Setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - Zone Read + - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:read' @@ -12725,102 +2720,121 @@ paths: free: true pro: true patch: - description: Cloudflare security header for a zone. - operationId: zone-settings-change-security-header-(-hsts)-setting + description: >- + Origin H2 Max Streams configures the max number of concurrent requests + that Cloudflare will send within the same connection when communicating + with the origin server, if the origin supports it. Note that if your + origin does not support H2 multiplexing, 5xx errors may be observed, + particularly 520s. Also note that the default value is `100` for all + plan types except Enterprise where it is `1`. `1` means that H2 + multiplexing is disabled. + operationId: zone-cache-settings-change-origin-h2-max-streams-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: value: - $ref: '#/components/schemas/security_header_value' + $ref: '#/components/schemas/cacheRulesOriginH2MaxStreamsValue' required: - value - required: true + type: object responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_header' - description: Change Security Header (HSTS) setting response - 4xx: + $ref: '#/components/schemas/cacheRulesOriginH2MaxStreamsResponseValue' + description: Change Origin H2 Max Streams setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_header' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Security Header (HSTS) setting response failure + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Change Origin H2 Max Streams response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Security Header (HSTS) setting + summary: Change Origin H2 Max Streams Setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: - business: true + business: false enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/security_level': + free: false + pro: false + /zones/{zone_id}/settings/origin_max_http_version: get: - description: 'Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).' - operationId: zone-settings-get-security-level-setting + description: >- + Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare + will attempt to use with your origin. This setting allows Cloudflare to + make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to + Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), + for more information.). The default value is "2" for all plan types + except Enterprise where it is "1". + operationId: zone-cache-settings-get-origin-max-http-version-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_level' - description: Get Security Level setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/originMaxHttpVersion' + required: + - success + - errors + - messages + description: Get Origin Max HTTP Version setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_level' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Security Level setting response failure + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Get Origin Max HTTP Version setting response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Security Level setting + summary: Get Origin Max HTTP Version Setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - Zone Read + - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:read' @@ -12830,54 +2844,70 @@ paths: free: true pro: true patch: - description: 'Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).' - operationId: zone-settings-change-security-level-setting + description: >- + Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare + will attempt to use with your origin. This setting allows Cloudflare to + make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to + Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), + for more information.). The default value is "2" for all plan types + except Enterprise where it is "1". + operationId: zone-cache-settings-change-origin-max-http-version-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: value: - $ref: '#/components/schemas/security_level_value' + $ref: '#/components/schemas/cacheRulesOriginMaxHttpVersionValue' required: - value - required: true + type: object responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_level' - description: Change Security Level setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + result: + $ref: '#/components/schemas/originMaxHttpVersion' + required: + - success + - errors + - messages + description: Change Origin Max HTTP Version setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/security_level' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Security Level setting response failure + $ref: '#/components/schemas/cacheRulesApiResponseCommonFailure' + description: Change Origin Max HTTP Version response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Security Level setting + summary: Change Origin Max HTTP Version Setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' @@ -12886,256 +2916,139 @@ paths: enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/server_side_exclude': + /zones/{zone_id}/settings/rum: get: - description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won''t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).' - operationId: zone-settings-get-server-side-exclude-setting + description: Retrieves RUM status for a zone. + operationId: web-analytics-get-rum-status parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/server_side_exclude' - description: Get Server Side Exclude setting response - 4xx: + $ref: '#/components/schemas/rumRumSiteResponseSingle' + description: Rum Status. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/server_side_exclude' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Server Side Exclude setting response failure + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Server Side Exclude setting + summary: Get RUM status for a zone tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' + - Web Analytics + x-api-token-group: + - Zone Settings Write + - Zone Settings Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true patch: - description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won''t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).' - operationId: zone-settings-change-server-side-exclude-setting + description: Toggles RUM on/off for an existing zone. + operationId: web-analytics-toggle-rum parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/server_side_exclude_value' - required: - - value - required: true + $ref: '#/components/schemas/rumToggleRumRequest' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/server_side_exclude' - description: Change Server Side Exclude setting response - 4xx: + $ref: '#/components/schemas/rumRumSiteResponseSingle' + description: Rum toggled on/off for an existing zone. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/server_side_exclude' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Server Side Exclude setting response failure + $ref: '#/components/schemas/rumApiResponseCommonFailure' + description: Failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Server Side Exclude setting + summary: Toggle RUM on/off for a zone tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' + - Web Analytics + x-api-token-group: + - Zone Settings Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/sort_query_string_for_cache': + /zones/{zone_id}/settings/speed_brain: get: - description: 'Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.' - operationId: zone-settings-get-enable-query-string-sort-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/sort_query_string_for_cache' - description: Get Enable Query String Sort setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/sort_query_string_for_cache' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Enable Query String Sort setting response failure - security: - - api_email: [] - api_key: [] - - api_token: [] - summary: Get Enable Query String Sort setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - patch: - description: 'Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.' - operationId: zone-settings-change-enable-query-string-sort-setting + description: >- + Speed Brain lets compatible browsers speculate on content which can be + prefetched or preloaded, making website navigation faster. Refer to the + Cloudflare Speed Brain documentation for more information. + operationId: zone-settings-get-speed-brain-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/sort_query_string_for_cache_value' - required: - - value - required: true + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/sort_query_string_for_cache' - description: Change Enable Query String Sort setting response - 4xx: + properties: + errors: + $ref: '#/components/schemas/speedMessages' + messages: + $ref: '#/components/schemas/speedMessages' + success: + description: Whether the API call was successful. + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/speedCloudflareSpeedBrainResponse' + required: + - success + - errors + - messages + type: object + description: Get Cloudflare Speed Brain setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/sort_query_string_for_cache' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Enable Query String Sort setting response failure + $ref: '#/components/schemas/speedApiResponseCommonFailure' + description: Get Cloudflare Speed Brain setting response failure. security: - - api_email: [] - api_key: [] - api_token: [] - summary: Change Enable Query String Sort setting - tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' - x-cfPlanAvailability: - business: false - enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/ssl': - get: - description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).' - operationId: zone-settings-get-ssl-setting - parameters: - - in: path - name: zone_identifier - required: true - schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl' - description: Get SSL setting response - 4xx: - content: - application/json: - schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get SSL setting response failure - security: - api_email: [] api_key: [] - - api_token: [] - summary: Get SSL setting + summary: Get Cloudflare Speed Brain setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' @@ -13145,54 +3058,69 @@ paths: free: true pro: true patch: - description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).' - operationId: zone-settings-change-ssl-setting + description: >- + Speed Brain lets compatible browsers speculate on content which can be + prefetched or preloaded, making website navigation faster. Refer to the + Cloudflare Speed Brain documentation for more information. + operationId: zone-settings-change-speed-brain-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: properties: value: - $ref: '#/components/schemas/ssl_value' + description: Whether the feature is enabled or disabled. + enum: + - 'on' + - 'off' + type: string required: - value - required: true + type: object responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl' - description: Change SSL setting response - 4xx: + properties: + errors: + $ref: '#/components/schemas/speedMessages' + messages: + $ref: '#/components/schemas/speedMessages' + success: + description: Whether the API call was successful. + type: boolean + x-auditable: true + result: + $ref: '#/components/schemas/speedCloudflareSpeedBrainResponse' + required: + - success + - errors + - messages + type: object + description: Cloudflare Speed Brain setting response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change SSL setting response failure + $ref: '#/components/schemas/speedApiResponseCommonFailure' + description: Change Cloudflare Speed Brain setting response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change SSL setting + summary: Change Cloudflare Speed Brain setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' @@ -13201,46 +3129,47 @@ paths: enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/ssl_recommender': + /zones/{zone_id}/settings/ssl_automatic_mode: get: - description: Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - operationId: zone-settings-get-ssl/-tls-recommender-enrollment + description: >- + If the system is enabled, the response will include next_scheduled_scan, + representing the next time this zone will be scanned and the zone's + ssl/tls encryption mode is potentially upgraded by the system. If the + system is disabled, next_scheduled_scan will not be present in the + response body. + operationId: ssl-detector-automatic-mode-get-enrollment parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl_recommender' - description: Get SSL/TLS Recommender enrollment response - 4xx: + $ref: '#/components/schemas/cacheApiResponseSingleId' + description: Get Automatic SSL/TLS Enrollment status response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl_recommender' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get SSL/TLS Recommender enrollment response failure + $ref: '#/components/schemas/cacheApiResponseCommonFailure' + description: Get Automatic SSL/TLS Enrollment status failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get SSL/TLS Recommender enrollment + summary: Get Automatic SSL/TLS enrollment status for the given zone tags: - - Zone Settings + - Automatic SSL/TLS + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - SSL and Certificates Write + - SSL and Certificates Read x-cfPermissionsRequired: enum: - '#zone_settings:read' @@ -13250,724 +3179,1211 @@ paths: free: true pro: true patch: - description: Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. - operationId: zone-settings-change-ssl/-tls-recommender-enrollment + description: >- + The automatic system is enabled when this endpoint is hit with value in + the request body is set to "auto", and disabled when the request body + value is set to "custom". + operationId: ssl-detector-automatic-mode-patch-enrollment parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - enabled: - $ref: '#/components/schemas/ssl_recommender_enabled' - required: - - enabled - required: true + $ref: '#/components/schemas/cacheSchemasPatch' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl_recommender' - description: Change SSL/TLS Recommender enrollment response - 4xx: + $ref: '#/components/schemas/cacheApiResponseSingleId' + description: Patch Automatic SSL/TLS Enrollment status response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/ssl_recommender' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change SSL/TLS Recommender enrollment response failure + $ref: '#/components/schemas/cacheApiResponseCommonFailure' + description: Patch Automatic SSL/TLS Enrollment status failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change SSL/TLS Recommender enrollment + summary: Patch Automatic SSL/TLS Enrollment status for given zone tags: - - Zone Settings + - Automatic SSL/TLS + x-api-token-group: + - Zone Settings Write + - SSL and Certificates Write x-cfPermissionsRequired: enum: + - '#zone_settings:read' - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true - '/zones/{zone_identifier}/settings/tls_1_3': + /zones/{zone_id}/settings/{setting_id}: get: - description: Gets TLS 1.3 setting enabled for a zone. - operationId: zone-settings-get-tls-1.-3-setting-enabled-for-a-zone + description: Fetch a single zone setting by name + operationId: zone-settings-get-single-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - in: path + name: setting_id + schema: + $ref: '#/components/schemas/zonesSettingName' + required: true responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_1_3' - description: Get TLS 1.3 setting enabled for a zone response - 4xx: + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful + type: boolean + result: + $ref: '#/components/schemas/zonesSetting' + required: + - success + - errors + - messages + type: object + description: Get zone setting response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_1_3' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get TLS 1.3 setting enabled for a zone response failure + $ref: >- + #/components/schemas/zonesComponentsSchemasApiResponseCommonFailure + description: Get zone setting response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get TLS 1.3 setting enabled for a zone + summary: Get zone setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true - free: true - pro: true + free: false + pro: false + x-stackql-sdk: + service: zones + resource_chain: + - settings + method: get patch: - description: Changes TLS 1.3 setting. - operationId: zone-settings-change-tls-1.-3-setting + description: Updates a single zone setting by the identifier + operationId: zone-settings-edit-single-setting parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: setting_id schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + $ref: '#/components/schemas/zonesSettingName' + required: true requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/tls_1_3_value' - required: - - value - required: true + $ref: '#/components/schemas/zonesZoneSettingsSingleRequest' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_1_3' - description: Change TLS 1.3 setting response - 4xx: + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful + type: boolean + result: + $ref: '#/components/schemas/zonesSetting' + required: + - success + - errors + - messages + type: object + description: Edit zone setting response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_1_3' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change TLS 1.3 setting response failure + $ref: >- + #/components/schemas/zonesComponentsSchemasApiResponseCommonFailure + description: Edit zone settings info response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change TLS 1.3 setting + summary: Edit zone setting tags: - Zone Settings + x-api-token-group: + - Zone Settings Write x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true - free: true - pro: true - '/zones/{zone_identifier}/settings/tls_client_auth': + free: false + pro: false + x-stackql-sdk: + service: zones + resource_chain: + - settings + method: edit + /zones/{zone_id}/smart_shield: get: - description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - operationId: zone-settings-get-tls-client-auth-setting + description: Retrieve Smart Shield Settings. + operationId: smart-shield-get-settings parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_client_auth' - description: Get TLS Client Auth setting response - 4xx: + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + $ref: >- + #/components/schemas/smartshieldSmartShieldSettingsGetResponse + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Smart Shield Settings response. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Get Smart Shield Settings response failure. + '502': + content: + application/json: + schema: + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Get Smart Shield Settings response failure. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_client_auth' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get TLS Client Auth setting response failure + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Patch Smart Shield Settings response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get TLS Client Auth setting + summary: Get Smart Shield Settings tags: - - Zone Settings + - Smart Shield Settings + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - Zone Read + - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: - business: false + business: true enterprise: true - free: false - pro: false + free: true + pro: true patch: - description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). - operationId: zone-settings-change-tls-client-auth-setting + description: Set Smart Shield Settings. + operationId: smart-shield-patch-settings parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/tls_client_auth_value' - required: - - value - required: true + $ref: '#/components/schemas/smartshieldSmartShieldSettingsPatchBody' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_client_auth' - description: Change TLS Client Auth setting response - 4xx: + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + $ref: >- + #/components/schemas/smartshieldSmartShieldSettingsPatchResponse + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + type: object + description: Smart Shield Settings response. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Get Smart Shield Settings response failure. + '502': + content: + application/json: + schema: + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Smart Shield Settings response failure. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/tls_client_auth' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change TLS Client Auth setting response failure + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Patch Smart Shield Settings response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change TLS Client Auth setting + summary: Patch Smart Shield Settings tags: - - Zone Settings + - Smart Shield Settings + x-api-token-group: + - Zone Settings Write + - Zone Write x-cfPermissionsRequired: enum: + - '#zone_settings:read' - '#zone_settings:edit' x-cfPlanAvailability: - business: false + business: true enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/true_client_ip_header': + free: true + pro: true + /zones/{zone_id}/smart_shield/cache_reserve_clear: get: - description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. - operationId: zone-settings-get-true-client-ip-setting + description: >- + You can use Cache Reserve Clear to clear your Cache Reserve, but you + must first disable Cache Reserve. In most cases, this will be + accomplished within 24 hours. You cannot re-enable Cache Reserve while + this process is ongoing. Keep in mind that you cannot undo or cancel + this operation. + operationId: smart-shield-settings-get-cache-reserve-clear parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/true_client_ip_header' - description: Get True Client IP setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + type: object + description: >- + You can use Cache Reserve Clear to clear your Cache + Reserve, but you must first disable Cache Reserve. In most + cases, this will be accomplished within 24 hours. You + cannot re-enable Cache Reserve while this process is + ongoing. Keep in mind that you cannot undo or cancel this + operation. + title: Cache Reserve Clear + properties: + id: + $ref: >- + #/components/schemas/unnamedSchemaRef2b5e755404a4bfd7892291ce97c4968d + modified_on: + description: Last time this setting was modified. + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + end_ts: + $ref: '#/components/schemas/smartshieldCacheReserveClearEndTs' + start_ts: + $ref: >- + #/components/schemas/smartshieldCacheReserveClearStartTs + state: + $ref: '#/components/schemas/smartshieldCacheReserveClearState' + required: + - id + - state + - start_ts + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Get Cache Reserve Clear response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/true_client_ip_header' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get True Client IP setting response failure + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Get Cache Reserve Clear failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get True Client IP setting + summary: Get Cache Reserve Clear tags: - - Zone Settings + - Cache Reserve Clear + x-api-token-group: + - Zone Settings Write + - Zone Settings Read + - Zone Read + - Zone Write x-cfPermissionsRequired: enum: - - '#zone_settings:edit' + - '#zone_settings:read' x-cfPlanAvailability: - business: false + business: true enterprise: true - free: false - pro: false - patch: - description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. - operationId: zone-settings-change-true-client-ip-setting + free: true + pro: true + post: + description: >- + You can use Cache Reserve Clear to clear your Cache Reserve, but you + must first disable Cache Reserve. In most cases, this will be + accomplished within 24 hours. You cannot re-enable Cache Reserve while + this process is ongoing. Keep in mind that you cannot undo or cancel + this operation. + operationId: smart-shield-settings-start-cache-reserve-clear parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/true_client_ip_header_value' - required: - - value - required: true + application/json: {} + description: The request body is currently not used. responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/true_client_ip_header' - description: Change True Client IP setting response - 4xx: + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + type: object + description: >- + You can use Cache Reserve Clear to clear your Cache + Reserve, but you must first disable Cache Reserve. In most + cases, this will be accomplished within 24 hours. You + cannot re-enable Cache Reserve while this process is + ongoing. Keep in mind that you cannot undo or cancel this + operation. + title: Cache Reserve Clear + properties: + id: + $ref: >- + #/components/schemas/unnamedSchemaRef2b5e755404a4bfd7892291ce97c4968d + modified_on: + description: Last time this setting was modified. + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + end_ts: + $ref: '#/components/schemas/smartshieldCacheReserveClearEndTs' + start_ts: + $ref: >- + #/components/schemas/smartshieldCacheReserveClearStartTs + state: + $ref: '#/components/schemas/smartshieldCacheReserveClearState' + required: + - id + - state + - start_ts + success: + description: Whether the API call was successful. + enum: + - true + type: boolean + required: + - success + - errors + - messages + - result + description: Start Cache Reserve Clear response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/true_client_ip_header' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change True Client IP setting response failure + $ref: '#/components/schemas/smartshieldApiResponseCommonFailure' + description: Start Cache Reserve Clear failure response. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change True Client IP setting + summary: Start Cache Reserve Clear tags: - - Zone Settings + - Cache Reserve Clear + x-api-token-group: + - Zone Settings Write + - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: - business: false + business: true enterprise: true - free: false - pro: false - '/zones/{zone_identifier}/settings/waf': + free: true + pro: true + /zones/{zone_id}/smart_shield/healthchecks: get: - description: 'The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will ''challenge'' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare''s WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).' - operationId: zone-settings-get-web-application-firewall-(-waf)-setting + description: List configured health checks. + operationId: smart-shield-list-health-checks parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + - description: Page number of paginated results. + in: query + name: page + schema: + default: 1 + minimum: 1 + type: number + - description: Maximum number of results per page. Must be a multiple of 5. + in: query + name: per_page + schema: + default: 25 + maximum: 1000 + minimum: 5 + type: number responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/waf' - description: Get Web Application Firewall (WAF) setting response - 4xx: + $ref: '#/components/schemas/smartshieldResponseCollection' + description: List Health Checks response + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/waf' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get Web Application Firewall (WAF) setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + items: + $ref: '#/components/schemas/smartshieldHealthchecks' + nullable: true + type: array + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + result_info: + $ref: '#/components/schemas/smartshieldResultInfo' + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: List Health Checks response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get Web Application Firewall (WAF) setting + summary: List Health Checks tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' + - Health Checks + x-api-token-group: + - Health Checks Write + - Health Checks Read x-cfPlanAvailability: business: true enterprise: true free: false pro: true - patch: - description: 'The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will ''challenge'' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare''s WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).' - operationId: zone-settings-change-web-application-firewall-(-waf)-setting + post: + description: Create a new health check. + operationId: smart-shield-create-health-check parameters: - - in: path - name: zone_identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/waf_value' - required: - - value - required: true + $ref: '#/components/schemas/smartshieldQueryHealthcheck' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/waf' - description: Change Web Application Firewall (WAF) setting response - 4xx: + $ref: '#/components/schemas/smartshieldSingleHcResponse' + description: Create Health Check response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/waf' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change Web Application Firewall (WAF) setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + properties: + address: + $ref: '#/components/schemas/smartshieldAddress' + check_regions: + $ref: '#/components/schemas/smartshieldCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/smartshieldConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/smartshieldConsecutiveSuccesses' + created_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/smartshieldDescription' + failure_reason: + $ref: '#/components/schemas/smartshieldFailureReason' + http_config: + $ref: '#/components/schemas/smartshieldHttpConfig' + id: + $ref: '#/components/schemas/smartshieldIdentifier' + interval: + $ref: '#/components/schemas/smartshieldInterval' + modified_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/smartshieldName' + retries: + $ref: '#/components/schemas/smartshieldRetries' + status: + $ref: '#/components/schemas/smartshieldStatus' + suspended: + $ref: '#/components/schemas/smartshieldSuspended' + tcp_config: + $ref: '#/components/schemas/smartshieldTcpConfig' + timeout: + $ref: '#/components/schemas/smartshieldTimeout' + type: + $ref: '#/components/schemas/smartshieldType' + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Create Health Check response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change Web Application Firewall (WAF) setting + summary: Create Health Check tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' + - Health Checks + x-api-token-group: + - Health Checks Write x-cfPlanAvailability: business: true enterprise: true free: false pro: true - '/zones/{zone_identifier}/settings/webp': - get: - description: 'When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.' - operationId: zone-settings-get-web-p-setting + /zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id}: + delete: + description: Delete a health check. + operationId: smart-shield-delete-health-check parameters: - in: path - name: zone_identifier + name: healthcheck_id + schema: + $ref: '#/components/schemas/smartshieldIdentifier' required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/webp' - description: Get WebP setting response - 4xx: + $ref: '#/components/schemas/smartshieldSingleHcIdResponse' + description: Delete Health Check response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/webp' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get WebP setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + properties: + id: + $ref: '#/components/schemas/smartshieldIdentifier' + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Delete Health Check response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get WebP setting + summary: Delete Health Check tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' + - Health Checks + x-api-token-group: + - Health Checks Write x-cfPlanAvailability: business: true enterprise: true - free: true + free: false pro: true - patch: - description: 'When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.' - operationId: zone-settings-change-web-p-setting + get: + description: Fetch a single configured health check. + operationId: smart-shield-health-check-details parameters: - in: path - name: zone_identifier + name: healthcheck_id + schema: + $ref: '#/components/schemas/smartshieldIdentifier' + required: true + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' - requestBody: - content: - application/json: - schema: - properties: - value: - $ref: '#/components/schemas/webp_value' - required: - - value - required: true + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/webp' - description: Change WebP setting response - 4xx: + $ref: '#/components/schemas/smartshieldSingleHcResponse' + description: Health Check Details response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/webp' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change WebP setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + properties: + address: + $ref: '#/components/schemas/smartshieldAddress' + check_regions: + $ref: '#/components/schemas/smartshieldCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/smartshieldConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/smartshieldConsecutiveSuccesses' + created_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/smartshieldDescription' + failure_reason: + $ref: '#/components/schemas/smartshieldFailureReason' + http_config: + $ref: '#/components/schemas/smartshieldHttpConfig' + id: + $ref: '#/components/schemas/smartshieldIdentifier' + interval: + $ref: '#/components/schemas/smartshieldInterval' + modified_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/smartshieldName' + retries: + $ref: '#/components/schemas/smartshieldRetries' + status: + $ref: '#/components/schemas/smartshieldStatus' + suspended: + $ref: '#/components/schemas/smartshieldSuspended' + tcp_config: + $ref: '#/components/schemas/smartshieldTcpConfig' + timeout: + $ref: '#/components/schemas/smartshieldTimeout' + type: + $ref: '#/components/schemas/smartshieldType' + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Health Check Details response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change WebP setting + summary: Health Check Details tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' + - Health Checks + x-api-token-group: + - Health Checks Write + - Health Checks Read x-cfPlanAvailability: business: true enterprise: true free: false pro: true - '/zones/{zone_identifier}/settings/websockets': - get: - description: 'Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).' - operationId: zone-settings-get-web-sockets-setting + patch: + description: Patch a configured health check. + operationId: smart-shield-patch-health-check parameters: - in: path - name: zone_identifier + name: healthcheck_id + schema: + $ref: '#/components/schemas/smartshieldIdentifier' required: true + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/smartshieldQueryHealthcheck' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/websockets' - description: Get WebSockets setting response - 4xx: + $ref: '#/components/schemas/smartshieldSingleHcResponse' + description: Patch Health Check response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/websockets' - - $ref: '#/components/schemas/api-response-common-failure' - description: Get WebSockets setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + properties: + address: + $ref: '#/components/schemas/smartshieldAddress' + check_regions: + $ref: '#/components/schemas/smartshieldCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/smartshieldConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/smartshieldConsecutiveSuccesses' + created_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/smartshieldDescription' + failure_reason: + $ref: '#/components/schemas/smartshieldFailureReason' + http_config: + $ref: '#/components/schemas/smartshieldHttpConfig' + id: + $ref: '#/components/schemas/smartshieldIdentifier' + interval: + $ref: '#/components/schemas/smartshieldInterval' + modified_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/smartshieldName' + retries: + $ref: '#/components/schemas/smartshieldRetries' + status: + $ref: '#/components/schemas/smartshieldStatus' + suspended: + $ref: '#/components/schemas/smartshieldSuspended' + tcp_config: + $ref: '#/components/schemas/smartshieldTcpConfig' + timeout: + $ref: '#/components/schemas/smartshieldTimeout' + type: + $ref: '#/components/schemas/smartshieldType' + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Patch Health Check response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Get WebSockets setting + summary: Patch Health Check tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:read' + - Health Checks + x-api-token-group: + - Health Checks Write x-cfPlanAvailability: business: true enterprise: true - free: true + free: false pro: true - patch: - description: 'Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).' - operationId: zone-settings-change-web-sockets-setting + put: + description: Update a configured health check. + operationId: smart-shield-update-health-check parameters: - in: path - name: zone_identifier + name: healthcheck_id + schema: + $ref: '#/components/schemas/smartshieldIdentifier' + required: true + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/common_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - properties: - value: - $ref: '#/components/schemas/websockets_value' - required: - - value - required: true + $ref: '#/components/schemas/smartshieldSingleHcResponse' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/websockets' - description: Change WebSockets setting response - 4xx: + $ref: '#/components/schemas/smartshieldSingleHcResponse' + description: Update Health Check response. + 4XX: content: application/json: schema: - allOf: - - allOf: - - $ref: '#/components/schemas/zone_settings_response_single' - - properties: - result: - $ref: '#/components/schemas/websockets' - - $ref: '#/components/schemas/api-response-common-failure' - description: Change WebSockets setting response failure + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + properties: + address: + $ref: '#/components/schemas/smartshieldAddress' + check_regions: + $ref: '#/components/schemas/smartshieldCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/smartshieldConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/smartshieldConsecutiveSuccesses' + created_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/smartshieldDescription' + failure_reason: + $ref: '#/components/schemas/smartshieldFailureReason' + http_config: + $ref: '#/components/schemas/smartshieldHttpConfig' + id: + $ref: '#/components/schemas/smartshieldIdentifier' + interval: + $ref: '#/components/schemas/smartshieldInterval' + modified_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/smartshieldName' + retries: + $ref: '#/components/schemas/smartshieldRetries' + status: + $ref: '#/components/schemas/smartshieldStatus' + suspended: + $ref: '#/components/schemas/smartshieldSuspended' + tcp_config: + $ref: '#/components/schemas/smartshieldTcpConfig' + timeout: + $ref: '#/components/schemas/smartshieldTimeout' + type: + $ref: '#/components/schemas/smartshieldType' + type: object + enum: + - null + success: + description: Whether the API call was successful. + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result + description: Update Health Check response failure. security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] - summary: Change WebSockets setting + summary: Update Health Check tags: - - Zone Settings - x-cfPermissionsRequired: - enum: - - '#zone_settings:edit' + - Health Checks + x-api-token-group: + - Health Checks Write x-cfPlanAvailability: business: true enterprise: true - free: true + free: false pro: true - '/zones/{identifier}/subscription': + /zones/{zone_id}/subscription: get: description: Lists zone subscription details. operationId: zone-subscription-zone-subscription-details parameters: - - in: path - name: identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/zone_subscription_response_single' + $ref: '#/components/schemas/billSubsApiZoneSubscriptionResponseSingle' description: Zone Subscription Details response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_subscription_response_single' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + type: object + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + description: How often the subscription is renewed automatically. + enum: + - weekly + - monthly + - quarterly + - yearly + - not-applicable + type: string + x-auditable: true + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result description: Zone Subscription Details response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Zone Subscription Details tags: - Zone Subscription + x-api-token-group: + - Billing Write + - Billing Read x-cfPermissionsRequired: enum: - '#billing:read' @@ -13976,43 +4392,97 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: zones + resource_chain: + - subscriptions + method: get post: - description: 'Create a zone subscription, either plan or add-ons.' + description: Create a zone subscription, either plan or add-ons. operationId: zone-subscription-create-zone-subscription parameters: - - in: path - name: identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/subscription-v2' - required: true + $ref: '#/components/schemas/billSubsApiSubscriptionV2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/zone_subscription_response_single' + $ref: '#/components/schemas/billSubsApiZoneSubscriptionResponseSingle' description: Create Zone Subscription response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_subscription_response_single' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + type: object + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + description: How often the subscription is renewed automatically. + enum: + - weekly + - monthly + - quarterly + - yearly + - not-applicable + type: string + x-auditable: true + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result description: Create Zone Subscription response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Create Zone Subscription tags: - Zone Subscription + x-api-token-group: + - Billing Write x-cfPermissionsRequired: enum: - '#billing:read' @@ -14022,49 +4492,4368 @@ paths: enterprise: true free: true pro: true + x-stackql-sdk: + service: zones + resource_chain: + - subscriptions + method: create put: - description: 'Updates zone subscriptions, either plan or add-ons.' + description: Updates zone subscriptions, either plan or add-ons. operationId: zone-subscription-update-zone-subscription parameters: - - in: path - name: identifier + - name: zone_id + in: path required: true + description: The Cloudflare zone ID. schema: - $ref: '#/components/schemas/subscription-v2_components-schemas-identifier' + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/subscription-v2' - required: true + $ref: '#/components/schemas/billSubsApiSubscriptionV2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/zone_subscription_response_single' + $ref: '#/components/schemas/billSubsApiZoneSubscriptionResponseSingle' description: Update Zone Subscription response - 4xx: + 4XX: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/zone_subscription_response_single' - - $ref: '#/components/schemas/api-response-common-failure' + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + type: object + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + description: How often the subscription is renewed automatically. + enum: + - weekly + - monthly + - quarterly + - yearly + - not-applicable + type: string + x-auditable: true + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + enum: + - null + success: + description: Whether the API call was successful + enum: + - true + - false + type: boolean + required: + - success + - errors + - messages + - result + - success + - errors + - messages + - result description: Update Zone Subscription response failure security: + - api_token: [] - api_email: [] api_key: [] - - api_token: [] summary: Update Zone Subscription tags: - Zone Subscription + x-api-token-group: + - Billing Write x-cfPermissionsRequired: enum: - - '#billing:read' - - '#billing:edit' - x-cfPlanAvailability: - business: true - enterprise: true - free: true - pro: true + - '#billing:read' + - '#billing:edit' + x-cfPlanAvailability: + business: true + enterprise: true + free: true + pro: true + x-stackql-sdk: + service: zones + resource_chain: + - subscriptions + method: update + /zones/{zone_id}/email/sending/suppression: + get: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: query + name: page + schema: + default: 1 + minimum: 0 + type: integer + - in: query + name: per_page + schema: + default: 100 + maximum: 1000 + minimum: 0 + type: integer + - in: query + name: order + schema: + default: created_at + enum: + - email + - expires_at + - created_at + type: string + - in: query + name: direction + schema: + default: desc + enum: + - asc + - desc + type: string + responses: + '200': + content: + application/json: + schema: + properties: + page: + type: integer + per_page: + type: integer + result: + items: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + type: array + total: + type: integer + required: + - page + - per_page + - total + - result + type: object + description: Returns suppressed emails. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: List account or zone email suppressions + tags: [] + operationId: get_zones_zone_id_email_sending_suppression + post: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + required: + - email + type: object + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + id: + format: uuid + type: string + required: + - id + type: object + required: + - result + type: object + description: Returns suppression. + '400': + content: + application/json: + schema: + properties: + errors: + items: + type: string + type: array + success: + type: boolean + required: + - success + - errors + type: object + description: Bad request. + security: + - bearerAuth: [] + summary: Create account or zone email suppression + tags: [] + operationId: post_zones_zone_id_email_sending_suppression + /zones/{zone_id}/email/sending/suppression/{suppression_id}: + get: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + result: + properties: + created_at: + format: date-time + type: string + readOnly: true + email: + format: email + type: string + expires_at: + format: date-time + nullable: true + type: string + id: + format: uuid + type: string + reason: + type: string + zones: + default: [] + items: + type: string + type: array + required: + - id + - email + - reason + - created_at + - expires_at + type: object + required: + - result + type: object + description: Returns suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Get account or zone email suppression + tags: [] + operationId: get_zones_zone_id_email_sending_suppression_suppression_id + delete: + parameters: + - name: zone_id + in: path + required: true + description: The Cloudflare zone ID. + schema: + type: string + - in: path + name: suppression_id + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + properties: + success: + type: boolean + required: + - success + type: object + description: Deletes suppression. + '404': + content: + application/json: + schema: + properties: + error: + type: string + success: + type: boolean + required: + - success + - error + type: object + description: Suppression not found. + security: + - bearerAuth: [] + summary: Delete account or zone email suppression + tags: [] + operationId: delete_zones_zone_id_email_sending_suppression_suppression_id +components: + schemas: + argoAnalyticsMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + argoAnalyticsResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/argoAnalyticsMessages' + messages: + $ref: '#/components/schemas/argoAnalyticsMessages' + result: + type: object + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + billSubsApiAvailableRatePlan: + properties: + can_subscribe: + $ref: '#/components/schemas/billSubsApiCanSubscribe' + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + externally_managed: + $ref: '#/components/schemas/billSubsApiExternallyManaged' + frequency: + $ref: '#/components/schemas/billSubsApiSchemasFrequency' + id: + $ref: '#/components/schemas/billSubsApiIdentifier' + is_subscribed: + $ref: '#/components/schemas/billSubsApiIsSubscribed' + legacy_discount: + $ref: '#/components/schemas/billSubsApiLegacyDiscount' + legacy_id: + $ref: '#/components/schemas/billSubsApiLegacyId' + name: + $ref: '#/components/schemas/billSubsApiSchemasName' + price: + $ref: '#/components/schemas/billSubsApiSchemasPrice' + type: object + billSubsApiCanSubscribe: + default: false + description: Indicates whether you can subscribe to this plan. + example: true + type: boolean + x-auditable: true + billSubsApiComponentValue: + properties: + default: + $ref: '#/components/schemas/billSubsApiDefault' + name: + $ref: '#/components/schemas/billSubsApiComponentsSchemasName' + unit_price: + $ref: '#/components/schemas/billSubsApiUnitPrice' + type: object + billSubsApiComponentsSchemasName: + description: The unique component. + enum: + - zones + - page_rules + - dedicated_certificates + - dedicated_certificates_custom + example: page_rules + x-auditable: true + type: string + billSubsApiCurrency: + description: The monetary unit in which pricing information is displayed. + example: USD + readOnly: true + type: string + x-auditable: true + billSubsApiCurrentPeriodEnd: + description: The end of the current period and also when the next billing is due. + example: '2014-03-31T12:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + billSubsApiCurrentPeriodStart: + description: >- + When the current billing period started. May match initial_period_start + if this is the first period. + example: '2014-05-11T12:20:00Z' + format: date-time + readOnly: true + type: string + x-auditable: true + billSubsApiDefault: + description: The default amount allocated. + example: 5 + type: number + x-auditable: true + billSubsApiDuration: + description: The duration of the plan subscription. + example: 1 + type: number + x-auditable: true + billSubsApiExternallyManaged: + default: false + description: Indicates whether this plan is managed externally. + example: false + type: boolean + x-auditable: true + billSubsApiFrequency: + description: How often the subscription is renewed automatically. + enum: + - weekly + - monthly + - quarterly + - yearly + example: monthly + type: string + x-auditable: true + billSubsApiIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + billSubsApiIsSubscribed: + default: false + description: Indicates whether you are currently subscribed to this plan. + example: false + type: boolean + x-auditable: true + billSubsApiLegacyDiscount: + default: false + description: Indicates whether this plan has a legacy discount applied. + example: false + type: boolean + x-auditable: true + billSubsApiLegacyId: + description: The legacy identifier for this rate plan, if any. + example: free + readOnly: true + type: string + x-auditable: true + billSubsApiMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + billSubsApiPlanResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + items: + $ref: '#/components/schemas/billSubsApiSchemasRatePlan' + nullable: true + type: array + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/billSubsApiResultInfo' + required: + - success + - errors + - messages + - result + billSubsApiPrice: + description: The price of the subscription that will be billed, in US dollars. + example: 20 + readOnly: true + type: number + x-auditable: true + billSubsApiRatePlan: + properties: + components: + $ref: '#/components/schemas/billSubsApiSchemasComponentValues' + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + duration: + $ref: '#/components/schemas/billSubsApiDuration' + frequency: + $ref: '#/components/schemas/billSubsApiSchemasFrequency' + id: + $ref: '#/components/schemas/billSubsApiRatePlanComponentsSchemasIdentifier' + name: + $ref: '#/components/schemas/billSubsApiSchemasName' + type: object + billSubsApiRatePlanComponentsSchemasIdentifier: + description: Plan identifier tag. + example: free + readOnly: true + type: string + x-auditable: true + billSubsApiRatePlan_2: + description: The rate plan applied to the subscription. + properties: + currency: + description: The currency applied to the rate plan subscription. + example: USD + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + externally_managed: + description: Whether this rate plan is managed externally from Cloudflare. + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + id: + description: The ID of the rate plan. + example: free + type: string + x-auditable: true + enum: + - free + - lite + - pro + - pro_plus + - business + - enterprise + - partners_free + - partners_pro + - partners_business + - partners_enterprise + is_contract: + description: >- + Whether a rate plan is enterprise-based (or newly adopted term + contract). + example: false + type: boolean + x-auditable: true + x-stainless-terraform-configurability: computed_optional + public_name: + description: The full name of the rate plan. + example: Business Plan + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + scope: + description: The scope that this rate plan applies to. + example: zone + type: string + x-auditable: true + x-stainless-terraform-configurability: computed_optional + sets: + description: >- + The list of sets this rate plan applies to. Returns array of + strings. + example: [] + items: + type: string + x-auditable: true + type: array + x-stainless-terraform-configurability: optional + type: object + billSubsApiResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + billSubsApiSchemasComponentValues: + description: Array of available components values for the plan. + items: + $ref: '#/components/schemas/billSubsApiComponentValue' + type: array + billSubsApiSchemasFrequency: + description: The frequency at which you will be billed for this plan. + enum: + - weekly + - monthly + - quarterly + - yearly + example: monthly + readOnly: true + type: string + x-auditable: true + billSubsApiSchemasIdentifier: + description: Subscription identifier tag. + example: 506e3185e9c882d175a2d0cb0093d9f2 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + billSubsApiSchemasName: + description: The plan name. + example: Free Plan + maxLength: 80 + readOnly: true + type: string + x-auditable: true + billSubsApiSchemasPrice: + description: The amount you will be billed for this plan. + example: 0 + type: number + x-auditable: true + billSubsApiSchemasRatePlan: + type: object + $ref: '#/components/schemas/billSubsApiRatePlan' + billSubsApiState: + description: The state that the subscription is in. + enum: + - Trial + - Provisioned + - Paid + - AwaitingPayment + - Cancelled + - Failed + - Expired + example: Paid + readOnly: true + type: string + x-auditable: true + billSubsApiSubscriptionResponse: + type: object + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + description: How often the subscription is renewed automatically. + enum: + - weekly + - monthly + - quarterly + - yearly + - not-applicable + example: monthly + type: string + x-auditable: true + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + billSubsApiSubscriptionV2: + properties: + currency: + $ref: '#/components/schemas/billSubsApiCurrency' + current_period_end: + $ref: '#/components/schemas/billSubsApiCurrentPeriodEnd' + current_period_start: + $ref: '#/components/schemas/billSubsApiCurrentPeriodStart' + frequency: + $ref: '#/components/schemas/billSubsApiFrequency' + id: + $ref: '#/components/schemas/billSubsApiSchemasIdentifier' + price: + $ref: '#/components/schemas/billSubsApiPrice' + rate_plan: + $ref: '#/components/schemas/billSubsApiRatePlan_2' + state: + $ref: '#/components/schemas/billSubsApiState' + type: object + billSubsApiUnitPrice: + description: The unit price of the addon. + example: 1 + readOnly: true + type: number + x-auditable: true + billSubsApiZoneSubscriptionResponseSingle: + type: object + properties: + errors: + $ref: '#/components/schemas/billSubsApiMessages' + messages: + $ref: '#/components/schemas/billSubsApiMessages' + result: + $ref: '#/components/schemas/billSubsApiSubscriptionResponse' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + cacheApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/cacheMessages' + messages: + example: [] + $ref: '#/components/schemas/cacheMessages' + result: + $ref: '#/components/schemas/cacheResult' + success: + description: Indicates the API call's success or failure. + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + cacheApiResponseSingleId: + properties: + errors: + $ref: '#/components/schemas/cacheMessages' + messages: + $ref: '#/components/schemas/cacheMessages' + result: + $ref: '#/components/schemas/cacheResult' + success: + description: Indicates the API call's success or failure. + example: true + type: boolean + required: + - success + - errors + - messages + - result + type: object + cacheMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + cacheResult: + properties: + editable: + description: Whether this setting can be updated or not. + readOnly: true + type: boolean + id: + example: ssl_automatic_mode + readOnly: true + type: string + modified_on: + description: Last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + next_scheduled_scan: + description: Next time this zone will be scanned by the Automatic SSL/TLS. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + value: + description: Current setting of the automatic SSL/TLS. + enum: + - auto + - custom + example: auto + readOnly: true + type: string + required: + - id + - modified_on + - value + - editable + type: object + cacheRulesAegisValue: + description: Value of the zone setting. + properties: + enabled: + description: Whether the feature is enabled or not. + type: boolean + x-auditable: true + pool_id: + description: >- + Egress pool id which refers to a grouping of dedicated egress IPs + through which Cloudflare will connect to origin. + example: pool-id + type: string + x-auditable: true + type: object + cacheRulesApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + items: + type: object + minLength: 1 + type: array + $ref: '#/components/schemas/cacheRulesMessages' + messages: + example: [] + items: + type: object + type: array + $ref: '#/components/schemas/cacheRulesMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + cacheRulesEditable: + description: Whether the setting is editable. + type: boolean + x-auditable: true + cacheRulesMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + cacheRulesModifiedOn: + description: The time when the setting was last modified. + format: date-time + type: string + x-auditable: true + cacheRulesOriginH2MaxStreams: + description: >- + Origin H2 Max Streams configures the max number of concurrent requests + that Cloudflare will send within the same connection when communicating + with the origin server, if the origin supports it. Note that if your + origin does not support H2 multiplexing, 5xx errors may be observed, + particularly 520s. Also note that the default value is `100` for all + plan types except Enterprise where it is `1`. `1` means that H2 + multiplexing is disabled. + title: Origin H2 Max Streams + type: object + properties: + id: + description: Value of the zone setting. + type: string + x-auditable: true + enum: + - origin_h2_max_streams + example: origin_h2_max_streams + modified_on: + description: Last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + $ref: '#/components/schemas/cacheRulesOriginH2MaxStreamsValue' + required: + - id + cacheRulesOriginH2MaxStreamsResponseValue: + properties: + errors: + $ref: '#/components/schemas/cacheRulesMessages' + messages: + $ref: '#/components/schemas/cacheRulesMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result: + $ref: '#/components/schemas/cacheRulesOriginH2MaxStreams' + required: + - success + - errors + - messages + type: object + cacheRulesOriginH2MaxStreamsValue: + description: Value of the Origin H2 Max Streams Setting. + example: 50 + maximum: 1000 + minimum: 1 + type: integer + x-auditable: true + cacheRulesOriginMaxHttpVersionValue: + description: Value of the Origin Max HTTP Version Setting. + enum: + - '2' + - '1' + type: string + x-auditable: true + cacheSchemasPatch: + description: Update enablement of Automatic SSL/TLS. + properties: + value: + $ref: '#/components/schemas/cacheSchemasValue' + required: + - value + type: object + cacheSchemasValue: + description: Controls enablement of Automatic SSL/TLS. + enum: + - auto + - custom + example: auto + type: string + dnsCustomNameserversGetResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + enabled: + description: Whether zone uses account-level custom nameservers. + example: true + type: boolean + x-auditable: true + ns_set: + default: 1 + description: The number of the name server set to assign to the zone. + example: 1 + maximum: 5 + minimum: 1 + type: number + x-auditable: true + required: + - success + - errors + - messages + dnsCustomNameserversMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + dnsCustomNameserversSchemasEmptyResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + messages: + $ref: '#/components/schemas/dnsCustomNameserversMessages' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + type: object + result: + items: + description: Unused + type: string + x-auditable: true + maxItems: 0 + type: array + required: + - success + - errors + - messages + dnsCustomNameserversZoneMetadata: + properties: + enabled: + description: Whether zone uses account-level custom nameservers. + example: true + type: boolean + x-auditable: true + ns_set: + default: 1 + description: The number of the name server set to assign to the zone. + example: 1 + maximum: 5 + minimum: 1 + type: number + x-auditable: true + type: object + kaminoEnvironment: + properties: + expression: + type: string + http_application_id: + nullable: true + type: string + locked_on_deployment: + nullable: true + type: boolean + name: + type: string + position: + $ref: '#/components/schemas/kaminoEnvironmentPosition' + ref: + type: string + version: + format: int64 + nullable: true + type: integer + required: + - name + - ref + - version + - expression + - locked_on_deployment + - position + type: object + kaminoEnvironmentPosition: + $ref: '#/components/schemas/unnamedSchemaRef34bb6e31800bc0207c083affa12d2775' + kaminoEnvironmentsRequest: + properties: + environments: + items: + $ref: '#/components/schemas/kaminoEnvironment' + type: array + required: + - environments + type: object + kaminoEnvironmentsResponse: + properties: + errors: + items: + $ref: '#/components/schemas/kaminoMessage' + type: array + messages: + items: + $ref: '#/components/schemas/kaminoMessage' + type: array + result: + $ref: '#/components/schemas/kaminoEnvironmentsResult' + success: + type: boolean + required: + - result + - success + - errors + - messages + type: object + kaminoEnvironmentsResult: + properties: + environments: + items: + $ref: '#/components/schemas/kaminoEnvironment' + type: array + required: + - environments + type: object + kaminoErrorResponse: + properties: + errors: + items: + $ref: '#/components/schemas/kaminoMessage' + type: array + messages: + items: + $ref: '#/components/schemas/kaminoMessage' + type: array + result: + nullable: true + type: object + success: + type: boolean + required: + - result + - success + - errors + - messages + type: object + kaminoMessage: + $ref: '#/components/schemas/responseInfo' + originMaxHttpVersion: + properties: + editable: + $ref: '#/components/schemas/cacheRulesEditable' + id: + description: The identifier of the caching setting. + type: string + x-auditable: true + enum: + - origin_max_http_version + modified_on: + $ref: '#/components/schemas/cacheRulesModifiedOn' + description: Last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: Value of the Origin Max HTTP Version Setting. + type: string + x-auditable: true + enum: + - '2' + - '1' + required: + - id + - value + - editable + - id + type: object + title: Origin Max HTTP Version + responseInfo: + properties: + code: + minimum: 1000 + type: integer + message: + type: string + documentation_url: + type: string + source: + type: object + properties: + pointer: + type: string + required: + - code + - message + type: object + uniqueItems: true + rumApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/rumSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/rumSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + rumEditable: + example: true + type: boolean + rumId: + example: rum + type: string + x-auditable: true + rumMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + rumRumSite: + properties: + editable: + $ref: '#/components/schemas/rumEditable' + id: + $ref: '#/components/schemas/rumId' + value: + $ref: '#/components/schemas/rumValue' + type: object + rumRumSiteResponseSingle: + properties: + errors: + $ref: '#/components/schemas/rumMessages' + messages: + $ref: '#/components/schemas/rumMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + $ref: '#/components/schemas/rumRumSite' + required: + - success + - errors + - messages + type: object + rumSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + rumToggleRumRequest: + properties: + value: + description: Value can either be On or Off. + example: 'on' + type: string + type: object + rumValue: + description: Current state of RUM. Returns On, Off, or Manual. + example: 'on' + type: string + x-auditable: true + smartshieldAddress: + description: The hostname or IP address of the origin server to run health checks on. + example: www.example.com + type: string + x-auditable: true + smartshieldApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/smartshieldMessages' + messages: + example: [] + $ref: '#/components/schemas/smartshieldMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + smartshieldCacheReserveClearEndTs: + description: The time that the latest Cache Reserve Clear operation completed. + example: '2023-10-02T12:00:00.12345Z' + format: date-time + type: string + x-auditable: true + smartshieldCacheReserveClearStartTs: + description: The time that the latest Cache Reserve Clear operation started. + example: '2023-10-02T10:00:00.12345Z' + format: date-time + type: string + x-auditable: true + smartshieldCacheReserveClearState: + description: The current state of the Cache Reserve Clear operation. + enum: + - In-progress + - Completed + example: In-progress + type: string + x-auditable: true + smartshieldCheckRegions: + description: >- + A list of regions from which to run health checks. Null means Cloudflare + will pick a default region. + example: + - WEU + - ENAM + items: + description: >- + WNAM: Western North America, ENAM: Eastern North America, WEU: Western + Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: + Southern South America, OC: Oceania, ME: Middle East, NAF: North + Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: + North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE + customers only). + enum: + - WNAM + - ENAM + - WEU + - EEU + - NSAM + - SSAM + - OC + - ME + - NAF + - SAF + - IN + - SEAS + - NEAS + - ALL_REGIONS + type: string + nullable: true + type: array + x-auditable: true + smartshieldConsecutiveFails: + default: 1 + description: >- + The number of consecutive fails required from a health check before + changing the health to unhealthy. + type: integer + x-auditable: true + smartshieldConsecutiveSuccesses: + default: 1 + description: >- + The number of consecutive successes required from a health check before + changing the health to healthy. + type: integer + x-auditable: true + smartshieldDescription: + description: A human-readable description of the health check. + example: Health check for www.example.com + type: string + x-auditable: true + smartshieldFailureReason: + description: The current failure reason if status is unhealthy. + example: '' + readOnly: true + type: string + x-auditable: true + smartshieldHealthchecks: + properties: + address: + $ref: '#/components/schemas/smartshieldAddress' + check_regions: + $ref: '#/components/schemas/smartshieldCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/smartshieldConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/smartshieldConsecutiveSuccesses' + created_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + description: + $ref: '#/components/schemas/smartshieldDescription' + failure_reason: + $ref: '#/components/schemas/smartshieldFailureReason' + http_config: + $ref: '#/components/schemas/smartshieldHttpConfig' + id: + $ref: '#/components/schemas/smartshieldIdentifier' + interval: + $ref: '#/components/schemas/smartshieldInterval' + modified_on: + $ref: '#/components/schemas/smartshieldTimestamp' + readOnly: true + name: + $ref: '#/components/schemas/smartshieldName' + retries: + $ref: '#/components/schemas/smartshieldRetries' + status: + $ref: '#/components/schemas/smartshieldStatus' + suspended: + $ref: '#/components/schemas/smartshieldSuspended' + tcp_config: + $ref: '#/components/schemas/smartshieldTcpConfig' + timeout: + $ref: '#/components/schemas/smartshieldTimeout' + type: + $ref: '#/components/schemas/smartshieldType' + type: object + smartshieldHttpConfig: + description: Parameters specific to an HTTP or HTTPS health check. + nullable: true + properties: + allow_insecure: + default: false + description: Do not validate the certificate when the health check uses HTTPS. + type: boolean + x-auditable: true + expected_body: + description: >- + A case-insensitive sub-string to look for in the response body. If + this string is not found, the origin will be marked as unhealthy. + example: success + type: string + x-auditable: true + expected_codes: + description: >- + The expected HTTP response codes (e.g. "200") or code ranges (e.g. + "2xx" for all codes starting with 2) of the health check. + example: + - 2xx + - '302' + items: + type: string + nullable: true + type: array + x-auditable: true + follow_redirects: + default: false + description: Follow redirects if the origin returns a 3xx status code. + type: boolean + x-auditable: true + header: + description: >- + The HTTP request headers to send in the health check. It is + recommended you set a Host header by default. The User-Agent header + cannot be overridden. + example: + Host: + - example.com + X-App-ID: + - abc123 + nullable: true + type: object + method: + default: GET + description: The HTTP method to use for the health check. + enum: + - GET + - HEAD + type: string + x-auditable: true + path: + default: / + description: The endpoint path to health check against. + example: /health + type: string + x-auditable: true + port: + default: 80 + description: >- + Port number to connect to for the health check. Defaults to 80 if + type is HTTP or 443 if type is HTTPS. + type: integer + x-auditable: true + type: object + smartshieldIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + x-auditable: true + smartshieldInterval: + default: 60 + description: >- + The interval between each health check. Shorter intervals may give + quicker notifications if the origin status changes, but will increase + load on the origin as we check from multiple locations. + type: integer + x-auditable: true + smartshieldMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + smartshieldName: + description: >- + A short name to identify the health check. Only alphanumeric characters, + hyphens and underscores are allowed. + example: server-1 + type: string + x-auditable: true + smartshieldQueryHealthcheck: + properties: + address: + $ref: '#/components/schemas/smartshieldAddress' + check_regions: + $ref: '#/components/schemas/smartshieldCheckRegions' + consecutive_fails: + $ref: '#/components/schemas/smartshieldConsecutiveFails' + consecutive_successes: + $ref: '#/components/schemas/smartshieldConsecutiveSuccesses' + description: + $ref: '#/components/schemas/smartshieldDescription' + http_config: + $ref: '#/components/schemas/smartshieldHttpConfig' + interval: + $ref: '#/components/schemas/smartshieldInterval' + name: + $ref: '#/components/schemas/smartshieldName' + retries: + $ref: '#/components/schemas/smartshieldRetries' + suspended: + $ref: '#/components/schemas/smartshieldSuspended' + tcp_config: + $ref: '#/components/schemas/smartshieldTcpConfig' + timeout: + $ref: '#/components/schemas/smartshieldTimeout' + type: + $ref: '#/components/schemas/smartshieldType' + required: + - name + - address + type: object + smartshieldResponseCollection: + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + items: + $ref: '#/components/schemas/smartshieldHealthchecks' + nullable: true + type: array + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + result_info: + $ref: '#/components/schemas/smartshieldResultInfo' + required: + - success + - errors + - messages + - result + smartshieldResultInfo: + properties: + count: + description: Total number of results for the requested service + example: 1 + type: number + page: + description: Current page within paginated list of results + example: 1 + type: number + per_page: + description: Number of results per page of results + example: 20 + type: number + total_count: + description: Total results available without any search parameters + example: 2000 + type: number + type: object + smartshieldRetries: + default: 2 + description: >- + The number of retries to attempt in case of a timeout before marking the + origin as unhealthy. Retries are attempted immediately. + type: integer + x-auditable: true + smartshieldSingleHcIdResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + properties: + id: + $ref: '#/components/schemas/smartshieldIdentifier' + type: object + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + smartshieldSingleHcResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/smartshieldMessages' + messages: + $ref: '#/components/schemas/smartshieldMessages' + result: + $ref: '#/components/schemas/smartshieldHealthchecks' + success: + description: Whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + smartshieldSmartShieldSettingsGetResponse: + description: >- + A consolidated object containing settings from multiple APIs for partial + updates. + required: + - smart_tiered_cache + - smart_routing + - regional_tiered_cache + - cache_reserve + - healthchecks_count + type: object + properties: + cache_reserve: + properties: + editable: + description: Whether the setting is editable. + example: true + type: boolean + id: + description: The id of the Cache Reserve setting. + example: cache_reserve + type: string + value: + description: Specifies the enablement value of Cache Reserve. + enum: + - 'on' + - 'off' + example: 'off' + type: string + type: object + regional_tiered_cache: + properties: + editable: + description: Whether the setting is editable. + example: true + type: boolean + id: + description: The id of the Regional Tiered Cache setting. + example: regional_tiered_cache + type: string + value: + description: Specifies the enablement value of Cache Reserve. + enum: + - 'on' + - 'off' + example: 'off' + type: string + type: object + smart_routing: + properties: + editable: + description: Whether the setting is editable. + example: true + type: boolean + id: + description: The id of the Smart Routing setting. + example: smart_routing + type: string + value: + description: Specifies the enablement value of Argo Smart Routing. + enum: + - 'on' + - 'off' + example: 'off' + type: string + type: object + smart_tiered_cache: + properties: + editable: + description: Whether the setting is editable. + example: true + type: boolean + id: + description: The id of the Smart Tiered Cache setting. + example: smart_tiered_cache + type: string + modified_on: + description: The last time the setting was modified. + example: '2025-09-10T22:53:22.946098Z' + type: string + readOnly: true + value: + description: Specifies the enablement value of Tiered Cache. + enum: + - 'on' + - 'off' + example: 'on' + type: string + type: object + healthchecks_count: + description: The total number of health checks associated with the zone. + example: 5 + type: integer + smartshieldSmartShieldSettingsPatchBody: + description: The patch body for Smart Shield. + example: + smart_tiered_cache: + value: 'on' + properties: + cache_reserve: + properties: + value: + description: Specifies the enablement value of Cache Reserve. + enum: + - 'on' + - 'off' + example: 'on' + type: string + type: object + regional_tiered_cache: + properties: + value: + description: Specifies the enablement value of Regional Tiered Cache. + enum: + - 'on' + - 'off' + example: 'on' + type: string + type: object + smart_routing: + properties: + value: + description: Specifies the enablement value of Smart Routing. + enum: + - 'on' + - 'off' + example: 'on' + type: string + type: object + smart_tiered_cache: + properties: + value: + description: Specifies the enablement value of Smart Tiered Cache. + enum: + - 'on' + - 'off' + example: 'on' + type: string + type: object + type: object + smartshieldSmartShieldSettingsPatchResponse: + description: >- + A consolidated object containing settings from multiple APIs for partial + updates. + properties: + smart_tiered_cache: + properties: + editable: + description: Whether the setting is editable. + example: true + type: boolean + id: + description: The id of the Smart Tiered Cache setting. + example: smart_tiered_cache + type: string + modified_on: + description: The last time the setting was modified. + example: '2025-09-10T22:53:22.946098Z' + type: string + readOnly: true + value: + description: Specifies the enablement value of Tiered Cache. + enum: + - 'on' + - 'off' + example: 'on' + type: string + type: object + required: + - smart_tiered_cache + - smart_routing + - regional_tiered_cache + - cache_reserve + type: object + smartshieldStatus: + description: The current status of the origin server according to the health check. + enum: + - unknown + - healthy + - unhealthy + - suspended + example: healthy + readOnly: true + type: string + x-auditable: true + smartshieldSuspended: + default: false + description: If suspended, no health checks are sent to the origin. + type: boolean + x-auditable: true + smartshieldTcpConfig: + description: Parameters specific to TCP health check. + nullable: true + properties: + method: + default: connection_established + description: The TCP connection method to use for the health check. + enum: + - connection_established + type: string + x-auditable: true + port: + default: 80 + description: Port number to connect to for the health check. Defaults to 80. + type: integer + x-auditable: true + type: object + smartshieldTimeout: + default: 5 + description: The timeout (in seconds) before marking the health check as failed. + type: integer + x-auditable: true + smartshieldTimestamp: + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + x-auditable: true + smartshieldType: + default: HTTP + description: >- + The protocol to use for the health check. Currently supported protocols + are 'HTTP', 'HTTPS' and 'TCP'. + example: HTTPS + type: string + x-auditable: true + speedApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/speedMessages' + messages: + example: [] + $ref: '#/components/schemas/speedMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful. + example: false + type: boolean + x-auditable: true + required: + - success + - errors + - messages + - result + type: object + speedCloudflareFonts: + description: >- + Enhance your website's font delivery with Cloudflare Fonts. Deliver + Google Hosted fonts from your own domain, boost performance, and enhance + user privacy. Refer to the Cloudflare Fonts documentation for more + information. + title: Cloudflare Fonts + properties: + editable: + default: true + description: >- + Whether or not this setting can be modified for this zone (based on + your Cloudflare plan level). + enum: + - true + - false + readOnly: true + type: boolean + x-auditable: true + id: + description: ID of the zone setting. + example: fonts + type: string + x-auditable: true + enum: + - fonts + modified_on: + description: last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: Current value of the zone setting. + enum: + - 'on' + - 'off' + example: 'on' + type: string + x-auditable: true + type: object + speedCloudflareFontsValue: + default: 'off' + description: Whether the feature is enabled or disabled. + enum: + - 'on' + - 'off' + type: string + x-auditable: true + speedCloudflareSpeedBrainResponse: + title: Cloudflare Speed Brain response + properties: + editable: + default: true + description: >- + Whether or not this setting can be modified for this zone (based on + your Cloudflare plan level). + enum: + - true + - false + readOnly: true + type: boolean + x-auditable: true + id: + description: Identifier of the zone setting. + example: development_mode + type: string + x-auditable: true + modified_on: + description: last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + x-auditable: true + value: + description: >- + Whether the feature is enabled or disabled. Defaults to "on" for + Free plans, otherwise defaults to "off". + enum: + - 'on' + - 'off' + example: 'on' + type: string + x-auditable: true + type: object + speedMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + unnamedSchemaRef2b5e755404a4bfd7892291ce97c4968d: + description: ID of the zone setting. + type: string + x-auditable: true + enum: + - cache_reserve_clear + example: cache_reserve_clear + unnamedSchemaRef34bb6e31800bc0207c083affa12d2775: + properties: + after: + example: yyy + type: string + x-auditable: true + before: + example: xxx + type: string + x-auditable: true + type: object + unnamedSchemaRef619309774d07ec6904f1e354560d6028: + items: + description: Unused + type: string + x-auditable: true + maxItems: 0 + type: array + enum: + - null + wafProductApiBundleCustomTopic: + properties: + label: + description: >- + Unique label identifier. Must contain only lowercase letters (a–z), + digits (0–9), and hyphens. + example: credit-cards + maxLength: 20 + minLength: 2 + type: string + topic: + description: >- + Description of the topic category. Must contain only printable ASCII + characters. + example: credit card numbers + maxLength: 50 + minLength: 2 + type: string + required: + - label + - topic + type: object + wafProductApiBundleCustomTopics: + properties: + topics: + description: Custom topic categories for Firewall for AI content detection. + items: + $ref: '#/components/schemas/wafProductApiBundleCustomTopic' + maxItems: 20 + type: array + type: object + wafProductApiBundleMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + wafProductApiBundleResponseCustomTopics: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + $ref: '#/components/schemas/wafProductApiBundleCustomTopics' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + wafProductApiBundleResponseSettings: + type: object + properties: + errors: + $ref: '#/components/schemas/wafProductApiBundleMessages' + messages: + $ref: '#/components/schemas/wafProductApiBundleMessages' + result: + $ref: '#/components/schemas/wafProductApiBundleSettings' + success: + description: Defines whether the API call was successful. + enum: + - true + example: true + type: boolean + required: + - success + - errors + - messages + - result + wafProductApiBundleSettings: + description: Firewall for AI enablement status for a zone. + properties: + enabled: + description: Whether Firewall for AI is enabled on the zone. + example: true + type: boolean + type: object + zoneActivationApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/zoneActivationMessages' + messages: + example: [] + $ref: '#/components/schemas/zoneActivationMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + zoneActivationIdentifier: + description: Identifier. + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + x-auditable: true + zoneActivationMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + zoneAnalyticsApiBandwidth: + description: Breakdown of totals for bandwidth in the form of bytes. + properties: + all: + description: The total number of bytes served within the time frame. + type: integer + cached: + description: The number of bytes that were cached (and served) by Cloudflare. + type: integer + content_type: + description: >- + A variable list of key/value pairs where the key represents the type + of content served, and the value is the number in bytes served. + example: + css: 237421 + gif: 1234242 + html: 1231290 + javascript: 123245 + jpeg: 784278 + type: object + country: + description: >- + A variable list of key/value pairs where the key is a two-digit + country code and the value is the number of bytes served to that + country. + example: + AG: 2342483 + GI: 984753 + US: 123145433 + type: object + ssl: + description: A break down of bytes served over HTTPS. + properties: + encrypted: + description: The number of bytes served over HTTPS. + type: integer + unencrypted: + description: The number of bytes served over HTTP. + type: integer + type: object + ssl_protocols: + description: A breakdown of requests by their SSL protocol. + properties: + TLSv1: + description: The number of requests served over TLS v1.0. + type: integer + TLSv1.1: + description: The number of requests served over TLS v1.1. + type: integer + TLSv1.2: + description: The number of requests served over TLS v1.2. + type: integer + TLSv1.3: + description: The number of requests served over TLS v1.3. + type: integer + none: + description: The number of requests served over HTTP. + type: integer + type: object + uncached: + description: >- + The number of bytes that were fetched and served from the origin + server. + type: integer + type: object + zoneAnalyticsApiBandwidthByColo: + description: Breakdown of totals for bandwidth in the form of bytes. + properties: + all: + description: The total number of bytes served within the time frame. + type: integer + cached: + description: The number of bytes that were cached (and served) by Cloudflare. + type: integer + uncached: + description: >- + The number of bytes that were fetched and served from the origin + server. + type: integer + type: object + zoneAnalyticsApiColoResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + messages: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + result: + $ref: '#/components/schemas/zoneAnalyticsApiDatacenters' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + query: + $ref: '#/components/schemas/zoneAnalyticsApiQueryResponse' + required: + - success + - errors + - messages + - result + zoneAnalyticsApiDashboard: + description: Totals and timeseries data. + properties: + timeseries: + $ref: '#/components/schemas/zoneAnalyticsApiTimeseries' + totals: + $ref: '#/components/schemas/zoneAnalyticsApiTotals' + title: Dashboard response + type: object + zoneAnalyticsApiDashboardResponse: + type: object + properties: + errors: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + messages: + $ref: '#/components/schemas/zoneAnalyticsApiMessages' + result: + $ref: '#/components/schemas/zoneAnalyticsApiDashboard' + success: + description: Whether the API call was successful + enum: + - true + example: true + type: boolean + query: + $ref: '#/components/schemas/zoneAnalyticsApiQueryResponse' + required: + - success + - errors + - messages + - result + zoneAnalyticsApiDatacenters: + description: >- + A breakdown of all dashboard analytics data by co-locations. This is + limited to Enterprise zones only. + items: + properties: + colo_id: + description: The airport code identifer for the co-location. + example: SFO + type: string + timeseries: + $ref: '#/components/schemas/zoneAnalyticsApiTimeseriesByColo' + totals: + $ref: '#/components/schemas/zoneAnalyticsApiTotalsByColo' + type: object + title: Analytics data by datacenter + type: array + zoneAnalyticsApiIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + readOnly: true + type: string + zoneAnalyticsApiMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + zoneAnalyticsApiPageviews: + description: Breakdown of totals for pageviews. + properties: + all: + description: The total number of pageviews served within the time range. + type: integer + search_engine: + description: >- + A variable list of key/value pairs representing the search engine + and number of hits. + example: + baidubot: 1345 + bingbot: 5372 + googlebot: 35272 + pingdom: 13435 + type: object + type: object + zoneAnalyticsApiQueryResponse: + description: >- + The exact parameters/timestamps the analytics service used to return + data. + properties: + since: + $ref: '#/components/schemas/zoneAnalyticsApiSince' + time_delta: + description: >- + The amount of time (in minutes) that each data point in the + timeseries represents. The granularity of the time-series returned + (e.g. each bucket in the time series representing 1-minute vs 1-day) + is calculated by the API based on the time-range provided to the + API. + type: integer + until: + $ref: '#/components/schemas/zoneAnalyticsApiUntil' + readOnly: true + type: object + zoneAnalyticsApiRequests: + description: Breakdown of totals for requests. + properties: + all: + description: Total number of requests served. + type: integer + cached: + description: Total number of cached requests served. + type: integer + content_type: + description: >- + A variable list of key/value pairs where the key represents the type + of content served, and the value is the number of requests. + example: + css: 15343 + gif: 23178 + html: 1234213 + javascript: 318236 + jpeg: 1982048 + type: object + country: + description: >- + A variable list of key/value pairs where the key is a two-digit + country code and the value is the number of requests served to that + country. + example: + AG: 37298 + GI: 293846 + US: 4181364 + type: object + http_status: + description: >- + Key/value pairs where the key is a HTTP status code and the value is + the number of requests served with that code. + example: + '200': 13496983 + '301': 283 + '400': 187936 + '402': 1828 + '404': 1293 + type: object + ssl: + description: A break down of requests served over HTTPS. + properties: + encrypted: + description: The number of requests served over HTTPS. + type: integer + unencrypted: + description: The number of requests served over HTTP. + type: integer + type: object + ssl_protocols: + description: A breakdown of requests by their SSL protocol. + properties: + TLSv1: + description: The number of requests served over TLS v1.0. + type: integer + TLSv1.1: + description: The number of requests served over TLS v1.1. + type: integer + TLSv1.2: + description: The number of requests served over TLS v1.2. + type: integer + TLSv1.3: + description: The number of requests served over TLS v1.3. + type: integer + none: + description: The number of requests served over HTTP. + type: integer + type: object + uncached: + description: Total number of requests served from the origin. + type: integer + type: object + zoneAnalyticsApiRequestsByColo: + description: Breakdown of totals for requests. + properties: + all: + description: Total number of requests served. + type: integer + cached: + description: Total number of cached requests served. + type: integer + country: + description: >- + Key/value pairs where the key is a two-digit country code and the + value is the number of requests served to that country. + example: + AG: 37298 + GI: 293846 + US: 4181364 + type: object + http_status: + description: >- + A variable list of key/value pairs where the key is a HTTP status + code and the value is the number of requests with that code served. + example: + '200': 13496983 + '301': 283 + '400': 187936 + '402': 1828 + '404': 1293 + type: object + uncached: + description: Total number of requests served from the origin. + type: integer + type: object + zoneAnalyticsApiSince: + default: -10080 + description: >- + The (inclusive) beginning of the requested time frame. This value can be + a negative integer representing the number of minutes in the past + relative to time the request is made, or can be an absolute timestamp + that conforms to RFC 3339. At this point in time, it cannot exceed a + time in the past greater than one year. Ranges that the Cloudflare web + application provides will provide the following period length for each + point: - Last 60 minutes (from -59 to -1): 1 minute resolution - Last 7 + hours (from -419 to -60): 15 minutes resolution - Last 15 hours (from + -899 to -420): 30 minutes resolution - Last 72 hours (from -4320 to + -900): 1 hour resolution - Older than 3 days (-525600 to -4320): 1 day + resolution. + example: '2015-01-01T12:23:00Z' + type: string + zoneAnalyticsApiThreats: + description: Breakdown of totals for threats. + properties: + all: + description: >- + The total number of identifiable threats received over the time + frame. + type: integer + country: + description: >- + A list of key/value pairs where the key is a two-digit country code + and the value is the number of malicious requests received from that + country. + example: + AU: 91 + CN: 523423 + US: 123 + type: object + type: + description: >- + The list of key/value pairs where the key is a threat category and + the value is the number of requests. + example: + hot.ban.unknown: 5324 + macro.chl.captchaErr: 1341 + macro.chl.jschlErr: 5323 + user.ban.ip: 123 + type: object + type: object + zoneAnalyticsApiTimeseries: + description: >- + Time deltas containing metadata about each bucket of time. The number of + buckets (resolution) is determined by the amount of time between the + since and until parameters. + items: + properties: + bandwidth: + $ref: '#/components/schemas/zoneAnalyticsApiBandwidth' + pageviews: + $ref: '#/components/schemas/zoneAnalyticsApiPageviews' + requests: + $ref: '#/components/schemas/zoneAnalyticsApiRequests' + since: + $ref: '#/components/schemas/zoneAnalyticsApiSince' + threats: + $ref: '#/components/schemas/zoneAnalyticsApiThreats' + uniques: + $ref: '#/components/schemas/zoneAnalyticsApiUniques' + until: + $ref: '#/components/schemas/zoneAnalyticsApiUntil' + type: object + type: array + zoneAnalyticsApiTimeseriesByColo: + description: >- + Time deltas containing metadata about each bucket of time. The number of + buckets (resolution) is determined by the amount of time between the + since and until parameters. + items: + properties: + bandwidth: + $ref: '#/components/schemas/zoneAnalyticsApiBandwidthByColo' + requests: + $ref: '#/components/schemas/zoneAnalyticsApiRequestsByColo' + since: + $ref: '#/components/schemas/zoneAnalyticsApiSince' + threats: + $ref: '#/components/schemas/zoneAnalyticsApiThreats' + until: + $ref: '#/components/schemas/zoneAnalyticsApiUntil' + type: object + type: array + zoneAnalyticsApiTotals: + description: Breakdown of totals by data type. + properties: + bandwidth: + $ref: '#/components/schemas/zoneAnalyticsApiBandwidth' + pageviews: + $ref: '#/components/schemas/zoneAnalyticsApiPageviews' + requests: + $ref: '#/components/schemas/zoneAnalyticsApiRequests' + since: + $ref: '#/components/schemas/zoneAnalyticsApiSince' + threats: + $ref: '#/components/schemas/zoneAnalyticsApiThreats' + uniques: + $ref: '#/components/schemas/zoneAnalyticsApiUniques' + until: + $ref: '#/components/schemas/zoneAnalyticsApiUntil' + type: object + zoneAnalyticsApiTotalsByColo: + description: Breakdown of totals by data type. + properties: + bandwidth: + $ref: '#/components/schemas/zoneAnalyticsApiBandwidthByColo' + requests: + $ref: '#/components/schemas/zoneAnalyticsApiRequestsByColo' + since: + $ref: '#/components/schemas/zoneAnalyticsApiSince' + threats: + $ref: '#/components/schemas/zoneAnalyticsApiThreats' + until: + $ref: '#/components/schemas/zoneAnalyticsApiUntil' + type: object + zoneAnalyticsApiUniques: + properties: + all: + description: Total number of unique IP addresses within the time range. + type: integer + type: object + zoneAnalyticsApiUntil: + default: 0 + description: >- + The (exclusive) end of the requested time frame. This value can be a + negative integer representing the number of minutes in the past relative + to time the request is made, or can be an absolute timestamp that + conforms to RFC 3339. If omitted, the time of the request is used. + example: '2015-01-02T12:23:00Z' + type: string + zoneHold: + properties: + hold: + example: true + type: boolean + hold_after: + example: '2023-01-31T15:56:36+00:00' + type: string + include_subdomains: + type: string + type: object + zones0rttValue: + default: 'off' + description: Value of the 0-RTT setting. + enum: + - 'on' + - 'off' + type: string + zonesApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/zonesMessages' + messages: + example: [] + $ref: '#/components/schemas/zonesMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful. + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + zonesApiResponseSingleId: + type: object + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful. + example: true + type: boolean + result: + nullable: true + properties: + id: + $ref: '#/components/schemas/zonesIdentifier' + required: + - id + type: object + required: + - success + - errors + - messages + zonesComponentsSchemasApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/zonesMessages' + messages: + example: [] + $ref: '#/components/schemas/zonesMessages' + result: + nullable: true + type: object + success: + description: Whether the API call was successful + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + zonesIdentifier: + description: Identifier + example: 023e105f4ecef8ad9ca31a8372d0c353 + maxLength: 32 + type: string + zonesMessages: + example: [] + items: + $ref: '#/components/schemas/responseInfo' + type: array + zonesMultipleSettings: + items: + type: object + title: 0-RTT Value + description: 0-RTT session resumption enabled for this zone. + properties: + editable: + default: true + description: >- + Whether or not this setting can be modified for this zone (based + on your Cloudflare plan level). + enum: + - true + - false + readOnly: true + type: boolean + id: + description: ID of the zone setting. + example: 0rtt + type: string + enum: + - 0rtt + modified_on: + description: last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + value: + description: Current value of the zone setting. + example: 'on' + $ref: '#/components/schemas/zones0rttValue' + time_remaining: + description: >- + Value of the zone setting. Notes: The interval (in seconds) from + when development mode expires (positive integer) or last expired + (negative integer) for the domain. If development mode has never + been enabled, this value is false. + example: 3600 + readOnly: true + type: number + enabled: + $ref: '#/components/schemas/zonesSslRecommenderEnabled' + required: + - id + type: array + zonesName: + description: >- + The domain name. Per [RFC + 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) the + overall zone name can be up to 253 characters, with each segment + ("label") not exceeding 63 characters. + example: example.com + maxLength: 253 + type: string + zonesPaused: + default: false + description: >- + Indicates whether the zone is only using Cloudflare DNS services. A true + value means the zone will not receive security or performance benefits. + type: boolean + zonesResultInfo: + properties: + count: + description: Total number of results for the requested service. + example: 1 + type: number + page: + description: Current page within paginated list of results. + example: 1 + type: number + per_page: + description: Number of results per page of results. + example: 20 + type: number + total_count: + description: Total results available without any search parameters. + example: 2000 + type: number + total_pages: + description: Total number of pages + example: 100 + type: number + type: object + zonesSchemasApiResponseCommonFailure: + properties: + errors: + example: + - code: 7003 + message: No route for the URI + minLength: 1 + $ref: '#/components/schemas/zonesSchemasMessages' + messages: + example: [] + $ref: '#/components/schemas/zonesSchemasMessages' + result: + enum: + - null + nullable: true + type: object + success: + description: Whether the API call was successful. + enum: + - false + example: false + type: boolean + required: + - success + - errors + - messages + - result + type: object + zonesSchemasMessages: + example: [] + items: + properties: + code: + minimum: 1000 + type: integer + documentation_url: + type: string + message: + type: string + source: + properties: + pointer: + type: string + type: object + required: + - code + - message + type: object + uniqueItems: true + type: array + zonesSetting: + type: object + title: 0-RTT Value + description: 0-RTT session resumption enabled for this zone. + properties: + editable: + default: true + description: >- + Whether or not this setting can be modified for this zone (based on + your Cloudflare plan level). + enum: + - true + - false + readOnly: true + type: boolean + id: + description: ID of the zone setting. + example: 0rtt + type: string + enum: + - 0rtt + modified_on: + description: last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + value: + description: Current value of the zone setting. + example: 'on' + $ref: '#/components/schemas/zones0rttValue' + time_remaining: + description: >- + Value of the zone setting. Notes: The interval (in seconds) from + when development mode expires (positive integer) or last expired + (negative integer) for the domain. If development mode has never + been enabled, this value is false. + example: 3600 + readOnly: true + type: number + enabled: + $ref: '#/components/schemas/zonesSslRecommenderEnabled' + required: + - id + zonesSettingName: + description: Setting name + example: always_online + type: string + zonesSettingValue: + type: string + description: Value of the 0-RTT setting. + default: 'off' + enum: + - 'on' + - 'off' + properties: + enabled: + description: Whether the feature is enabled or not. + type: boolean + x-auditable: true + pool_id: + description: >- + Egress pool id which refers to a grouping of dedicated egress IPs + through which Cloudflare will connect to origin. + example: pool-id + type: string + x-auditable: true + cache_by_device_type: + description: >- + Indicates whether or not [cache by device + type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) + is enabled. + example: false + type: boolean + cf: + default: false + description: Indicates whether or not Cloudflare proxy is enabled. + example: true + type: boolean + hostnames: + description: >- + An array of hostnames where Automatic Platform Optimization for + WordPress is activated. + example: + - www.example.com + - example.com + - shop.example.com + items: + format: hostname + type: string + type: array + wordpress: + default: false + description: Indicates whether or not site is powered by WordPress. + example: true + type: boolean + wp_plugin: + default: false + description: >- + Indicates whether or not [Cloudflare for WordPress + plugin](https://wordpress.org/plugins/cloudflare/) is installed. + example: true + type: boolean + strict_transport_security: + description: Strict Transport Security. + properties: + enabled: + description: Whether or not strict transport security is enabled. + example: true + type: boolean + include_subdomains: + description: Include all subdomains for strict transport security. + example: true + type: boolean + max_age: + description: Max age in seconds of the strict transport security. + example: 86400 + type: number + nosniff: + description: >- + Whether or not to include 'X-Content-Type-Options: nosniff' + header. + example: true + type: boolean + preload: + description: Enable automatic preload of the HSTS configuration. + example: true + type: boolean + type: object + example: + - ECDHE-RSA-AES128-GCM-SHA256 + - AES128-SHA + items: + type: string + required: + - cache_by_device_type + - wp_plugin + - wordpress + - hostnames + - enabled + - cf + zonesSslRecommenderEnabled: + default: false + description: ssl-recommender enrollment setting. + type: boolean + zonesType: + default: full + description: >- + A full zone implies that DNS is hosted with Cloudflare. A partial zone + is typically a partner-hosted zone or a CNAME setup. + enum: + - full + - partial + - secondary + - internal + example: full + type: string + zonesVanityNameServers: + default: [] + description: >- + An array of domains used for custom name servers. This is only available + for Business and Enterprise plans. + example: + - ns1.example.com + - ns2.example.com + items: + format: hostname + maxLength: 253 + type: string + type: array + zonesZone: + properties: + account: + description: The account the zone belongs to. + properties: + id: + $ref: '#/components/schemas/zonesIdentifier' + name: + description: The name of the account. + example: Example Account Name + type: string + type: object + activated_on: + description: >- + The last time proof of ownership was detected and the zone was made + active. + example: '2014-01-02T00:01:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + cname_suffix: + description: >- + Allows the customer to use a custom apex. *Tenants Only + Configuration*. + example: cdn.cloudflare.com + type: string + created_on: + description: When the zone was created. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + development_mode: + description: >- + The interval (in seconds) from when development mode expires + (positive integer) or last expired (negative integer) for the + domain. If development mode has never been enabled, this value is 0. + example: 7200 + readOnly: true + type: number + id: + $ref: '#/components/schemas/zonesIdentifier' + meta: + description: Metadata about the zone. + properties: + cdn_only: + description: The zone is only configured for CDN. + example: true + type: boolean + custom_certificate_quota: + description: Number of Custom Certificates the zone can have. + example: 1 + type: integer + dns_only: + description: The zone is only configured for DNS. + example: true + type: boolean + foundation_dns: + description: The zone is setup with Foundation DNS. + example: true + type: boolean + page_rule_quota: + description: Number of Page Rules a zone can have. + example: 100 + type: integer + phishing_detected: + description: The zone has been flagged for phishing. + example: false + type: boolean + step: + example: 2 + type: integer + type: object + modified_on: + description: When the zone was last modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + readOnly: true + type: string + name: + description: >- + The domain name. Per [RFC + 1035](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4) + the overall zone name can be up to 253 characters, with each segment + ("label") not exceeding 63 characters. + example: example.com + maxLength: 253 + type: string + name_servers: + description: The name servers Cloudflare assigns to a zone. + example: + - bob.ns.cloudflare.com + - lola.ns.cloudflare.com + items: + format: hostname + type: string + readOnly: true + type: array + original_dnshost: + description: DNS host at the time of switching to Cloudflare. + example: NameCheap + maxLength: 50 + nullable: true + readOnly: true + type: string + original_name_servers: + description: Original name servers before moving to Cloudflare. + example: + - ns1.originaldnshost.com + - ns2.originaldnshost.com + items: + format: hostname + type: string + nullable: true + readOnly: true + type: array + original_registrar: + description: Registrar for the domain at the time of switching to Cloudflare. + example: GoDaddy + nullable: true + readOnly: true + type: string + owner: + description: The owner of the zone. + properties: + id: + $ref: '#/components/schemas/zonesIdentifier' + name: + description: Name of the owner. + example: Example Org + type: string + type: + description: The type of owner. + example: organization + type: string + type: object + paused: + $ref: '#/components/schemas/zonesPaused' + permissions: + deprecated: true + description: Legacy permissions based on legacy user membership information. + items: + example: '#worker:read' + type: string + type: array + x-stainless-deprecation-message: This has been replaced by Account memberships. + plan: + deprecated: true + description: A Zones subscription information. + properties: + can_subscribe: + description: States if the subscription can be activated. + example: false + type: boolean + currency: + description: The denomination of the customer. + example: USD + type: string + externally_managed: + description: If this Zone is managed by another company. + example: false + type: boolean + frequency: + description: How often the customer is billed. + example: monthly + type: string + id: + $ref: '#/components/schemas/zonesIdentifier' + is_subscribed: + description: States if the subscription active. + example: false + type: boolean + legacy_discount: + description: If the legacy discount applies to this Zone. + example: false + type: boolean + legacy_id: + description: The legacy name of the plan. + example: free + type: string + name: + description: Name of the owner. + example: Example Org + type: string + price: + description: How much the customer is paying. + example: 10.99 + type: number + x-stainless-deprecation-message: >- + Please use the `/zones/{zone_id}/subscription` API + + to update a zone's plan. Changing this value will create/cancel + + associated subscriptions. To view available plans for this zone, + + see [Zone + Plans](https://developers.cloudflare.com/api/resources/zones/subresources/plans/). + type: object + status: + description: The zone status on Cloudflare. + enum: + - initializing + - pending + - active + - moved + example: active + readOnly: true + type: string + tenant: + description: >- + The root organizational unit that this zone belongs to (such as a + tenant or organization). + properties: + id: + $ref: '#/components/schemas/zonesIdentifier' + name: + description: The name of the Tenant account. + example: Example Account Name + type: string + type: object + tenant_unit: + description: >- + The immediate parent organizational unit that this zone belongs to + (such as under a tenant or sub-organization). + properties: + id: + $ref: '#/components/schemas/zonesIdentifier' + type: object + type: + $ref: '#/components/schemas/zonesType' + vanity_name_servers: + default: [] + description: >- + An array of domains used for custom name servers. This is only + available for Business and Enterprise plans. + example: + - ns1.example.com + - ns2.example.com + items: + format: hostname + maxLength: 253 + type: string + type: array + verification_key: + description: Verification key for partial zone setup. + example: 284344499-1084221259 + readOnly: true + type: string + required: + - id + - name + - development_mode + - owner + - account + - meta + - name_servers + - original_name_servers + - original_registrar + - original_dnshost + - created_on + - modified_on + - activated_on + - plan + type: object + zonesZoneSettingsResponseCollection: + properties: + errors: + $ref: '#/components/schemas/zonesMessages' + messages: + $ref: '#/components/schemas/zonesMessages' + success: + description: Whether the API call was successful + example: true + type: boolean + result: + items: + $ref: >- + #/components/schemas/zonesZoneSettingsResponseCollection_result_item + type: array + required: + - success + - errors + - messages + type: object + zonesZoneSettingsResponseCollection_result_item: + type: object + title: 0-RTT Value + description: 0-RTT session resumption enabled for this zone. + properties: + editable: + default: true + description: >- + Whether or not this setting can be modified for this zone (based on + your Cloudflare plan level). + enum: + - true + - false + readOnly: true + type: boolean + id: + description: ID of the zone setting. + example: 0rtt + type: string + enum: + - 0rtt + modified_on: + description: last time this setting was modified. + example: '2014-01-01T05:20:00.12345Z' + format: date-time + nullable: true + readOnly: true + type: string + value: + description: Current value of the zone setting. + example: 'on' + $ref: '#/components/schemas/zones0rttValue' + time_remaining: + description: >- + Value of the zone setting. Notes: The interval (in seconds) from + when development mode expires (positive integer) or last expired + (negative integer) for the domain. If development mode has never + been enabled, this value is false. + example: 3600 + readOnly: true + type: number + enabled: + $ref: '#/components/schemas/zonesSslRecommenderEnabled' + required: + - id + zonesZoneSettingsSingleRequest: + type: object + properties: + enabled: + $ref: '#/components/schemas/zonesSslRecommenderEnabled' + value: + $ref: '#/components/schemas/zonesSettingValue' + securitySchemes: + api_email: + in: header + name: X-Auth-Email + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API, used in conjunction with a Global API key. + api_key: + in: header + name: X-Auth-Key + type: apiKey + description: >- + The previous authorization scheme for interacting with the Cloudflare + API. When possible, use API tokens instead of Global API keys. + api_token: + scheme: bearer + type: http + description: >- + The preferred authorization scheme for interacting with the Cloudflare + API. [Create a + token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). + user_service_key: + in: header + name: X-Auth-User-Service-Key + type: apiKey + description: >- + Used when interacting with the Origin CA certificates API. [View/change + your + key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys). + x-stackQL-resources: + zones: + id: cloudflare.zones.zones + name: zones + title: Zones + methods: + list: + operation: + $ref: '#/paths/~1zones/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + trigger_activation_check: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1activation_check/put' + response: + mediaType: application/json + openAPIDocKey: '200' + update_custom_ns: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_ns/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zones/methods/get' + - $ref: '#/components/x-stackQL-resources/zones/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/zones/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/zones/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/zones/methods/delete' + replace: [] + analytics_colos: + id: cloudflare.zones.analytics_colos + name: analytics_colos + title: Analytics Colos + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1colos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/analytics_colos/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + dashboard: + id: cloudflare.zones.dashboard + name: dashboard + title: Dashboard + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_identifier}~1analytics~1dashboard/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + latency: + id: cloudflare.zones.latency + name: latency + title: Latency + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1analytics~1latency/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/latency/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + latency_colos: + id: cloudflare.zones.latency_colos + name: latency_colos + title: Latency Colos + methods: + list_by_zone: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1analytics~1latency~1colos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/latency_colos/methods/list_by_zone + insert: [] + update: [] + delete: [] + replace: [] + plans: + id: cloudflare.zones.plans + name: plans + title: Plans + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1available_plans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1available_plans~1{plan_identifier}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/plans/methods/get' + - $ref: '#/components/x-stackQL-resources/plans/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + rate_plans: + id: cloudflare.zones.rate_plans + name: rate_plans + title: Rate Plans + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1available_rate_plans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rate_plans/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + custom_nameservers: + id: cloudflare.zones.custom_nameservers + name: custom_nameservers + title: Custom Nameservers + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1custom_ns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_nameservers/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + environments: + id: cloudflare.zones.environments + name: environments + title: Environments + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1environments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.environments + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1environments/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1environments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1environments/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1environments~1{environment_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + rollback: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1environments~1{environment_id}~1rollback/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/environments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete' + replace: + - $ref: '#/components/x-stackQL-resources/environments/methods/update' + custom_topics: + id: cloudflare.zones.custom_topics + name: custom_topics + title: Custom Topics + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall-for-ai~1custom-topics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result.topics + firewall_for_ai_custom_topics_put: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall-for-ai~1custom-topics/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_topics/methods/list' + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/custom_topics/methods/firewall_for_ai_custom_topics_put + firewall_for_ai_settings: + id: cloudflare.zones.firewall_for_ai_settings + name: firewall_for_ai_settings + title: Firewall For Ai Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall-for-ai~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/firewall_for_ai_settings/methods/list + insert: [] + update: [] + delete: [] + replace: [] + settings: + id: cloudflare.zones.settings + name: settings + title: Settings + methods: + firewall_for_ai_settings_put: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1firewall-for-ai~1settings/put' + response: + mediaType: application/json + openAPIDocKey: '200' + zone_settings_edit_zone_settings_info: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1{setting_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1{setting_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/edit' + - $ref: >- + #/components/x-stackQL-resources/settings/methods/zone_settings_edit_zone_settings_info + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/settings/methods/firewall_for_ai_settings_put + holds: + id: cloudflare.zones.holds + name: holds + title: Holds + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1hold/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1hold/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + edit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1hold/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1hold/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/holds/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/holds/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/holds/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/holds/methods/delete' + replace: [] + zones_settings: + id: cloudflare.zones.zones_settings + name: zones_settings + title: Zones Settings + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zones_settings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + aegis: + id: cloudflare.zones.aegis + name: aegis + title: Aegis + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1aegis/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + zone_cache_settings_change_aegis_setting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1aegis/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/aegis/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/aegis/methods/zone_cache_settings_change_aegis_setting + delete: [] + replace: [] + fonts: + id: cloudflare.zones.fonts + name: fonts + title: Fonts + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1fonts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + zone_settings_change_fonts_setting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1fonts/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fonts/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/fonts/methods/zone_settings_change_fonts_setting + delete: [] + replace: [] + origin_h2_max_streams: + id: cloudflare.zones.origin_h2_max_streams + name: origin_h2_max_streams + title: Origin H2 Max Streams + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1origin_h2_max_streams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + zone_cache_settings_change_origin_h2_max_streams_setting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1origin_h2_max_streams/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/origin_h2_max_streams/methods/list + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/origin_h2_max_streams/methods/zone_cache_settings_change_origin_h2_max_streams_setting + delete: [] + replace: [] + origin_max_http_version: + id: cloudflare.zones.origin_max_http_version + name: origin_max_http_version + title: Origin Max Http Version + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1origin_max_http_version/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + zone_cache_settings_change_origin_max_http_version_setting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1settings~1origin_max_http_version/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/origin_max_http_version/methods/list + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/origin_max_http_version/methods/zone_cache_settings_change_origin_max_http_version_setting + delete: [] + replace: [] + rum: + id: cloudflare.zones.rum + name: rum + title: Rum + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1rum/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + web_analytics_toggle_rum: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1rum/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rum/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/rum/methods/web_analytics_toggle_rum + delete: [] + replace: [] + speed_brain: + id: cloudflare.zones.speed_brain + name: speed_brain + title: Speed Brain + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1speed_brain/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + zone_settings_change_speed_brain_setting: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1speed_brain/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/speed_brain/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/speed_brain/methods/zone_settings_change_speed_brain_setting + delete: [] + replace: [] + ssl_automatic_mode: + id: cloudflare.zones.ssl_automatic_mode + name: ssl_automatic_mode + title: Ssl Automatic Mode + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1ssl_automatic_mode/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + ssl_detector_automatic_mode_patch_enrollment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1settings~1ssl_automatic_mode/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ssl_automatic_mode/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/ssl_automatic_mode/methods/ssl_detector_automatic_mode_patch_enrollment + delete: [] + replace: [] + smart_shield: + id: cloudflare.zones.smart_shield + name: smart_shield + title: Smart Shield + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1smart_shield/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + smart_shield_patch_settings: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1smart_shield/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/smart_shield/methods/list' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/smart_shield/methods/smart_shield_patch_settings + delete: [] + replace: [] + cache_reserve_clear: + id: cloudflare.zones.cache_reserve_clear + name: cache_reserve_clear + title: Cache Reserve Clear + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1smart_shield~1cache_reserve_clear/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + smart_shield_settings_start_cache_reserve_clear: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1smart_shield~1cache_reserve_clear/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cache_reserve_clear/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/cache_reserve_clear/methods/smart_shield_settings_start_cache_reserve_clear + update: [] + delete: [] + replace: [] + healthchecks: + id: cloudflare.zones.healthchecks + name: healthchecks + title: Healthchecks + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1smart_shield~1healthchecks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + smart_shield_create_health_check: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1smart_shield~1healthchecks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + smart_shield_delete_health_check: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1smart_shield~1healthchecks~1{healthcheck_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1smart_shield~1healthchecks~1{healthcheck_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + smart_shield_patch_health_check: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1smart_shield~1healthchecks~1{healthcheck_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + smart_shield_update_health_check: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1smart_shield~1healthchecks~1{healthcheck_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/get' + - $ref: '#/components/x-stackQL-resources/healthchecks/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/healthchecks/methods/smart_shield_create_health_check + update: + - $ref: >- + #/components/x-stackQL-resources/healthchecks/methods/smart_shield_patch_health_check + delete: + - $ref: >- + #/components/x-stackQL-resources/healthchecks/methods/smart_shield_delete_health_check + replace: + - $ref: >- + #/components/x-stackQL-resources/healthchecks/methods/smart_shield_update_health_check + subscriptions: + id: cloudflare.zones.subscriptions + name: subscriptions + title: Subscriptions + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1subscription/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1subscription/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1subscription/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/create' + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/update' + suppression: + id: cloudflare.zones.suppression + name: suppression + title: Suppression + methods: + list: + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1sending~1suppression/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.result + post_zones_zone_id_email_sending_suppression: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zone_id}~1email~1sending~1suppression/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1suppression~1{suppression_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_zones_zone_id_email_sending_suppression_suppression_id: + operation: + $ref: >- + #/paths/~1zones~1{zone_id}~1email~1sending~1suppression~1{suppression_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/suppression/methods/get' + - $ref: '#/components/x-stackQL-resources/suppression/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/suppression/methods/post_zones_zone_id_email_sending_suppression + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/suppression/methods/delete_zones_zone_id_email_sending_suppression_suppression_id + replace: []